OrxAnimPointer

Typedefs
typedef struct __orxANIMPOINTER_t	orxANIMPOINTER
Functions
orxDLLAPI orxANIMPOINTER *orxFASTCALL	orxAnimPointer_Create (const orxSTRUCTURE *_pstOwner, orxANIMSET *_pstAnimSet)
orxDLLAPI orxANIMPOINTER *orxFASTCALL	orxAnimPointer_CreateFromConfig (const orxSTRUCTURE *_pstOwner, 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 orxHANDLE orxFASTCALL	orxAnimPointer_GetCurrentAnimHandle (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI orxFLOAT orxFASTCALL	orxAnimPointer_GetCurrentTime (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI orxFLOAT orxFASTCALL	orxAnimPointer_GetFrequency (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI orxSTRUCTURE *orxFASTCALL	orxAnimPointer_GetOwner (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI orxU32 orxFASTCALL	orxAnimPointer_GetTargetAnim (const orxANIMPOINTER *_pstAnimPointer)
orxDLLAPI orxHANDLE orxFASTCALL	orxAnimPointer_GetTargetAnimHandle (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_SetCurrentAnimHandle (orxANIMPOINTER *_pstAnimPointer, orxHANDLE _hAnimHandle)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnimPointer_SetFrequency (orxANIMPOINTER *_pstAnimPointer, orxFLOAT _fFrequency)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnimPointer_SetTargetAnim (orxANIMPOINTER *_pstAnimPointer, orxU32 _u32AnimID)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnimPointer_SetTargetAnimHandle (orxANIMPOINTER *_pstAnimPointer, orxHANDLE _hAnimHandle)
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	(	const orxSTRUCTURE *	_pstOwner,
		orxANIMSET *	_pstAnimSet
	)

Creates an empty AnimPointer

Parameters:

[in]	_pstOwner	AnimPointer's owner used for event callbacks (usually an orxOBJECT)
[in]	_pstAnimSet	AnimSet reference

Returns:

orxANIMPOINTER / orxNULL

orxDLLAPI orxANIMPOINTER* orxFASTCALL orxAnimPointer_CreateFromConfig	(	const orxSTRUCTURE *	_pstOwner,
		const orxSTRING	_zConfigID
	)

Creates an animation pointer from config

Parameters:

[in]	_pstOwner	AnimPointer's owner used for event callbacks (usually an orxOBJECT)
[in]	_zConfigID	Config ID

Returns:

orxANIMPOINTER / orxNULL

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_Delete

(

orxANIMPOINTER *

_pstAnimPointer )

Deletes an AnimPointer

Parameters:

[in]

_pstAnimPointer

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

_pstAnimPointer

Concerned AnimPointer

Returns:

Referenced orxANIMSET

orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetCurrentAnim

(

const orxANIMPOINTER *

_pstAnimPointer )

AnimPointer current Animation ID get accessor

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

Current Animation ID

orxDLLAPI orxSTRUCTURE* orxFASTCALL orxAnimPointer_GetCurrentAnimData

(

const orxANIMPOINTER *

_pstAnimPointer )

AnimPointer current anim data get accessor

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

Current anim data / orxNULL

orxDLLAPI orxHANDLE orxFASTCALL orxAnimPointer_GetCurrentAnimHandle

(

const orxANIMPOINTER *

_pstAnimPointer )

AnimPointer current Animation get accessor

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

Current Animation handle

orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetCurrentTime

(

const orxANIMPOINTER *

_pstAnimPointer )

AnimPointer current Time get accessor

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

Current time

orxDLLAPI orxFLOAT orxFASTCALL orxAnimPointer_GetFrequency

(

const orxANIMPOINTER *

_pstAnimPointer )

AnimPointer Frequency get accessor

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

AnimPointer frequency

orxDLLAPI orxSTRUCTURE* orxFASTCALL orxAnimPointer_GetOwner

(

const orxANIMPOINTER *

_pstAnimPointer )

Gets an AnimPointer owner

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

orxSTRUCTURE / orxNULL

orxDLLAPI orxU32 orxFASTCALL orxAnimPointer_GetTargetAnim

(

const orxANIMPOINTER *

_pstAnimPointer )

AnimPointer target Animation ID get accessor

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

Target Animation ID

orxDLLAPI orxHANDLE orxFASTCALL orxAnimPointer_GetTargetAnimHandle

(

const orxANIMPOINTER *

_pstAnimPointer )

AnimPointer target Animation get accessor

Parameters:

[in]

_pstAnimPointer

Concerned AnimPointer

Returns:

Target Animation handle

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]	_pstAnimPointer	Concerned AnimPointer
[in]	_bPause	Pause / Unpause

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

AnimPointer current Animation set accessor using ID

Parameters:

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_u32AnimID	Animation ID (config's name CRC) to set

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetCurrentAnimHandle	(	orxANIMPOINTER *	_pstAnimPointer,
		orxHANDLE	_hAnimHandle
	)

AnimPointer current Animation set accessor

Parameters:

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_hAnimHandle	Animation handle to set

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

AnimPointer Frequency set accessor

Parameters:

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

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

AnimPointer target Animation set accessor using ID

Parameters:

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_u32AnimID	Animation ID (config's name CRC) to set / orxU32_UNDEFINED

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI orxSTATUS orxFASTCALL orxAnimPointer_SetTargetAnimHandle	(	orxANIMPOINTER *	_pstAnimPointer,
		orxHANDLE	_hAnimHandle
	)

AnimPointer target Animation set accessor

Parameters:

[in]	_pstAnimPointer	Concerned AnimPointer
[in]	_hAnimHandle	Animation handle to set / orxHANDLE_UNDEFINED

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

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

AnimPointer current Time accessor

Parameters:

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

Returns:

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxDLLAPI void orxFASTCALL orxAnimPointer_Setup

(

)

AnimPointer module setup