OrxObject

Macros
#define	orxOBJECT_GET_STRUCTURE(OBJECT, TYPE)
#define	orxOBJECT_KZ_DEFAULT_GROUP   "default"

Typedefs
typedef struct __orxOBJECT_t	orxOBJECT
typedef orxBOOL(orxFASTCALL *	orxOBJECT_NEIGHBOR_FUNCTION) (orxOBJECT *_pstObject, void *_pContext)

Enumerations
enum	orxOBJECT_EVENT {   orxOBJECT_EVENT_CREATE = 0 , orxOBJECT_EVENT_DELETE , orxOBJECT_EVENT_PREPARE , 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)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_FindOwnedChild (const orxOBJECT *_pstObject, const orxSTRING _zPath)

Clock
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetClock (orxOBJECT *_pstObject, orxCLOCK *_pstClock)
orxDLLAPI void orxFASTCALL	orxObject_SetClockRecursive (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_ClearFlip (orxOBJECT *_pstObject)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_HasFlip (const orxOBJECT *_pstObject)
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_SetRelativePivot (orxOBJECT *_pstObject, orxU32 _u32AlignFlags)
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 orxVECTOR *orxFASTCALL	orxObject_GetRGB (const orxOBJECT *_pstObject, orxVECTOR *_pvRGB)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetAlpha (orxOBJECT *_pstObject, orxFLOAT _fAlpha)
orxDLLAPI void orxFASTCALL	orxObject_SetAlphaRecursive (orxOBJECT *_pstObject, orxFLOAT _fAlpha)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetAlpha (const orxOBJECT *_pstObject)
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 void orxFASTCALL	orxObject_SetBlendModeRecursive (orxOBJECT *_pstObject, orxDISPLAY_BLEND_MODE _eBlendMode)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_HasBlendMode (const orxOBJECT *_pstObject)
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 orxOBJECT *orxFASTCALL	orxObject_GetChild (const orxOBJECT *_pstObject)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_GetSibling (const orxOBJECT *_pstObject)
orxDLLAPI orxSTRUCTURE *orxFASTCALL	orxObject_GetNextChild (const orxOBJECT *_pstObject, void *_pChild, orxSTRUCTURE_ID _eStructureID)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_FindChild (const orxOBJECT *_pstObject, const orxSTRING _zPath)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_Attach (orxOBJECT *_pstObject, void *_pParent)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_Detach (orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetIgnoreFlags (orxOBJECT *_pstObject, orxU32 _u32IgnoreFlags)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetLiteralIgnoreFlags (orxOBJECT *_pstObject, const orxSTRING _zIgnoreFlags)
orxDLLAPI orxU32 orxFASTCALL	orxObject_GetIgnoreFlags (const orxOBJECT *_pstObject)
orxDLLAPI const orxSTRING orxFASTCALL	orxObject_GetLiteralIgnoreFlags (const orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_LogParents (const orxOBJECT *_pstObject)

Animation
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetAnimSet (orxOBJECT *_pstObject, orxANIMSET *_pstAnimSet)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetAnimFrequency (orxOBJECT *_pstObject, orxFLOAT _fFrequency)
orxDLLAPI void orxFASTCALL	orxObject_SetAnimFrequencyRecursive (orxOBJECT *_pstObject, orxFLOAT _fFrequency)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetAnimFrequency (const orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetAnimTime (orxOBJECT *_pstObject, orxFLOAT _fTime)
orxDLLAPI void orxFASTCALL	orxObject_SetAnimTimeRecursive (orxOBJECT *_pstObject, orxFLOAT _fTime)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetAnimTime (const orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetCurrentAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI void orxFASTCALL	orxObject_SetCurrentAnimRecursive (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetTargetAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI void orxFASTCALL	orxObject_SetTargetAnimRecursive (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
orxDLLAPI const orxSTRING orxFASTCALL	orxObject_GetCurrentAnim (const orxOBJECT *_pstObject)
orxDLLAPI const orxSTRING orxFASTCALL	orxObject_GetTargetAnim (const orxOBJECT *_pstObject)
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 *_pvBegin, 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 (const 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 void orxFASTCALL	orxObject_AddFXRecursive (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fPropagationDelay)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddUniqueFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
orxDLLAPI void orxFASTCALL	orxObject_AddUniqueFXRecursive (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fPropagationDelay)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
orxDLLAPI void orxFASTCALL	orxObject_RemoveFXRecursive (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveAllFXs (orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveAllFXsRecursive (orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetFXFrequency (orxOBJECT *_pstObject, orxFLOAT _fFrequency)
orxDLLAPI void orxFASTCALL	orxObject_SetFXFrequencyRecursive (orxOBJECT *_pstObject, orxFLOAT _fFrequency)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetFXFrequency (const orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetFXTime (orxOBJECT *_pstObject, orxFLOAT _fTime)
orxDLLAPI void orxFASTCALL	orxObject_SetFXTimeRecursive (orxOBJECT *_pstObject, orxFLOAT _fTime)
orxDLLAPI orxFLOAT orxFASTCALL	orxObject_GetFXTime (const orxOBJECT *_pstObject)
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 orxSTATUS orxFASTCALL	orxObject_RemoveAllSounds (orxOBJECT *_pstObject)
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)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetPanning (orxOBJECT *_pstObject, orxFLOAT _fPanning, orxBOOL _bMix)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_Play (orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_Stop (orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddFilter (orxOBJECT *_pstObject, const orxSTRING _zFilterConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveLastFilter (orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveAllFilters (orxOBJECT *_pstObject)

Shader
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetShader (orxOBJECT *_pstObject, orxSHADER *_pstShader)
orxDLLAPI void orxFASTCALL	orxObject_SetShaderRecursive (orxOBJECT *_pstObject, orxSHADER *_pstShader)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetShaderFromConfig (orxOBJECT *_pstObject, const orxSTRING _zShaderID)
orxDLLAPI void orxFASTCALL	orxObject_SetShaderFromConfigRecursive (orxOBJECT *_pstObject, const orxSTRING _zShaderID)
orxDLLAPI const orxSHADER *orxFASTCALL	orxObject_GetShader (const orxOBJECT *_pstObject)
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 void orxFASTCALL	orxObject_AddTimeLineTrackRecursive (orxOBJECT *_pstObject, const orxSTRING _zTrackConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveTimeLineTrack (orxOBJECT *_pstObject, const orxSTRING _zTrackConfigID)
orxDLLAPI void orxFASTCALL	orxObject_RemoveTimeLineTrackRecursive (orxOBJECT *_pstObject, const orxSTRING _zTrackConfigID)
orxDLLAPI void orxFASTCALL	orxObject_EnableTimeLine (orxOBJECT *_pstObject, orxBOOL _bEnable)
orxDLLAPI orxBOOL orxFASTCALL	orxObject_IsTimeLineEnabled (const orxOBJECT *_pstObject)

Trigger
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_AddTrigger (orxOBJECT *_pstObject, const orxSTRING _zTriggerConfigID)
orxDLLAPI void orxFASTCALL	orxObject_AddTriggerRecursive (orxOBJECT *_pstObject, const orxSTRING _zTriggerConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveTrigger (orxOBJECT *_pstObject, const orxSTRING _zTriggerConfigID)
orxDLLAPI void orxFASTCALL	orxObject_RemoveTriggerRecursive (orxOBJECT *_pstObject, const orxSTRING _zTriggerConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_FireTrigger (orxOBJECT *_pstObject, const orxSTRING _zEvent, const orxSTRING *_azRefinementList, orxU32 _u32Count)
orxDLLAPI void orxFASTCALL	orxObject_FireTriggerRecursive (orxOBJECT *_pstObject, const orxSTRING _zEvent, const orxSTRING *_azRefinementList, orxU32 _u32Count)

Name
orxDLLAPI const orxSTRING orxFASTCALL	orxObject_GetName (const orxOBJECT *_pstObject)

Neighboring
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_ForAllNeighbors (const orxOBJECT_NEIGHBOR_FUNCTION _pfnNeighborCallback, const orxOBOX *_pstCheckBox, orxSTRINGID _stGroupID, orxBOOL _bEnabled, void *_pContext)

Smoothing
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetSmoothing (orxOBJECT *_pstObject, orxDISPLAY_SMOOTHING _eSmoothing)
orxDLLAPI void orxFASTCALL	orxObject_SetSmoothingRecursive (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_SetLiteralLifeTime (orxOBJECT *_pstObject, const orxSTRING _zLifeTime)
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)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_ResetActiveTime (orxOBJECT *_pstObject)
orxDLLAPI void orxFASTCALL	orxObject_ResetActiveTimeRecursive (orxOBJECT *_pstObject)

Group
orxDLLAPI orxSTRINGID orxFASTCALL	orxObject_GetDefaultGroupID ()
orxDLLAPI orxSTRINGID orxFASTCALL	orxObject_GetGroupID (const orxOBJECT *_pstObject)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_SetGroupID (orxOBJECT *_pstObject, orxSTRINGID _stGroupID)
orxDLLAPI void orxFASTCALL	orxObject_SetGroupIDRecursive (orxOBJECT *_pstObject, orxSTRINGID _stGroupID)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_GetNext (const orxOBJECT *_pstObject, orxSTRINGID _stGroupID)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_GetNextEnabled (const orxOBJECT *_pstObject, orxSTRINGID _stGroupID)

Picking
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_Pick (const orxVECTOR *_pvPosition, orxSTRINGID _stGroupID)
orxDLLAPI orxOBJECT *orxFASTCALL	orxObject_BoxPick (const orxOBOX *_pstBox, orxSTRINGID _stGroupID)

Detailed Description

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

Macro Definition Documentation

orxOBJECT_GET_STRUCTURE

#define orxOBJECT_GET_STRUCTURE	(		OBJECT,
			TYPE )

Value:

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

Defines

Definition at line 62 of file orxObject.h.

orxOBJECT_KZ_DEFAULT_GROUP

#define orxOBJECT_KZ_DEFAULT_GROUP   "default"

Definition at line 64 of file orxObject.h.

Typedef Documentation

orxOBJECT

typedef struct __orxOBJECT_t orxOBJECT

Internal object structure

Definition at line 87 of file orxObject.h.

orxOBJECT_NEIGHBOR_FUNCTION

typedef orxBOOL(orxFASTCALL * orxOBJECT_NEIGHBOR_FUNCTION) (orxOBJECT *_pstObject, void *_pContext)

Object callback function type to use with ForAllNeighbors

Definition at line 90 of file orxObject.h.

Enumeration Type Documentation

orxOBJECT_EVENT

enum orxOBJECT_EVENT

Event enum

Enumerator
orxOBJECT_EVENT_CREATE
orxOBJECT_EVENT_DELETE
orxOBJECT_EVENT_PREPARE
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

_orxObject_GetStructure()

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

extern

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]	_pstObject	Concerned object
[in]	_eStructureID	ID of the structure to get

Returns

orxSTRUCTURE / orxNULL

orxObject_AddFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddFilter ( orxOBJECT * _pstObject, const orxSTRING _zFilterConfigID )

extern

Adds a filter to the sounds of an object (cascading).

Parameters

[in]	_pstObject	Concerned object
[in]	_zFilterConfigID	Config ID of the filter to add

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_AddFX()

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

extern

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

orxObject_AddFXRecursive()

orxDLLAPI void orxFASTCALL orxObject_AddFXRecursive ( orxOBJECT * _pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fPropagationDelay )

extern

Adds an FX to an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zFXConfigID	Config ID of the FX to add
[in]	_fPropagationDelay	Propagation delay for each child

orxObject_AddSound()

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

extern

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

orxObject_AddTimeLineTrack()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddTimeLineTrack ( orxOBJECT * _pstObject, const orxSTRING _zTrackConfigID )

extern

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

Parameters

[in]	_pstObject	Concerned object
[in]	_zTrackConfigID	Config ID of the timeline track to add

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_AddTimeLineTrackRecursive()

orxDLLAPI void orxFASTCALL orxObject_AddTimeLineTrackRecursive ( orxOBJECT * _pstObject, const orxSTRING _zTrackConfigID )

extern

Adds a timeline track to an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zTrackConfigID	Config ID of the timeline track to add

orxObject_AddTrigger()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddTrigger ( orxOBJECT * _pstObject, const orxSTRING _zTriggerConfigID )

extern

Adds a trigger to an object using its config ID.

Parameters

[in]	_pstObject	Concerned object
[in]	_zTriggerConfigID	Config ID of the trigger to add

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_AddTriggerRecursive()

orxDLLAPI void orxFASTCALL orxObject_AddTriggerRecursive ( orxOBJECT * _pstObject, const orxSTRING _zTriggerConfigID )

extern

Adds a trigger to an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zTriggerConfigID	Config ID of the trigger to add

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_AddUniqueFX()

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

extern

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

orxObject_AddUniqueFXRecursive()

orxDLLAPI void orxFASTCALL orxObject_AddUniqueFXRecursive ( orxOBJECT * _pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fPropagationDelay )

extern

Adds a unique FX to an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zFXConfigID	Config ID of the FX to add
[in]	_fPropagationDelay	Propagation delay for each child

orxObject_ApplyForce()

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

extern

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

orxObject_ApplyImpulse()

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

extern

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

orxObject_ApplyTorque()

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

extern

Applies a torque.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_Attach()

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

extern

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

Parameters

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

Returns

orsSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_BoxPick()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_BoxPick ( const orxOBOX * _pstBox, orxSTRINGID _stGroupID )

extern

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

Parameters

[in]	_pstBox	Box to use for picking
[in]	_stGroupID	Group ID to consider, orxSTRINGID_UNDEFINED for all

Returns

orxOBJECT / orxNULL

orxObject_ClearFlip()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_ClearFlip ( orxOBJECT * _pstObject )

extern

Clears object flipping.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_Create()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_Create ( )

extern

Creates an empty object.

Returns

orxOBJECT / orxNULL

orxObject_CreateFromConfig()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_CreateFromConfig ( const orxSTRING _zConfigID )

extern

Creates an object from config.

Parameters

[in]

_zConfigID

Config ID @ return orxOBJECT / orxNULL

orxObject_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Delete ( orxOBJECT * _pstObject )

extern

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

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_Detach()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Detach ( orxOBJECT * _pstObject )

extern

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

Parameters

[in]

_pstObject

Concerned object

Returns

orsSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_Enable()

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

extern

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]	_pstObject	Concerned object
[in]	_bEnable	Enable / disable

orxObject_EnableRecursive()

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

extern

Enables/disables an object and all its owned children.

Parameters

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

orxObject_EnableShader()

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

extern

Enables an object's shader.

Parameters

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

orxObject_EnableTimeLine()

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

extern

Enables an object's timeline.

Parameters

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

orxObject_Exit()

orxDLLAPI void orxFASTCALL orxObject_Exit ( )

extern

Exits from the object module.

orxObject_FindChild()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_FindChild ( const orxOBJECT * _pstObject, const orxSTRING _zPath )

extern

Finds the child inside an object's frame hierarchy that matches the given path. See orxObject_SetOwner() and orxObject_SetParent() for a comparison of ownership and parenthood in Orx. Note: this function will filter out any camera or spawner and retrieve the child matching the provided path. Paths are composed by object names separated by '.'. A wildcard can be used * instead of a name to find children at any depth inside the hierarchy, using depth-first search. If a name is prefixed by '@', then the name will be tested against all the config ancestry of the object's name, in addition to object's name itself. Lastly, C subscript syntax, '[N]', can be used to access the N+1th (indices are 0-based) object matching the path until there. For example:

orxObject_FindChild(pstObject, "Higher.Lower"); will find the first child named Lower of the first child named Higher of pstObject
orxObject_FindChild(pstObject, "Higher.*.Deep"); will find the first object named Deep at any depth (depth-first search) under the first child named Higher of pstObject
orxObject_FindOwnedChild(pstObject, "*.@Parent"); will find the first child (depth-first search) of pstObject which is either named Parent or has Parent in its config ancestry
orxObject_FindChild(pstObject, "*.Other[2]"); will find the third object named Other at any depth under pstObject (depth-first search)
orxObject_FindChild(pstObject, "Higher.[1]"); will find the second child (no matter its name) of the first child named Higher of pstObject

Parameters

[in]	_pstObject	Concerned object
[in]	_zPath	Path defining which object to find in the hierarchy (cf. notes above)

Returns

Object matching path / orxNULL

orxObject_FindOwnedChild()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_FindOwnedChild ( const orxOBJECT * _pstObject, const orxSTRING _zPath )

extern

Finds the child inside an object's owner hierarchy that matches the given path. See orxObject_SetOwner() and orxObject_SetParent() for a comparison of ownership and parenthood in Orx. Note: this function will filter out any camera or spawner and retrieve the child matching the provided path. Paths are composed by object names separated by '.'. A wildcard can be used * instead of a name to find children at any depth inside the hierarchy, using depth-first search. If a name is prefixed by '@', then the name will be tested against all the config ancestry of the object's name, in addition to object's name itself. Lastly, C subscript syntax, '[N]', can be used to access the N+1th (indices are 0-based) object matching the path until there. For example:

orxObject_FindOwnedChild(pstObject, "Higher.Lower"); will find the first child named Lower of the first child named Higher of pstObject
orxObject_FindOwnedChild(pstObject, "Higher.*.Deep"); will find the first object named Deep at any depth (depth-first search) under the first child named Higher of pstObject
orxObject_FindOwnedChild(pstObject, "*.@Parent"); will find the first child (depth-first search) of pstObject which is either named Parent or has Parent in its config ancestry
orxObject_FindOwnedChild(pstObject, "*.Other[2]"); will find the third object named Other at any depth under pstObject (depth-first search)
orxObject_FindOwnedChild(pstObject, "Higher.[1]"); will find the second child (no matter its name) of the first child named Higher of pstObject

Parameters

[in]	_pstObject	Concerned object
[in]	_zPath	Path defining which object to find in the hierarchy (cf. notes above)

Returns

Object matching path / orxNULL

orxObject_FireTrigger()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_FireTrigger ( orxOBJECT * _pstObject, const orxSTRING _zEvent, const orxSTRING * _azRefinementList, orxU32 _u32Count )

extern

Fires an object's trigger.

Parameters

[in]	_pstObject	Concerned object
[in]	_zEvent	Event to fire
[in]	_azRefinementList	List of refinements for this event, unused if _u32Count == 0
[in]	_u32Count	Number of refinements in the list, 0 for none

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_FireTriggerRecursive()

orxDLLAPI void orxFASTCALL orxObject_FireTriggerRecursive ( orxOBJECT * _pstObject, const orxSTRING _zEvent, const orxSTRING * _azRefinementList, orxU32 _u32Count )

extern

Fires a trigger on an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zEvent	Event to fire
[in]	_azRefinementList	List of refinements for this event, unused if _u32Count == 0
[in]	_u32Count	Number of refinements in the list, 0 for none

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_ForAllNeighbors()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_ForAllNeighbors ( const orxOBJECT_NEIGHBOR_FUNCTION _pfnNeighborCallback, const orxOBOX * _pstCheckBox, orxSTRINGID _stGroupID, orxBOOL _bEnabled, void * _pContext )

extern

Runs a callback for all neighboring objects (ie. whose bounding volume intersects this box).

Parameters

[in]	_pfnNeighborCallback	Function to run for each neighbor. If this function returns orxFALSE, no other neighbor will be processed (ie. early exit)
[in]	_pstCheckBox	Box to check intersection with, orxNULL for all objects
[in]	_stGroupID	Group ID to consider, orxSTRINGID_UNDEFINED for all
[in]	_bEnabled	Only consider enabled objects if set to orxTRUE, consider all objects otherwise
[in]	_pContext	User defined context, passed to the callback

Returns

orxSTATUS_SUCCESS if all neighbors were processed without interruption, orxSTATUS_FAILURE otherwise

orxObject_GetActiveTime()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetActiveTime ( const orxOBJECT * _pstObject )

extern

Gets object's 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]

_pstObject

Concerned object

Returns

Active time

orxObject_GetAlpha()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAlpha ( const orxOBJECT * _pstObject )

extern

Gets object alpha.

Parameters

[in]

_pstObject

Concerned object

Returns

orxFLOAT

orxObject_GetAngularVelocity()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAngularVelocity ( const orxOBJECT * _pstObject )

extern

Gets an object angular velocity.

Parameters

[in]

_pstObject

Concerned object

Returns

Object angular velocity (radians/seconds)

orxObject_GetAnimFrequency()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAnimFrequency ( const orxOBJECT * _pstObject )

extern

Gets an object's relative animation frequency.

Parameters

[in]

_pstObject

Concerned object

Returns

Animation frequency / -orxFLOAT_1

orxObject_GetAnimTime()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAnimTime ( const orxOBJECT * _pstObject )

extern

Gets an object's animation time.

Parameters

[in]

_pstObject

Concerned object

Returns

Animation time / -orxFLOAT_1

orxObject_GetBlendMode()

orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxObject_GetBlendMode ( const orxOBJECT * _pstObject )

extern

Gets object blend mode.

Parameters

[in]

_pstObject

Concerned object

Returns

Blend mode (alpha, multiply, add or none)

orxObject_GetBoundingBox()

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

extern

Gets object's bounding box (OBB).

Parameters

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

Returns

Bounding box / orxNULL

orxObject_GetChild()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetChild ( const orxOBJECT * _pstObject )

extern

Gets object's first child object. See orxObject_SetOwner() and orxObject_SetParent() for a comparison of ownership and parenthood in Orx. Note: this function will filter out any camera or spawner and retrieve the first child object. This function is typically used to iterate over the children objects of an object. For example:

for(orxOBJECT *pstChild = orxObject_GetChild(pstObject);
    pstChild != orxNULL;
    pstChild = orxObject_GetSibling(pstChild))
{
    DoSomething(pstChild); // DoSomething() can recurse into the children of pstChild for a depth-first traversal
}

Parameters

[in]

_pstObject

Concerned object

Returns

First child object / orxNULL

orxObject_GetClock()

orxDLLAPI orxCLOCK *orxFASTCALL orxObject_GetClock ( const orxOBJECT * _pstObject )

extern

Gets object's clock.

Parameters

[in]

_pstObject

Concerned object

Returns

Associated clock / orxNULL

orxObject_GetColor()

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

extern

Gets object color.

Parameters

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

Returns

orxCOLOR / orxNULL

orxObject_GetCurrentAnim()

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetCurrentAnim ( const orxOBJECT * _pstObject )

extern

Gets current animation.

Parameters

[in]

_pstObject

Concerned object

Returns

Current animation / orxSTRING_EMPTY

orxObject_GetCustomGravity()

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

extern

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

orxObject_GetDefaultGroupID()

orxDLLAPI orxSTRINGID orxFASTCALL orxObject_GetDefaultGroupID ( )

extern

Gets default group ID.

Returns

Default group ID

orxObject_GetFlip()

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

extern

Gets object flipping.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_GetFXFrequency()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetFXFrequency ( const orxOBJECT * _pstObject )

extern

Gets an object's relative FX frequency.

Parameters

[in]

_pstObject

Concerned object

Returns

FX frequency / -orxFLOAT_1

orxObject_GetFXTime()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetFXTime ( const orxOBJECT * _pstObject )

extern

Gets an object's FX time.

Parameters

[in]

_pstObject

Concerned object

Returns

FX time / -orxFLOAT_1

orxObject_GetGroupID()

orxDLLAPI orxSTRINGID orxFASTCALL orxObject_GetGroupID ( const orxOBJECT * _pstObject )

extern

Gets object's group ID.

Parameters

[in]

_pstObject

Concerned object

Returns

Object's group ID. This is the string ID (see orxString_GetFromID()) of the object's group name.

orxObject_GetIgnoreFlags()

orxDLLAPI orxU32 orxFASTCALL orxObject_GetIgnoreFlags ( const orxOBJECT * _pstObject )

extern

Gets object's ignore flags.

Parameters

[in]

_pstObject

Concerned object

Returns

Ignore flags

orxObject_GetLastAddedSound()

orxDLLAPI orxSOUND *orxFASTCALL orxObject_GetLastAddedSound ( const orxOBJECT * _pstObject )

extern

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

Parameters

[in]

_pstObject

Concerned object

Returns

orxSOUND / orxNULL

orxObject_GetLifeTime()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetLifeTime ( const orxOBJECT * _pstObject )

extern

Gets object's lifetime.

Parameters

[in]

_pstObject

Concerned object

Returns

Lifetime / negative value if none

orxObject_GetLiteralIgnoreFlags()

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetLiteralIgnoreFlags ( const orxOBJECT * _pstObject )

extern

Gets object's ignore flags literals. The result will not persist through other calls to this function or to orxFrame_GetIgnoreFlagNames().

Parameters

[in]

_pstObject

Concerned object

Returns

Ignore flags literals

orxObject_GetMass()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetMass ( const orxOBJECT * _pstObject )

extern

Gets an object mass.

Parameters

[in]

_pstObject

Concerned object

Returns

Object mass

orxObject_GetMassCenter()

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

extern

Gets an object center of mass (object space).

Parameters

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

Returns

Mass center / orxNULL

orxObject_GetName()

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetName ( const orxOBJECT * _pstObject )

extern

Gets object config name.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTRING / orxSTRING_EMPTY

orxObject_GetNext()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetNext ( const orxOBJECT * _pstObject, orxSTRINGID _stGroupID )

extern

Gets next object in group.

Parameters

[in]	_pstObject	Concerned object, orxNULL to get the first one
[in]	_stGroupID	Group ID to consider, orxSTRINGID_UNDEFINED for all

Returns

orxOBJECT / orxNULL

orxObject_GetNextChild()

orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetNextChild ( const orxOBJECT * _pstObject, void * _pChild, orxSTRUCTURE_ID _eStructureID )

extern

Gets object's next child structure of a given type (camera, object or spawner). See orxObject_SetOwner() and orxObject_SetParent() for a comparison of ownership and parenthood in Orx. See orxObject_GetChild()/orxObject_GetSibling() if you want to only consider children objects. This function is typically used to iterate over the children of an object. For example, iterating over the immediate children cameras:

for(orxCAMERA *pstChild = orxCAMERA(orxObject_GetNextChild(pstObject, orxNULL, orxSTRUCTURE_ID_CAMERA));
    pstChild != orxNULL;
    pstChild = orxCAMERA(orxObject_GetNextChild(pstObject, pstChild, orxSTRUCTURE_ID_CAMERA)))
{
    DoSomethingWithCamera(pstChild);
}

Parameters

[in]	_pstObject	Concerned object
[in]	_pChild	Concerned child to retrieve the next sibling, orxNULL to retrieve the first child
[in]	_eStructureID	ID of the structure to consider (camera, spawner, object or frame)

Returns

Next child/sibling structure (camera, spawner, object or frame) / orxNULL

orxObject_GetNextEnabled()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetNextEnabled ( const orxOBJECT * _pstObject, orxSTRINGID _stGroupID )

extern

Gets next enabled object.

Parameters

[in]	_pstObject	Concerned object, orxNULL to get the first one
[in]	_stGroupID	Group ID to consider, orxSTRINGID_UNDEFINED for all

Returns

orxOBJECT / orxNULL

orxObject_GetOrigin()

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

extern

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

Parameters

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

Returns

orxVECTOR / orxNULL

orxObject_GetOwnedChild()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetOwnedChild ( const orxOBJECT * _pstObject )

extern

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;

for(orxOBJECT * pstChild = orxObject_GetOwnedChild(pstObject);
    pstChild;
    pstChild = orxObject_GetOwnedSibling(pstChild))
{
    do_something(pstChild);
} 

Parameters

[in]

_pstObject

Concerned object

Returns

First owned child object / orxNULL

orxObject_GetOwnedSibling()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetOwnedSibling ( const orxOBJECT * _pstObject )

extern

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]

_pstObject

Concerned object

Returns

Next sibling object / orxNULL

orxObject_GetOwner()

orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetOwner ( const orxOBJECT * _pstObject )

extern

Gets object's owner. See orxObject_SetOwner().

Parameters

[in]

_pstObject

Concerned object

Returns

Owner / orxNULL

orxObject_GetParent()

orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetParent ( const orxOBJECT * _pstObject )

extern

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

Parameters

[in]

_pstObject

Concerned object

Returns

Parent (object, spawner, camera or frame) / orxNULL

orxObject_GetPivot()

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

extern

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

Parameters

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

Returns

orxVECTOR / orxNULL

orxObject_GetPosition()

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

extern

Get object position. See orxObject_SetPosition().

Parameters

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

Returns

orxVECTOR / orxNULL

orxObject_GetRelativeSpeed()

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

extern

Gets an object relative speed.

Parameters

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

Returns

Object relative speed / orxNULL

orxObject_GetRepeat()

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

extern

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

orxObject_GetRGB()

orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetRGB ( const orxOBJECT * _pstObject, orxVECTOR * _pvRGB )

extern

Gets object RGB values.

Parameters

[in]	_pstObject	Concerned object
[out]	_pvRGB	Object's RGB values

Returns

orxVECTOR / orxNULL

orxObject_GetRotation()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetRotation ( const orxOBJECT * _pstObject )

extern

Get object rotation. See orxObject_SetRotation().

Parameters

[in]

_pstObject

Concerned object

Returns

orxFLOAT (radians)

orxObject_GetScale()

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

extern

Get object scale. See orxObject_SetScale().

Parameters

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

Returns

orxVECTOR / orxNULL

orxObject_GetShader()

orxDLLAPI const orxSHADER *orxFASTCALL orxObject_GetShader ( const orxOBJECT * _pstObject )

extern

Gets the shader of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTRING / orx

orxObject_GetSibling()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetSibling ( const orxOBJECT * _pstObject )

extern

Gets object's next sibling object. This function is typically used for iterating over the children objects of an object, see orxObject_GetChild() for an iteration example. Note: this function will filter out any camera or spawner and retrieve the next sibling object.

Parameters

[in]

_pstObject

Concerned object

Returns

Next sibling object / orxNULL

orxObject_GetSize()

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

extern

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

Parameters

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

Returns

orxVECTOR / orxNULL

orxObject_GetSmoothing()

orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxObject_GetSmoothing ( const orxOBJECT * _pstObject )

extern

Gets object smoothing.

Parameters

[in]

_pstObject

Concerned object

Returns

Smoothing type (enabled, default or none)

orxObject_GetSpeed()

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

extern

Gets an object speed.

Parameters

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

Returns

Object speed / orxNULL

orxObject_GetTargetAnim()

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetTargetAnim ( const orxOBJECT * _pstObject )

extern

Gets target animation.

Parameters

[in]

_pstObject

Concerned object

Returns

Target animation / orxSTRING_EMPTY

orxObject_GetTextString()

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetTextString ( const orxOBJECT * _pstObject )

extern

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

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTRING / orxSTRING_EMPTY

orxObject_GetUserData()

orxDLLAPI void *orxFASTCALL orxObject_GetUserData ( const orxOBJECT * _pstObject )

extern

Gets object's user data.

Parameters

[in]

_pstObject

Concerned object

Returns

Stored user data / orxNULL

orxObject_GetWorkingGraphic()

orxDLLAPI orxGRAPHIC *orxFASTCALL orxObject_GetWorkingGraphic ( const orxOBJECT * _pstObject )

extern

Gets object working graphic.

Parameters

[in]

_pstObject

Concerned object

Returns

orxGRAPHIC / orxNULL

orxObject_GetWorkingTexture()

orxDLLAPI orxTEXTURE *orxFASTCALL orxObject_GetWorkingTexture ( const orxOBJECT * _pstObject )

extern

Gets object working texture.

Parameters

[in]

_pstObject

Concerned object

Returns

orxTEXTURE / orxNULL

orxObject_GetWorldPosition()

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

extern

Get object world position. See orxObject_SetWorldPosition().

Parameters

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

Returns

orxVECTOR / orxNULL

orxObject_GetWorldRotation()

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetWorldRotation ( const orxOBJECT * _pstObject )

extern

Get object world rotation. See orxObject_SetWorldRotation().

Parameters

[in]

_pstObject

Concerned object

Returns

orxFLOAT (radians)

orxObject_GetWorldScale()

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

extern

Gets object world scale. See orxObject_SetWorldScale().

Parameters

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

Returns

orxVECTOR / orxNULL

orxObject_HasBlendMode()

orxDLLAPI orxBOOL orxFASTCALL orxObject_HasBlendMode ( const orxOBJECT * _pstObject )

extern

Object has blend mode accessor?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE / orxFALSE

orxObject_HasColor()

orxDLLAPI orxBOOL orxFASTCALL orxObject_HasColor ( const orxOBJECT * _pstObject )

extern

Object has color accessor?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE / orxFALSE

orxObject_HasFlip()

orxDLLAPI orxBOOL orxFASTCALL orxObject_HasFlip ( const orxOBJECT * _pstObject )

extern

Object has flip accessor?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE / orxFALSE

orxObject_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Init ( )

extern

Inits the object module.

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_IsCurrentAnim()

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

extern

Is current animation test.

Parameters

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

Returns

orxTRUE / orxFALSE

orxObject_IsEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsEnabled ( const orxOBJECT * _pstObject )

extern

Is object enabled?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if enabled, orxFALSE otherwise

orxObject_IsPaused()

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsPaused ( const orxOBJECT * _pstObject )

extern

Is object paused?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if paused, orxFALSE otherwise

orxObject_IsShaderEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsShaderEnabled ( const orxOBJECT * _pstObject )

extern

Is an object's shader enabled?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if enabled, orxFALSE otherwise

orxObject_IsTargetAnim()

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

extern

Is target animation test.

Parameters

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

Returns

orxTRUE / orxFALSE

orxObject_IsTimeLineEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTimeLineEnabled ( const orxOBJECT * _pstObject )

extern

Is an object's timeline enabled?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if enabled, orxFALSE otherwise

orxObject_LinkStructure()

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

extern

Links a structure to an object.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_LogParents()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_LogParents ( const orxOBJECT * _pstObject )

extern

Logs all parents of an object, including their frame data.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_Pause()

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

extern

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

Parameters

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

orxObject_PauseRecursive()

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

extern

Pauses/unpauses an object and its owned children.

Parameters

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

orxObject_Pick()

orxDLLAPI orxOBJECT *orxFASTCALL orxObject_Pick ( const orxVECTOR * _pvPosition, orxSTRINGID _stGroupID )

extern

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

Parameters

[in]	_pvPosition	Position to pick from
[in]	_stGroupID	Group ID to consider, orxSTRINGID_UNDEFINED for all

Returns

orxOBJECT / orxNULL

orxObject_Play()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Play ( orxOBJECT * _pstObject )

extern

Plays all the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_Raycast()

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

extern

Issues a raycast to test for potential objects in the way.

Parameters

[in]	_pvBegin	Beginning 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

orxObject_RemoveAllFilters()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveAllFilters ( orxOBJECT * _pstObject )

extern

Removes all filters from the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveAllFXs()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveAllFXs ( orxOBJECT * _pstObject )

extern

Removes all FXs.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveAllFXsRecursive()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveAllFXsRecursive ( orxOBJECT * _pstObject )

extern

Removes all FXs from an object and its owned children.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveAllSounds()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveAllSounds ( orxOBJECT * _pstObject )

extern

Removes all sounds.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveFX()

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

extern

Removes an FX using its config ID.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveFXRecursive()

orxDLLAPI void orxFASTCALL orxObject_RemoveFXRecursive ( orxOBJECT * _pstObject, const orxSTRING _zFXConfigID )

extern

Removes an FX from an object and its owned children.

Parameters

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

orxObject_RemoveLastFilter()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveLastFilter ( orxOBJECT * _pstObject )

extern

Removes last added filter from the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveSound()

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

extern

Removes a sound using its config ID.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveTimeLineTrack()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveTimeLineTrack ( orxOBJECT * _pstObject, const orxSTRING _zTrackConfigID )

extern

Removes a timeline track using its config ID

Parameters

[in]	_pstObject	Concerned object
[in]	_zTrackConfigID	Config ID of the timeline track to remove

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveTimeLineTrackRecursive()

orxDLLAPI void orxFASTCALL orxObject_RemoveTimeLineTrackRecursive ( orxOBJECT * _pstObject, const orxSTRING _zTrackConfigID )

extern

Removes a timeline track from an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zTrackConfigID	Config ID of the timeline track to remove

orxObject_RemoveTrigger()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveTrigger ( orxOBJECT * _pstObject, const orxSTRING _zTriggerConfigID )

extern

Removes a trigger using its config ID

Parameters

[in]	_pstObject	Concerned object
[in]	_zTriggerConfigID	Config ID of the trigger to remove

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_RemoveTriggerRecursive()

orxDLLAPI void orxFASTCALL orxObject_RemoveTriggerRecursive ( orxOBJECT * _pstObject, const orxSTRING _zTriggerConfigID )

extern

Removes a trigger from an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zTriggerConfigID	Config ID of the trigger to remove

orxObject_ResetActiveTime()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_ResetActiveTime ( orxOBJECT * _pstObject )

extern

Resets an object's active time.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_ResetActiveTimeRecursive()

orxDLLAPI void orxFASTCALL orxObject_ResetActiveTimeRecursive ( orxOBJECT * _pstObject )

extern

Resets an object's and its owned children's active time.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetAlpha()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAlpha ( orxOBJECT * _pstObject, orxFLOAT _fAlpha )

extern

Sets object alpha.

Parameters

[in]	_pstObject	Concerned object
[in]	_fAlpha	Alpha value to set

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetAlphaRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetAlphaRecursive ( orxOBJECT * _pstObject, orxFLOAT _fAlpha )

extern

Sets alpha of an object and all its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_fAlpha	Alpha value to set

orxObject_SetAngularVelocity()

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

extern

Sets an object angular velocity.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetAnimFrequency()

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

extern

Sets an object's relative animation frequency.

Parameters

[in]	_pstObject	Concerned object
[in]	_fFrequency	Frequency to set: < 1.0 for slower than initial, > 1.0 for faster than initial

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetAnimFrequencyRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetAnimFrequencyRecursive ( orxOBJECT * _pstObject, orxFLOAT _fFrequency )

extern

Sets the relative animation frequency for an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_fFrequency	Frequency to set: < 1.0 for slower than initial, > 1.0 for faster than initial

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetAnimSet()

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

extern

Sets an object animset.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetAnimTime()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimTime ( orxOBJECT * _pstObject, orxFLOAT _fTime )

extern

Sets an object's animation time.

Parameters

[in]	_pstObject	Concerned object
[in]	_fTime	Time to set

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetAnimTimeRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetAnimTimeRecursive ( orxOBJECT * _pstObject, orxFLOAT _fTime )

extern

Sets the animation time for an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_fTime	Time to set

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetBlendMode()

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

extern

Sets object blend mode.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetBlendModeRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetBlendModeRecursive ( orxOBJECT * _pstObject, orxDISPLAY_BLEND_MODE _eBlendMode )

extern

Sets blend mode of an object and its owned children.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetClock()

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

extern

Sets associated clock for an object.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetClockRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetClockRecursive ( orxOBJECT * _pstObject, orxCLOCK * _pstClock )

extern

Sets associated clock for an object and its owned children.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetColor()

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

extern

Sets object color.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetColorRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetColorRecursive ( orxOBJECT * _pstObject, const orxCOLOR * _pstColor )

extern

Sets color of an object and all its owned children.

Parameters

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

orxObject_SetCurrentAnim()

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

extern

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

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetCurrentAnimRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetCurrentAnimRecursive ( orxOBJECT * _pstObject, const orxSTRING _zAnimName )

extern

Sets current animation for an object and its owned children.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetCustomGravity()

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

extern

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

orxObject_SetFlip()

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

extern

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

orxObject_SetFXFrequency()

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

extern

Sets an object's relative FX frequency.

Parameters

[in]	_pstObject	Concerned object
[in]	_fFrequency	Frequency to set: < 1.0 for slower than initial, > 1.0 for faster than initial

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetFXFrequencyRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetFXFrequencyRecursive ( orxOBJECT * _pstObject, orxFLOAT _fFrequency )

extern

Sets the relative FX frequency for an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_fFrequency	Frequency to set: < 1.0 for slower than initial, > 1.0 for faster than initial

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetFXTime()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetFXTime ( orxOBJECT * _pstObject, orxFLOAT _fTime )

extern

Sets an object's FX time.

Parameters

[in]	_pstObject	Concerned object
[in]	_fTime	Time to set

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetFXTimeRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetFXTimeRecursive ( orxOBJECT * _pstObject, orxFLOAT _fTime )

extern

Sets the FX time for an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_fTime	Time to set

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetGroupID()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetGroupID ( orxOBJECT * _pstObject, orxSTRINGID _stGroupID )

extern

Sets object's group ID.

Parameters

[in]	_pstObject	Concerned object
[in]	_stGroupID	Group ID to set. This is the string ID (see orxString_GetID()) of the object's group name.

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetGroupIDRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetGroupIDRecursive ( orxOBJECT * _pstObject, orxSTRINGID _stGroupID )

extern

Sets group ID of an object and all its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_stGroupID	Group ID to set. This is the string ID (see orxString_GetID()) of the object's group name.

orxObject_SetIgnoreFlags()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetIgnoreFlags ( orxOBJECT * _pstObject, orxU32 _u32IgnoreFlags )

extern

Sets object's ignore flags.

Parameters

[in]	_pstObject	Concerned object
[out]	_u32IgnoreFlags	Ignore flags to set (all other ignore flags will get cleared)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetLifeTime()

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

extern

Sets object's lifetime.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetLiteralIgnoreFlags()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetLiteralIgnoreFlags ( orxOBJECT * _pstObject, const orxSTRING _zIgnoreFlags )

extern

Sets object's ignore flags using literals.

Parameters

[in]	_pstObject	Concerned object
[out]	_zIgnoreFlags	Literals of the ignore flags to set (all other ignore flags will get cleared)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetLiteralLifeTime()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetLiteralLifeTime ( orxOBJECT * _pstObject, const orxSTRING _zLifeTime )

extern

Sets object's literal lifetime.

Parameters

[in]	_pstObject	Concerned object
[in]	_zLifeTime	Lifetime to set, can be composed of multiple tags, separated by space: anim, child, fx, sound, spawner and track

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetOrigin()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetOrigin ( orxOBJECT * _pstObject, const orxVECTOR * _pvOrigin )

extern

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]	_pstObject	Concerned object
[in]	_pvOrigin	Object origin

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetOwner()

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

extern

Sets owner for an object. Ownership in Orx is only about lifetime management. That is, when an object dies, it also kills its owned 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 owned 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]	_pstObject	Concerned object
[in]	_pOwner	Owner to set / orxNULL, if owner is an orxOBJECT, the owned object will be added to it as a children

orxObject_SetPanning()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPanning ( orxOBJECT * _pstObject, orxFLOAT _fPanning, orxBOOL _bMix )

extern

Sets panning of all sounds of an object.

Parameters

[in]	_pstObject	Concerned object
[in]	_fPanning	Sound panning, -1.0f for full left, 0.0f for center, 1.0f for full right
[in]	_bMix	Left/Right channels will be mixed if orxTRUE or act like a balance otherwise

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetParent()

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

extern

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]	_pstObject	Concerned object
[in]	_pParent	Parent structure to set (object, spawner, camera or frame) / orxNULL

Returns

orsSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetPitch()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPitch ( orxOBJECT * _pstObject, orxFLOAT _fPitch )

extern

Sets pitch for all sounds of an object.

Parameters

[in]	_pstObject	Concerned object
[in]	_fPitch	Desired pitch (< 1.0 => lower pitch, = 1.0 => original pitch, > 1.0 => higher pitch). 0.0 is ignored.

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetPivot()

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

extern

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]	_pstObject	Concerned object
[in]	_pvPivot	Object pivot

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetPosition()

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

extern

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]	_pstObject	Concerned object
[in]	_pvPosition	Object position

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetRelativePivot()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRelativePivot ( orxOBJECT * _pstObject, orxU32 _u32AlignFlags )

extern

Sets object relative pivot.

Parameters

[in]	_pstObject	Concerned object
[in]	_u32AlignFlags	Graphic alignment flags

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetRelativeSpeed()

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

extern

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

orxObject_SetRepeat()

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

extern

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

orxObject_SetRGB()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRGB ( orxOBJECT * _pstObject, const orxVECTOR * _pvRGB )

extern

Sets object RGB values.

Parameters

[in]	_pstObject	Concerned object
[in]	_pvRGB	RGB values to set

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetRGBRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetRGBRecursive ( orxOBJECT * _pstObject, const orxVECTOR * _pvRGB )

extern

Sets color of an object and all its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_pvRGB	RGB values to set

orxObject_SetRotation()

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

extern

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]	_pstObject	Concerned object
[in]	_fRotation	Object rotation (radians)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetScale()

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

extern

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]	_pstObject	Concerned object
[in]	_pvScale	Object scale vector

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetShader()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetShader ( orxOBJECT * _pstObject, orxSHADER * _pstShader )

extern

Sets the shader of an object.

Parameters

[in]	_pstObject	Concerned object
[in]	_pstShader	Shader to set, orxNULL to remove the current one

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetShaderFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetShaderFromConfig ( orxOBJECT * _pstObject, const orxSTRING _zShaderID )

extern

Sets the shader of an object using its config ID.

Parameters

[in]	_pstObject	Concerned object
[in]	_zShaderID	Config ID of the shader to set, orxNULL to remove the current one

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetShaderFromConfigRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetShaderFromConfigRecursive ( orxOBJECT * _pstObject, const orxSTRING _zShaderID )

extern

Sets the shader of an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_zShaderID	Config ID of the shader to set, orxNULL to remove the current one

orxObject_SetShaderRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetShaderRecursive ( orxOBJECT * _pstObject, orxSHADER * _pstShader )

extern

Sets the shader of an object and its owned children.

Parameters

[in]	_pstObject	Concerned object
[in]	_pstShader	Shader to set, orxNULL to remove the current one

orxObject_SetSize()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSize ( orxOBJECT * _pstObject, const orxVECTOR * _pvSize )

extern

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]	_pstObject	Concerned object
[in]	_pvSize	Object size

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetSmoothing()

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

extern

Sets object smoothing.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetSmoothingRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetSmoothingRecursive ( orxOBJECT * _pstObject, orxDISPLAY_SMOOTHING _eSmoothing )

extern

Sets smoothing for an object and its owned children.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetSpeed()

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

extern

Sets an object speed.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetTargetAnim()

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

extern

Sets target animation for an 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]	_pstObject	Concerned object
[in]	_zAnimName	Animation name (config's one) to set / orxNULL

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetTargetAnimRecursive()

orxDLLAPI void orxFASTCALL orxObject_SetTargetAnimRecursive ( orxOBJECT * _pstObject, const orxSTRING _zAnimName )

extern

Sets target animation for an object and its owned children.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetTextString()

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

extern

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

orxObject_Setup()

orxDLLAPI void orxFASTCALL orxObject_Setup ( )

extern

Object module setup

orxObject_SetUserData()

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

extern

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]	_pstObject	Concerned object
[in]	_pUserData	User data to store / orxNULL

orxObject_SetVolume()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetVolume ( orxOBJECT * _pstObject, orxFLOAT _fVolume )

extern

Sets volume for all sounds of an object.

Parameters

[in]	_pstObject	Concerned object
[in]	_fVolume	Desired volume (0.0 - 1.0)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetWorldPosition()

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

extern

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]	_pstObject	Concerned object
[in]	_pvPosition	Object world position

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetWorldRotation()

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

extern

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]	_pstObject	Concerned object
[in]	_fRotation	Object world rotation (radians)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SetWorldScale()

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

extern

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]	_pstObject	Concerned object
[in]	_pvScale	Object world scale vector

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_Stop()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Stop ( orxOBJECT * _pstObject )

extern

Stops all the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_SynchronizeFX()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_SynchronizeFX ( orxOBJECT * _pstObject, const orxOBJECT * _pstModel )

extern

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

Parameters

[in]	_pstObject	Concerned object
[in]	_pstModel	Model object on which to synchronize FXs

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxObject_UnlinkStructure()

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

extern

Unlinks structure from an object, given its structure ID.

Parameters

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

orxObject_Update()

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Update ( orxOBJECT * _pstObject, const orxCLOCK_INFO * _pstClockInfo )

extern

Updates an object.

Parameters

[in]	_pstObject	Concerned object
[in]	_pstClockInfo	Clock information used to compute new object's state

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE