CrystalSpace

Public API Reference

Main Page   Modules   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

iEngineSequenceManager Struct Reference

Sequence manager specifically designed for working on the engine. More...

#include <engseq.h>

Inheritance diagram for iEngineSequenceManager:

iBase List of all members.

Public Methods

virtual iSequenceManagerGetSequenceManager ()=0
 Get a pointer to the underlying sequence manager that is being used. More...

virtual void SetCamera (iCamera *camera)=0
 Set the camera to use for some of the features (like clicking on mesh objects). More...

virtual iCameraGetCamera ()=0
 Get the camera that is used for some features. More...

virtual csPtr< iParameterESMCreateParameterESM (iBase *value)=0
 Create a parameter ESM for a constant value. More...

virtual csPtr< iSequenceTriggerCreateTrigger (const char *name)=0
 Create a new trigger with a given name. More...

virtual void RemoveTrigger (iSequenceTrigger *trigger)=0
 Remove trigger from the manager. More...

virtual void RemoveTriggers ()=0
 Remove all triggers. More...

virtual int GetTriggerCount () const=0
 Get the number of triggers. More...

virtual iSequenceTriggerGetTrigger (int idx) const=0
 Get a trigger. More...

virtual iSequenceTriggerFindTriggerByName (const char *name) const=0
 Get a trigger by name. More...

virtual bool FireTriggerByName (const char *name, bool now=false) const=0
 Fire a trigger manually, specifying the name. More...

virtual csPtr< iSequenceWrapperCreateSequence (const char *name)=0
 Create a new sequence with a given name. More...

virtual void RemoveSequence (iSequenceWrapper *seq)=0
 Remove sequence from the manager. More...

virtual void RemoveSequences ()=0
 Remove all sequences. More...

virtual int GetSequenceCount () const=0
 Get the number of sequences. More...

virtual iSequenceWrapperGetSequence (int idx) const=0
 Get a sequence. More...

virtual iSequenceWrapperFindSequenceByName (const char *name) const=0
 Get a sequence by name. More...

virtual bool RunSequenceByName (const char *name, int delay) const=0
 Run a sequence and don't mess around with triggers. More...

virtual void FireTimedOperation (csTicks delta, csTicks duration, iSequenceTimedOperation *op, iBase *params=NULL)=0
 Start a timed operation with a given delta (in ticks). More...


Detailed Description

Sequence manager specifically designed for working on the engine.

Definition at line 472 of file engseq.h.


Member Function Documentation

virtual csPtr<iParameterESM> iEngineSequenceManager::CreateParameterESM iBase   value [pure virtual]
 

Create a parameter ESM for a constant value.

virtual csPtr<iSequenceWrapper> iEngineSequenceManager::CreateSequence const char *    name [pure virtual]
 

Create a new sequence with a given name.

virtual csPtr<iSequenceTrigger> iEngineSequenceManager::CreateTrigger const char *    name [pure virtual]
 

Create a new trigger with a given name.

virtual iSequenceWrapper* iEngineSequenceManager::FindSequenceByName const char *    name const [pure virtual]
 

Get a sequence by name.

virtual iSequenceTrigger* iEngineSequenceManager::FindTriggerByName const char *    name const [pure virtual]
 

Get a trigger by name.

virtual void iEngineSequenceManager::FireTimedOperation csTicks    delta,
csTicks    duration,
iSequenceTimedOperation   op,
iBase   params = NULL
[pure virtual]
 

Start a timed operation with a given delta (in ticks).

The delta has to be interpreted as the amount of time that has already elapsed since the beginning of the timed operation. The params block is increffed for as long as is needed so you can release your reference.

virtual bool iEngineSequenceManager::FireTriggerByName const char *    name,
bool    now = false
const [pure virtual]
 

Fire a trigger manually, specifying the name.

This will call ForceFire() on the trigger (if one is found). If now == false then the usual delay will be respected. Otherwise the sequence will be run immediatelly without the default delay.

virtual iCamera* iEngineSequenceManager::GetCamera   [pure virtual]
 

Get the camera that is used for some features.

virtual iSequenceWrapper* iEngineSequenceManager::GetSequence int    idx const [pure virtual]
 

Get a sequence.

virtual int iEngineSequenceManager::GetSequenceCount   const [pure virtual]
 

Get the number of sequences.

virtual iSequenceManager* iEngineSequenceManager::GetSequenceManager   [pure virtual]
 

Get a pointer to the underlying sequence manager that is being used.

virtual iSequenceTrigger* iEngineSequenceManager::GetTrigger int    idx const [pure virtual]
 

Get a trigger.

virtual int iEngineSequenceManager::GetTriggerCount   const [pure virtual]
 

Get the number of triggers.

virtual void iEngineSequenceManager::RemoveSequence iSequenceWrapper   seq [pure virtual]
 

Remove sequence from the manager.

virtual void iEngineSequenceManager::RemoveSequences   [pure virtual]
 

Remove all sequences.

virtual void iEngineSequenceManager::RemoveTrigger iSequenceTrigger   trigger [pure virtual]
 

Remove trigger from the manager.

virtual void iEngineSequenceManager::RemoveTriggers   [pure virtual]
 

Remove all triggers.

virtual bool iEngineSequenceManager::RunSequenceByName const char *    name,
int    delay
const [pure virtual]
 

Run a sequence and don't mess around with triggers.

virtual void iEngineSequenceManager::SetCamera iCamera   camera [pure virtual]
 

Set the camera to use for some of the features (like clicking on mesh objects).

If this is not set then those features will not be available.


The documentation for this struct was generated from the following file:
Generated for Crystal Space by doxygen 1.2.14