orx  stable
Portable Game Engine
OrxOBox

Data Structures

struct  orxOBOX
 

Functions

static orxINLINE orxBOOL orxOBox_2DIsInside (const orxOBOX *_pstBox, const orxVECTOR *_pvPosition)
 
static orxINLINE orxOBOXorxOBox_2DRotate (orxOBOX *_pstRes, const orxOBOX *_pstOp, orxFLOAT _fAngle)
 
static orxINLINE orxOBOXorxOBox_2DSet (orxOBOX *_pstRes, const orxVECTOR *_pvWorldPosition, const orxVECTOR *_pvPivot, const orxVECTOR *_pvSize, orxFLOAT _fAngle)
 
static orxINLINE orxOBOXorxOBox_Copy (orxOBOX *_pstDst, const orxOBOX *_pstSrc)
 
static orxINLINE orxVECTORorxOBox_GetCenter (const orxOBOX *_pstOp, orxVECTOR *_pvRes)
 
static orxINLINE orxBOOL orxOBox_IsInside (const orxOBOX *_pstBox, const orxVECTOR *_pvPosition)
 
static orxINLINE orxOBOXorxOBox_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]_pstBoxBox to test against position
[in]_pvPositionPosition 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]_pstResOBox where to store result
[in]_pstOpOBox to rotate (its Z-axis vector will be unchanged)
[in]_fAngleZ-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]_pstResOBox to set
[in]_pvWorldPositionWorld space position vector
[in]_pvPivotPivot vector
[in]_pvSizeSize vector
[in]_fAngleZ-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]_pstDstOBox to copy to (destination)
[in]_pstSrcOBox 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]_pstOpConcerned OBox
[out]_pvResCenter 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]_pstBoxBox to test against position
[in]_pvPositionPosition 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]_pstResOBox where to store result
[in]_pstOpOBox to move
[in]_pvMoveMove 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]_pstBox1First box operand
[in]_pstBox2Second box operand
Returns
orxTRUE if boxes intersect, orxFALSE otherwise

Definition at line 288 of file orxOBox.h.


Generated for orx by doxygen 1.5.6