OOQuaternion.m File Reference

#include "OOMaths.h"

Include dependency graph for OOQuaternion.m:

Go to the source code of this file.

Functions
Quaternion	quaternion_multiply (Quaternion q1, Quaternion q2)
void	quaternion_set_random (Quaternion *quat)
Vector	vector_forward_from_quaternion (Quaternion quat)
HPVector	HPvector_forward_from_quaternion (Quaternion quat)
Vector	vector_up_from_quaternion (Quaternion quat)
Vector	vector_right_from_quaternion (Quaternion quat)
void	basis_vectors_from_quaternion (Quaternion quat, Vector *outRight, Vector *outUp, Vector *outForward)
Quaternion	quaternion_rotation_between (Vector v0, Vector v1)
Quaternion	quaternion_rotation_betweenHP (HPVector v0, HPVector v1)
Quaternion	quaternion_limited_rotation_between (Vector v0, Vector v1, float maxArc)
void	quaternion_rotate_about_x (Quaternion *quat, OOScalar angle)
void	quaternion_rotate_about_y (Quaternion *quat, OOScalar angle)
void	quaternion_rotate_about_z (Quaternion *quat, OOScalar angle)
void	quaternion_rotate_about_axis (Quaternion *quat, Vector axis, OOScalar angle)
Vector	quaternion_rotate_vector (Quaternion q, Vector v)
HPVector	quaternion_rotate_HPvector (Quaternion q, HPVector v)

Variables
const Quaternion	kIdentityQuaternion = { 1.0f, 0.0f, 0.0f, 0.0f }
const Quaternion	kZeroQuaternion = { 0.0f, 0.0f, 0.0f, 0.0f }

Function Documentation

basis_vectors_from_quaternion()

void basis_vectors_from_quaternion	(	Quaternion	quat,
		Vector *	outRight,
		Vector *	outUp,
		Vector *	outForward
	)

Definition at line 145 of file OOQuaternion.m.

{
    OOScalar    w, wz, wy, wx;
    OOScalar    x, xz, xy, xx;
    OOScalar    y, yz, yy;
    OOScalar    z, zz;
    
    w = quat.w;
    z = quat.z;
    y = quat.y;
    x = quat.x;
    
    xx = 2.0f * x; yy = 2.0f * y; zz = 2.0f * z;
    wx = w * xx; wy = w * yy; wz = w * zz;
    xx = x * xx; xy = x * yy; xz = x * zz;
    yy = y * yy; yz = y * zz;
    zz = z * zz;
    
    if (outRight != NULL)
    {
        outRight->x = 1.0f - yy - zz;
        outRight->y = xy - wz;
        outRight->z = xz + wy;
 
        if (outRight->x || outRight->y || outRight->z)  *outRight = vector_normal(*outRight);
        else  *outRight = make_vector(1.0f, 0.0f, 0.0f);
    }
    
    if (outUp != NULL)
    {
        outUp->x = xy + wz;
        outUp->y = 1.0f - xx - zz;
        outUp->z = yz - wx;
        
        if (outUp->x || outUp->y || outUp->z)  *outUp = vector_normal(*outUp);
        else  *outUp = make_vector(0.0f, 1.0f, 0.0f);
    }
    
    if (outForward != NULL)
    {
        outForward->x = xz - wy;
        outForward->y = yz + wx;
        outForward->z = 1.0f - xx - yy;
        
        if (outForward->x || outForward->y || outForward->z)  *outForward = vector_normal(*outForward);
        else  *outForward = make_vector(0.0f, 0.0f, 1.0f);
    }
}

References x, and y.

HPvector_forward_from_quaternion()

HPVector HPvector_forward_from_quaternion

(

Quaternion

quat

)

Definition at line 83 of file OOQuaternion.m.

{
    // HPVect: profile this later
    return vectorToHPVector(vector_forward_from_quaternion(quat));
}

References vector_forward_from_quaternion().

Here is the call graph for this function:

quaternion_limited_rotation_between()

Quaternion quaternion_limited_rotation_between	(	Vector	v0,
		Vector	v1,
		float	maxArc
	)

Definition at line 257 of file OOQuaternion.m.

{
    Quaternion q;
    OOScalar min_s = 2.0f * cosf(0.5f * maxArc);
    OOScalar s = sqrtf((1.0f + v0.x * v1.x + v0.y * v1.y + v0.z * v1.z) * 2.0f);
    // for some antiparallel vectors, s returns a NaN instead of 0. Testing s > 0 catches both.
    if (EXPECT(s > 0.0f))
    {
        if (s < min_s)  // larger angle => smaller cos
        {
            OOScalar a = maxArc * 0.5f;
            OOScalar w = cosf(a);
            OOScalar scale = sinf(a);
            q.x = (v0.y * v1.z - v0.z * v1.y) * scale;
            q.y = (v0.z * v1.x - v0.x * v1.z) * scale;
            q.z = (v0.x * v1.y - v0.y * v1.x) * scale;
            q.w = w;
        }
        else
        {
            OOScalar is = 1.0f / s;
            q.x = (v0.y * v1.z - v0.z * v1.y) * is;
            q.y = (v0.z * v1.x - v0.x * v1.z) * is;
            q.z = (v0.x * v1.y - v0.y * v1.x) * is;
            q.w = s * 0.5f;
        }
    }
    else
    {
        // Is this actually a problem?
        q = kIdentityQuaternion;
    }
    return q;
}

References EXPECT, and kIdentityQuaternion.

Referenced by VectorRotationTo().

Here is the caller graph for this function:

quaternion_multiply()

Quaternion quaternion_multiply	(	Quaternion	q1,
		Quaternion	q2
	)

Definition at line 33 of file OOQuaternion.m.

{
    Quaternion  result;
    result.w = q1.w * q2.w - q1.x * q2.x - q1.y * q2.y - q1.z * q2.z;
    result.x = q1.w * q2.x + q1.x * q2.w + q1.y * q2.z - q1.z * q2.y;
    result.y = q1.w * q2.y + q1.y * q2.w + q1.z * q2.x - q1.x * q2.z;
    result.z = q1.w * q2.z + q1.z * q2.w + q1.x * q2.y - q1.y * q2.x;
    return result;
}

Referenced by HeadUpDisplay::hudRotateViewpointForVirtualDepth, quaternion_rotate_about_axis(), and QuaternionMultiply().

Here is the caller graph for this function:

quaternion_rotate_about_axis()

void quaternion_rotate_about_axis	(	Quaternion *	quat,
		Vector	axis,
		OOScalar	angle
	)

Definition at line 350 of file OOQuaternion.m.

{
    Quaternion q2 /*, result */;
    OOScalar a = angle * 0.5f;
    OOScalar w = cosf(a);
    OOScalar scale = sinf(a);
    
    q2.w = w;
    q2.x = axis.x * scale;
    q2.y = axis.y * scale;
    q2.z = axis.z * scale;
    
    *quat = quaternion_multiply(*quat, q2);
}

References quaternion_multiply().

Referenced by OOLaserShotEntity::dealloc, HeadUpDisplay::hudRotateViewpointForVirtualDepth, OOPlanetEntity::initFromDictionary:withAtmosphere:andSeed:forSystem:, and QuaternionRotate().

Here is the call graph for this function:

Here is the caller graph for this function:

quaternion_rotate_about_x()

void quaternion_rotate_about_x	(	Quaternion *	quat,
		OOScalar	angle
	)

Definition at line 293 of file OOQuaternion.m.

{
    Quaternion result;
    OOScalar a = angle * 0.5f;
    OOScalar w = cosf(a);
    OOScalar scale = sinf(a);
    
    result.w = quat->w * w - quat->x * scale;
    result.x = quat->w * scale + quat->x * w;
    result.y = quat->y * w + quat->z * scale;
    result.z = quat->z * w - quat->y * scale;
    
    quat->w = result.w;
    quat->x = result.x;
    quat->y = result.y;
    quat->z = result.z;
}

Referenced by QuaternionRotateX().

Here is the caller graph for this function:

quaternion_rotate_about_y()

void quaternion_rotate_about_y	(	Quaternion *	quat,
		OOScalar	angle
	)

Definition at line 312 of file OOQuaternion.m.

{
    Quaternion result;
    OOScalar a = angle * 0.5f;
    OOScalar w = cosf(a);
    OOScalar scale = sinf(a);
    
    result.w = quat->w * w - quat->y * scale;
    result.x = quat->x * w - quat->z * scale;
    result.y = quat->w * scale + quat->y * w;
    result.z = quat->z * w + quat->x * scale;
    
    quat->w = result.w;
    quat->x = result.x;
    quat->y = result.y;
    quat->z = result.z;
}

Referenced by QuaternionRotateY().

Here is the caller graph for this function:

quaternion_rotate_about_z()

void quaternion_rotate_about_z	(	Quaternion *	quat,
		OOScalar	angle
	)

Definition at line 331 of file OOQuaternion.m.

{
    Quaternion result;
    OOScalar a = angle * 0.5f;
    OOScalar w = cosf(a);
    OOScalar scale = sinf(a);
    
    result.w = quat->w * w - quat->z * scale;
    result.x = quat->x * w + quat->y * scale;
    result.y = quat->y * w - quat->x * scale;
    result.z = quat->w * scale + quat->z * w;
    
    quat->w = result.w;
    quat->x = result.x;
    quat->y = result.y;
    quat->z = result.z;
}

Referenced by QuaternionRotateZ().

Here is the caller graph for this function:

quaternion_rotate_HPvector()

HPVector quaternion_rotate_HPvector	(	Quaternion	q,
		HPVector	v
	)

Definition at line 401 of file OOQuaternion.m.

{
    OOHPScalar qvw, qvx, qvy, qvz;
    
    qvw = 0.0 - q.x * v.x - q.y * v.y - q.z * v.z;
    qvx = -q.w * v.x + q.y * v.z - q.z * v.y;
    qvy = -q.w * v.y + q.z * v.x - q.x * v.z;
    qvz = -q.w * v.z + q.x * v.y - q.y * v.x;
    
    v.x = qvw * -q.x + qvx * -q.w + qvy * -q.z - qvz * -q.y;
    v.y = qvw * -q.y + qvy * -q.w + qvz * -q.x - qvx * -q.z;
    v.z = qvw * -q.z + qvz * -q.w + qvx * -q.y - qvy * -q.x;
    
    return v;
}

Referenced by VectorRotateBy().

Here is the caller graph for this function:

quaternion_rotate_vector()

Vector quaternion_rotate_vector	(	Quaternion	q,
		Vector	v
	)

Definition at line 385 of file OOQuaternion.m.

{
    Quaternion              qv;
    
    qv.w = 0.0f - q.x * v.x - q.y * v.y - q.z * v.z;
    qv.x = -q.w * v.x + q.y * v.z - q.z * v.y;
    qv.y = -q.w * v.y + q.z * v.x - q.x * v.z;
    qv.z = -q.w * v.z + q.x * v.y - q.y * v.x;
    
    v.x = qv.w * -q.x + qv.x * -q.w + qv.y * -q.z - qv.z * -q.y;
    v.y = qv.w * -q.y + qv.y * -q.w + qv.z * -q.x - qv.x * -q.z;
    v.z = qv.w * -q.z + qv.z * -q.w + qv.x * -q.y - qv.y * -q.x;
    
    return v;
}

quaternion_rotation_between()

Quaternion quaternion_rotation_between	(	Vector	v0,
		Vector	v1
	)

Definition at line 195 of file OOQuaternion.m.

{
    Quaternion q;
    OOScalar s = sqrt((1.0f + v0.x * v1.x + v0.y * v1.y + v0.z * v1.z) * 2.0f);
    if (EXPECT(s > 0.0f))
    {
        OOScalar is = 1.0f / s;
        q.x = (v0.y * v1.z - v0.z * v1.y) * is;
        q.y = (v0.z * v1.x - v0.x * v1.z) * is;
        q.z = (v0.x * v1.y - v0.y * v1.x) * is;
        q.w = s * 0.5f;
    }
    else
    {
        // Is this actually a problem?
        if (vector_equal(v1, kBasisZVector) || vector_equal(v0, kBasisZVector))
        {
            q = make_quaternion(0, 1, 0, 0);
        }
        else
        {
            q = kIdentityQuaternion;
        }
        // We arrive here for antiparallel vectors. Rotation axis is then undefined, but not rotating is
        // wrong. Probably the calling function should exclude this situation. For current
        // in-game use of this function we return (0,1,0,0), but generally that is also wrong.
    }
    return q;
}

References EXPECT, kBasisZVector, and kIdentityQuaternion.

Referenced by VectorRotationTo().

Here is the caller graph for this function:

quaternion_rotation_betweenHP()

Quaternion quaternion_rotation_betweenHP	(	HPVector	v0,
		HPVector	v1
	)

Definition at line 226 of file OOQuaternion.m.

{
    Quaternion q;
    OOHPScalar s = sqrt((1.0 + v0.x * v1.x + v0.y * v1.y + v0.z * v1.z) * 2.0);
    if (EXPECT(s > 0.0))
    {
        OOHPScalar is = 1.0 / s;
        q.x = (v0.y * v1.z - v0.z * v1.y) * is;
        q.y = (v0.z * v1.x - v0.x * v1.z) * is;
        q.z = (v0.x * v1.y - v0.y * v1.x) * is;
        q.w = s * 0.5;
    }
    else
    {
        // Is this actually a problem?
        if (HPvector_equal(v1, kBasisZHPVector) || HPvector_equal(v0, kBasisZHPVector))
        {
            q = make_quaternion(0, 1, 0, 0);
        }
        else
        {
            q = kIdentityQuaternion;
        }
        // We arrive here for antiparallel vectors. Rotation axis is then undefined, but not rotating is
        // wrong. Probably the calling function should exclude this situation. For current
        // in-game use of this function we return (0,1,0,0), but generally that is also wrong.
    }
    return q;
}

References EXPECT, kBasisZHPVector, and kIdentityQuaternion.

quaternion_set_random()

void quaternion_set_random

(

Quaternion *

quat

)

Definition at line 46 of file OOQuaternion.m.

{
    quat->w = (OOScalar)(Ranrot() % 1024) - 511.5f;  // -511.5 to +511.5
    quat->x = (OOScalar)(Ranrot() % 1024) - 511.5f;  // -511.5 to +511.5
    quat->y = (OOScalar)(Ranrot() % 1024) - 511.5f;  // -511.5 to +511.5
    quat->z = (OOScalar)(Ranrot() % 1024) - 511.5f;  // -511.5 to +511.5
    quaternion_normalize(quat);
}

References Ranrot().

Here is the call graph for this function:

vector_forward_from_quaternion()

Vector vector_forward_from_quaternion

(

Quaternion

quat

)

Definition at line 57 of file OOQuaternion.m.

{
    OOScalar    w, wy, wx;
    OOScalar    x, xz, xx;
    OOScalar    y, yz, yy;
    OOScalar    z, zz;
    Vector res;
    
    w = quat.w;
    z = quat.z;
    y = quat.y;
    x = quat.x;
    
    xx = 2.0f * x; yy = 2.0f * y; zz = 2.0f * z;
    wx = w * xx; wy = w * yy;
    xx = x * xx; xz = x * zz;
    yy = y * yy; yz = y * zz;
    
    res.x = xz - wy;
    res.y = yz + wx;
    res.z = 1.0f - xx - yy;
    
    if (res.x||res.y||res.z)  return vector_normal(res);
    else  return make_vector(0.0f, 0.0f, 1.0f);
}

References x, and y.

Referenced by ShipEntity::abandonShip, OOLaserShotEntity::dealloc, EntityGetProperty(), HPvector_forward_from_quaternion(), and QuaternionVectorForward().

Here is the caller graph for this function:

vector_right_from_quaternion()

Vector vector_right_from_quaternion

(

Quaternion

quat

)

Definition at line 117 of file OOQuaternion.m.

{
    OOScalar    w, wz, wy;
    OOScalar    x, xz, xy;
    OOScalar    y, yy;
    OOScalar    z, zz;
    Vector res;
    
    w = quat.w;
    z = quat.z;
    y = quat.y;
    x = quat.x;
    
    yy = 2.0f * y; zz = 2.0f * z;
    wy = w * yy; wz = w * zz;
    xy = x * yy; xz = x * zz;
    yy = y * yy;
    zz = z * zz;
    
    res.x = 1.0f - yy - zz;
    res.y = xy - wz;
    res.z = xz + wy;
    
    if (res.x||res.y||res.z)  return vector_normal(res);
    else  return make_vector(1.0f, 0.0f, 0.0f);
}

References x, and y.

Referenced by ShipEntity::abandonShip, and QuaternionVectorRight().

Here is the caller graph for this function:

vector_up_from_quaternion()

Vector vector_up_from_quaternion

(

Quaternion

quat

)

Definition at line 89 of file OOQuaternion.m.

{
    OOScalar    w, wz, wx;
    OOScalar    x, xy, xx;
    OOScalar    y, yz, yy;
    OOScalar    z, zz;
    Vector res;
    
    w = quat.w;
    z = quat.z;
    y = quat.y;
    x = quat.x;
    
    xx = 2.0f * x; yy = 2.0f * y; zz = 2.0f * z;
    wx = w * xx; wz = w * zz;
    xx = x * xx; xy = x * yy;
    yz = y * zz;
    zz = z * zz;
    
    res.x = xy + wz;
    res.y = 1.0f - xx - zz;
    res.z = yz - wx;
    
    if (res.x||res.y||res.z)  return vector_normal(res);
    else  return make_vector(0.0f, 1.0f, 0.0f);
}

References x, and y.

Referenced by ShipEntity::abandonShip, OOLaserShotEntity::dealloc, HeadUpDisplay::hudRotateViewpointForVirtualDepth, OOPlanetEntity::initFromDictionary:withAtmosphere:andSeed:forSystem:, and QuaternionVectorUp().

Here is the caller graph for this function:

Variable Documentation

kIdentityQuaternion

const Quaternion kIdentityQuaternion = { 1.0f, 0.0f, 0.0f, 0.0f }

Definition at line 29 of file OOQuaternion.m.

{ 1.0f, 0.0f, 0.0f, 0.0f };

Referenced by OOLaserShotEntity::dealloc, OOPlanetEntity::initFromDictionary:withAtmosphere:andSeed:forSystem:, PlayerShipSetCustomView(), quaternion_limited_rotation_between(), quaternion_rotation_between(), quaternion_rotation_betweenHP(), QuaternionConstruct(), Verify_Quaternion(), and WaypointGetProperty().

kZeroQuaternion

const Quaternion kZeroQuaternion = { 0.0f, 0.0f, 0.0f, 0.0f }

Definition at line 30 of file OOQuaternion.m.

{ 0.0f, 0.0f, 0.0f, 0.0f };

Referenced by JSObjectGetQuaternion(), Verify_Quaternion(), and WaypointGetProperty().