orx  1.5
Portable Game Engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
OrxAnim

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_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 orxANIM *orxFASTCALL orxAnim_CreateFromConfig (const orxSTRING _zConfigID)
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_Delete (orxANIM *_pstAnim)
 
orxDLLAPI void orxFASTCALL orxAnim_Exit ()
 
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetEventCounter (const orxANIM *_pstAnim)
 
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetEventStorageSize (const orxANIM *_pstAnim)
 
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKeyCounter (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 ()
 
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_Update (orxANIM *_pstAnim, orxFLOAT _fTimeStamp, orxU32 *_pu32CurrentKey)
 

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

#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

All mask

Definition at line 64 of file orxAnim.h.

#define orxANIM_KU32_MASK_USER_ALL   0x0000000F

User all ID mask

Definition at line 62 of file orxAnim.h.

Typedef Documentation

typedef struct __orxANIM_t orxANIM

Internal Anim structure

Definition at line 74 of file orxAnim.h.

Enumeration Type Documentation

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_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

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

Adds an event to an animation

Parameters
[in]_pstAnimConcerned animation
[in]_zEventNameEvent name to add
[in]_fTimeStampTimestamp for this event
[in]_fValueValue for this event
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_AddKey ( orxANIM _pstAnim,
orxSTRUCTURE _pstData,
orxFLOAT  _fTimeStamp 
)

Adds a key to an animation

Parameters
[in]_pstAnimConcerned animation
[in]_pstDataKey data to add
[in]_fTimeStampTimestamp 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]_u32FlagsFlags for created animation
[in]_u32KeyNumberNumber of keys for this animation
[in]_u32EventNumberNumber of events for this animation
Returns
Created orxANIM / orxNULL
orxDLLAPI orxANIM* orxFASTCALL orxAnim_CreateFromConfig ( const orxSTRING  _zConfigID)

Creates an animation from config

Parameters
[in]_zConfigIDConfig ID
Returns
orxANIMSET / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_Delete ( orxANIM _pstAnim)

Deletes an animation

Parameters
[in]_pstAnimAnim to delete
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxAnim_Exit ( )

Exits from the Anim module

orxDLLAPI orxU32 orxFASTCALL orxAnim_GetEventCounter ( const orxANIM _pstAnim)

Anim event counter accessor

Parameters
[in]_pstAnimConcerned animation
Returns
Anim event counter
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetEventStorageSize ( const orxANIM _pstAnim)

Anim event storage size accessor

Parameters
[in]_pstAnimConcerned animation
Returns
Anim event storage size
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKeyCounter ( const orxANIM _pstAnim)

Anim key counter accessor

Parameters
[in]_pstAnimConcerned animation
Returns
Anim key counter
orxDLLAPI orxSTRUCTURE* orxFASTCALL orxAnim_GetKeyData ( const orxANIM _pstAnim,
orxU32  _u32Index 
)

Anim key data accessor

Parameters
[in]_pstAnimConcerned animation
[in]_u32IndexIndex of desired key data
Returns
Desired orxSTRUCTURE / orxNULL
orxDLLAPI orxU32 orxFASTCALL orxAnim_GetKeyStorageSize ( const orxANIM _pstAnim)

Anim key storage size accessor

Parameters
[in]_pstAnimConcerned animation
Returns
Anim key storage size
orxDLLAPI orxFLOAT orxFASTCALL orxAnim_GetLength ( const orxANIM _pstAnim)

Anim time length accessor

Parameters
[in]_pstAnimConcerned animation
Returns
Anim time length
orxDLLAPI const orxSTRING orxFASTCALL orxAnim_GetName ( const orxANIM _pstAnim)

Anim name get accessor

Parameters
[in]_pstAnimConcerned animation
Returns
orxSTRING / orxSTRING_EMPTY
orxDLLAPI const orxANIM_CUSTOM_EVENT* orxFASTCALL orxAnim_GetNextEvent ( const orxANIM _pstAnim,
orxFLOAT  _fTimeStamp 
)

Gets next event after given timestamp

Parameters
[in]_pstAnimConcerned animation
[in]_fTimeStampTime stamp, excluded
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_Init ( )

Inits the Anim module

orxDLLAPI void orxFASTCALL orxAnim_RemoveAllEvents ( orxANIM _pstAnim)

Removes all events from an animation

Parameters
[in]_pstAnimConcerned animation
orxDLLAPI void orxFASTCALL orxAnim_RemoveAllKeys ( orxANIM _pstAnim)

Removes all keys from an animation

Parameters
[in]_pstAnimConcerned animation
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_RemoveLastEvent ( orxANIM _pstAnim)

Removes last added event from an animation

Parameters
[in]_pstAnimConcerned animation
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxAnim_RemoveLastKey ( orxANIM _pstAnim)

Removes last added key from an animation

Parameters
[in]_pstAnimConcerned animation
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxAnim_Setup ( )

Anim module setup

orxDLLAPI orxSTATUS orxFASTCALL orxAnim_Update ( orxANIM _pstAnim,
orxFLOAT  _fTimeStamp,
orxU32 *  _pu32CurrentKey 
)

Updates anim given a timestamp

Parameters
[in]_pstAnimConcerned animation
[in]_fTimeStampTimeStamp for animation update
[out]_pu32CurrentKeyCurrent key as a result of update
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE

Generated for orx by doxygen 1.5.6