orx  stable
Portable Game Engine
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 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

typedef struct __orxTIMELINE_t orxTIMELINE

Internal TimeLine structure

Definition at line 53 of file orxTimeLine.h.

Enumeration Type Documentation

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

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

Adds a track to a TimeLine from config

Parameters
[in]_pstTimeLineConcerned TimeLine
[in]_zTrackIDConfig ID return orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_ClearCache ( )

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
orxDLLAPI orxTIMELINE* orxFASTCALL orxTimeLine_Create ( )

Creates an empty TimeLine

Returns
orxTIMELINE / orxNULL
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Delete ( orxTIMELINE _pstTimeLine)

Deletes a TimeLine

Parameters
[in]_pstTimeLineConcerned TimeLine
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxTimeLine_Enable ( orxTIMELINE _pstTimeLine,
orxBOOL  _bEnable 
)

Enables/disables a TimeLine

Parameters
[in]_pstTimeLineConcerned TimeLine
[in]_bEnableEnable / disable
orxDLLAPI void orxFASTCALL orxTimeLine_Exit ( )

Exits from the TimeLine module

orxDLLAPI orxFLOAT orxFASTCALL orxTimeLine_GetTrackDuration ( const orxSTRING  _zTrackID)

Gets a track duration using its config ID

Parameters
[in]_zTrackIDConfig ID of the concerned track
Returns
Duration if found, -orxFLOAT_1 otherwise
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_Init ( )

Inits the TimeLine module

Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI orxBOOL orxFASTCALL orxTimeLine_IsEnabled ( const orxTIMELINE _pstTimeLine)

Is TimeLine enabled?

Parameters
[in]_pstTimeLineConcerned TimeLine
Returns
orxTRUE if enabled, orxFALSE otherwise
orxDLLAPI orxSTATUS orxFASTCALL orxTimeLine_RemoveTrackFromConfig ( orxTIMELINE _pstTimeLine,
const orxSTRING  _zTrackID 
)

Removes a track using its config ID

Parameters
[in]_pstTimeLineConcerned TimeLine
[in]_zTrackIDConfig ID of the track to remove
Returns
orxSTATUS_SUCCESS / orxSTATUS_FAILURE
orxDLLAPI void orxFASTCALL orxTimeLine_Setup ( )

TimeLine module setup


Generated for orx by doxygen 1.5.6