Defines
#define	orxOBJECT_GET_STRUCTURE(OBJECT, TYPE) orx##TYPE(_orxObject_GetStructure(OBJECT, orxSTRUCTURE_ID_##TYPE))
Typedefs
typedef struct __orxOBJECT_t	orxOBJECT
Enumerations
enum	orxOBJECT_EVENT { orxOBJECT_EVENT_CREATE = 0, orxOBJECT_EVENT_DELETE, orxOBJECT_EVENT_NUMBER, orxOBJECT_EVENT_NONE = orxENUM_NONE }
Functions
orxDLLAPI orxSTRUCTURE *orxFASTCALL	_orxObject_GetStructure (const orxOBJECT *_pstObject, orxSTRUCTURE_ID _eStructureID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddDelayedFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddSound (orxOBJECT *_pstObject, const orxSTRING _zSoundConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddUniqueDelayedFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddUniqueFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_ApplyForce (orxOBJECT _pstObject, const orxVECTOR _pvForce, const orxVECTOR *_pvPoint)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_ApplyImpulse (orxOBJECT _pstObject, const orxVECTOR _pvImpulse, const orxVECTOR *_pvPoint)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_ApplyTorque (orxOBJECT *_pstObject, orxFLOAT _fTorque)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_BoxPick (const orxOBOX *_pstBox)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_ClearColor (orxOBJECT *_pstObject)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_Create ()
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_CreateFromConfig (const orxSTRING _zConfigID)
orxDLLAPI orxBANK *orxFASTCALL	orxObject_CreateNeighborList (const orxOBOX *_pstCheckBox)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_Delete (orxOBJECT *_pstObject)
orxDLLAPI void orxFASTCALL	orxObject_DeleteNeighborList (orxBANK *_pstObjectList)
orxDLLAPI void orxFASTCALL	orxObject_Enable (orxOBJECT *_pstObject, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxObject_EnableShader (orxOBJECT *_pstObject, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxObject_Exit ()
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetAngularVelocity (const orxOBJECT *_pstObject)
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL	orxObject_GetBlendMode (const orxOBJECT *_pstObject)
orxDLLAPI orxOBOX *orxFASTCALL	orxObject_GetBoundingBox (const orxOBJECT _pstObject, orxOBOX _pstBoundingBox)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_GetChild (const orxOBJECT *_pstObject)
orxDLLAPI orxCLOCK *orxFASTCALL	orxObject_GetClock (const orxOBJECT *_pstObject)
orxDLLAPI orxCOLOR *orxFASTCALL	orxObject_GetColor (const orxOBJECT _pstObject, orxCOLOR _pstColor)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetCustomGravity (const orxOBJECT _pstObject, orxVECTOR _pvCustomGravity)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_GetFlip (const orxOBJECT _pstObject, orxBOOL _pbFlipX, orxBOOL *_pbFlipY)
orxDLLAPI orxSOUND *orxFASTCALL	orxObject_GetLastAddedSound (const orxOBJECT *_pstObject)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetLifeTime (const orxOBJECT *_pstObject)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetMass (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetMassCenter (const orxOBJECT _pstObject, orxVECTOR _pvMassCenter)
orxDLLAPI const orxSTRING orxFASTCALL	orxObject_GetName (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetOrigin (const orxOBJECT _pstObject, orxVECTOR _pvOrigin)
orxDLLAPI orxSTRUCTURE *orxFASTCALL	orxObject_GetOwner (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetPivot (const orxOBJECT _pstObject, orxVECTOR _pvPivot)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetPosition (const orxOBJECT _pstObject, orxVECTOR _pvPosition)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetRelativeSpeed (const orxOBJECT _pstObject, orxVECTOR _pvRelativeSpeed)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_GetRepeat (const orxOBJECT _pstObject, orxFLOAT _pfRepeatX, orxFLOAT *_pfRepeatY)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetRotation (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetScale (const orxOBJECT _pstObject, orxVECTOR _pvScale)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_GetSibling (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetSize (const orxOBJECT _pstObject, orxVECTOR _pvSize)
orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL	orxObject_GetSmoothing (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetSpeed (const orxOBJECT _pstObject, orxVECTOR _pvSpeed)
orxDLLAPI void *orxFASTCALL	orxObject_GetUserData (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetWorldPosition (const orxOBJECT _pstObject, orxVECTOR _pvPosition)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetWorldRotation (const orxOBJECT *_pstObject)
orxDLLAPI orxVECTOR *orxFASTCALL	orxObject_GetWorldScale (const orxOBJECT _pstObject, orxVECTOR _pvScale)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_HasColor (const orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxObject_IsCurrentAnim (const orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_IsEnabled (const orxOBJECT *_pstObject)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_IsPaused (const orxOBJECT *_pstObject)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_IsShaderEnabled (const orxOBJECT *_pstObject)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_IsTargetAnim (const orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_LinkStructure (orxOBJECT _pstObject, orxSTRUCTURE _pstStructure)
orxDLLAPI void orxFASTCALL	orxObject_Pause (orxOBJECT *_pstObject, orxBOOL _bPause)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_Pick (const orxVECTOR *_pvPosition)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_Raycast (const orxVECTOR _pvStart, const orxVECTOR _pvEnd, orxU16 _u16SelfFlags, orxU16 _u16CheckMask, orxBOOL _bEarlyExit, orxVECTOR _pvContact, orxVECTOR _pvNormal)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveSound (orxOBJECT *_pstObject, const orxSTRING _zSoundConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetAngularVelocity (orxOBJECT *_pstObject, orxFLOAT _fVelocity)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetAnimFrequency (orxOBJECT *_pstObject, orxFLOAT _fFrequency)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetAnimSet (orxOBJECT _pstObject, orxANIMSET _pstAnimSet)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetBlendMode (orxOBJECT *_pstObject, orxDISPLAY_BLEND_MODE _eBlendMode)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetClock (orxOBJECT _pstObject, orxCLOCK _pstClock)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetColor (orxOBJECT _pstObject, const orxCOLOR _pstColor)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetCurrentAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetCustomGravity (orxOBJECT _pstObject, const orxVECTOR _pvCustomGravity)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetFlip (orxOBJECT *_pstObject, orxBOOL _bFlipX, orxBOOL _bFlipY)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetLifeTime (orxOBJECT *_pstObject, orxFLOAT _fLifeTime)
orxDLLAPI void orxFASTCALL	orxObject_SetOwner (orxOBJECT _pstObject, void _pOwner)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetParent (orxOBJECT _pstObject, void _pParent)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetPivot (orxOBJECT _pstObject, const orxVECTOR _pvPivot)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetPosition (orxOBJECT _pstObject, const orxVECTOR _pvPosition)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetRelativeSpeed (orxOBJECT _pstObject, const orxVECTOR _pvRelativeSpeed)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetRepeat (orxOBJECT *_pstObject, orxFLOAT _fRepeatX, orxFLOAT _fRepeatY)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetRotation (orxOBJECT *_pstObject, orxFLOAT _fRotation)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetScale (orxOBJECT _pstObject, const orxVECTOR _pvScale)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetSmoothing (orxOBJECT *_pstObject, orxDISPLAY_SMOOTHING _eSmoothing)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetSpeed (orxOBJECT _pstObject, const orxVECTOR _pvSpeed)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetTargetAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetTextString (orxOBJECT *_pstObject, const orxSTRING _zString)
orxDLLAPI void orxFASTCALL	orxObject_Setup ()
orxDLLAPI void orxFASTCALL	orxObject_SetUserData (orxOBJECT _pstObject, void _pUserData)
orxDLLAPI void orxFASTCALL	orxObject_UnlinkStructure (orxOBJECT *_pstObject, orxSTRUCTURE_ID _eStructureID)

Detailed Description

Object module Allows to creates and handle objects Objects are structures containers that can refer to many other structures such as frames, graphics, etc...

Define Documentation

#define orxOBJECT_GET_STRUCTURE	(	OBJECT,
		TYPE
	)	orx##TYPE(_orxObject_GetStructure(OBJECT, orxSTRUCTURE_ID_##TYPE))

Defines

Definition at line 60 of file orxObject.h.

Typedef Documentation

typedef struct __orxOBJECT_t orxOBJECT

Internal object structure

Definition at line 78 of file orxObject.h.

Enumeration Type Documentation

enum orxOBJECT_EVENT

Event enum

Enumerator:

orxOBJECT_EVENT_CREATE
orxOBJECT_EVENT_DELETE
orxOBJECT_EVENT_NUMBER
orxOBJECT_EVENT_NONE

Definition at line 65 of file orxObject.h.

Function Documentation

orxDLLAPI orxSTRUCTURE* orxFASTCALL _orxObject_GetStructure	(	const orxOBJECT *	_pstObject,
		orxSTRUCTURE_ID	_eStructureID
	)

Structure used by an object get accessor, given its structure ID. Structure must then be cast correctly (see helper macro)

Parameters:

[in]	_pstObject	Concerned object
[in]	_eStructureID	ID of the structure to get

Returns:: orxSTRUCTURE / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddDelayedFX	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zFXConfigID,
		orxFLOAT	_fDelay
	)

Adds a delayed FX using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zFXConfigID	Config ID of the FX to add
[in]	_fDelay	Delay time

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddFX	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zFXConfigID
	)

Adds an FX using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zFXConfigID	Config ID of the FX to add

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddShader	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zShaderConfigID
	)

Adds a shader to an object using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zShaderConfigID	Config ID of the shader to add

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddSound	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zSoundConfigID
	)

Adds a sound using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zSoundConfigID	Config ID of the sound to add

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddUniqueDelayedFX	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zFXConfigID,
		orxFLOAT	_fDelay
	)

Adds a unique delayed FX using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zFXConfigID	Config ID of the FX to add
[in]	_fDelay	Delay time

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddUniqueFX	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zFXConfigID
	)

Adds a unique FX using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zFXConfigID	Config ID of the FX to add

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_ApplyForce	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvForce,
		const orxVECTOR *	_pvPoint
	)

Applies a force

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvForce	Force to apply
[in]	_pvPoint	Point (world coordinates) where the force will be applied, if orxNULL, center of mass will be used

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_ApplyImpulse	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvImpulse,
		const orxVECTOR *	_pvPoint
	)

Applies an impulse

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvImpulse	Impulse to apply
[in]	_pvPoint	Point (world coordinates) where the impulse will be applied, if orxNULL, center of mass will be used

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_ApplyTorque	(	orxOBJECT *	_pstObject,
		orxFLOAT	_fTorque
	)

Applies a torque

Parameters:

[in]	_pstObject	Concerned object
[in]	_fTorque	Torque to apply

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_BoxPick ( const orxOBOX * _pstBox )

Picks the first active object with graphic in contact with the given box

Parameters:

[in] _pstBox Box to use for picking

Returns:: orxOBJECT / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxObject_ClearColor ( orxOBJECT * _pstObject )

Clears object color

Parameters:

[in] _pstObject Concerned object

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_Create ( )

Creates an empty object

Returns:: orxOBJECT / orxNULL

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_CreateFromConfig ( const orxSTRING _zConfigID )

Creates an object from config

Parameters:

[in] _zConfigID Config ID @ return orxOBJECT / orxNULL

orxDLLAPI orxBANK* orxFASTCALL orxObject_CreateNeighborList ( const orxOBOX * _pstCheckBox )

Creates a list of object at neighboring of the given box (ie. whose bounding volume intersects this box)

Parameters:

[in] _pstCheckBox Box to check intersection with

Returns:: orxBANK / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Delete ( orxOBJECT * _pstObject )

Deletes an object

Parameters:

[in] _pstObject Concerned object

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_DeleteNeighborList ( orxBANK * _pstObjectList )

Deletes an object list created with orxObject_CreateNeighborList

Parameters:

[in] _pstObjectList Concerned object list

orxDLLAPI void orxFASTCALL orxObject_Enable	(	orxOBJECT *	_pstObject,
		orxBOOL	_bEnable
	)

Enables/disables an object

Parameters:

[in]	_pstObject	Concerned object
[in]	_bEnable	Enable / disable

orxDLLAPI void orxFASTCALL orxObject_EnableShader	(	orxOBJECT *	_pstObject,
		orxBOOL	_bEnable
	)

Enables an object's shader

Parameters:

[in]	_pstObject	Concerned object
[in]	_bEnable	Enable / disable

orxDLLAPI void orxFASTCALL orxObject_Exit ( )

Exits from the object module

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAngularVelocity ( const orxOBJECT * _pstObject )

Gets an object angular velocity

Parameters:

[in] _pstObject Concerned object

Returns:: Object angular velocity (radians/seconds)

orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxObject_GetBlendMode ( const orxOBJECT * _pstObject )

Gets object blend mode

Parameters:

[in] _pstObject Concerned object

Returns:: Blend mode (alpha, multiply, add or none)

orxDLLAPI orxOBOX* orxFASTCALL orxObject_GetBoundingBox	(	const orxOBJECT *	_pstObject,
		orxOBOX *	_pstBoundingBox
	)

Gets object's bounding box (OBB)

Parameters:

[in]	_pstObject	Concerned object
[in]	_pstBoundingBox	Bounding box result

Returns:: Bounding box / orxNULL

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_GetChild ( const orxOBJECT * _pstObject )

Gets object's first child (only if created with a config ChildList)

Parameters:

[in] _pstObject Concerned object

Returns:: First child object / orxNULL

orxDLLAPI orxCLOCK* orxFASTCALL orxObject_GetClock ( const orxOBJECT * _pstObject )

Gets object's clock

Parameters:

[in] _pstObject Concerned object

Returns:: Associated clock / orxNULL

orxDLLAPI orxCOLOR* orxFASTCALL orxObject_GetColor	(	const orxOBJECT *	_pstObject,
		orxCOLOR *	_pstColor
	)

Gets object color

Parameters:

[in]	_pstObject	Concerned object
[out]	_pstColor	Object's color

Returns:: orxCOLOR / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetCustomGravity	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvCustomGravity
	)

Gets an object custom gravity

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvCustomGravity	Custom gravity to get

Returns:: Object custom gravity / orxNULL is object doesn't have any

orxDLLAPI orxSTATUS orxFASTCALL orxObject_GetFlip	(	const orxOBJECT *	_pstObject,
		orxBOOL *	_pbFlipX,
		orxBOOL *	_pbFlipY
	)

Gets object flipping

Parameters:

[in]	_pstObject	Concerned object
[in]	_pbFlipX	X axis flipping
[in]	_pbFlipY	Y axis flipping

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSOUND* orxFASTCALL orxObject_GetLastAddedSound ( const orxOBJECT * _pstObject )

Gets last added sound (Do *NOT* destroy it directly before removing it!!!)

Parameters:

[in] _pstObject Concerned object

Returns:: orxSOUND / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetLifeTime ( const orxOBJECT * _pstObject )

Gets object lifetime

Parameters:

[in] _pstObject Concerned object

Returns:: Lifetime / negative value if none

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetMass ( const orxOBJECT * _pstObject )

Gets an object mass

Parameters:

[in] _pstObject Concerned object

Returns:: Object mass

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetMassCenter	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvMassCenter
	)

Gets an object center of mass

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvMassCenter	Mass center to get

Returns:: Mass center / orxNULL

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetName ( const orxOBJECT * _pstObject )

Gets object config name

Parameters:

[in] _pstObject Concerned object

Returns:: orxSTRING / orxSTRING_EMPTY

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetOrigin	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvOrigin
	)

Get object origin

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvOrigin	Object origin

Returns:: orxVECTOR / orxNULL

orxDLLAPI orxSTRUCTURE* orxFASTCALL orxObject_GetOwner ( const orxOBJECT * _pstObject )

Gets object's owner

Parameters:

[in] _pstObject Concerned object

Returns:: Owner / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetPivot	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvPivot
	)

Get object pivot

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvPivot	Object pivot

Returns:: orxVECTOR / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetPosition	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvPosition
	)

Get object position

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvPosition	Object position

Returns:: orxVECTOR / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetRelativeSpeed	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvRelativeSpeed
	)

Gets an object relative speed

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvRelativeSpeed	Relative speed to get

Returns:: Object relative speed / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxObject_GetRepeat	(	const orxOBJECT *	_pstObject,
		orxFLOAT *	_pfRepeatX,
		orxFLOAT *	_pfRepeatY
	)

Gets object repeat (wrap) values

Parameters:

[in]	_pstObject	Concerned object
[out]	_pfRepeatX	X-axis repeat value
[out]	_pfRepeatY	Y-axis repeat value

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetRotation ( const orxOBJECT * _pstObject )

Get object rotation

Parameters:

[in] _pstObject Concerned object

Returns:: orxFLOAT (radians)

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetScale	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvScale
	)

Get object scale

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvScale	Object scale vector

Returns:: Scale vector

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_GetSibling ( const orxOBJECT * _pstObject )

Gets object's next sibling (only if created with a config ChildList)

Parameters:

[in] _pstObject Concerned object

Returns:: Next sibling object / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetSize	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvSize
	)

Gets object size

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvSize	Object's size

Returns:: orxVECTOR / orxNULL

orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxObject_GetSmoothing ( const orxOBJECT * _pstObject )

Gets object smoothing

Parameters:

[in] _pstObject Concerned object

Returns:: Smoothing type (enabled, default or none)

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetSpeed	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvSpeed
	)

Gets an object speed

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvSpeed	Speed to get

Returns:: Object speed / orxNULL

orxDLLAPI void* orxFASTCALL orxObject_GetUserData ( const orxOBJECT * _pstObject )

Gets object's user data

Parameters:

[in] _pstObject Concerned object

Returns:: Stored user data / orxNULL

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetWorldPosition	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvPosition
	)

Get object world position

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvPosition	Object world position

Returns:: orxVECTOR / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetWorldRotation ( const orxOBJECT * _pstObject )

Get object world rotation

Parameters:

[in] _pstObject Concerned object

Returns:: orxFLOAT (radians)

orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetWorldScale	(	const orxOBJECT *	_pstObject,
		orxVECTOR *	_pvScale
	)

Gets object world scale

Parameters:

[in]	_pstObject	Concerned object
[out]	_pvScale	Object world scale

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxObject_HasColor ( const orxOBJECT * _pstObject )

Object has color accessor

Parameters:

[in] _pstObject Concerned object

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Init ( )

Inits the object module

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsCurrentAnim	(	const orxOBJECT *	_pstObject,
		const orxSTRING	_zAnimName
	)

Is current animation test

Parameters:

[in]	_pstObject	Concerned object
[in]	_zAnimName	Animation name (config's one) to test

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsEnabled ( const orxOBJECT * _pstObject )

Is object enabled?

Parameters:

[in] _pstObject Concerned object

Returns:: orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsPaused ( const orxOBJECT * _pstObject )

Is object paused?

Parameters:

[in] _pstObject Concerned object

Returns:: orxTRUE if paused, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsShaderEnabled ( const orxOBJECT * _pstObject )

Is an object's shader enabled?

Parameters:

[in] _pstObject Concerned object

Returns:: orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTargetAnim	(	const orxOBJECT *	_pstObject,
		const orxSTRING	_zAnimName
	)

Is target animation test

Parameters:

[in]	_pstObject	Concerned object
[in]	_zAnimName	Animation name (config's one) to test

Returns:: orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_LinkStructure	(	orxOBJECT *	_pstObject,
		orxSTRUCTURE *	_pstStructure
	)

Links a structure to an object

Parameters:

[in]	_pstObject	Concerned object
[in]	_pstStructure	Structure to link

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_Pause	(	orxOBJECT *	_pstObject,
		orxBOOL	_bPause
	)

Pauses/unpauses an object

Parameters:

[in]	_pstObject	Concerned object
[in]	_bPause	Pause / unpause

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_Pick ( const orxVECTOR * _pvPosition )

Picks the first active object with graphic "under" the given position

Parameters:

[in] _pvPosition Position to pick from

Returns:: orxOBJECT / orxNULL

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_Raycast	(	const orxVECTOR *	_pvStart,
		const orxVECTOR *	_pvEnd,
		orxU16	_u16SelfFlags,
		orxU16	_u16CheckMask,
		orxBOOL	_bEarlyExit,
		orxVECTOR *	_pvContact,
		orxVECTOR *	_pvNormal
	)

Issues a raycast to test for potential objects in the way

Parameters:

[in]	_pvStart	Start of raycast
[in]	_pvEnd	End of raycast
[in]	_u16SelfFlags	Selfs flags used for filtering (0xFFFF for no filtering)
[in]	_u16CheckMask	Check mask used for filtering (0xFFFF for no filtering)
[in]	_bEarlyExit	Should stop as soon as an object has been hit (which might not be the closest)
[in]	_pvContact	If non-null and a contact is found it will be stored here
[in]	_pvNormal	If non-null and a contact is found, its normal will be stored here

Returns:: Colliding orxOBJECT / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveFX	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zFXConfigID
	)

Removes an FX using using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zFXConfigID	Config ID of the FX to remove

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveShader	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zShaderConfigID
	)

Removes a shader using using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zShaderConfigID	Config ID of the shader to remove

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveSound	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zSoundConfigID
	)

Removes a sound using using its config ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_zSoundConfigID	Config ID of the sound to remove

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAngularVelocity	(	orxOBJECT *	_pstObject,
		orxFLOAT	_fVelocity
	)

Sets an object angular velocity

Parameters:

[in]	_pstObject	Concerned object
[in]	_fVelocity	Angular velocity to set (radians/seconds)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimFrequency	(	orxOBJECT *	_pstObject,
		orxFLOAT	_fFrequency
	)

Sets an object animation frequency

Parameters:

[in]	_pstObject	Concerned object
[in]	_fFrequency	Frequency to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimSet	(	orxOBJECT *	_pstObject,
		orxANIMSET *	_pstAnimSet
	)

Sets an object animset

Parameters:

[in]	_pstObject	Concerned object
[in]	_pstAnimSet	Animation set to set / orxNULL

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetBlendMode	(	orxOBJECT *	_pstObject,
		orxDISPLAY_BLEND_MODE	_eBlendMode
	)

Sets object blend mode

Parameters:

[in]	_pstObject	Concerned object
[in]	_eBlendMode	Blend mode (alpha, multiply, add or none)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetClock	(	orxOBJECT *	_pstObject,
		orxCLOCK *	_pstClock
	)

Sets associated clock for an object

Parameters:

[in]	_pstObject	Concerned object
[in]	_pstClock	Clock to associate / orxNULL

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetColor	(	orxOBJECT *	_pstObject,
		const orxCOLOR *	_pstColor
	)

Sets object color

Parameters:

[in]	_pstObject	Concerned object
[in]	_pstColor	Color to set, orxNULL to remove any specifig color

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetCurrentAnim	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zAnimName
	)

Sets current animation for object

Parameters:

[in]	_pstObject	Concerned object
[in]	_zAnimName	Animation name (config's one) to set / orxNULL

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetCustomGravity	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvCustomGravity
	)

Sets an object custom gravity

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvCustomGravity	Custom gravity to set / orxNULL to remove it

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetFlip	(	orxOBJECT *	_pstObject,
		orxBOOL	_bFlipX,
		orxBOOL	_bFlipY
	)

Sets object flipping

Parameters:

[in]	_pstObject	Concerned object
[in]	_bFlipX	Flip it on X axis
[in]	_bFlipY	Flip it on Y axis

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetLifeTime	(	orxOBJECT *	_pstObject,
		orxFLOAT	_fLifeTime
	)

Sets object lifetime

Parameters:

[in]	_pstObject	Concerned object
[in]	_fLifeTime	Lifetime to set, negative value to disable it

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_SetOwner	(	orxOBJECT *	_pstObject,
		void *	_pOwner
	)

Sets owner for an object

Parameters:

[in]	_pstObject	Concerned object
[in]	_pOwner	Owner to set / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetParent	(	orxOBJECT *	_pstObject,
		void *	_pParent
	)

Sets an object parent

Parameters:

[in]	_pstObject	Concerned object
[in]	_pParent	Parent structure to set (object, spawner, camera or frame) / orxNULL

Returns:: orsSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPivot	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvPivot
	)

Sets object pivot

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvPivot	Object pivot

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPosition	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvPosition
	)

Sets object position

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvPosition	Object position

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRelativeSpeed	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvRelativeSpeed
	)

Sets an object speed relative to its rotation/scale

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvRelativeSpeed	Relative speed to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRepeat	(	orxOBJECT *	_pstObject,
		orxFLOAT	_fRepeatX,
		orxFLOAT	_fRepeatY
	)

Sets object repeat (wrap) values

Parameters:

[in]	_pstObject	Concerned object
[in]	_fRepeatX	X-axis repeat value
[in]	_fRepeatY	Y-axis repeat value

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRotation	(	orxOBJECT *	_pstObject,
		orxFLOAT	_fRotation
	)

Sets object rotation

Parameters:

[in]	_pstObject	Concerned object
[in]	_fRotation	Object rotation (radians)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetScale	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvScale
	)

Sets object scale

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvScale	Object scale vector

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSmoothing	(	orxOBJECT *	_pstObject,
		orxDISPLAY_SMOOTHING	_eSmoothing
	)

Sets object smoothing

Parameters:

[in]	_pstObject	Concerned object
[in]	_eSmoothing	Smoothing type (enabled, default or none)

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSpeed	(	orxOBJECT *	_pstObject,
		const orxVECTOR *	_pvSpeed
	)

Sets an object speed

Parameters:

[in]	_pstObject	Concerned object
[in]	_pvSpeed	Speed to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetTargetAnim	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zAnimName
	)

Sets target animation for object

Parameters:

[in]	_pstObject	Concerned object
[in]	_zAnimName	Animation name (config's one) to set / orxNULL

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetTextString	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zString
	)

Sets object text string, if object is associated to a text

Parameters:

[in]	_pstObject	Concerned object
[in]	_zString	String to set

Returns:: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_Setup ( )

Object module setup

orxDLLAPI void orxFASTCALL orxObject_SetUserData	(	orxOBJECT *	_pstObject,
		void *	_pUserData
	)

Sets user data for an object

Parameters:

[in]	_pstObject	Concerned object
[in]	_pUserData	User data to store / orxNULL

orxDLLAPI void orxFASTCALL orxObject_UnlinkStructure	(	orxOBJECT *	_pstObject,
		orxSTRUCTURE_ID	_eStructureID
	)

Unlinks structure from an object, given its structure ID

Parameters:

[in]	_pstObject	Concerned object
[in]	_eStructureID	ID of structure to unlink

OrxObject

Defines

Typedefs

Enumerations

Functions

Detailed Description

Define Documentation

Typedef Documentation

Enumeration Type Documentation

Function Documentation