orx  stable
Portable Game Engine
OrxAnimPointer

Typedefs

typedef struct __orxANIMPOINTER_t orxANIMPOINTER
 

Functions

orxDLLAPI orxANIMPOINTER *orxFASTCALL orxAnimPointer_Create (orxANIMSET *_pstAnimSet)
 
orxDLLAPI orxANIMPOINTER *orxFASTCALL orxAnimPointer_CreateFromConfig (const orxSTRING _zConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Delete (orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI void orxFASTCALL orxAnimPointer_Exit ()
 
orxDLLAPI orxANIMSET *orxFASTCALL orxAnimPointer_GetAnimSet (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetCurrentAnim (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI orxSTRUCTURE *orxFASTCALL orxAnimPointer_GetCurrentAnimData (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI const orxSTRING orxFASTCALL orxAnimPointer_GetCurrentAnimName (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetCurrentTime (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetFrequency (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetTargetAnim (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI const orxSTRING orxFASTCALL orxAnimPointer_GetTargetAnimName (const orxANIMPOINTER *_pstAnimPointer)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Init ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Pause (orxANIMPOINTER *_pstAnimPointer, orxBOOL _bPause)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetCurrentAnim (orxANIMPOINTER *_pstAnimPointer, orxU32 _u32AnimID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetCurrentAnimFromName (orxANIMPOINTER *_pstAnimPointer, const orxSTRING _zAnimName)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetFrequency (orxANIMPOINTER *_pstAnimPointer, orxFLOAT _fFrequency)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTargetAnim (orxANIMPOINTER *_pstAnimPointer, orxU32 _u32AnimID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTargetAnimFromName (orxANIMPOINTER *_pstAnimPointer, const orxSTRING _zAnimName)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTime (orxANIMPOINTER *_pstAnimPointer, orxFLOAT _fTime)
 
orxDLLAPI void orxFASTCALL orxAnimPointer_Setup ()
 

Detailed Description

Animation (Pointer) Module. Allows to creates and handle Animation Set Pointers. It consists of a structure containing pointers and counters referenced to an Animation Set. It also contains functions for handling and accessing animations of the referenced Animation Set. Animation Pointers are structures. They thus can be referenced by Graphics.

Typedef Documentation

typedef struct __orxANIMPOINTER_t orxANIMPOINTER

Internal AnimPointer structure

Definition at line 58 of file orxAnimPointer.h.

Function Documentation

orxDLLAPI orxANIMPOINTER* orxFASTCALL orxAnimPointer_Create ( orxANIMSET _pstAnimSet)

Creates an empty AnimPointer

Parameters
[in]_pstAnimSetAnimSet reference
Returns
orxANIMPOINTER / orxNULL
orxDLLAPI orxANIMPOINTER* orxFASTCALL orxAnimPointer_CreateFromConfig ( const orxSTRING  _zConfigID)

Creates an animation pointer from config

Parameters
[in]_zConfigIDConfig ID
Returns
orxANIMPOINTER / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Delete ( orxANIMPOINTER _pstAnimPointer)

Deletes an AnimPointer

Parameters
[in]_pstAnimPointerAnimPointer to delete
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxAnimPointer_Exit ( )

Exits from the AnimPointer module

orxDLLAPI orxANIMSET* orxFASTCALL orxAnimPointer_GetAnimSet ( const orxANIMPOINTER _pstAnimPointer)

Gets the referenced AnimSet

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
Referenced orxANIMSET
orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetCurrentAnim ( const orxANIMPOINTER _pstAnimPointer)

AnimPointer current Animation get accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
Current Animation ID
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxAnimPointer_GetCurrentAnimData ( const orxANIMPOINTER _pstAnimPointer)

AnimPointer current anim data get accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
Current anim data / orxNULL
orxDLLAPI const orxSTRING orxFASTCALL orxAnimPointer_GetCurrentAnimName ( const orxANIMPOINTER _pstAnimPointer)

AnimPointer current Animation name get accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
Current Animation name / orxSTRING_EMPTY
orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetCurrentTime ( const orxANIMPOINTER _pstAnimPointer)

AnimPointer current Time get accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
Current time
orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetFrequency ( const orxANIMPOINTER _pstAnimPointer)

AnimPointer Frequency get accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
AnimPointer frequency
orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetTargetAnim ( const orxANIMPOINTER _pstAnimPointer)

AnimPointer target Animation get accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
Target Animation ID
orxDLLAPI const orxSTRING orxFASTCALL orxAnimPointer_GetTargetAnimName ( const orxANIMPOINTER _pstAnimPointer)

AnimPointer target Animation ID get accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
Returns
Target Animation name / orxSTRING_EMPTY
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Init ( )

Inits the AnimPointer module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Pause ( orxANIMPOINTER _pstAnimPointer,
orxBOOL  _bPause 
)

AnimPointer pause accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
[in]_bPausePause / Unpause
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetCurrentAnim ( orxANIMPOINTER _pstAnimPointer,
orxU32  _u32AnimID 
)

AnimPointer current Animation set accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
[in]_u32AnimIDAnimation ID to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetCurrentAnimFromName ( orxANIMPOINTER _pstAnimPointer,
const orxSTRING  _zAnimName 
)

AnimPointer current Animation set accessor using name

Parameters
[in]_pstAnimPointerConcerned AnimPointer
[in]_zAnimNameAnimation name (config's name) to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetFrequency ( orxANIMPOINTER _pstAnimPointer,
orxFLOAT  _fFrequency 
)

AnimPointer Frequency set accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
[in]_fFrequencyFrequency to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTargetAnim ( orxANIMPOINTER _pstAnimPointer,
orxU32  _u32AnimID 
)

AnimPointer target Animation set accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
[in]_u32AnimIDAnimation ID to set / orxU32_UNDEFINED
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTargetAnimFromName ( orxANIMPOINTER _pstAnimPointer,
const orxSTRING  _zAnimName 
)

AnimPointer target Animation set accessor using name

Parameters
[in]_pstAnimPointerConcerned AnimPointer
[in]_zAnimNameAnimation name (config's name) to set / orxNULL
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTime ( orxANIMPOINTER _pstAnimPointer,
orxFLOAT  _fTime 
)

AnimPointer current Time accessor

Parameters
[in]_pstAnimPointerConcerned AnimPointer
[in]_fTimeTime to set
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxAnimPointer_Setup ( )

AnimPointer module setup


Generated for orx by doxygen 1.5.6