![]() |
Public API Reference |
#include <engseq.h>
Inheritance diagram for iEngineSequenceParameters:
Public Methods | |
virtual int | GetParameterCount () const=0 |
Get the number of parameters supported. More... | |
virtual iBase * | GetParameter (int idx) const=0 |
Get a parameter. More... | |
virtual iBase * | GetParameter (const char *name) const=0 |
Get a parameter by name. More... | |
virtual int | GetParameterIdx (const char *name) const=0 |
Get a parameter index by name. More... | |
virtual const char * | GetParameterName (int idx) const=0 |
Get parameter name. More... | |
virtual void | AddParameter (const char *name, iBase *def_value=0)=0 |
Add a parameter. More... | |
virtual void | SetParameter (int idx, iBase *value)=0 |
Set a parameter by index. More... | |
virtual void | SetParameter (const char *name, iBase *value)=0 |
Set a parameter by name. More... | |
virtual csPtr< iParameterESM > | CreateParameterESM (const char *name)=0 |
Create a parameter ESM which keeps a reference to this parameter block and knows how to resolve the specified parameter. More... |
You can create a ready-made instance of this interface by calling iSequenceWrapper->CreateBaseParameterBlock(). This will create an empty parameter block that specifies the supported parameters (and optional default values) that are relevant for that sequence. When running a sequence later you can call iSequenceWrapper->CreateParameterBlock() to make a clone of the base parameter block and then fill in the values.
To use a value from this parameter block you can call CreateParameterESM() which will return a parameter that you can give to an operation.
Definition at line 93 of file engseq.h.
|
Add a parameter. Warning! ONLY call this for setting up the base parameter block. Don't use this to set the values for parameters later on blocks created with CreateParameterBlock()! |
|
Create a parameter ESM which keeps a reference to this parameter block and knows how to resolve the specified parameter. Returns 0 if the parameter 'name' is not known in this block. You can use the return of this function to give as an argument for operations. |
|
Get a parameter by name.
|
|
Get a parameter.
|
|
Get the number of parameters supported.
|
|
Get a parameter index by name.
|
|
Get parameter name.
|
|
Set a parameter by name.
|
|
Set a parameter by index.
|