Data Structures
struct	orxVECTOR

Macros
#define	orxCOLOR_DECLARE(NAME, R, G, B) extern orxDLLAPI const orxVECTOR orxVECTOR_##NAME;

Functions
static orxINLINE orxFLOAT	orxVector_2DDot (const orxVECTOR _pvOp1, const orxVECTOR _pvOp2)

static orxINLINE orxVECTOR *	orxVector_2DRotate (orxVECTOR _pvRes, const orxVECTOR _pvOp, orxFLOAT _fAngle)

static orxINLINE orxVECTOR *	orxVector_Abs (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxVECTOR *	orxVector_Add (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2)

static orxINLINE orxBOOL	orxVector_AreEqual (const orxVECTOR _pvOp1, const orxVECTOR _pvOp2)

orxDLLAPI orxVECTOR *orxFASTCALL	orxVector_Bezier (orxVECTOR _pvRes, const orxVECTOR _pvPoint1, const orxVECTOR _pvPoint2, const orxVECTOR _pvPoint3, const orxVECTOR *_pvPoint4, orxFLOAT _fT)

orxDLLAPI orxVECTOR *orxFASTCALL	orxVector_CatmullRom (orxVECTOR _pvRes, const orxVECTOR _pvPoint1, const orxVECTOR _pvPoint2, const orxVECTOR _pvPoint3, const orxVECTOR *_pvPoint4, orxFLOAT _fT)

static orxINLINE orxVECTOR *	orxVector_Clamp (orxVECTOR _pvRes, const orxVECTOR _pvOp, const orxVECTOR _pvMin, const orxVECTOR _pvMax)

static orxINLINE orxVECTOR *	orxVector_Copy (orxVECTOR _pvDst, const orxVECTOR _pvSrc)

static orxINLINE orxVECTOR *	orxVector_Cross (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2)

static orxINLINE orxVECTOR *	orxVector_Div (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2)

static orxINLINE orxVECTOR *	orxVector_Divf (orxVECTOR _pvRes, const orxVECTOR _pvOp1, orxFLOAT _fOp2)

static orxINLINE orxFLOAT	orxVector_Dot (const orxVECTOR _pvOp1, const orxVECTOR _pvOp2)

static orxINLINE orxVECTOR *	orxVector_Floor (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxVECTOR *	orxVector_FromCartesianToSpherical (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxVECTOR *	orxVector_FromSphericalToCartesian (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxFLOAT	orxVector_GetDistance (const orxVECTOR _pvOp1, const orxVECTOR _pvOp2)

static orxINLINE orxFLOAT	orxVector_GetSize (const orxVECTOR *_pvOp)

static orxINLINE orxFLOAT	orxVector_GetSquareDistance (const orxVECTOR _pvOp1, const orxVECTOR _pvOp2)

static orxINLINE orxFLOAT	orxVector_GetSquareSize (const orxVECTOR *_pvOp)

static orxINLINE orxBOOL	orxVector_IsNull (const orxVECTOR *_pvOp)

static orxINLINE orxVECTOR *	orxVector_Lerp (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2, orxFLOAT _fOp)

static orxINLINE orxVECTOR *	orxVector_Max (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2)

static orxINLINE orxVECTOR *	orxVector_Min (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2)

static orxINLINE orxVECTOR *	orxVector_Mul (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2)

static orxINLINE orxVECTOR *	orxVector_Mulf (orxVECTOR _pvRes, const orxVECTOR _pvOp1, orxFLOAT _fOp2)

static orxINLINE orxVECTOR *	orxVector_Neg (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxVECTOR *	orxVector_Normalize (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxVECTOR *	orxVector_Rec (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxVECTOR *	orxVector_Round (orxVECTOR _pvRes, const orxVECTOR _pvOp)

static orxINLINE orxVECTOR *	orxVector_Set (orxVECTOR *_pvVec, orxFLOAT _fX, orxFLOAT _fY, orxFLOAT _fZ)

static orxINLINE orxVECTOR *	orxVector_SetAll (orxVECTOR *_pvVec, orxFLOAT _fValue)

static orxINLINE orxVECTOR *	orxVector_Sub (orxVECTOR _pvRes, const orxVECTOR _pvOp1, const orxVECTOR *_pvOp2)

Variables
orxDLLAPI const orxVECTOR	orxVECTOR_0

orxDLLAPI const orxVECTOR	orxVECTOR_1

orxDLLAPI const orxVECTOR	orxVECTOR_X

orxDLLAPI const orxVECTOR	orxVECTOR_Y

orxDLLAPI const orxVECTOR	orxVECTOR_Z

Detailed Description

Vector module Module that handles vectors and basic structures based on them

Macro Definition Documentation

#define orxCOLOR_DECLARE	(	NAME,
		R,
		G,
		B
	)	extern orxDLLAPI const orxVECTOR orxVECTOR_##NAME;

Definition at line 919 of file orxVector.h.

Function Documentation

static orxINLINE orxFLOAT orxVector_2DDot	(	const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Gets 2D dot product of two vectors

Parameters

[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: 2D dot product

Definition at line 843 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_2DRotate	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp,
		orxFLOAT	_fAngle
	)

static

Rotates a 2D vector (along Z-axis)

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Vector to rotate
[in]	_fAngle	Angle of rotation (radians)

Returns: Rotated vector

Definition at line 593 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Abs	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Gets the absolute value of a vector and stores it in another one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Input value

Returns: Resulting vector (Abs(Op))

Definition at line 380 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Add	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Adds vectors and stores result in a third one

Parameters

[out]	_pvRes	Vector where to store result (can be one of the two operands)
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Resulting vector (Op1 + Op2)

Definition at line 154 of file orxVector.h.

static orxINLINE orxBOOL orxVector_AreEqual	(	const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Are vectors equal?

Parameters

[in]	_pvOp1	First vector to compare
[in]	_pvOp2	Second vector to compare

Returns: orxTRUE if both vectors are equal, orxFALSE otherwise

Definition at line 662 of file orxVector.h.

orxDLLAPI orxVECTOR* orxFASTCALL orxVector_Bezier	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvPoint1,
		const orxVECTOR *	_pvPoint2,
		const orxVECTOR *	_pvPoint3,
		const orxVECTOR *	_pvPoint4,
		orxFLOAT	_fT
	)

Computes an interpolated point on a cubic Bezier curve segment for a given parameter

Parameters

[out]	_pvRes	Vector where to store result
[in]	_pvPoint1	First point for this curve segment
[in]	_pvPoint2	First control point for this curve segment
[in]	_pvPoint3	Second control point for this curve segment
[in]	_pvPoint4	Last point for this curve segment
[in]	_fT	Interpolation parameter in [0.0, 1.0]

Returns: Interpolated point on the cubic Bezier curve segment

orxDLLAPI orxVECTOR* orxFASTCALL orxVector_CatmullRom	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvPoint1,
		const orxVECTOR *	_pvPoint2,
		const orxVECTOR *	_pvPoint3,
		const orxVECTOR *	_pvPoint4,
		orxFLOAT	_fT
	)

Computes an interpolated point on a Catmull-Rom curve segment for a given parameter

Parameters

[out]	_pvRes	Vector where to store result
[in]	_pvPoint1	First control point for this curve segment
[in]	_pvPoint2	Second control point for this curve segment
[in]	_pvPoint3	Third control point for this curve segment
[in]	_pvPoint4	Fourth control point for this curve segment
[in]	_fT	Interpolation parameter in [0.0, 1.0]

Returns: Interpolated point on the Catmull-Rom curve segment

static orxINLINE orxVECTOR* orxVector_Clamp	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp,
		const orxVECTOR *	_pvMin,
		const orxVECTOR *	_pvMax
	)

static

Clamps a vector between two others

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Vector to clamp
[in]	_pvMin	Minimum boundary
[in]	_pvMax	Maximum boundary

Returns: Resulting vector CLAMP(Op, MIN, MAX)

Definition at line 358 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Copy	(	orxVECTOR *	_pvDst,
		const orxVECTOR *	_pvSrc
	)

static

Copies a vector onto another one

Parameters

[in]	_pvDst	Vector to copy to (destination)
[in]	_pvSrc	Vector to copy from (source)

Returns: Destination vector

Definition at line 135 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Cross	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Gets cross product of two vectors

Parameters

[out]	_pvRes	Vector where to store result
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Cross product orxVECTOR / orxNULL

Definition at line 864 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Div	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Divides a vector by another vector and stores result in a third one

Parameters

[out]	_pvRes	Vector where to store result (can be one of the two operands)
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Resulting vector (Op1 / Op2)

Definition at line 268 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Divf	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		orxFLOAT	_fOp2
	)

static

Divides a vector by an orxFLOAT and stores result in another one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp1	First operand
[in]	_fOp2	Second operand

Returns: Resulting vector

Definition at line 241 of file orxVector.h.

static orxINLINE orxFLOAT orxVector_Dot	(	const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Gets dot product of two vectors

Parameters

[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Dot product

Definition at line 823 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Floor	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Gets floored vector and stores the result in another one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Input value

Returns: Resulting vector Floor(Op)

Definition at line 440 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_FromCartesianToSpherical	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Transforms a cartesian vector into a spherical one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Vector to transform

Returns: Transformed vector

Definition at line 682 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_FromSphericalToCartesian	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Transforms a spherical vector into a cartesian one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Vector to transform

Returns: Transformed vector

Definition at line 776 of file orxVector.h.

static orxINLINE orxFLOAT orxVector_GetDistance	(	const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Gets distance between 2 positions

Parameters

[in]	_pvOp1	First position
[in]	_pvOp2	Second position

Returns: Distance

Definition at line 540 of file orxVector.h.

static orxINLINE orxFLOAT orxVector_GetSize ( const orxVECTOR * _pvOp )

static

Gets vector size

Parameters

[in] _pvOp Input vector

Returns: Vector's size

Definition at line 497 of file orxVector.h.

static orxINLINE orxFLOAT orxVector_GetSquareDistance	(	const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Gets squared distance between 2 positions

Parameters

[in]	_pvOp1	First position
[in]	_pvOp2	Second position

Returns: Squared distance

Definition at line 516 of file orxVector.h.

static orxINLINE orxFLOAT orxVector_GetSquareSize ( const orxVECTOR * _pvOp )

static

Gets vector squared size

Parameters

[in] _pvOp Input vector

Returns: Vector's squared size

Definition at line 479 of file orxVector.h.

static orxINLINE orxBOOL orxVector_IsNull ( const orxVECTOR * _pvOp )

static

Is vector null?

Parameters

[in] _pvOp Vector to test

Returns: orxTRUE if vector's null, orxFALSE otherwise

Definition at line 643 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Lerp	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2,
		orxFLOAT	_fOp
	)

static

Lerps from one vector to another one using a coefficient

Parameters

[out]	_pvRes	Vector where to store result (can be one of the two operands)
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand
[in]	_fOp	Lerp coefficient parameter

Returns: Resulting vector

Definition at line 291 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Max	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Gets maximum between two vectors

Parameters

[out]	_pvRes	Vector where to store result (can be one of the two operands)
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Resulting vector MAX(Op1, Op2)

Definition at line 335 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Min	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Gets minimum between two vectors

Parameters

[out]	_pvRes	Vector where to store result (can be one of the two operands)
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Resulting vector MIN(Op1, Op2)

Definition at line 313 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Mul	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Multiplies a vector by another vector and stores result in a third one

Parameters

[out]	_pvRes	Vector where to store result (can be one of the two operands)
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Resulting vector (Op1 * Op2)

Definition at line 219 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Mulf	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		orxFLOAT	_fOp2
	)

static

Multiplies a vector by an orxFLOAT and stores result in another one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp1	First operand
[in]	_fOp2	Second operand

Returns: Resulting vector

Definition at line 198 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Neg	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Negates a vector and stores result in another one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Vector to negates

Returns: Resulting vector (-Op)

Definition at line 400 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Normalize	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Normalizes a vector

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Vector to normalize

Returns: Normalized vector

Definition at line 564 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Rec	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Gets reciprocal (1.0 /) vector and stores the result in another one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Input value

Returns: Resulting vector (1 / Op)

Definition at line 420 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Round	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp
	)

static

Gets rounded vector and stores the result in another one

Parameters

[out]	_pvRes	Vector where to store result (can be the operand)
[in]	_pvOp	Input value

Returns: Resulting vector Round(Op)

Definition at line 460 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Set	(	orxVECTOR *	_pvVec,
		orxFLOAT	_fX,
		orxFLOAT	_fY,
		orxFLOAT	_fZ
	)

static

Sets vector XYZ values (also work for other coordinate system)

Parameters

[in]	_pvVec	Concerned vector
[in]	_fX	First coordinate value
[in]	_fY	Second coordinate value
[in]	_fZ	Third coordinate value

Returns: Vector

Definition at line 105 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_SetAll	(	orxVECTOR *	_pvVec,
		orxFLOAT	_fValue
	)

static

Sets all the vector coordinates with the given value

Parameters

[in]	_pvVec	Concerned vector
[in]	_fValue	Value to set

Returns: Vector

Definition at line 124 of file orxVector.h.

static orxINLINE orxVECTOR* orxVector_Sub	(	orxVECTOR *	_pvRes,
		const orxVECTOR *	_pvOp1,
		const orxVECTOR *	_pvOp2
	)

static

Substracts vectors and stores result in a third one

Parameters

[out]	_pvRes	Vector where to store result (can be one of the two operands)
[in]	_pvOp1	First operand
[in]	_pvOp2	Second operand

Returns: Resulting vector (Op1 - Op2)

Definition at line 176 of file orxVector.h.

Variable Documentation

orxDLLAPI const orxVECTOR orxVECTOR_0

Null vector

orxDLLAPI const orxVECTOR orxVECTOR_1

Vector filled with 1s

orxDLLAPI const orxVECTOR orxVECTOR_X

X-Axis unit vector

orxDLLAPI const orxVECTOR orxVECTOR_Y

Y-Axis unit vector

orxDLLAPI const orxVECTOR orxVECTOR_Z

Z-Axis unit vector

Data Structures

Macros

Functions

Variables

Detailed Description

Macro Definition Documentation

Function Documentation

Variable Documentation