1.7.3Please send us your comment about this page
Functions |
|
| virtual bool | Init (IObject *pCont, Object *pSystem, INode *node, Tab< Object * > &actions, Tab< INode * > &actionNodes)=0 |
| Returns true if the operation has been
proceeded successfully. |
|
| virtual bool | Release (IObject *pCont)=0 |
| See Init(). |
|
| virtual const ParticleChannelMask & | ChannelsUsed (const Interval &time) const =0 |
| See Init(). |
|
| PFExport void | ChannelsUsed (const Interval &time, FPValue *channels) const |
| "Function publishing" alternative for
ChannelsUsed method. |
|
| virtual const Interval | ActivityInterval () const =0 |
| Casting the FPValue->ptr parameter to
Tab<Interface_ID>* as
in PFExport void ChannelsUsed(...); an Action may have a time
interval when the Action is active. |
|
| virtual bool | IsFertile () const |
| Birth Action is a special type of actions
since it can create particles from scratch. |
|
| virtual bool | IsNonExecutable () const |
| There is a special case of non-executable
actions. |
|
| virtual bool | Has3dIcon () const |
| An action may have 3d icon representation in
viewport. |
|
| virtual int | IsColorCoordinated () const |
| If an operator/test has a 3D icon the icon
can be automatically color matched to the color of the display
operator in the same event. |
|
| virtual bool | SupportRand () const =0 |
| An Action may carry some
chaos/unpredictibility in its processing. |
|
| virtual int | GetRand ()=0 |
| For chaos/unpredictibility action, gets rand
value. |
|
| virtual void | SetRand (int seed)=0 |
| For chaos/unpredictibility action, sets rand
value. |
|
| PFExport int | NewRand () |
| For chaos/unpredictibility action, sets and
returns new rand value. |
|
| static PFExport int | NewRand (IParamBlock2 *pblock, ParamID randomSeedParamID) |
| Alternative for PFExport int NewRand(); but
not in FnPub interface. |
|
| virtual bool | IsMaterialHolder () const |
| If the Action may potentically change
particle material, then return true. |
|
| virtual Mtl * | GetMaterial () |
| Returns a material for particles. |
|
| virtual bool | SetMaterial (Mtl *mtl) |
| Return true if material was set
successfully. |
|
| virtual bool | SupportScriptWiring () const |
| An Action may have parameters controlled by
script channels. |
|
| virtual bool | GetUseScriptWiring () const |
| Supports script wiring. |
|
| virtual void | SetUseScriptWiring (bool useScriptWiring) |
| Supports script wiring. |
|
| virtual bool | IsEmitterTMDependent () const |
| An Action may or may not be dependent on the
particle system emitter. |
|
| virtual bool | IsEmitterPropDependent () const |
| Checks the props category for dependency.
|
|
| virtual IObject * | GetCurrentState (IObject *pContainer) |
| Returns action state (see IPFActionState.h
for details). |
|
| virtual void | SetCurrentState (IObject *actionState, IObject *pContainer) |
| Sets the state of the action to the given
state. |
|
| FPInterfaceDesc * | GetDesc () |
| bool Init | ( | IObject * | pCont, |
| Object * | pSystem, | ||
| INode * | node, | ||
| Tab< Object * > & | actions, | ||
| Tab< INode * > & | actionNodes | ||
| ) | [pure virtual, inherited] |
Returns true if the operation has been proceeded successfully.
The method is called when the ActionList is established the first time, when there is a first particle that enters the ActionList and there is a need to proceed particles. /param pCont: particle container with particle data /param pSystem: the particle system that generates the particle stream; the same operator may get calls from different particle systems; if the result varies according to the particle system that generates particles, then this parameter is useful. /param pNode: INode of the particle system that generates the particles. /param actions: Tab<Object*> of Actions in the current ActionList. The stack will be used to proceed particles. The stack is mutable: an Action may change the stack (to remove or add some Actions) to fine-tune the order of execution or add some extra actions. The next parameter should sync with the mutation. /param actionNodes: Tab<INode*> of action nodes.
Implemented in PFSimpleAction.
| bool Release | ( | IObject * | pCont | ) | [pure virtual, inherited] |
| const ParticleChannelMask & ChannelsUsed | ( | const Interval & | time | ) | const [pure virtual, inherited] |
"Function publishing" alternative for ChannelsUsed method.
Reserved for future use.
| const Interval ActivityInterval | ( | ) | const [pure virtual, inherited] |
Casting the FPValue->ptr parameter to Tab<Interface_ID>* as in PFExport void ChannelsUsed(...); an Action may have a time interval when the Action is active.
Outside this interval the Action does nothing, therefore there is no need to proceed particles outside the activity interval.
Implemented in PFSimpleAction.
| bool IsFertile | ( | ) | const [inline, virtual, inherited] |
Birth Action is a special type of actions since it can create particles from scratch.
All other type of actions proceed existing particles. Only Action that can create absolutely new particles (if number of particles in the container is zero) should override this method returning true.
{ return false; }
| bool IsNonExecutable | ( | ) | const [inline, virtual, inherited] |
There is a special case of non-executable actions.
They are present in the action schematics but don't affect the particle behavior. Example: Comments operator
{ return false; }
| bool Has3dIcon | ( | ) | const [inline, virtual, inherited] |
An action may have 3d icon representation in viewport.
The 3d icon can be used as a reference for some of the action parameters.
{ return false; }
| int IsColorCoordinated | ( | ) | const [inline, virtual, inherited] |
If an operator/test has a 3D icon the icon can be automatically color matched to the color of the display operator in the same event.
For the automatic color match the operator/test should return 1 in this method. If returns 0 then the action gets the default color for operator/test. If returns -1 then the action doesn't need any color coordination from Particle Flow.
{ return -1; }
| bool SupportRand | ( | ) | const [pure virtual, inherited] |
An Action may carry some chaos/unpredictibility in its processing.
This method supports chaos randomness.
Implemented in PFSimpleAction.
| virtual int GetRand | ( | ) | [pure virtual, inherited] |
For chaos/unpredictibility action, gets rand value.
Implemented in PFSimpleAction.
| void SetRand | ( | int | seed | ) | [pure virtual, inherited] |
For chaos/unpredictibility action, sets rand value.
Implemented in PFSimpleAction.
| PFExport int NewRand | ( | ) | [inherited] |
For chaos/unpredictibility action, sets and returns new rand value.
Reimplemented in PFSimpleAction.
| PFExport static int NewRand | ( | IParamBlock2 * | pblock, |
| ParamID | randomSeedParamID | ||
| ) | [static, inherited] |
Alternative for PFExport int NewRand(); but not in FnPub interface.
| bool IsMaterialHolder | ( | ) | const [inline, virtual, inherited] |
If the Action may potentically change particle material, then return true.
{ return false; }
| Mtl * GetMaterial | ( | ) | [inline, virtual, inherited] |
| bool SetMaterial | ( | Mtl * | mtl | ) | [inline, virtual, inherited] |
| bool SupportScriptWiring | ( | ) | const [inline, virtual, inherited] |
An Action may have parameters controlled by script channels.
How the script wiring is set up is controlled by a separate rollup with script-wiring pblock. The rollup is visible if "Use Script Wiring" option in the right-click menu is set to ON. The option is visible only for actions that support script wiring.
{ return false; }
| bool GetUseScriptWiring | ( | ) | const [inline, virtual, inherited] |
| void SetUseScriptWiring | ( | bool | useScriptWiring | ) | [inline, virtual, inherited] |
| bool IsEmitterTMDependent | ( | ) | const [inline, virtual, inherited] |
An Action may or may not be dependent on the particle system emitter.
When the emitter is invalidated, a particle group has to decide if it needs to invalidate itself. To make the decision, the group checks all the actions if any of them are dependent on the emitter change. There are two categories of dependency: the transformation matrix of the emitter (TM), and object parameters of the emitter (props). This method checks the TM category.
{ return false; }
| bool IsEmitterPropDependent | ( | ) | const [inline, virtual, inherited] |
Checks the props category for dependency.
See IsEmitterTMDependent().
{ return false; }
Returns action state (see IPFActionState.h for details).
You have to delete the IObject by DeleteIObject method when the state is no longer needed.
Reimplemented in PFSimpleAction.
{ return NULL; }
| FPInterfaceDesc * GetDesc | ( | ) | [inline, virtual, inherited] |
Implements FPInterface.
{ return GetDescByID(PFACTION_INTERFACE); }