|
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 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 orxFLOAT orxFASTCALL | orxAnim_GetLength (const orxANIM *_pstAnim) |
|
orxDLLAPI const orxSTRING orxFASTCALL | orxAnim_GetName (const orxANIM *_pstAnim) |
|
orxDLLAPI const orxANIM_CUSTOM_EVENT *orxFASTCALL | orxAnim_GetNextEvent (const orxANIM *_pstAnim, orxFLOAT _fTimeStamp) |
|
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 () |
|
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.
#define orxANIM_KU32_EVENT_MAX_NUMBER 65535 |
Maximum number of events for an animation
Definition at line 69 of file orxAnim.h.
#define orxANIM_KU32_FLAG_2D 0x00000001 |
2D type animation ID flag
Definition at line 60 of file orxAnim.h.
#define orxANIM_KU32_FLAG_NONE 0x00000000 |
Anim flagsNo flags
Definition at line 58 of file orxAnim.h.
#define orxANIM_KU32_KEY_MAX_NUMBER 65535 |
Anim definesMaximum number of keys for an animation
Definition at line 68 of file orxAnim.h.
#define orxANIM_KU32_MASK_ALL 0xFFFFFFFF |
#define orxANIM_KU32_MASK_USER_ALL 0x0000000F |
User all ID mask
Definition at line 62 of file orxAnim.h.
Internal Anim structure
Definition at line 74 of file orxAnim.h.
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.
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_AddEvent |
( |
orxANIM * |
_pstAnim, |
|
|
const orxSTRING |
_zEventName, |
|
|
orxFLOAT |
_fTimeStamp, |
|
|
orxFLOAT |
_fValue |
|
) |
| |
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
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
orxDLLAPI orxANIM* orxFASTCALL orxAnim_Create |
( |
orxU32 |
_u32Flags, |
|
|
orxU32 |
_u32KeyNumber, |
|
|
orxU32 |
_u32EventNumber |
|
) |
| |
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
Deletes an animation
- Parameters
-
[in] | _pstAnim | Anim to delete |
- Returns
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
Exits from the Anim module
Anim event count accessor
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- Anim event count
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetEventStorageSize |
( |
const orxANIM * |
_pstAnim | ) |
|
Anim event storage size accessor
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- Anim event storage size
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKey |
( |
const orxANIM * |
_pstAnim, |
|
|
orxFLOAT |
_fTimeStamp |
|
) |
| |
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
Anim key count accessor
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- Anim key count
Anim key data accessor
- Parameters
-
[in] | _pstAnim | Concerned animation |
[in] | _u32Index | Index of desired key data |
- Returns
- Desired orxSTRUCTURE / orxNULL
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKeyStorageSize |
( |
const orxANIM * |
_pstAnim | ) |
|
Anim key storage size accessor
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- Anim key storage size
Anim time length accessor
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- Anim time length
orxDLLAPI const orxSTRING orxFASTCALL orxAnim_GetName |
( |
const orxANIM * |
_pstAnim | ) |
|
Anim name get accessor
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- orxSTRING / orxSTRING_EMPTY
Gets next event after given timestamp
- Parameters
-
[in] | _pstAnim | Concerned animation |
[in] | _fTimeStamp | Time stamp, excluded |
- Returns
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
Removes all events from an animation
- Parameters
-
[in] | _pstAnim | Concerned animation |
Removes all keys from an animation
- Parameters
-
[in] | _pstAnim | Concerned animation |
Removes last added event from an animation
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE
Removes last added key from an animation
- Parameters
-
[in] | _pstAnim | Concerned animation |
- Returns
- orxSTATUS_SUCCESS / orxSTATUS_FAILURE