OrxTimeLine

Data Structures
struct	orxTIMELINE_EVENT_PAYLOAD

Typedefs
typedef struct __orxTIMELINE_t	orxTIMELINE

Enumerations
enum	orxTIMELINE_EVENT {   orxTIMELINE_EVENT_TRACK_START = 0 , orxTIMELINE_EVENT_TRACK_STOP , orxTIMELINE_EVENT_TRACK_ADD , orxTIMELINE_EVENT_TRACK_REMOVE ,   orxTIMELINE_EVENT_LOOP , orxTIMELINE_EVENT_TRIGGER , orxTIMELINE_EVENT_NUMBER , orxTIMELINE_EVENT_NONE = orxENUM_NONE }

Functions
orxDLLAPI orxSTATUS orxFASTCALL	orxTimeLine_AddTrackFromConfig (orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID)
orxDLLAPI orxSTATUS orxFASTCALL	orxTimeLine_ClearCache ()
orxDLLAPI orxTIMELINE *orxFASTCALL	orxTimeLine_Create ()
orxDLLAPI orxSTATUS orxFASTCALL	orxTimeLine_Delete (orxTIMELINE *_pstTimeLine)
orxDLLAPI void orxFASTCALL	orxTimeLine_Enable (orxTIMELINE *_pstTimeLine, orxBOOL _bEnable)
orxDLLAPI void orxFASTCALL	orxTimeLine_Exit ()
orxDLLAPI orxU32 orxFASTCALL	orxTimeLine_GetCount (const orxTIMELINE *_pstTimeLine)
orxDLLAPI orxFLOAT orxFASTCALL	orxTimeLine_GetTrackDuration (const orxSTRING _zTrackID)
orxDLLAPI orxSTATUS orxFASTCALL	orxTimeLine_Init ()
orxDLLAPI orxBOOL orxFASTCALL	orxTimeLine_IsEnabled (const orxTIMELINE *_pstTimeLine)
orxDLLAPI orxSTATUS orxFASTCALL	orxTimeLine_RemoveTrackFromConfig (orxTIMELINE *_pstTimeLine, const orxSTRING _zTrackID)
orxDLLAPI void orxFASTCALL	orxTimeLine_Setup ()

Detailed Description

TimeLine module Allows to creates time lines: sequences of text events

Typedef Documentation

orxTIMELINE

typedef struct __orxTIMELINE_t orxTIMELINE

Internal TimeLine structure

Definition at line 53 of file orxTimeLine.h.

Enumeration Type Documentation

orxTIMELINE_EVENT

enum orxTIMELINE_EVENT

Event enum

Enumerator
orxTIMELINE_EVENT_TRACK_START	Event sent when a track starts
orxTIMELINE_EVENT_TRACK_STOP	Event sent when a track stops
orxTIMELINE_EVENT_TRACK_ADD	Event sent when a track is added
orxTIMELINE_EVENT_TRACK_REMOVE	Event sent when a track is removed
orxTIMELINE_EVENT_LOOP	Event sent when a track is looping
orxTIMELINE_EVENT_TRIGGER	Event sent when an event is triggered
orxTIMELINE_EVENT_NUMBER
orxTIMELINE_EVENT_NONE

Definition at line 58 of file orxTimeLine.h.

Function Documentation

orxTimeLine_AddTrackFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_AddTrackFromConfig ( orxTIMELINE * _pstTimeLine, const orxSTRING _zTrackID )

extern

Adds a track to a TimeLine from config

Parameters

[in]	_pstTimeLine	Concerned TimeLine
[in]	_zTrackID	Config ID return orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTimeLine_ClearCache()

orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_ClearCache ( )

extern

Clears cache (if any TimeLine track is still in active use, it'll remain in memory until not referenced anymore)

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTimeLine_Create()

orxDLLAPI orxTIMELINE *orxFASTCALL orxTimeLine_Create ( )

extern

Creates an empty TimeLine

Returns

orxTIMELINE / orxNULL

orxTimeLine_Delete()

orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Delete ( orxTIMELINE * _pstTimeLine )

extern

Deletes a TimeLine

Parameters

[in]

_pstTimeLine

Concerned TimeLine

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTimeLine_Enable()

orxDLLAPI void orxFASTCALL orxTimeLine_Enable ( orxTIMELINE * _pstTimeLine, orxBOOL _bEnable )

extern

Enables/disables a TimeLine

Parameters

[in]	_pstTimeLine	Concerned TimeLine
[in]	_bEnable	Enable / disable

orxTimeLine_Exit()

orxDLLAPI void orxFASTCALL orxTimeLine_Exit ( )

extern

Exits from the TimeLine module

orxTimeLine_GetCount()

orxDLLAPI orxU32 orxFASTCALL orxTimeLine_GetCount ( const orxTIMELINE * _pstTimeLine )

extern

Gets how many tracks are currently in use

Parameters

[in]

_pstTimeLine

Concerned TimeLine

Returns

orxU32

orxTimeLine_GetTrackDuration()

orxDLLAPI orxFLOAT orxFASTCALL orxTimeLine_GetTrackDuration ( const orxSTRING _zTrackID )

extern

Gets a track duration using its config ID

Parameters

[in]

_zTrackID

Config ID of the concerned track

Returns

Duration if found, -orxFLOAT_1 otherwise

orxTimeLine_Init()

orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Init ( )

extern

Inits the TimeLine module

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTimeLine_IsEnabled()

orxDLLAPI orxBOOL orxFASTCALL orxTimeLine_IsEnabled ( const orxTIMELINE * _pstTimeLine )

extern

Is TimeLine enabled?

Parameters

[in]

_pstTimeLine

Concerned TimeLine

Returns

orxTRUE if enabled, orxFALSE otherwise

orxTimeLine_RemoveTrackFromConfig()

orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_RemoveTrackFromConfig ( orxTIMELINE * _pstTimeLine, const orxSTRING _zTrackID )

extern

Removes a track using its config ID

Parameters

[in]	_pstTimeLine	Concerned TimeLine
[in]	_zTrackID	Config ID of the track to remove

Returns

orxSTATUS_SUCCESS / orxSTATUS_FAILURE

orxTimeLine_Setup()

orxDLLAPI void orxFASTCALL orxTimeLine_Setup ( )

extern

TimeLine module setup