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_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)

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_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 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 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 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 (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_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)
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_AddShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
orxDLLAPI void orxFASTCALL	orxObject_AddShaderRecursive (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
orxDLLAPI orxSTATUS orxFASTCALL	orxObject_RemoveShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
orxDLLAPI void orxFASTCALL	orxObject_RemoveShaderRecursive (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 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)

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

Neighboring
orxDLLAPI orxBANK *orxFASTCALL	orxObject_CreateNeighborList (const orxOBOX *_pstCheckBox, orxSTRINGID _stGroupID)
orxDLLAPI void orxFASTCALL	orxObject_DeleteNeighborList (orxBANK *_pstObjectList)

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)

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

#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 87 of file orxObject.h.

Enumeration Type Documentation

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

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

Returns

orxSTRUCTURE / orxNULL

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

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

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

Adds an FX using its config ID.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Adds a shader to an object using its config ID.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_AddShaderRecursive	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zShaderConfigID
	)

Adds a shader to an object and its owned children.

Parameters

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

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

Adds a sound using its config ID.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

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

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

Adds a unique FX using its config ID.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Applies a force.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Applies an impulse.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Applies a torque.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

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]	_pstBox	Box to use for picking
[in]	_stGroupID	Group ID to consider, orxSTRINGID_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]

_zConfigID

Config ID @ return orxOBJECT / orxNULL

orxDLLAPI orxBANK* orxFASTCALL orxObject_CreateNeighborList	(	const orxOBOX *	_pstCheckBox,
		orxSTRINGID	_stGroupID
	)

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:

orxVECTOR vPosition; // The world position of the neighborhood area
// set_position(vPosition);
orxVECTOR vSize; // The size of the neighborhood area
// set_size(vSize);
orxVECTOR vPivot; // The pivot of the neighborhood area
// set_pivot(vPivot);

orxOBOX stBox;
orxOBox_2DSet(&stBox, &vPosition, &vPivot, &vSize, 0);

orxBANK * pstBank = orxObject_CreateNeighborList(&stBox, orxSTRINGID_UNDEFINED);
if(pstBank) {
    for(int i=0; i < orxBank_GetCount(pstBank); ++i)
    {
        orxOBJECT * pstObject = *((orxOBJECT **) orxBank_GetAtIndex(pstBank, i));
        do_something_with(pstObject);
    }
    orxObject_DeleteNeighborList(pstBank);
}

Parameters

[in]	_pstCheckBox	Box to check intersection with
[in]	_stGroupID	Group ID to consider, orxSTRINGID_UNDEFINED for all

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]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_DeleteNeighborList

(

orxBANK *

_pstObjectList

)

Deletes an object list created with orxObject_CreateNeighborList().

Parameters

[in]

_pstObjectList

Concerned object list

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Detach

(

orxOBJECT *

_pstObject

)

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

Parameters

[in]

_pstObject

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

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

Enables/disables an object and all its owned children.

Parameters

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

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

Enables an object's shader.

Parameters

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

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

Enables an object's timeline.

Parameters

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

_pstObject

Concerned object

Returns

Active time

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAngularVelocity

(

const orxOBJECT *

_pstObject

)

Gets an object angular velocity.

Parameters

[in]

_pstObject

Concerned object

Returns

Object angular velocity (radians/seconds)

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAnimFrequency

(

const orxOBJECT *

_pstObject

)

Gets an object's relative animation frequency.

Parameters

[in]

_pstObject

Concerned object

Returns

Animation frequency / -orxFLOAT_1

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAnimTime

(

const orxOBJECT *

_pstObject

)

Gets an object's animation time.

Parameters

[in]

_pstObject

Concerned object

Returns

Animation time / -orxFLOAT_1

orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxObject_GetBlendMode

(

const orxOBJECT *

_pstObject

)

Gets object blend mode.

Parameters

[in]

_pstObject

Concerned object

Returns

Blend mode (alpha, multiply, add or none)

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

Gets object's bounding box (OBB).

Parameters

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

Returns

Bounding box / orxNULL

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_GetChild

(

const orxOBJECT *

_pstObject

)

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

orxDLLAPI orxCLOCK* orxFASTCALL orxObject_GetClock

(

const orxOBJECT *

_pstObject

)

Gets object's clock.

Parameters

[in]

_pstObject

Concerned object

Returns

Associated clock / orxNULL

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

Gets object color.

Parameters

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

Returns

orxCOLOR / orxNULL

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetCurrentAnim

(

const orxOBJECT *

_pstObject

)

Gets current animation.

Parameters

[in]

_pstObject

Concerned object

Returns

Current animation / orxSTRING_EMPTY

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

Gets an object custom gravity.

Parameters

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

Returns

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

orxDLLAPI orxSTRINGID 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]	_pstObject	Concerned object
[in]	_pbFlipX	X axis flipping
[in]	_pbFlipY	Y axis flipping

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetFXFrequency

(

const orxOBJECT *

_pstObject

)

Gets an object's relative FX frequency.

Parameters

[in]

_pstObject

Concerned object

Returns

FX frequency / -orxFLOAT_1

orxDLLAPI orxSTRINGID orxFASTCALL orxObject_GetGroupID

(

const orxOBJECT *

_pstObject

)

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.

orxDLLAPI orxU32 orxFASTCALL orxObject_GetIgnoreFlags

(

const orxOBJECT *

_pstObject

)

Gets object's ignore flags.

Parameters

[in]

_pstObject

Concerned object

Returns

Ignore flags

orxDLLAPI orxSOUND* orxFASTCALL orxObject_GetLastAddedSound

(

const orxOBJECT *

_pstObject

)

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

Parameters

[in]

_pstObject

Concerned object

Returns

orxSOUND / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetLifeTime

(

const orxOBJECT *

_pstObject

)

Gets object lifetime.

Parameters

[in]

_pstObject

Concerned object

Returns

Lifetime / negative value if none

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetLiteralIgnoreFlags

(

const orxOBJECT *

_pstObject

)

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

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetMass

(

const orxOBJECT *

_pstObject

)

Gets an object mass.

Parameters

[in]

_pstObject

Concerned object

Returns

Object mass

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

Gets an object center of mass (object space).

Parameters

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

Returns

Mass center / orxNULL

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetName

(

const orxOBJECT *

_pstObject

)

Gets object config name.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTRING / orxSTRING_EMPTY

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

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

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

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

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

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

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

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

Parameters

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

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

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]

_pstObject

Concerned object

Returns

Next sibling object / orxNULL

orxDLLAPI orxSTRUCTURE* orxFASTCALL orxObject_GetOwner

(

const orxOBJECT *

_pstObject

)

Gets object's owner. See orxObject_SetOwner().

Parameters

[in]

_pstObject

Concerned 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]

_pstObject

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

Returns

orxVECTOR / orxNULL

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

Get object position. See orxObject_SetPosition().

Parameters

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

Returns

orxVECTOR / orxNULL

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

Gets an object relative speed.

Parameters

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

Returns

Object relative speed / orxNULL

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

Gets object repeat (wrap) values.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetRotation

(

const orxOBJECT *

_pstObject

)

Get object rotation. See orxObject_SetRotation().

Parameters

[in]

_pstObject

Concerned object

Returns

orxFLOAT (radians)

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

Get object scale. See orxObject_SetScale().

Parameters

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

Returns

orxVECTOR / orxNULL

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_GetSibling

(

const orxOBJECT *

_pstObject

)

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

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

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

Parameters

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

Returns

orxVECTOR / orxNULL

orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxObject_GetSmoothing

(

const orxOBJECT *

_pstObject

)

Gets object smoothing.

Parameters

[in]

_pstObject

Concerned object

Returns

Smoothing type (enabled, default or none)

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

Gets an object speed.

Parameters

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

Returns

Object speed / orxNULL

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetTargetAnim

(

const orxOBJECT *

_pstObject

)

Gets target animation.

Parameters

[in]

_pstObject

Concerned object

Returns

Target animation / orxSTRING_EMPTY

orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetTextString

(

orxOBJECT *

_pstObject

)

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

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTRING / orxSTRING_EMPTY

orxDLLAPI void* orxFASTCALL orxObject_GetUserData

(

const orxOBJECT *

_pstObject

)

Gets object's user data.

Parameters

[in]

_pstObject

Concerned object

Returns

Stored user data / orxNULL

orxDLLAPI orxGRAPHIC* orxFASTCALL orxObject_GetWorkingGraphic

(

const orxOBJECT *

_pstObject

)

Gets object working graphic.

Parameters

[in]

_pstObject

Concerned object

Returns

orxGRAPHIC / orxNULL

orxDLLAPI orxTEXTURE* orxFASTCALL orxObject_GetWorkingTexture

(

const orxOBJECT *

_pstObject

)

Gets object working texture.

Parameters

[in]

_pstObject

Concerned object

Returns

orxTEXTURE / orxNULL

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

Get object world position. See orxObject_SetWorldPosition().

Parameters

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

Returns

orxVECTOR / orxNULL

orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetWorldRotation

(

const orxOBJECT *

_pstObject

)

Get object world rotation. See orxObject_SetWorldRotation().

Parameters

[in]

_pstObject

Concerned object

Returns

orxFLOAT (radians)

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

Gets object world scale. See orxObject_SetWorldScale().

Parameters

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

Returns

orxVECTOR / orxNULL

orxDLLAPI orxBOOL orxFASTCALL orxObject_HasBlendMode

(

const orxOBJECT *

_pstObject

)

Object has blend mode accessor?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxObject_HasColor

(

const orxOBJECT *

_pstObject

)

Object has color accessor?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE / orxFALSE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Init

(

)

Inits the object module.

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Is current animation test.

Parameters

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

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsEnabled

(

const orxOBJECT *

_pstObject

)

Is object enabled?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if enabled, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsPaused

(

const orxOBJECT *

_pstObject

)

Is object paused?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if paused, orxFALSE otherwise

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsShaderEnabled

(

const orxOBJECT *

_pstObject

)

Is an object's shader enabled?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if enabled, orxFALSE otherwise

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

Is target animation test.

Parameters

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

Returns

orxTRUE / orxFALSE

orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTimeLineEnabled

(

const orxOBJECT *

_pstObject

)

Is an object's timeline enabled?

Parameters

[in]

_pstObject

Concerned object

Returns

orxTRUE if enabled, orxFALSE otherwise

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

Links a structure to an object.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_LogParents

(

const orxOBJECT *

_pstObject

)

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

Parameters

[in]

_pstObject

Concerned object

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]	_pstObject	Concerned object
[in]	_bPause	Pause / unpause

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

Pauses/unpauses an object and its owned children.

Parameters

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

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

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]	_pvPosition	Position to pick from
[in]	_stGroupID	Group ID to consider, orxSTRINGID_UNDEFINED for all

Returns

orxOBJECT / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Play

(

orxOBJECT *

_pstObject

)

Plays all the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxOBJECT* orxFASTCALL orxObject_Raycast	(	const orxVECTOR *	_pvBegin,
		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]	_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

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveAllFilters

(

orxOBJECT *

_pstObject

)

Removes all filters from the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveAllFXs

(

orxOBJECT *

_pstObject

)

Removes all FXs.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveAllFXsRecursive

(

orxOBJECT *

_pstObject

)

Removes all FXs from an object and its owned children.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Removes an FX from an object and its owned children.

Parameters

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

orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveLastFilter

(

orxOBJECT *

_pstObject

)

Removes last added filter from the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Removes a shader using its config ID.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_RemoveShaderRecursive	(	orxOBJECT *	_pstObject,
		const orxSTRING	_zShaderConfigID
	)

Removes a shader from an object and its owned children.

Parameters

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

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

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

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

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

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

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

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

Sets object alpha.

Parameters

[in]	_pstObject	Concerned object
[in]	_fAlpha	Alpha 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 owned children.

Parameters

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

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

Sets an object angular velocity.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets an object'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

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

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

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

Sets an object animset.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets an object's animation time.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Sets object blend mode.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Sets associated clock for an object.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Sets object color.

Parameters

[in]	_pstObject	Concerned object
[in]	_pstColor	Color to set, orxNULL to remove any 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 owned children.

Parameters

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

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

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

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

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

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

Sets an object custom gravity.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets object flipping.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

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

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

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

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

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.

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

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

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

Sets object lifetime.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Sets object 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

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

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

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

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets object position 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

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

Sets object relative pivot.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets an object speed relative to its rotation/scale.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets object repeat (wrap) values.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets object RGB values.

Parameters

[in]	_pstObject	Concerned object
[in]	_pvRGB	RGB 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 owned children.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets object scale 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

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets object smoothing.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

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

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

Sets an object speed.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

Sets target animation for 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

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

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

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

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

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxObject_Setup

(

)

Object module setup

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

Sets user data for an object. 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

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

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

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxObject_Stop

(

orxOBJECT *

_pstObject

)

Stops all the sounds of an object.

Parameters

[in]

_pstObject

Concerned object

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]	_pstObject	Concerned object
[in]	_pstModel	Model 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]	_pstObject	Concerned object
[in]	_eStructureID	ID of structure to unlink

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

Updates an object.

Parameters

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

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE