Data Structures
struct	orxANIM_CUSTOM_EVENT
struct	orxANIM_EVENT_PAYLOAD

Macros
#define	orxANIM_KU32_EVENT_MAX_NUMBER 65535
#define	orxANIM_KU32_FLAG_2D 0x00000001
#define	orxANIM_KU32_FLAG_NONE 0x00000000
#define	orxANIM_KU32_KEY_MAX_NUMBER 65535
#define	orxANIM_KU32_MASK_ALL 0xFFFFFFFF
#define	orxANIM_KU32_MASK_USER_ALL 0x0000000F

Typedefs
typedef struct __orxANIM_t	orxANIM

Enumerations
enum	orxANIM_EVENT { orxANIM_EVENT_START = 0 , orxANIM_EVENT_STOP , orxANIM_EVENT_CUT , orxANIM_EVENT_LOOP , orxANIM_EVENT_UPDATE , orxANIM_EVENT_CUSTOM_EVENT , orxANIM_EVENT_NUMBER , orxANIM_EVENT_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxAnim_AddEvent (orxANIM *_pstAnim, const orxSTRING _zEventName, orxFLOAT _fTimeStamp, orxFLOAT _fValue)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnim_AddKey (orxANIM _pstAnim, orxSTRUCTURE _pstData, orxFLOAT _fTimeStamp)
orxDLLAPI orxANIM *orxFASTCALL	orxAnim_Create (orxU32 _u32Flags, orxU32 _u32KeyNumber, orxU32 _u32EventNumber)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnim_Delete (orxANIM *_pstAnim)
orxDLLAPI void orxFASTCALL	orxAnim_Exit ()
orxDLLAPI orxFLOAT orxFASTCALL	orxAnim_GetDuration (const orxANIM *_pstAnim)
orxDLLAPI const orxANIM_CUSTOM_EVENT *orxFASTCALL	orxAnim_GetEventAfter (const orxANIM *_pstAnim, orxFLOAT _fTimeStamp)
orxDLLAPI orxU32 orxFASTCALL	orxAnim_GetEventCount (const orxANIM *_pstAnim)
orxDLLAPI orxU32 orxFASTCALL	orxAnim_GetEventStorageSize (const orxANIM *_pstAnim)
orxDLLAPI orxU32 orxFASTCALL	orxAnim_GetKey (const orxANIM *_pstAnim, orxFLOAT _fTimeStamp)
orxDLLAPI orxU32 orxFASTCALL	orxAnim_GetKeyCount (const orxANIM *_pstAnim)
orxDLLAPI orxSTRUCTURE *orxFASTCALL	orxAnim_GetKeyData (const orxANIM *_pstAnim, orxU32 _u32Index)
orxDLLAPI orxU32 orxFASTCALL	orxAnim_GetKeyStorageSize (const orxANIM *_pstAnim)
orxDLLAPI const orxSTRING orxFASTCALL	orxAnim_GetName (const orxANIM *_pstAnim)
orxDLLAPI const orxANIM_CUSTOM_EVENT *orxFASTCALL	orxAnim_GetNextEvent (const orxANIM _pstAnim, const orxANIM_CUSTOM_EVENT _pstEvent)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnim_Init ()
orxDLLAPI void orxFASTCALL	orxAnim_RemoveAllEvents (orxANIM *_pstAnim)
orxDLLAPI void orxFASTCALL	orxAnim_RemoveAllKeys (orxANIM *_pstAnim)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnim_RemoveLastEvent (orxANIM *_pstAnim)
orxDLLAPI orxSTATUS orxFASTCALL	orxAnim_RemoveLastKey (orxANIM *_pstAnim)
orxDLLAPI void orxFASTCALL	orxAnim_Setup ()

Detailed Description

Animation (Data) Module. Allows to creates and handle Animations data. It consists of a structure containing data for a single animation and functions for handling and accessing them. Animations are structures. They thus can be referenced by Animation Sets (orxAnimSet) Module.

Macro Definition Documentation

◆ orxANIM_KU32_EVENT_MAX_NUMBER

#define orxANIM_KU32_EVENT_MAX_NUMBER 65535

Maximum number of events for an animation

Definition at line 69 of file orxAnim.h.

◆ orxANIM_KU32_FLAG_2D

#define orxANIM_KU32_FLAG_2D 0x00000001

2D type animation ID flag

Definition at line 60 of file orxAnim.h.

◆ orxANIM_KU32_FLAG_NONE

#define orxANIM_KU32_FLAG_NONE 0x00000000

Anim flags No flags

Definition at line 58 of file orxAnim.h.

◆ orxANIM_KU32_KEY_MAX_NUMBER

#define orxANIM_KU32_KEY_MAX_NUMBER 65535

Anim defines Maximum number of keys for an animation

Definition at line 68 of file orxAnim.h.

◆ orxANIM_KU32_MASK_ALL

#define orxANIM_KU32_MASK_ALL 0xFFFFFFFF

All mask

Definition at line 64 of file orxAnim.h.

◆ orxANIM_KU32_MASK_USER_ALL

#define orxANIM_KU32_MASK_USER_ALL 0x0000000F

User all ID mask

Definition at line 62 of file orxAnim.h.

Typedef Documentation

◆ orxANIM

typedef struct __orxANIM_t orxANIM

Internal Anim structure

Definition at line 74 of file orxAnim.h.

Enumeration Type Documentation

◆ orxANIM_EVENT

enum orxANIM_EVENT

Event enum

Enumerator
orxANIM_EVENT_START	Event sent when an animation starts
orxANIM_EVENT_STOP	Event sent when an animation stops
orxANIM_EVENT_CUT	Event sent when an animation is cut
orxANIM_EVENT_LOOP	Event sent when an animation has looped
orxANIM_EVENT_UPDATE	Event sent when an animation has been updated (current key)
orxANIM_EVENT_CUSTOM_EVENT	Event sent when a custom event is reached
orxANIM_EVENT_NUMBER
orxANIM_EVENT_NONE

Definition at line 79 of file orxAnim.h.

Function Documentation

◆ orxAnim_AddEvent()

orxDLLAPI orxSTATUS orxFASTCALL orxAnim_AddEvent	(	orxANIM *	_pstAnim,
		const orxSTRING	_zEventName,
		orxFLOAT	_fTimeStamp,
		orxFLOAT	_fValue )

extern

Adds an event to an animation

Parameters

[in]	_pstAnim	Concerned animation
[in]	_zEventName	Event name to add
[in]	_fTimeStamp	Timestamp for this event
[in]	_fValue	Value for this event

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnim_AddKey()

orxDLLAPI orxSTATUS orxFASTCALL orxAnim_AddKey	(	orxANIM *	_pstAnim,
		orxSTRUCTURE *	_pstData,
		orxFLOAT	_fTimeStamp )

extern

Adds a key to an animation

Parameters

[in]	_pstAnim	Concerned animation
[in]	_pstData	Key data to add
[in]	_fTimeStamp	Timestamp for this key

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnim_Create()

orxDLLAPI orxANIM *orxFASTCALL orxAnim_Create	(	orxU32	_u32Flags,
		orxU32	_u32KeyNumber,
		orxU32	_u32EventNumber )

extern

Creates an empty animation

Parameters

[in]	_u32Flags	Flags for created animation
[in]	_u32KeyNumber	Number of keys for this animation
[in]	_u32EventNumber	Number of events for this animation

Returns: Created orxANIM / orxNULL

◆ orxAnim_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxAnim_Delete ( orxANIM * _pstAnim )

extern

Deletes an animation

Parameters

[in] _pstAnim Anim to delete

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnim_Exit()

orxDLLAPI void orxFASTCALL orxAnim_Exit ( )

extern

Exits from the Anim module

◆ orxAnim_GetDuration()

orxDLLAPI orxFLOAT orxFASTCALL orxAnim_GetDuration ( const orxANIM * _pstAnim )

extern

Anim duration accessor

Parameters

[in] _pstAnim Concerned animation

Returns: Anim time length

◆ orxAnim_GetEventAfter()

orxDLLAPI const orxANIM_CUSTOM_EVENT *orxFASTCALL orxAnim_GetEventAfter	(	const orxANIM *	_pstAnim,
		orxFLOAT	_fTimeStamp )

extern

Gets event strictly after given timestamp

Parameters

[in]	_pstAnim	Concerned animation
[in]	_fTimeStamp	Time stamp, excluded

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnim_GetEventCount()

orxDLLAPI orxU32 orxFASTCALL orxAnim_GetEventCount ( const orxANIM * _pstAnim )

extern

Anim event count accessor

Parameters

[in] _pstAnim Concerned animation

Returns: Anim event count

◆ orxAnim_GetEventStorageSize()

orxDLLAPI orxU32 orxFASTCALL orxAnim_GetEventStorageSize ( const orxANIM * _pstAnim )

extern

Anim event storage size accessor

Parameters

[in] _pstAnim Concerned animation

Returns: Anim event storage size

◆ orxAnim_GetKey()

orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKey	(	const orxANIM *	_pstAnim,
		orxFLOAT	_fTimeStamp )

extern

Gets animation's key index from a time stamp

Parameters

[in]	_pstAnim	Concerned animation
[in]	_fTimeStamp	TimeStamp of the desired animation key

Returns: Animation key index / orxU32_UNDEFINED

◆ orxAnim_GetKeyCount()

orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKeyCount ( const orxANIM * _pstAnim )

extern

Anim key count accessor

Parameters

[in] _pstAnim Concerned animation

Returns: Anim key count

◆ orxAnim_GetKeyData()

orxDLLAPI orxSTRUCTURE *orxFASTCALL orxAnim_GetKeyData	(	const orxANIM *	_pstAnim,
		orxU32	_u32Index )

extern

Anim key data accessor

Parameters

[in]	_pstAnim	Concerned animation
[in]	_u32Index	Index of desired key data

Returns: Desired orxSTRUCTURE / orxNULL

◆ orxAnim_GetKeyStorageSize()

orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKeyStorageSize ( const orxANIM * _pstAnim )

extern

Anim key storage size accessor

Parameters

[in] _pstAnim Concerned animation

Returns: Anim key storage size

◆ orxAnim_GetName()

orxDLLAPI const orxSTRING orxFASTCALL orxAnim_GetName ( const orxANIM * _pstAnim )

extern

Anim name get accessor

Parameters

[in] _pstAnim Concerned animation

Returns: orxSTRING / orxSTRING_EMPTY

◆ orxAnim_GetNextEvent()

orxDLLAPI const orxANIM_CUSTOM_EVENT *orxFASTCALL orxAnim_GetNextEvent	(	const orxANIM *	_pstAnim,
		const orxANIM_CUSTOM_EVENT *	_pstEvent )

extern

Gets next event

Parameters

[in]	_pstAnim	Concerned animation
[in]	_pstEvent	Event, orxNULL for first

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnim_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxAnim_Init ( )

extern

Inits the Anim module

◆ orxAnim_RemoveAllEvents()

orxDLLAPI void orxFASTCALL orxAnim_RemoveAllEvents ( orxANIM * _pstAnim )

extern

Removes all events from an animation

Parameters

[in] _pstAnim Concerned animation

◆ orxAnim_RemoveAllKeys()

orxDLLAPI void orxFASTCALL orxAnim_RemoveAllKeys ( orxANIM * _pstAnim )

extern

Removes all keys from an animation

Parameters

[in] _pstAnim Concerned animation

◆ orxAnim_RemoveLastEvent()

orxDLLAPI orxSTATUS orxFASTCALL orxAnim_RemoveLastEvent ( orxANIM * _pstAnim )

extern

Removes last added event from an animation

Parameters

[in] _pstAnim Concerned animation

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnim_RemoveLastKey()

orxDLLAPI orxSTATUS orxFASTCALL orxAnim_RemoveLastKey ( orxANIM * _pstAnim )

extern

Removes last added key from an animation

Parameters

[in] _pstAnim Concerned animation

Returns: orxSTATUS_SUCCESS / orxSTATUS_FAILURE

◆ orxAnim_Setup()

orxDLLAPI void orxFASTCALL orxAnim_Setup ( )

extern

Anim module setup

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ orxANIM_KU32_EVENT_MAX_NUMBER

◆ orxANIM_KU32_FLAG_2D

◆ orxANIM_KU32_FLAG_NONE

◆ orxANIM_KU32_KEY_MAX_NUMBER

◆ orxANIM_KU32_MASK_ALL

◆ orxANIM_KU32_MASK_USER_ALL

Typedef Documentation

◆ orxANIM

Enumeration Type Documentation

◆ orxANIM_EVENT

Function Documentation

◆ orxAnim_AddEvent()

◆ orxAnim_AddKey()

◆ orxAnim_Create()

◆ orxAnim_Delete()

◆ orxAnim_Exit()

◆ orxAnim_GetDuration()

◆ orxAnim_GetEventAfter()

◆ orxAnim_GetEventCount()

◆ orxAnim_GetEventStorageSize()

◆ orxAnim_GetKey()

◆ orxAnim_GetKeyCount()

◆ orxAnim_GetKeyData()

◆ orxAnim_GetKeyStorageSize()

◆ orxAnim_GetName()

◆ orxAnim_GetNextEvent()

◆ orxAnim_Init()

◆ orxAnim_RemoveAllEvents()

◆ orxAnim_RemoveAllKeys()

◆ orxAnim_RemoveLastEvent()

◆ orxAnim_RemoveLastKey()

◆ orxAnim_Setup()