orx  stable
Portable Game Engine
orxObject.h File Reference
#include "orxInclude.h"
#include "anim/orxAnimSet.h"
#include "core/orxClock.h"
#include "display/orxDisplay.h"
#include "display/orxGraphic.h"
#include "display/orxTexture.h"
#include "math/orxOBox.h"
#include "memory/orxBank.h"
#include "object/orxStructure.h"
#include "sound/orxSound.h"

Go to the source code of this file.

Macros

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

Typedefs

typedef struct __orxOBJECT_t orxOBJECT
 

Enumerations

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

Functions

Internal module function
orxDLLAPI void orxFASTCALL orxObject_Setup ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Init ()
 
orxDLLAPI void orxFASTCALL orxObject_Exit ()
 
Basic handling
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_Create ()
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_CreateFromConfig (const orxSTRING _zConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Delete (orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Update (orxOBJECT *_pstObject, const orxCLOCK_INFO *_pstClockInfo)
 
orxDLLAPI void orxFASTCALL orxObject_Enable (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI void orxFASTCALL orxObject_EnableRecursive (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsEnabled (const orxOBJECT *_pstObject)
 
orxDLLAPI void orxFASTCALL orxObject_Pause (orxOBJECT *_pstObject, orxBOOL _bPause)
 
orxDLLAPI void orxFASTCALL orxObject_PauseRecursive (orxOBJECT *_pstObject, orxBOOL _bPause)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsPaused (const orxOBJECT *_pstObject)
 
User data
orxDLLAPI void orxFASTCALL orxObject_SetUserData (orxOBJECT *_pstObject, void *_pUserData)
 
orxDLLAPI void *orxFASTCALL orxObject_GetUserData (const orxOBJECT *_pstObject)
 
Ownership
orxDLLAPI void orxFASTCALL orxObject_SetOwner (orxOBJECT *_pstObject, void *_pOwner)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetOwner (const orxOBJECT *_pstObject)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetOwnedChild (const orxOBJECT *_pstObject)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetOwnedSibling (const orxOBJECT *_pstObject)
 
Clock
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetClock (orxOBJECT *_pstObject, orxCLOCK *_pstClock)
 
orxDLLAPI orxCLOCK *orxFASTCALL orxObject_GetClock (const orxOBJECT *_pstObject)
 
Linked structures
orxDLLAPI orxSTATUS orxFASTCALL orxObject_LinkStructure (orxOBJECT *_pstObject, orxSTRUCTURE *_pstStructure)
 
orxDLLAPI void orxFASTCALL orxObject_UnlinkStructure (orxOBJECT *_pstObject, orxSTRUCTURE_ID _eStructureID)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL _orxObject_GetStructure (const orxOBJECT *_pstObject, orxSTRUCTURE_ID _eStructureID)
 
Flip
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetFlip (orxOBJECT *_pstObject, orxBOOL _bFlipX, orxBOOL _bFlipY)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_GetFlip (const orxOBJECT *_pstObject, orxBOOL *_pbFlipX, orxBOOL *_pbFlipY)
 
graphic
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPivot (orxOBJECT *_pstObject, const orxVECTOR *_pvPivot)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetOrigin (orxOBJECT *_pstObject, const orxVECTOR *_pvOrigin)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSize (orxOBJECT *_pstObject, const orxVECTOR *_pvSize)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetPivot (const orxOBJECT *_pstObject, orxVECTOR *_pvPivot)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetOrigin (const orxOBJECT *_pstObject, orxVECTOR *_pvOrigin)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetSize (const orxOBJECT *_pstObject, orxVECTOR *_pvSize)
 
orxDLLAPI orxGRAPHIC *orxFASTCALL orxObject_GetWorkingGraphic (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetColor (orxOBJECT *_pstObject, const orxCOLOR *_pstColor)
 
orxDLLAPI void orxFASTCALL orxObject_SetColorRecursive (orxOBJECT *_pstObject, const orxCOLOR *_pstColor)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_HasColor (const orxOBJECT *_pstObject)
 
orxDLLAPI orxCOLOR *orxFASTCALL orxObject_GetColor (const orxOBJECT *_pstObject, orxCOLOR *_pstColor)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRGB (orxOBJECT *_pstObject, const orxVECTOR *_pvRGB)
 
orxDLLAPI void orxFASTCALL orxObject_SetRGBRecursive (orxOBJECT *_pstObject, const orxVECTOR *_pvRGB)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAlpha (orxOBJECT *_pstObject, orxFLOAT _fAlpha)
 
orxDLLAPI void orxFASTCALL orxObject_SetAlphaRecursive (orxOBJECT *_pstObject, orxFLOAT _fAlpha)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRepeat (orxOBJECT *_pstObject, orxFLOAT _fRepeatX, orxFLOAT _fRepeatY)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_GetRepeat (const orxOBJECT *_pstObject, orxFLOAT *_pfRepeatX, orxFLOAT *_pfRepeatY)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetBlendMode (orxOBJECT *_pstObject, orxDISPLAY_BLEND_MODE _eBlendMode)
 
orxDLLAPI orxDISPLAY_BLEND_MODE orxFASTCALL orxObject_GetBlendMode (const orxOBJECT *_pstObject)
 
Frame
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPosition (orxOBJECT *_pstObject, const orxVECTOR *_pvPosition)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldPosition (orxOBJECT *_pstObject, const orxVECTOR *_pvPosition)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRotation (orxOBJECT *_pstObject, orxFLOAT _fRotation)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldRotation (orxOBJECT *_pstObject, orxFLOAT _fRotation)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetScale (orxOBJECT *_pstObject, const orxVECTOR *_pvScale)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetWorldScale (orxOBJECT *_pstObject, const orxVECTOR *_pvScale)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetPosition (const orxOBJECT *_pstObject, orxVECTOR *_pvPosition)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetWorldPosition (const orxOBJECT *_pstObject, orxVECTOR *_pvPosition)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetRotation (const orxOBJECT *_pstObject)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetWorldRotation (const orxOBJECT *_pstObject)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetScale (const orxOBJECT *_pstObject, orxVECTOR *_pvScale)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetWorldScale (const orxOBJECT *_pstObject, orxVECTOR *_pvScale)
 
Parent
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetParent (orxOBJECT *_pstObject, void *_pParent)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetParent (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetChild (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxObject_GetSibling (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Attach (orxOBJECT *_pstObject, void *_pParent)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_Detach (orxOBJECT *_pstObject)
 
Animation
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimSet (orxOBJECT *_pstObject, orxANIMSET *_pstAnimSet)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAnimFrequency (orxOBJECT *_pstObject, orxFLOAT _fFrequency)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetCurrentAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetTargetAnim (orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsCurrentAnim (const orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTargetAnim (const orxOBJECT *_pstObject, const orxSTRING _zAnimName)
 
Physics / dynamics
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSpeed (orxOBJECT *_pstObject, const orxVECTOR *_pvSpeed)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetRelativeSpeed (orxOBJECT *_pstObject, const orxVECTOR *_pvRelativeSpeed)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetAngularVelocity (orxOBJECT *_pstObject, orxFLOAT _fVelocity)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetCustomGravity (orxOBJECT *_pstObject, const orxVECTOR *_pvCustomGravity)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetSpeed (const orxOBJECT *_pstObject, orxVECTOR *_pvSpeed)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetRelativeSpeed (const orxOBJECT *_pstObject, orxVECTOR *_pvRelativeSpeed)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetAngularVelocity (const orxOBJECT *_pstObject)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetCustomGravity (const orxOBJECT *_pstObject, orxVECTOR *_pvCustomGravity)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetMass (const orxOBJECT *_pstObject)
 
orxDLLAPI orxVECTOR *orxFASTCALL orxObject_GetMassCenter (const orxOBJECT *_pstObject, orxVECTOR *_pvMassCenter)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_ApplyTorque (orxOBJECT *_pstObject, orxFLOAT _fTorque)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_ApplyForce (orxOBJECT *_pstObject, const orxVECTOR *_pvForce, const orxVECTOR *_pvPoint)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_ApplyImpulse (orxOBJECT *_pstObject, const orxVECTOR *_pvImpulse, const orxVECTOR *_pvPoint)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_Raycast (const orxVECTOR *_pvStart, const orxVECTOR *_pvEnd, orxU16 _u16SelfFlags, orxU16 _u16CheckMask, orxBOOL _bEarlyExit, orxVECTOR *_pvContact, orxVECTOR *_pvNormal)
 
Text
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetTextString (orxOBJECT *_pstObject, const orxSTRING _zString)
 
orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetTextString (orxOBJECT *_pstObject)
 
Bounding box
orxDLLAPI orxOBOX *orxFASTCALL orxObject_GetBoundingBox (const orxOBJECT *_pstObject, orxOBOX *_pstBoundingBox)
 
FX
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddUniqueFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddDelayedFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddUniqueDelayedFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID, orxFLOAT _fDelay)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveFX (orxOBJECT *_pstObject, const orxSTRING _zFXConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SynchronizeFX (orxOBJECT *_pstObject, const orxOBJECT *_pstModel)
 
Sound
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddSound (orxOBJECT *_pstObject, const orxSTRING _zSoundConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveSound (orxOBJECT *_pstObject, const orxSTRING _zSoundConfigID)
 
orxDLLAPI orxSOUND *orxFASTCALL orxObject_GetLastAddedSound (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetVolume (orxOBJECT *_pstObject, orxFLOAT _fVolume)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetPitch (orxOBJECT *_pstObject, orxFLOAT _fPitch)
 
Shader
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveShader (orxOBJECT *_pstObject, const orxSTRING _zShaderConfigID)
 
orxDLLAPI void orxFASTCALL orxObject_EnableShader (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsShaderEnabled (const orxOBJECT *_pstObject)
 
TimeLine
orxDLLAPI orxSTATUS orxFASTCALL orxObject_AddTimeLineTrack (orxOBJECT *_pstObject, const orxSTRING _zTrackConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_RemoveTimeLineTrack (orxOBJECT *_pstObject, const orxSTRING _zTrackConfigID)
 
orxDLLAPI void orxFASTCALL orxObject_EnableTimeLine (orxOBJECT *_pstObject, orxBOOL _bEnable)
 
orxDLLAPI orxBOOL orxFASTCALL orxObject_IsTimeLineEnabled (const orxOBJECT *_pstObject)
 
Name
orxDLLAPI const orxSTRING orxFASTCALL orxObject_GetName (const orxOBJECT *_pstObject)
 
Neighboring
orxDLLAPI orxBANK *orxFASTCALL orxObject_CreateNeighborList (const orxOBOX *_pstCheckBox)
 
orxDLLAPI void orxFASTCALL orxObject_DeleteNeighborList (orxBANK *_pstObjectList)
 
Smoothing
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetSmoothing (orxOBJECT *_pstObject, orxDISPLAY_SMOOTHING _eSmoothing)
 
orxDLLAPI orxDISPLAY_SMOOTHING orxFASTCALL orxObject_GetSmoothing (const orxOBJECT *_pstObject)
 
texture
orxDLLAPI orxTEXTURE *orxFASTCALL orxObject_GetWorkingTexture (const orxOBJECT *_pstObject)
 
Life time / active time
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetLifeTime (orxOBJECT *_pstObject, orxFLOAT _fLifeTime)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetLifeTime (const orxOBJECT *_pstObject)
 
orxDLLAPI orxFLOAT orxFASTCALL orxObject_GetActiveTime (const orxOBJECT *_pstObject)
 
Group
orxDLLAPI orxU32 orxFASTCALL orxObject_GetDefaultGroupID ()
 
orxDLLAPI orxU32 orxFASTCALL orxObject_GetGroupID (const orxOBJECT *_pstObject)
 
orxDLLAPI orxSTATUS orxFASTCALL orxObject_SetGroupID (orxOBJECT *_pstObject, orxU32 _u32GroupID)
 
orxDLLAPI void orxFASTCALL orxObject_SetGroupIDRecursive (orxOBJECT *_pstObject, orxU32 _u32GroupID)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_GetNext (const orxOBJECT *_pstObject, orxU32 _u32GroupID)
 
Picking
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_Pick (const orxVECTOR *_pvPosition, orxU32 _u32GroupID)
 
orxDLLAPI orxOBJECT *orxFASTCALL orxObject_BoxPick (const orxOBOX *_pstBox, orxU32 _u32GroupID)
 

Detailed Description


Generated for orx by doxygen 1.5.6