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_GetFrequency (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI orxU32 orxFASTCALL	orxAnimPointer_GetTargetAnim (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI const orxSTRING orxFASTCALL	orxAnimPointer_GetTargetAnimName (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI orxFLOAT orxFASTCALL	orxAnimPointer_GetTime (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

◆ orxANIMPOINTER

typedef struct __orxANIMPOINTER_t orxANIMPOINTER

Internal AnimPointer structure

Definition at line 58 of file orxAnimPointer.h.

Function Documentation

◆ orxAnimPointer_Create()

orxDLLAPI orxANIMPOINTER *orxFASTCALL orxAnimPointer_Create ( orxANIMSET * _pstAnimSet )

extern

Creates an empty AnimPointer

Parameters

[in] _pstAnimSet AnimSet reference

Returns: orxANIMPOINTER / orxNULL

◆ orxAnimPointer_CreateFromConfig()

orxDLLAPI orxANIMPOINTER *orxFASTCALL orxAnimPointer_CreateFromConfig ( const orxSTRING _zConfigID )

extern

Creates an animation pointer from config

Parameters

[in] _zConfigID Config ID

Returns: orxANIMPOINTER / orxNULL

◆ orxAnimPointer_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Delete ( orxANIMPOINTER * _pstAnimPointer )

extern

Deletes an AnimPointer

Parameters

[in] _pstAnimPointer AnimPointer to delete

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_Exit()

orxDLLAPI void orxFASTCALL orxAnimPointer_Exit ( )

extern

Exits from the AnimPointer module

◆ orxAnimPointer_GetAnimSet()

orxDLLAPI orxANIMSET *orxFASTCALL orxAnimPointer_GetAnimSet ( const orxANIMPOINTER * _pstAnimPointer )

extern

Gets the referenced AnimSet

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: Referenced orxANIMSET

◆ orxAnimPointer_GetCurrentAnim()

orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetCurrentAnim ( const orxANIMPOINTER * _pstAnimPointer )

extern

AnimPointer current Animation get accessor

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: Current Animation ID

◆ orxAnimPointer_GetCurrentAnimData()

orxDLLAPI orxSTRUCTURE *orxFASTCALL orxAnimPointer_GetCurrentAnimData ( const orxANIMPOINTER * _pstAnimPointer )

extern

AnimPointer current anim data get accessor

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: Current anim data / orxNULL

◆ orxAnimPointer_GetCurrentAnimName()

orxDLLAPI const orxSTRING orxFASTCALL orxAnimPointer_GetCurrentAnimName ( const orxANIMPOINTER * _pstAnimPointer )

extern

AnimPointer current Animation name get accessor

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: Current Animation name / orxSTRING_EMPTY

◆ orxAnimPointer_GetFrequency()

orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetFrequency ( const orxANIMPOINTER * _pstAnimPointer )

extern

AnimPointer frequency get accessor

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: AnimPointer frequency

◆ orxAnimPointer_GetTargetAnim()

orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetTargetAnim ( const orxANIMPOINTER * _pstAnimPointer )

extern

AnimPointer target Animation get accessor

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: Target Animation ID

◆ orxAnimPointer_GetTargetAnimName()

orxDLLAPI const orxSTRING orxFASTCALL orxAnimPointer_GetTargetAnimName ( const orxANIMPOINTER * _pstAnimPointer )

extern

AnimPointer target Animation ID get accessor

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: Target Animation name / orxSTRING_EMPTY

◆ orxAnimPointer_GetTime()

orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetTime ( const orxANIMPOINTER * _pstAnimPointer )

extern

AnimPointer time get accessor

Parameters

[in] _pstAnimPointer Concerned AnimPointer

Returns: Current time

◆ orxAnimPointer_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Init ( )

extern

Inits the AnimPointer module

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_Pause()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Pause	(	orxANIMPOINTER *	_pstAnimPointer,
		orxBOOL	_bPause )

extern

AnimPointer pause accessor

Parameters

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_bPause	Pause / Unpause

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_SetCurrentAnim()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetCurrentAnim	(	orxANIMPOINTER *	_pstAnimPointer,
		orxU32	_u32AnimID )

extern

AnimPointer current Animation set accessor

Parameters

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_u32AnimID	Animation ID to set

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_SetCurrentAnimFromName()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetCurrentAnimFromName	(	orxANIMPOINTER *	_pstAnimPointer,
		const orxSTRING	_zAnimName )

extern

AnimPointer current Animation set accessor using name

Parameters

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_zAnimName	Animation name (config's name) to set

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_SetFrequency()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetFrequency	(	orxANIMPOINTER *	_pstAnimPointer,
		orxFLOAT	_fFrequency )

extern

AnimPointer frequency set accessor

Parameters

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_fFrequency	Frequency to set

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_SetTargetAnim()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTargetAnim	(	orxANIMPOINTER *	_pstAnimPointer,
		orxU32	_u32AnimID )

extern

AnimPointer target Animation set accessor

Parameters

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_u32AnimID	Animation ID to set / orxU32_UNDEFINED

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_SetTargetAnimFromName()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTargetAnimFromName	(	orxANIMPOINTER *	_pstAnimPointer,
		const orxSTRING	_zAnimName )

extern

AnimPointer target Animation set accessor using name

Parameters

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_zAnimName	Animation name (config's name) to set / orxNULL

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_SetTime()

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTime	(	orxANIMPOINTER *	_pstAnimPointer,
		orxFLOAT	_fTime )

extern

AnimPointer current time set accessor

Parameters

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_fTime	Time to set

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnimPointer_Setup()

orxDLLAPI void orxFASTCALL orxAnimPointer_Setup ( )

extern

AnimPointer module setup

Typedefs

Functions

Detailed Description

Typedef Documentation

◆ orxANIMPOINTER

Function Documentation

◆ orxAnimPointer_Create()

◆ orxAnimPointer_CreateFromConfig()

◆ orxAnimPointer_Delete()

◆ orxAnimPointer_Exit()

◆ orxAnimPointer_GetAnimSet()

◆ orxAnimPointer_GetCurrentAnim()

◆ orxAnimPointer_GetCurrentAnimData()

◆ orxAnimPointer_GetCurrentAnimName()

◆ orxAnimPointer_GetFrequency()

◆ orxAnimPointer_GetTargetAnim()

◆ orxAnimPointer_GetTargetAnimName()

◆ orxAnimPointer_GetTime()

◆ orxAnimPointer_Init()

◆ orxAnimPointer_Pause()

◆ orxAnimPointer_SetCurrentAnim()

◆ orxAnimPointer_SetCurrentAnimFromName()

◆ orxAnimPointer_SetFrequency()

◆ orxAnimPointer_SetTargetAnim()

◆ orxAnimPointer_SetTargetAnimFromName()

◆ orxAnimPointer_SetTime()

◆ orxAnimPointer_Setup()