orx  stable
Portable Game Engine
OrxObject

Macros

#define orxOBJECT_GET_STRUCTURE(OBJECT, TYPE)   orx##TYPE(_orxObject_GetStructure(OBJECT, orxSTRUCTURE_ID_##TYPE))
 
#define orxOBJECT_KZ_DEFAULT_GROUP   "default"
 

Typedefs

typedef struct __orxOBJECT_t orxOBJECT
 

Enumerations

enum  orxOBJECT_EVENT {
  orxOBJECT_EVENT_CREATE = 0, orxOBJECT_EVENT_DELETE, orxOBJECT_EVENT_ENABLE, orxOBJECT_EVENT_DISABLE,
  orxOBJECT_EVENT_PAUSE, orxOBJECT_EVENT_UNPAUSE, orxOBJECT_EVENT_NUMBER, orxOBJECT_EVENT_NONE = orxENUM_NONE
}
 

Internal module function

orxDLLAPI void orxFASTCALL orxObject_Setup ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Init ()
 
orxDLLAPI void orxFASTCALL orxObject_Exit ()
 

Basic handling

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_Create ()
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_CreateFromConfig (const orxSTRING _zConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Delete (orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Update (orxOBJECT *_pstObject, const orxCLOCK_INFO *_pstClockInfo)
 
orxDLLAPI void orxFASTCALL orxObject_Enable (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI void orxFASTCALL orxObject_EnableRecursive (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsEnabled (const orxOBJECT *_pstObject)
 
orxDLLAPI void orxFASTCALL orxObject_Pause (orxOBJECT *_pstObject, orxBOOL _bPause)
 
orxDLLAPI void orxFASTCALL orxObject_PauseRecursive (orxOBJECT *_pstObject, orxBOOL _bPause)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsPaused (const orxOBJECT *_pstObject)
 

User data

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

Ownership

orxDLLAPI void orxFASTCALL orxObject_SetOwner (orxOBJECT *_pstObject, void *_pOwner)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetOwner (const orxOBJECT *_pstObject)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetOwnedChild (const orxOBJECT *_pstObject)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetOwnedSibling (const orxOBJECT *_pstObject)
 

Clock

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

Linked structures

orxDLLAPI orxSTATUS orxFASTCALL orxObject_LinkStructure (orxOBJECT *_pstObject, orxSTRUCTURE *_pstStructure)
 
orxDLLAPI void orxFASTCALL orxObject_UnlinkStructure (orxOBJECT *_pstObject, orxSTRUCTURE_ID _eStructureID)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL _orxObject_GetStructure (const orxOBJECT *_pstObject, orxSTRUCTURE_ID _eStructureID)
 

Flip

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

graphic

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPivot (orxOBJECT *_pstObject, const orxVECTOR *_pvPivot)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetOrigin (orxOBJECT *_pstObject, const orxVECTOR *_pvOrigin)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSize (orxOBJECT *_pstObject, const orxVECTOR *_pvSize)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetPivot (const orxOBJECT *_pstObject, orxVECTOR *_pvPivot)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetOrigin (const orxOBJECT *_pstObject, orxVECTOR *_pvOrigin)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetSize (const orxOBJECT *_pstObject, orxVECTOR *_pvSize)
 
orxDLLAPI orxGRAPHIC *orxFASTCALL orxObject_GetWorkingGraphic (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetColor (orxOBJECT *_pstObject, const orxCOLOR *_pstColor)
 
orxDLLAPI void orxFASTCALL orxObject_SetColorRecursive (orxOBJECT *_pstObject, const orxCOLOR *_pstColor)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_HasColor (const orxOBJECT *_pstObject)
 
orxDLLAPI orxCOLOR *orxFASTCALL orxObject_GetColor (const orxOBJECT *_pstObject, orxCOLOR *_pstColor)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRGB (orxOBJECT *_pstObject, const orxVECTOR *_pvRGB)
 
orxDLLAPI void orxFASTCALL orxObject_SetRGBRecursive (orxOBJECT *_pstObject, const orxVECTOR *_pvRGB)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAlpha (orxOBJECT *_pstObject, orxFLOAT _fAlpha)
 
orxDLLAPI void orxFASTCALL orxObject_SetAlphaRecursive (orxOBJECT *_pstObject, orxFLOAT _fAlpha)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRepeat (orxOBJECT *_pstObject, orxFLOAT _fRepeatX, orxFLOAT _fRepeatY)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_GetRepeat (const orxOBJECT *_pstObject, orxFLOAT *_pfRepeatX, orxFLOAT *_pfRepeatY)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetBlendMode (orxOBJECT *_pstObject, orxDISPLAY_BLEND_MODE _eBlendMode)
 
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxObject_GetBlendMode (const orxOBJECT *_pstObject)
 

Frame

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPosition (orxOBJECT *_pstObject, const orxVECTOR *_pvPosition)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldPosition (orxOBJECT *_pstObject, const orxVECTOR *_pvPosition)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRotation (orxOBJECT *_pstObject, orxFLOAT _fRotation)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldRotation (orxOBJECT *_pstObject, orxFLOAT _fRotation)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetScale (orxOBJECT *_pstObject, const orxVECTOR *_pvScale)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldScale (orxOBJECT *_pstObject, const orxVECTOR *_pvScale)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetPosition (const orxOBJECT *_pstObject, orxVECTOR *_pvPosition)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetWorldPosition (const orxOBJECT *_pstObject, orxVECTOR *_pvPosition)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetRotation (const orxOBJECT *_pstObject)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetWorldRotation (const orxOBJECT *_pstObject)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetScale (const orxOBJECT *_pstObject, orxVECTOR *_pvScale)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetWorldScale (const orxOBJECT *_pstObject, orxVECTOR *_pvScale)
 

Parent

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetParent (orxOBJECT *_pstObject, void *_pParent)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetParent (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetChild (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetSibling (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Attach (orxOBJECT *_pstObject, void *_pParent)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Detach (orxOBJECT *_pstObject)
 

Animation

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimSet (orxOBJECT *_pstObject, orxANIMSET *_pstAnimSet)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimFrequency (orxOBJECT *_pstObject, orxFLOAT _fFrequency)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetCurrentAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetTargetAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsCurrentAnim (const orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTargetAnim (const orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 

Physics / dynamics

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSpeed (orxOBJECT *_pstObject, const orxVECTOR *_pvSpeed)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRelativeSpeed (orxOBJECT *_pstObject, const orxVECTOR *_pvRelativeSpeed)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAngularVelocity (orxOBJECT *_pstObject, orxFLOAT _fVelocity)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetCustomGravity (orxOBJECT *_pstObject, const orxVECTOR *_pvCustomGravity)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetSpeed (const orxOBJECT *_pstObject, orxVECTOR *_pvSpeed)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetRelativeSpeed (const orxOBJECT *_pstObject, orxVECTOR *_pvRelativeSpeed)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAngularVelocity (const orxOBJECT *_pstObject)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetCustomGravity (const orxOBJECT *_pstObject, orxVECTOR *_pvCustomGravity)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetMass (const orxOBJECT *_pstObject)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetMassCenter (const orxOBJECT *_pstObject, orxVECTOR *_pvMassCenter)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_ApplyTorque (orxOBJECT *_pstObject, orxFLOAT _fTorque)
 
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 orxOBJECT *orxFASTCALL orxObject_Raycast (const orxVECTOR *_pvStart, const orxVECTOR *_pvEnd, orxU16 _u16SelfFlags, orxU16 _u16CheckMask, orxBOOL _bEarlyExit, orxVECTOR *_pvContact, orxVECTOR *_pvNormal)
 

Text

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

Bounding box

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

FX

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddUniqueFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddDelayedFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddUniqueDelayedFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SynchronizeFX (orxOBJECT *_pstObject, const orxOBJECT *_pstModel)
 

Sound

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddSound (orxOBJECT *_pstObject, const orxSTRING _zSoundConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveSound (orxOBJECT *_pstObject, const orxSTRING _zSoundConfigID)
 
orxDLLAPI orxSOUND *orxFASTCALL orxObject_GetLastAddedSound (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetVolume (orxOBJECT *_pstObject, orxFLOAT _fVolume)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPitch (orxOBJECT *_pstObject, orxFLOAT _fPitch)
 

Shader

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
 
orxDLLAPI void orxFASTCALL orxObject_EnableShader (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsShaderEnabled (const orxOBJECT *_pstObject)
 

TimeLine

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddTimeLineTrack (orxOBJECT *_pstObject, const orxSTRING _zTrackConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveTimeLineTrack (orxOBJECT *_pstObject, const orxSTRING _zTrackConfigID)
 
orxDLLAPI void orxFASTCALL orxObject_EnableTimeLine (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTimeLineEnabled (const orxOBJECT *_pstObject)
 

Name

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetName (const orxOBJECT *_pstObject)
 

Neighboring

orxDLLAPI orxBANK *orxFASTCALL orxObject_CreateNeighborList (const orxOBOX *_pstCheckBox)
 
orxDLLAPI void orxFASTCALL orxObject_DeleteNeighborList (orxBANK *_pstObjectList)
 

Smoothing

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

texture

orxDLLAPI orxTEXTURE *orxFASTCALL orxObject_GetWorkingTexture (const orxOBJECT *_pstObject)
 

Life time / active time

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

Group

orxDLLAPI orxU32 orxFASTCALL orxObject_GetDefaultGroupID ()
 
orxDLLAPI orxU32 orxFASTCALL orxObject_GetGroupID (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetGroupID (orxOBJECT *_pstObject, orxU32 _u32GroupID)
 
orxDLLAPI void orxFASTCALL orxObject_SetGroupIDRecursive (orxOBJECT *_pstObject, orxU32 _u32GroupID)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetNext (const orxOBJECT *_pstObject, orxU32 _u32GroupID)
 

Picking

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_Pick (const orxVECTOR *_pvPosition, orxU32 _u32GroupID)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_BoxPick (const orxOBOX *_pstBox, orxU32 _u32GroupID)
 

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...

Macro Definition Documentation

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

Defines

Definition at line 62 of file orxObject.h.

#define orxOBJECT_KZ_DEFAULT_GROUP   "default"

Definition at line 64 of file orxObject.h.

Typedef Documentation

typedef struct __orxOBJECT_t orxOBJECT

Internal object structure

Definition at line 86 of file orxObject.h.

Enumeration Type Documentation

Event enum

Enumerator
orxOBJECT_EVENT_CREATE 
orxOBJECT_EVENT_DELETE 
orxOBJECT_EVENT_ENABLE 
orxOBJECT_EVENT_DISABLE 
orxOBJECT_EVENT_PAUSE 
orxOBJECT_EVENT_UNPAUSE 
orxOBJECT_EVENT_NUMBER 
orxOBJECT_EVENT_NONE 

Definition at line 69 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 orxOBJECT_GET_STRUCTURE())

Parameters
[in]_pstObjectConcerned object
[in]_eStructureIDID 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]_pstObjectConcerned object
[in]_zFXConfigIDConfig ID of the FX to add
[in]_fDelayDelay 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]_pstObjectConcerned object
[in]_zFXConfigIDConfig 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]_pstObjectConcerned object
[in]_zShaderConfigIDConfig 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]_pstObjectConcerned object
[in]_zSoundConfigIDConfig ID of the sound to add
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddTimeLineTrack ( orxOBJECT _pstObject,
const orxSTRING  _zTrackConfigID 
)

Adds a timeline track to an object using its config ID.

Parameters
[in]_pstObjectConcerned object
[in]_zTrackConfigIDConfig ID of the timeline track 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. The difference between this function and orxObject_AddDelayedFX() is that this one does not add the specified FX, if the object already has an FX with the same config ID attached. note that the "uniqueness" is determined immediately at the time of this function call, not at the time of the FX start (i.e. after the delay).

Parameters
[in]_pstObjectConcerned object
[in]_zFXConfigIDConfig ID of the FX to add
[in]_fDelayDelay time
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddUniqueFX ( orxOBJECT _pstObject,
const orxSTRING  _zFXConfigID 
)

Adds a unique FX using its config ID. Refer to orxObject_AddUniqueDelayedFX() for details, since this function is the same as it with the delay argument set to 0.

Parameters
[in]_pstObjectConcerned object
[in]_zFXConfigIDConfig 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]_pstObjectConcerned object
[in]_pvForceForce to apply
[in]_pvPointPoint (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]_pstObjectConcerned object
[in]_pvImpulseImpulse to apply
[in]_pvPointPoint (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]_pstObjectConcerned object
[in]_fTorqueTorque to apply
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Attach ( orxOBJECT _pstObject,
void _pParent 
)

Attaches an object to a parent while maintaining the object's world position.

Parameters
[in]_pstObjectConcerned object
[in]_pParentParent structure to attach to (object, spawner, camera or frame)
Returns
orsSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxOBJECT* orxFASTCALL orxObject_BoxPick ( const orxOBOX _pstBox,
orxU32  _u32GroupID 
)

Picks the first active object with size in contact with the given box, withing a given group. Use orxObject_CreateNeighborList() to get all the objects in the box.

Parameters
[in]_pstBoxBox to use for picking
[in]_u32GroupIDGroup ID to consider, orxU32_UNDEFINED for all
Returns
orxOBJECT / orxNULL
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]_zConfigIDConfig 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). The following is an example for iterating over a neighbor list:

1 orxVECTOR vPosition; // The world position of the neighborhood area
2 // set_position(vPosition);
3 orxVECTOR vSize; // The size of the neighborhood area
4 // set_size(vSize);
5 orxVECTOR vPivot; // The pivot of the neighborhood area
6 // set_pivot(vPivot);
7 
8 orxOBOX stBox;
9 orxOBox_2DSet(&stBox, &vPosition, &vPivot, &vSize, 0);
10 
11 orxBANK * pstBank = orxObject_CreateNeighborList(&stBox);
12 if(pstBank) {
13  for(int i=0; i < orxBank_GetCounter(pstBank); ++i)
14  {
15  orxOBJECT * pstObject = *((orxOBJECT **) orxBank_GetAtIndex(pstBank, i));
16  do_something_with(pstObject);
17  }
18  orxObject_DeleteNeighborList(pstBank);
19 }
Parameters
[in]_pstCheckBoxBox to check intersection with
Returns
orxBANK / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Delete ( orxOBJECT _pstObject)

Deletes an object, unsafe when called from an event handler: call orxObject_SetLifeTime(orxFLOAT_0) instead

Parameters
[in]_pstObjectConcerned object
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_DeleteNeighborList ( orxBANK _pstObjectList)

Deletes an object list created with orxObject_CreateNeighborList().

Parameters
[in]_pstObjectListConcerned object list
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Detach ( orxOBJECT _pstObject)

Detaches an object from a parent while maintaining the object's world position.

Parameters
[in]_pstObjectConcerned object
Returns
orsSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_Enable ( orxOBJECT _pstObject,
orxBOOL  _bEnable 
)

Enables/disables an object. Note that enabling/disabling an object is not recursive, so its children will not be affected, see orxObject_EnableRecursive().

Parameters
[in]_pstObjectConcerned object
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxObject_EnableRecursive ( orxOBJECT _pstObject,
orxBOOL  _bEnable 
)

Enables/disables an object and all its children.

Parameters
[in]_pstObjectConcerned object
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxObject_EnableShader ( orxOBJECT _pstObject,
orxBOOL  _bEnable 
)

Enables an object's shader.

Parameters
[in]_pstObjectConcerned object
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxObject_EnableTimeLine ( orxOBJECT _pstObject,
orxBOOL  _bEnable 
)

Enables an object's timeline.

Parameters
[in]_pstObjectConcerned object
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxObject_Exit ( )

Exits from the object module.

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetActiveTime ( const orxOBJECT _pstObject)

Gets object active time, i.e. the amount of time that the object has been alive taking into account. the object's clock multiplier and object's periods of pause.

Parameters
[in]_pstObjectConcerned object
Returns
Active time
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAngularVelocity ( const orxOBJECT _pstObject)

Gets an object angular velocity.

Parameters
[in]_pstObjectConcerned object
Returns
Object angular velocity (radians/seconds)
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxObject_GetBlendMode ( const orxOBJECT _pstObject)

Gets object blend mode.

Parameters
[in]_pstObjectConcerned 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]_pstObjectConcerned object
[out]_pstBoundingBoxBounding box result
Returns
Bounding box / orxNULL
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxObject_GetChild ( const orxOBJECT _pstObject)

Gets object's first child. See orxObject_SetOwner() and orxObject_SetParent() for a comparison of ownership and parenthood in Orx.

This function is typically used to iterate over the children of an object. For example;

1 for(orxOBJECT * pstChild = orxObject_GetChild(pstObject);
2  pstChild;
3  pstChild = orxObject_GetSibling(pstChild))
4 {
5  do_something(pstChild);
6 }
Parameters
[in]_pstObjectConcerned object
Returns
First child structure (object, spawner, camera or frame) / orxNULL
orxDLLAPI orxCLOCK* orxFASTCALL orxObject_GetClock ( const orxOBJECT _pstObject)

Gets object's clock.

Parameters
[in]_pstObjectConcerned object
Returns
Associated clock / orxNULL
orxDLLAPI orxCOLOR* orxFASTCALL orxObject_GetColor ( const orxOBJECT _pstObject,
orxCOLOR _pstColor 
)

Gets object color.

Parameters
[in]_pstObjectConcerned object
[out]_pstColorObject's color
Returns
orxCOLOR / orxNULL
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetCustomGravity ( const orxOBJECT _pstObject,
orxVECTOR _pvCustomGravity 
)

Gets an object custom gravity.

Parameters
[in]_pstObjectConcerned object
[out]_pvCustomGravityCustom gravity to get
Returns
Object custom gravity / orxNULL is object doesn't have any
orxDLLAPI orxU32 orxFASTCALL orxObject_GetDefaultGroupID ( )

Gets default group ID.

Returns
Default group ID
orxDLLAPI orxSTATUS orxFASTCALL orxObject_GetFlip ( const orxOBJECT _pstObject,
orxBOOL *  _pbFlipX,
orxBOOL *  _pbFlipY 
)

Gets object flipping.

Parameters
[in]_pstObjectConcerned object
[in]_pbFlipXX axis flipping
[in]_pbFlipYY axis flipping
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxU32 orxFASTCALL orxObject_GetGroupID ( const orxOBJECT _pstObject)

Gets object's group ID.

Parameters
[in]_pstObjectConcerned object
Returns
Object's group ID. This is the string ID (see orxString_GetFromID()) of the object's group name.
orxDLLAPI orxSOUND* orxFASTCALL orxObject_GetLastAddedSound ( const orxOBJECT _pstObject)

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

Parameters
[in]_pstObjectConcerned object
Returns
orxSOUND / orxNULL
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetLifeTime ( const orxOBJECT _pstObject)

Gets object lifetime.

Parameters
[in]_pstObjectConcerned object
Returns
Lifetime / negative value if none
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetMass ( const orxOBJECT _pstObject)

Gets an object mass.

Parameters
[in]_pstObjectConcerned object
Returns
Object mass
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetMassCenter ( const orxOBJECT _pstObject,
orxVECTOR _pvMassCenter 
)

Gets an object center of mass (object space).

Parameters
[in]_pstObjectConcerned object
[out]_pvMassCenterMass center to get
Returns
Mass center / orxNULL
orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetName ( const orxOBJECT _pstObject)

Gets object config name.

Parameters
[in]_pstObjectConcerned object
Returns
orxSTRING / orxSTRING_EMPTY
orxDLLAPI orxOBJECT* orxFASTCALL orxObject_GetNext ( const orxOBJECT _pstObject,
orxU32  _u32GroupID 
)

Gets next object in group.

Parameters
[in]_pstObjectConcerned object, orxNULL to get the first one
[in]_u32GroupIDGroup ID to consider, orxU32_UNDEFINED for all
Returns
orxOBJECT / orxNULL
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetOrigin ( const orxOBJECT _pstObject,
orxVECTOR _pvOrigin 
)

Get object origin. See orxObject_SetOrigin() for a more detailed explanation.

Parameters
[in]_pstObjectConcerned object
[out]_pvOriginObject origin
Returns
orxVECTOR / orxNULL
orxDLLAPI orxOBJECT* orxFASTCALL orxObject_GetOwnedChild ( const orxOBJECT _pstObject)

Gets object's first owned child (only if created with a config ChildList / has an owner set with orxObject_SetOwner) see orxObject_SetOwner() and orxObject_SetParent() for a comparison of ownership and parenthood in Orx.

This function is typically used to iterate over the owned children of an object. For example;

1 for(orxOBJECT * pstChild = orxObject_GetOwnedChild(pstObject);
2  pstChild;
3  pstChild = orxObject_GetOwnedSibling(pstChild))
4 {
5  do_something(pstChild);
6 }
Parameters
[in]_pstObjectConcerned object
Returns
First owned child object / orxNULL
orxDLLAPI orxOBJECT* orxFASTCALL orxObject_GetOwnedSibling ( const orxOBJECT _pstObject)

Gets object's next owned sibling (only if created with a config ChildList / has an owner set with orxObject_SetOwner) This function is typically used to iterate over the owned children of an object, see orxObject_GetOwnedChild() for an example.

Parameters
[in]_pstObjectConcerned object
Returns
Next sibling object / orxNULL
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxObject_GetOwner ( const orxOBJECT _pstObject)

Gets object's owner. See orxObject_SetOwner().

Parameters
[in]_pstObjectConcerned object
Returns
Owner / orxNULL
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxObject_GetParent ( const orxOBJECT _pstObject)

Gets object's parent. See orxObject_SetParent() for a more detailed explanation.

Parameters
[in]_pstObjectConcerned object
Returns
Parent (object, spawner, camera or frame) / orxNULL
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetPivot ( const orxOBJECT _pstObject,
orxVECTOR _pvPivot 
)

Get object pivot. See orxObject_SetPivot() for a more detailed explanation.

Parameters
[in]_pstObjectConcerned object
[out]_pvPivotObject pivot
Returns
orxVECTOR / orxNULL
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetPosition ( const orxOBJECT _pstObject,
orxVECTOR _pvPosition 
)

Get object position. See orxObject_SetPosition().

Parameters
[in]_pstObjectConcerned object
[out]_pvPositionObject position
Returns
orxVECTOR / orxNULL
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetRelativeSpeed ( const orxOBJECT _pstObject,
orxVECTOR _pvRelativeSpeed 
)

Gets an object relative speed.

Parameters
[in]_pstObjectConcerned object
[out]_pvRelativeSpeedRelative 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]_pstObjectConcerned object
[out]_pfRepeatXX-axis repeat value
[out]_pfRepeatYY-axis repeat value
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetRotation ( const orxOBJECT _pstObject)

Get object rotation. See orxObject_SetRotation().

Parameters
[in]_pstObjectConcerned object
Returns
orxFLOAT (radians)
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetScale ( const orxOBJECT _pstObject,
orxVECTOR _pvScale 
)

Get object scale. See orxObject_SetScale().

Parameters
[in]_pstObjectConcerned object
[out]_pvScaleObject scale vector
Returns
Scale vector
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxObject_GetSibling ( const orxOBJECT _pstObject)

Gets object's next sibling. This function is typically used for iterating over the children of an object, see orxObject_GetChild() for an iteration example.

Parameters
[in]_pstObjectConcerned object
Returns
Next sibling structure (object, spawner, camera or frame) / orxNULL
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetSize ( const orxOBJECT _pstObject,
orxVECTOR _pvSize 
)

Gets object size. See orxObject_SetSize() for a more detailed explanation.

Parameters
[in]_pstObjectConcerned object
[out]_pvSizeObject's size
Returns
orxVECTOR / orxNULL
orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxObject_GetSmoothing ( const orxOBJECT _pstObject)

Gets object smoothing.

Parameters
[in]_pstObjectConcerned object
Returns
Smoothing type (enabled, default or none)
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetSpeed ( const orxOBJECT _pstObject,
orxVECTOR _pvSpeed 
)

Gets an object speed.

Parameters
[in]_pstObjectConcerned object
[out]_pvSpeedSpeed to get
Returns
Object speed / orxNULL
orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetTextString ( orxOBJECT _pstObject)

Gets object text string, if object is associated to a text.

Parameters
[in]_pstObjectConcerned object
Returns
orxSTRING / orxSTRING_EMPTY
orxDLLAPI void* orxFASTCALL orxObject_GetUserData ( const orxOBJECT _pstObject)

Gets object's user data.

Parameters
[in]_pstObjectConcerned object
Returns
Stored user data / orxNULL
orxDLLAPI orxGRAPHIC* orxFASTCALL orxObject_GetWorkingGraphic ( const orxOBJECT _pstObject)

Gets object working graphic.

Parameters
[in]_pstObjectConcerned object
Returns
orxGRAPHIC / orxNULL
orxDLLAPI orxTEXTURE* orxFASTCALL orxObject_GetWorkingTexture ( const orxOBJECT _pstObject)

Gets object working texture.

Parameters
[in]_pstObjectConcerned object
Returns
orxTEXTURE / orxNULL
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetWorldPosition ( const orxOBJECT _pstObject,
orxVECTOR _pvPosition 
)

Get object world position. See orxObject_SetWorldPosition().

Parameters
[in]_pstObjectConcerned object
[out]_pvPositionObject world position
Returns
orxVECTOR / orxNULL
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetWorldRotation ( const orxOBJECT _pstObject)

Get object world rotation. See orxObject_SetWorldRotation().

Parameters
[in]_pstObjectConcerned object
Returns
orxFLOAT (radians)
orxDLLAPI orxVECTOR* orxFASTCALL orxObject_GetWorldScale ( const orxOBJECT _pstObject,
orxVECTOR _pvScale 
)

Gets object world scale. See orxObject_SetWorldScale().

Parameters
[in]_pstObjectConcerned object
[out]_pvScaleObject world scale
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxBOOL orxFASTCALL orxObject_HasColor ( const orxOBJECT _pstObject)

Object has color accessor?

Parameters
[in]_pstObjectConcerned 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]_pstObjectConcerned object
[in]_zAnimNameAnimation name (config's one) to test
Returns
orxTRUE / orxFALSE
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsEnabled ( const orxOBJECT _pstObject)

Is object enabled?

Parameters
[in]_pstObjectConcerned object
Returns
orxTRUE if enabled, orxFALSE otherwise
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsPaused ( const orxOBJECT _pstObject)

Is object paused?

Parameters
[in]_pstObjectConcerned object
Returns
orxTRUE if paused, orxFALSE otherwise
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsShaderEnabled ( const orxOBJECT _pstObject)

Is an object's shader enabled?

Parameters
[in]_pstObjectConcerned object
Returns
orxTRUE if enabled, orxFALSE otherwise
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTargetAnim ( const orxOBJECT _pstObject,
const orxSTRING  _zAnimName 
)

Is target animation test.

Parameters
[in]_pstObjectConcerned object
[in]_zAnimNameAnimation name (config's one) to test
Returns
orxTRUE / orxFALSE
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTimeLineEnabled ( const orxOBJECT _pstObject)

Is an object's timeline enabled?

Parameters
[in]_pstObjectConcerned object
Returns
orxTRUE if enabled, orxFALSE otherwise
orxDLLAPI orxSTATUS orxFASTCALL orxObject_LinkStructure ( orxOBJECT _pstObject,
orxSTRUCTURE _pstStructure 
)

Links a structure to an object.

Parameters
[in]_pstObjectConcerned object
[in]_pstStructureStructure to link
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_Pause ( orxOBJECT _pstObject,
orxBOOL  _bPause 
)

Pauses/unpauses an object. Note that pausing an object is not recursive, so its children will not be affected, see orxObject_PauseRecursive().

Parameters
[in]_pstObjectConcerned object
[in]_bPausePause / unpause
orxDLLAPI void orxFASTCALL orxObject_PauseRecursive ( orxOBJECT _pstObject,
orxBOOL  _bPause 
)

Pauses/unpauses an object and its children.

Parameters
[in]_pstObjectConcerned object
[in]_bPausePause / unpause
orxDLLAPI orxOBJECT* orxFASTCALL orxObject_Pick ( const orxVECTOR _pvPosition,
orxU32  _u32GroupID 
)

Picks the first active object with size "under" the given position, within a given group. See orxObject_BoxPick(), orxObject_CreateNeighborList() and orxObject_Raycast for other ways of picking objects.

Parameters
[in]_pvPositionPosition to pick from
[in]_u32GroupIDGroup ID to consider, orxU32_UNDEFINED for all
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]_pvStartStart of raycast
[in]_pvEndEnd of raycast
[in]_u16SelfFlagsSelfs flags used for filtering (0xFFFF for no filtering)
[in]_u16CheckMaskCheck mask used for filtering (0xFFFF for no filtering)
[in]_bEarlyExitShould stop as soon as an object has been hit (which might not be the closest)
[in]_pvContactIf non-null and a contact is found it will be stored here
[in]_pvNormalIf 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 its config ID.

Parameters
[in]_pstObjectConcerned object
[in]_zFXConfigIDConfig 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 its config ID.

Parameters
[in]_pstObjectConcerned object
[in]_zShaderConfigIDConfig 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 its config ID.

Parameters
[in]_pstObjectConcerned object
[in]_zSoundConfigIDConfig ID of the sound to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveTimeLineTrack ( orxOBJECT _pstObject,
const orxSTRING  _zTrackConfigID 
)

Removes a timeline track using its config ID

Parameters
[in]_pstObjectConcerned object
[in]_zTrackConfigIDConfig ID of the timeline track to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAlpha ( orxOBJECT _pstObject,
orxFLOAT  _fAlpha 
)

Sets object alpha.

Parameters
[in]_pstObjectConcerned object
[in]_fAlphaAlpha value to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_SetAlphaRecursive ( orxOBJECT _pstObject,
orxFLOAT  _fAlpha 
)

Sets alpha of an object and all its children.

Parameters
[in]_pstObjectConcerned object
[in]_fAlphaAlpha value to set
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAngularVelocity ( orxOBJECT _pstObject,
orxFLOAT  _fVelocity 
)

Sets an object angular velocity.

Parameters
[in]_pstObjectConcerned object
[in]_fVelocityAngular velocity to set (radians/seconds)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimFrequency ( orxOBJECT _pstObject,
orxFLOAT  _fFrequency 
)

Sets an object's relative animation frequency.

Parameters
[in]_pstObjectConcerned object
[in]_fFrequencyFrequency to set: < 1.0 for slower than initial, > 1.0 for faster than initial
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimSet ( orxOBJECT _pstObject,
orxANIMSET _pstAnimSet 
)

Sets an object animset.

Parameters
[in]_pstObjectConcerned object
[in]_pstAnimSetAnimation 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]_pstObjectConcerned object
[in]_eBlendModeBlend 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]_pstObjectConcerned object
[in]_pstClockClock to associate / orxNULL
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetColor ( orxOBJECT _pstObject,
const orxCOLOR _pstColor 
)

Sets object color.

Parameters
[in]_pstObjectConcerned object
[in]_pstColorColor to set, orxNULL to remove any specific color
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_SetColorRecursive ( orxOBJECT _pstObject,
const orxCOLOR _pstColor 
)

Sets color of an object and all its children.

Parameters
[in]_pstObjectConcerned object
[in]_pstColorColor to set, orxNULL to remove any specific color
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetCurrentAnim ( orxOBJECT _pstObject,
const orxSTRING  _zAnimName 
)

Sets current animation for object. This function switches the currently displayed animation of the object immediately. Compare this with orxObject_SetTargetAnim().

Parameters
[in]_pstObjectConcerned object
[in]_zAnimNameAnimation 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]_pstObjectConcerned object
[in]_pvCustomGravityCustom 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]_pstObjectConcerned object
[in]_bFlipXFlip it on X axis
[in]_bFlipYFlip it on Y axis
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetGroupID ( orxOBJECT _pstObject,
orxU32  _u32GroupID 
)

Sets object's group ID.

Parameters
[in]_pstObjectConcerned object
[in]_u32GroupIDGroup ID to set. This is the string ID (see orxString_GetID()) of the object's group name.
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_SetGroupIDRecursive ( orxOBJECT _pstObject,
orxU32  _u32GroupID 
)

Sets group ID of an object and all its children.

Parameters
[in]_pstObjectConcerned object
[in]_u32GroupIDGroup ID to set. This is the string ID (see orxString_GetID()) of the object's group name.
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetLifeTime ( orxOBJECT _pstObject,
orxFLOAT  _fLifeTime 
)

Sets object lifetime.

Parameters
[in]_pstObjectConcerned object
[in]_fLifeTimeLifetime to set, negative value to disable it
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetOrigin ( orxOBJECT _pstObject,
const orxVECTOR _pvOrigin 
)

Sets object origin. This is a convenience wrapper around orxGraphic_SetOrigin(). The "origin" of a graphic is essentially what is indicated by the "TextureOrigin" field of a config graphic section. The "origin" together with "size" (see orxObject_SetSize()) defines the sprite of an object.

Parameters
[in]_pstObjectConcerned object
[in]_pvOriginObject origin
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_SetOwner ( orxOBJECT _pstObject,
void _pOwner 
)

Sets owner for an object. Ownership in Orx is only about lifetime management. That is, when an object dies, it also kills its children. Compare this with orxObject_SetParent().

Note that the "ChildList" field of an object's config section implies two things; that the object is both the owner (orxObject_SetOwner()) and the parent (orxObject_SetParent()) of its children. There is an exception to this though; when an object's child has a parent camera, the object is only the owner, and the camera is the parent.

Parameters
[in]_pstObjectConcerned object
[in]_pOwnerOwner to set / orxNULL, if owner is an orxOBJECT, the owned object will be added to it as a children
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetParent ( orxOBJECT _pstObject,
void _pParent 
)

Sets an object parent (in the frame hierarchy). Parenthood in orx is about the transformation (position, rotation, scale) of objects. Transformation of objects are compounded in a frame hierarchy. Compare this with orxObject_SetOwner()

Note that the "ChildList" field of an object's config section implies two things; that the object is both the owner (orxObject_SetOwner()) and the parent (orxObject_SetParent()) of its children. There is an exception to this though; when an object's child has a parent camera, the object is only the owner, and the camera is the parent.

Parameters
[in]_pstObjectConcerned object
[in]_pParentParent structure to set (object, spawner, camera or frame) / orxNULL
Returns
orsSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPitch ( orxOBJECT _pstObject,
orxFLOAT  _fPitch 
)

Sets pitch for all sounds of an object.

Parameters
[in]_pstObjectConcerned object
[in]_fPitchDesired pitch (0.0 - 1.0)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPivot ( orxOBJECT _pstObject,
const orxVECTOR _pvPivot 
)

Sets object pivot. This is a convenience wrapper around orxGraphic_SetPivot(). The "pivot" is essentially what is indicated by the "Pivot" field of a config graphic section.

Parameters
[in]_pstObjectConcerned object
[in]_pvPivotObject pivot
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPosition ( orxOBJECT _pstObject,
const orxVECTOR _pvPosition 
)

Sets object position in its parent's reference frame. See orxObject_SetWorldPosition() for setting an object's position in the global reference frame.

Parameters
[in]_pstObjectConcerned object
[in]_pvPositionObject 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]_pstObjectConcerned object
[in]_pvRelativeSpeedRelative 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]_pstObjectConcerned object
[in]_fRepeatXX-axis repeat value
[in]_fRepeatYY-axis repeat value
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRGB ( orxOBJECT _pstObject,
const orxVECTOR _pvRGB 
)

Sets object RGB values.

Parameters
[in]_pstObjectConcerned object
[in]_pvRGBRGB values to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_SetRGBRecursive ( orxOBJECT _pstObject,
const orxVECTOR _pvRGB 
)

Sets color of an object and all its children.

Parameters
[in]_pstObjectConcerned object
[in]_pvRGBRGB values to set
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRotation ( orxOBJECT _pstObject,
orxFLOAT  _fRotation 
)

Sets object rotation in its parent's reference frame. See orxObject_SetWorldRotation() for setting an object's rotation in the global reference frame.

Parameters
[in]_pstObjectConcerned object
[in]_fRotationObject rotation (radians)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetScale ( orxOBJECT _pstObject,
const orxVECTOR _pvScale 
)

Sets object scale in its parent's reference frame. See orxObject_SetWorldScale() for setting an object's scale in the global reference frame. See orxObject_SetSize() for a deeper explanation of the "size" of an object.

Parameters
[in]_pstObjectConcerned object
[in]_pvScaleObject scale vector
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSize ( orxOBJECT _pstObject,
const orxVECTOR _pvSize 
)

Sets object size. For objects that have a graphic attached it's simply a convenience wrapper for orxGraphic_SetSize(), but an object can also have a size without a graphic.

Note the difference between "Scale" and "Size". The size of an object with a non-text graphic is the sprite size in pixels on its texture. The object's effective size for rendering and intersection purposes (see orxObject_Pick() and friends) is proportional to its "size" multiplied by its "scale". Another important distinction is that the scale of an object also affects its children (see orxObject_SetParent() and note the distinction between parenthood and ownership).

Parameters
[in]_pstObjectConcerned object
[in]_pvSizeObject size
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSmoothing ( orxOBJECT _pstObject,
orxDISPLAY_SMOOTHING  _eSmoothing 
)

Sets object smoothing.

Parameters
[in]_pstObjectConcerned object
[in]_eSmoothingSmoothing 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]_pstObjectConcerned object
[in]_pvSpeedSpeed to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetTargetAnim ( orxOBJECT _pstObject,
const orxSTRING  _zAnimName 
)

Sets target animation for object. The animations are sequenced on an object according to the animation link graph defined by its AnimationSet. The sequence follows the graph and tries to reach the target animation. Use orxObject_SetCurrentAnim() to switch the animation without using the link graph.

Parameters
[in]_pstObjectConcerned object
[in]_zAnimNameAnimation 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]_pstObjectConcerned object
[in]_zStringString 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. Orx ignores the user data, this is a mechanism for attaching custom data to be used later by user code.

Parameters
[in]_pstObjectConcerned object
[in]_pUserDataUser data to store / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetVolume ( orxOBJECT _pstObject,
orxFLOAT  _fVolume 
)

Sets volume for all sounds of an object.

Parameters
[in]_pstObjectConcerned object
[in]_fVolumeDesired volume (0.0 - 1.0)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldPosition ( orxOBJECT _pstObject,
const orxVECTOR _pvPosition 
)

Sets object position in the global reference frame. See orxObject_SetPosition() for setting an object's position in its parent's reference frame.

Parameters
[in]_pstObjectConcerned object
[in]_pvPositionObject world position
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldRotation ( orxOBJECT _pstObject,
orxFLOAT  _fRotation 
)

Sets object rotation in the global reference frame. See orxObject_SetRotation() for setting an object's rotation in its parent's reference frame.

Parameters
[in]_pstObjectConcerned object
[in]_fRotationObject world rotation (radians)
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldScale ( orxOBJECT _pstObject,
const orxVECTOR _pvScale 
)

Sets object scale in the global reference frame. See orxObject_SetScale() for setting an object's scale in its parent's reference frame.

Parameters
[in]_pstObjectConcerned object
[in]_pvScaleObject world scale vector
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SynchronizeFX ( orxOBJECT _pstObject,
const orxOBJECT _pstModel 
)

Synchronizes FXs with another object's ones (if FXs are not matching on both objects the behavior is undefined).

Parameters
[in]_pstObjectConcerned object
[in]_pstModelModel object on which to synchronize FXs
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxObject_UnlinkStructure ( orxOBJECT _pstObject,
orxSTRUCTURE_ID  _eStructureID 
)

Unlinks structure from an object, given its structure ID.

Parameters
[in]_pstObjectConcerned object
[in]_eStructureIDID of structure to unlink
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Update ( orxOBJECT _pstObject,
const orxCLOCK_INFO _pstClockInfo 
)

Updates an object.

Parameters
[in]_pstObjectConcerned object
[in]_pstClockInfoClock information used to compute new object's state
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Generated for orx by doxygen 1.5.6