iSequenceWrapper Struct Reference
A sequence wrapper. More...
#include <ivaria/engseq.h>
Inheritance diagram for iSequenceWrapper:

Public Member Functions | |
virtual iObject * | QueryObject ()=0 |
Query iObject that is implemented by the sequence manager. | |
virtual iSequence * | GetSequence ()=0 |
Get the sequence that this wrapper maintains. | |
virtual iEngineSequenceParameters * | CreateBaseParameterBlock ()=0 |
Create a parameter block for this sequence wrapper. | |
virtual iEngineSequenceParameters * | GetBaseParameterBlock ()=0 |
Get the pointer to the base parameter block (or 0 if there is no such block). | |
virtual csPtr< iEngineSequenceParameters > | CreateParameterBlock ()=0 |
Create a parameter block which you can then fill in and then give as a parameter running this sequence. | |
virtual void | AddOperationSetVariable (csTicks time, iSharedVariable *var, float value, float dvalue=0)=0 |
Operation: set a variable to a floating point value. | |
virtual void | AddOperationSetVariable (csTicks time, iSharedVariable *var, iSharedVariable *value, iSharedVariable *dvalue=0)=0 |
Operation: set a variable to the contents of another variable. | |
virtual void | AddOperationSetVariable (csTicks time, iSharedVariable *var, const csVector3 &v)=0 |
Operation: set a variable to a vector. | |
virtual void | AddOperationSetVariable (csTicks time, iSharedVariable *var, const csColor &c)=0 |
Operation: set a variable to a color. | |
virtual void | AddOperationSetMaterial (csTicks time, iParameterESM *mesh, iParameterESM *mat)=0 |
Operation: set a material on a mesh. | |
virtual void | AddOperationSetPolygonMaterial (csTicks time, iParameterESM *polygon, iParameterESM *mat)=0 |
Operation: set a material on a polygon. | |
virtual void | AddOperationSetLight (csTicks time, iParameterESM *light, const csColor &color)=0 |
Operation: set a light color. | |
virtual void | AddOperationFadeLight (csTicks time, iParameterESM *light, const csColor &color, csTicks duration)=0 |
Operation: fade a light to some color during some time. | |
virtual void | AddOperationSetAmbient (csTicks time, iParameterESM *sector, const csColor &color, iSharedVariable *colorvar)=0 |
Operation: set dynamic ambient light color. | |
virtual void | AddOperationFadeAmbient (csTicks time, iParameterESM *sector, const csColor &color, csTicks duration)=0 |
Operation: fade dynamic ambient light to some color during some time. | |
virtual void | AddOperationRandomDelay (csTicks time, int min, int max)=0 |
Operation: Delay executation of the rest of the script by a random time between min and max msec. | |
virtual void | AddOperationSetMeshColor (csTicks time, iParameterESM *mesh, const csColor &color)=0 |
Operation: set a mesh color. | |
virtual void | AddOperationFadeMeshColor (csTicks time, iParameterESM *mesh, const csColor &color, csTicks duration)=0 |
Operation: fade a mesh to some color during some time. | |
virtual void | AddOperationSetFog (csTicks time, iParameterESM *sector, const csColor &color, float density)=0 |
Operation: set a fog color and density. | |
virtual void | AddOperationFadeFog (csTicks time, iParameterESM *sector, const csColor &color, float density, csTicks duration)=0 |
Operation: fade fog to some color/density during some time. | |
virtual void | AddOperationRotateDuration (csTicks time, iParameterESM *mesh, int axis1, float tot_angle1, int axis2, float tot_angle2, int axis3, float tot_angle3, const csVector3 &offset, csTicks duration)=0 |
Operation: rotate object during some time. | |
virtual void | AddOperationMoveDuration (csTicks time, iParameterESM *mesh, const csVector3 &offset, csTicks duration)=0 |
Operation: move object (mesh or light) during some time. | |
virtual void | AddOperationTriggerState (csTicks time, iParameterESM *trigger, bool en)=0 |
Operation: enable/disable a given trigger. | |
virtual void | AddOperationCheckTrigger (csTicks time, iParameterESM *trigger, csTicks delay)=0 |
Operation: enable checking of trigger state every 'delay' milliseconds (or disable with delay == 0). | |
virtual void | AddOperationTestTrigger (csTicks time, iParameterESM *trigger, iSequence *trueSequence, iSequence *falseSequence)=0 |
Operation: test trigger state and run a sequence if trigger is still valid or another sequence if not (both sequences can be 0 in which case nothing is run). |
Detailed Description
A sequence wrapper.This objects holds the reference to the original sequence and also implements iObject. Basically a sequence corresponds to a series of operations that are time based and can be scheduled on the sequence manager. This class enhances iSequence with support for custom operations and parameter blocks.
Note that many parameters given to the AddOperation functions are of type iParameterESM.
Main creators of instances implementing this interface:
Main ways to get pointers to this interface: Main users of this interface:
Definition at line 208 of file engseq.h.
Member Function Documentation
|
Operation: enable checking of trigger state every 'delay' milliseconds (or disable with delay == 0). Use this in combination with AddOperationTestTrigger().
|
|
Operation: fade dynamic ambient light to some color during some time.
|
|
Operation: fade fog to some color/density during some time.
|
|
Operation: fade a light to some color during some time.
|
|
Operation: fade a mesh to some color during some time.
|
|
Operation: move object (mesh or light) during some time. After the time has elapsed the total relative move will be equal to the 'offset'.
|
|
Operation: Delay executation of the rest of the script by a random time between min and max msec.
|
|
Operation: rotate object during some time. After the time has elapsed the rotation will be equal to the given angle here. Axis is 0, 1, or 2 for x, y, or z. If axis is -1 it is not used.
|
|
Operation: set dynamic ambient light color.
|
|
Operation: set a fog color and density.
|
|
Operation: set a light color.
|
|
Operation: set a material on a mesh.
|
|
Operation: set a mesh color.
|
|
Operation: set a material on a polygon.
|
|
Operation: set a variable to a color.
|
|
Operation: set a variable to a vector.
|
|
Operation: set a variable to the contents of another variable. If 'dvalue' is not 0 then that will be used instead of the absolute value. In that case 'dvalue' is added. 'dvalue' has to be a floating point variable for that to work. 'value' can be any type. The type of 'var' will be set to the type of 'value' in that case.
|
|
Operation: set a variable to a floating point value. If 'dvalue' is not 0 then that will be used instead of the absolute value. In that case 'dvalue' is added.
|
|
Operation: test trigger state and run a sequence if trigger is still valid or another sequence if not (both sequences can be 0 in which case nothing is run). Use in combination with AddOperationCheckTrigger().
|
|
Operation: enable/disable a given trigger.
|
|
Create a parameter block for this sequence wrapper. After creating this you can initialized the parameters (with names and optional default values). Later on you can use GetSequenceParameters() to get a copy of a parameter block to use for running a sequence. |
|
Create a parameter block which you can then fill in and then give as a parameter running this sequence. This essentially creates a copy of the base parameter block created with CreateBaseParameterBlock(). Modifications on the parameter block returned by this function have no effect on the parameter block which is kept internally. You should only set the values of the given parameter block and not create/remove variables. This function returns 0 if there is no parameter block for this sequence. |
|
Get the pointer to the base parameter block (or 0 if there is no such block).
|
|
Get the sequence that this wrapper maintains. It is allowed to use the underlying sequence for general sequence operations like adding conditions, operations, and general sequence management. The AddOperationBla() functions provided in this wrapper do nothing more than add custom operations through the regular iSequence->AddOperation(). |
|
Query iObject that is implemented by the sequence manager.
|
The documentation for this struct was generated from the following file:
- ivaria/engseq.h
Generated for Crystal Space by doxygen 1.3.9.1