OrxOBox

Data Structures
struct	orxOBOX
Functions
static orxINLINE orxBOOL	orxOBox_2DIsInside (const orxOBOX *_pstBox, const orxVECTOR *_pvPosition)
static orxINLINE orxOBOX *	orxOBox_2DRotate (orxOBOX *_pstRes, const orxOBOX *_pstOp, orxFLOAT _fAngle)
static orxINLINE orxOBOX *	orxOBox_2DSet (orxOBOX *_pstRes, const orxVECTOR *_pvWorldPosition, const orxVECTOR *_pvPivot, const orxVECTOR *_pvSize, orxFLOAT _fAngle)
static orxINLINE orxOBOX *	orxOBox_Copy (orxOBOX *_pstDst, const orxOBOX *_pstSrc)
static orxINLINE orxVECTOR *	orxOBox_GetCenter (const orxOBOX *_pstOp, orxVECTOR *_pvRes)
static orxINLINE orxBOOL	orxOBox_IsInside (const orxOBOX *_pstBox, const orxVECTOR *_pvPosition)
static orxINLINE orxOBOX *	orxOBox_Move (orxOBOX *_pstRes, const orxOBOX *_pstOp, const orxVECTOR *_pvMove)
static orxINLINE orxBOOL	orxOBox_ZAlignedTestIntersection (const orxOBOX *_pstBox1, const orxOBOX *_pstBox2)

---

Detailed Description

Oriented box module Module that handles oriented boxes

---

Function Documentation

static orxINLINE orxBOOL orxOBox_2DIsInside	(	const orxOBOX *	_pstBox,
		const orxVECTOR *	_pvPosition
	)		[static]

Is 2D position inside oriented box test

Parameters:

[in]	_pstBox	Box to test against position
[in]	_pvPosition	Position to test against the box (no Z-test)

Returns:

orxTRUE if position is inside the box, orxFALSE otherwise

Definition at line 251 of file orxOBox.h.

static orxINLINE orxOBOX* orxOBox_2DRotate	(	orxOBOX *	_pstRes,
		const orxOBOX *	_pstOp,
		orxFLOAT	_fAngle
	)		[static]

Rotates in 2D an OBox

Parameters:

[out]	_pstRes	OBox where to store result
[in]	_pstOp	OBox to rotate (its Z-axis vector will be unchanged)
[in]	_fAngle	Z-axis rotation angle (radians)

Returns:

Rotated OBox

Definition at line 175 of file orxOBox.h.

static orxINLINE orxOBOX* orxOBox_2DSet	(	orxOBOX *	_pstRes,
		const orxVECTOR *	_pvWorldPosition,
		const orxVECTOR *	_pvPivot,
		const orxVECTOR *	_pvSize,
		orxFLOAT	_fAngle
	)		[static]

Sets 2D oriented box values

Parameters:

[out]	_pstRes	OBox to set
[in]	_pvWorldPosition	World space position vector
[in]	_pvPivot	Pivot vector
[in]	_pvSize	Size vector
[in]	_fAngle	Z-axis angle (radians)

Returns:

orxOBOX / orxNULL

Definition at line 75 of file orxOBox.h.

static orxINLINE orxOBOX* orxOBox_Copy	(	orxOBOX *	_pstDst,
		const orxOBOX *	_pstSrc
	)		[static]

Copies an OBox onto another one

Parameters:

[out]	_pstDst	OBox to copy to (destination)
[in]	_pstSrc	OBox to copy from (destination)

Returns:

Destination OBox

Definition at line 116 of file orxOBox.h.

static orxINLINE orxVECTOR* orxOBox_GetCenter	(	const orxOBOX *	_pstOp,
		orxVECTOR *	_pvRes
	)		[static]

Gets OBox center position

Parameters:

[in]	_pstOp	Concerned OBox
[out]	_pvRes	Center position

Returns:

Center position vector

Definition at line 134 of file orxOBox.h.

static orxINLINE orxBOOL orxOBox_IsInside	(	const orxOBOX *	_pstBox,
		const orxVECTOR *	_pvPosition
	)		[static]

Is position inside oriented box test

Parameters:

[in]	_pstBox	Box to test against position
[in]	_pvPosition	Position to test against the box

Returns:

orxTRUE if position is inside the box, orxFALSE otherwise

Definition at line 211 of file orxOBox.h.

static orxINLINE orxOBOX* orxOBox_Move	(	orxOBOX *	_pstRes,
		const orxOBOX *	_pstOp,
		const orxVECTOR *	_pvMove
	)		[static]

Moves an OBox

Parameters:

[out]	_pstRes	OBox where to store result
[in]	_pstOp	OBox to move
[in]	_pvMove	Move vector

Returns:

Moved OBox

Definition at line 155 of file orxOBox.h.

static orxINLINE orxBOOL orxOBox_ZAlignedTestIntersection	(	const orxOBOX *	_pstBox1,
		const orxOBOX *	_pstBox2
	)		[static]

Tests oriented box intersection (simple Z-axis test, to use with Z-axis aligned orxOBOX)

Parameters:

[in]	_pstBox1	First box operand
[in]	_pstBox2	Second box operand

Returns:

orxTRUE if boxes intersect, orxFALSE otherwise

Definition at line 286 of file orxOBox.h.