1.7.3Please send us your comment about this page
Enumerations |
|
| enum | { kPFDefaultDisplay_global, kPFDefaultDisplay_local } |
| enum | { kPFActionOrder_globalsFirst, kPFActionOrder_localsFirst } |
| enum | { kPFUpdateType_complete, kPFUpdateType_forward } |
| enum | { kPFDynamicNames_no, kPFDynamicNames_yes } |
| enum | { kPViewActionListHorSpace = 20 } |
Functions |
|
| virtual bool | OpenParticleView (Object *engine)=0 |
| Opens ParticleView for a given PFEngine.
|
|
| virtual bool | UpdateParticleViews (bool additionsOnly=false)=0 |
| If nothing was delete from PView then
additionsOnly is set to true. |
|
| virtual bool | PreUpdateParticleViews (bool additionsOnly=false)=0 |
| If procedures between Pre. |
|
| virtual bool | PostUpdateParticleViews (bool additionsOnly=false)=0 |
| If procedures between Pre. |
|
| virtual bool | CancelUpdateParticleViews ()=0 |
| Not supported for maxscript. |
|
| virtual bool | UpdateOnHold ()=0 |
| Return true when in between PreUpdate and
PostUpdate. |
|
| virtual void | UpdateParticleAmountShown () |
| Updates particle amount shown in PViews.
|
|
| virtual void | ActionProceedBegin (INode *actionNode) |
| Shows that an action starts the proceed.
|
|
| virtual void | ActionProceedEnd (INode *actionNode) |
| Shows that an action ends the proceed.
|
|
| virtual bool | IsParticleViewInForeground () |
| Check if any ParticleView is a foreground
window. |
|
| static PFExport int | NumActionClasses () |
| Public classes only. |
|
| static PFExport ClassDesc * | ActionClass (int index) |
| static PFExport MCHAR * | ActionName (int index) |
| static PFExport int | NumPViewItemClasses () |
| Public classes only. |
|
| static PFExport ClassDesc * | PViewItemClass (int index) |
| static PFExport MCHAR * | PViewItemName (int index) |
| virtual bool | ParticleViewOpenCloseToggle ()=0 |
| Used for CUI shortcuts. |
|
| virtual bool | ParticleFlowActivationToggle (bool selectedOnly=false)=0 |
| Used for CUI shortcuts. |
|
| virtual int | GetVacantSpace ()=0 |
| Returns X coordinate of half-plane of space
free from any PF item.
|
|
| virtual void | KeepMaterial (Mtl *mtl)=0 |
| The method is used to prevent automatic
removal of non-used materials from the scene. |
|
| static PFExport void | RegisterModule (Class_ID moduleID) |
| The method is used by a PFlow module to
register itself with the system. |
|
| static PFExport bool | IsModuleRegistered (Class_ID moduleID) |
| Returns true if a PFlow module was
registered. |
|
| FPInterfaceDesc * | GetDesc () |
| PFExport IPViewManager * | GetPViewManager () |
| Gets PViewManager from the scene. |
|
| PFExport INode * | CreatePFNode (Object *obj) |
| Creates an INode used by ParticleFlow objects
(actions, engines etc.) The ParticleFlow INode has some properties that are
different from a regular INode. |
|
| PFExport void | DeletePFNode (INode *node) |
| Deletes a PF-type INode. |
|
| PFExport bool | AppendPFAction (INode *actionList, INode *action) |
| There is a special relationship between an
action list and an action. |
|
| PFExport bool | InsertPFAction (INode *actionList, INode *action, int indexAt) |
| Ensures consistency in relationship between
action list and action. |
|
| PFExport bool | RemovePFAction (INode *actionList, int index) |
| Ensures consistency in relationship between
action list and action. |
|
| PFExport bool | RemovePFAction (INode *actionList, INode *action) |
| Ensures consistency in relationship between
action list and action. |
|
| PFExport int | GetPViewVacantSpace (INode *excludeNode=NULL) |
| Returns X coordinate of half-plane of space
free from any PF item.
|
|
| PFExport int | GetPViewMaximumZOrderIndex (INode *excludeNode=NULL) |
| All items in PView are shown according to
their Z order index. |
|
| PFExport bool | CompactPViewZOrder () |
| The Z order sequence may have some "holes".
|
|
| PFExport void | RegisterParticleFlowNotification () |
| ParticleFlow has to track creation of new
PF items. |
|
| PFExport void | SuspendParticleFlowNotification () |
| Avoids extra effort for tracking. |
|
| PFExport void | ResumeParticleFlowNotification () |
| Avoids extra effort for tracking. |
|
| PFExport bool | IsParticleFlowNotificationSuspended () |
| Avoids extra effort for tracking. |
|
| PFExport void | ReleasePViewManager () |
| The method is used to release PViewManager
when a scene is closed. |
|
| PFExport int | GetPFInt (IParamBlock2 *pblock, ParamID id, TimeValue t=0, int tabIndex=0) |
| GetPFInt, GetPFFloat and GetPFTimeValue
reinforce value boundaries set for parameter values. |
|
| PFExport float | GetPFFloat (IParamBlock2 *pblock, ParamID id, TimeValue t=0, int tabIndex=0) |
| See
GetPFInt();. |
|
| PFExport TimeValue | GetPFTimeValue (IParamBlock2 *pblock, ParamID id, TimeValue t=0, int tabIndex=0) |
| See
GetPFInt();. |
|
| PFExport bool | ValidateParticleFlows () |
| For internal use. |
|
| PFExport int | GetPFDefaultDisplay () |
| PFExport void | SetPFDefaultDisplay (int type) |
| PFExport void | InitPFDefaultDisplay (int type) |
| PFExport int | GetPFActionOrder () |
| PFExport void | SetPFActionOrder (int order) |
| PFExport void | InitPFActionOrder (int order) |
| PFExport int | GetPFUpdateType () |
| PFExport void | SetPFUpdateType (int type) |
| PFExport void | InitPFUpdateType (int type) |
| PFExport int | GetPFDynamicNames () |
| Names of actions in PView may have a dynamic
suffix to reflect the most important settings of the action.
|
|
| PFExport void | SetPFDynamicNames (int type) |
| Names of actions in PView may have a dynamic
suffix to reflect the most important settings of the action.
|
|
| PFExport void | InitPFDynamicNames (int type) |
| Names of actions in PView may have a dynamic
suffix to reflect the most important settings of the action.
|
|
| PFExport void | DisableParticleInvalidation () |
| Particle system and operators/tests may have
reference object (i.e. |
|
| PFExport void | EnableParticleInvalidation () |
| See
DisableParticleInvalidation();. |
|
| PFExport bool | IsAbleInvalidateParticles () |
| See
DisableParticleInvalidation();. |
|
| PFExport void | SetIgnoreEmitterTMChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport void | ClearIgnoreEmitterTMChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport bool | IsIgnoringEmitterTMChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport void | SetIgnoreEmitterPropChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport void | ClearIgnoreEmitterPropChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport bool | IsIgnoringEmitterPropChange () |
| For more selective tuning in notification
change. |
|
| PFExport void | SetIgnoreRefNodeChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport void | ClearIgnoreRefNodeChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport bool | IsIgnoringRefNodeChange () |
| See
DisableParticleInvalidation();. |
|
| PFExport void | SetPFProceedStatus () |
| When a particle system is in the process of
calculation/evaluation, it is not advisable to invalidate particle
containers. |
|
| PFExport void | ClearPFProceedStatus () |
| When a particle system is in the process of
calculation/evaluation, it is not advisable to invalidate particle
containers. |
|
| PFExport bool | IsPFProceeding () |
| When a particle system is in the process of
calculation/evaluation, it is not advisable to invalidate particle
containers. |
|
| PFExport Object * | GetPFObject (Object *obj) |
Friends |
|
| PFExport IPViewManager * | GetPViewManager () |
| friend PFExport void
ReleasePViewManager(); |
|
| PFExport void | ReleasePViewManager () |
| anonymous enum |
| anonymous enum |
| anonymous enum |
| anonymous enum |
| anonymous enum |
{ kPViewActionListHorSpace=20 };
| bool OpenParticleView | ( | Object * | engine | ) | [pure virtual, inherited] |
Opens ParticleView for a given PFEngine.
If there are several ParticleViews with the given PFEngine, a dialog pops up to make a choice.
| engine,: | PFEngine to open particle view for |
| bool UpdateParticleViews | ( | bool | additionsOnly =
false |
) | [pure virtual, inherited] |
If nothing was delete from PView then additionsOnly is set to true.
| bool PreUpdateParticleViews | ( | bool | additionsOnly =
false |
) | [pure virtual, inherited] |
If procedures between Pre.
. and Post.. involve additions of new items only then set "additionsOnly" to "true". The rollup panel won't be updated.
| bool PostUpdateParticleViews | ( | bool | additionsOnly =
false |
) | [pure virtual, inherited] |
If procedures between Pre.
. and Post.. involve additions of new items only then set "additionsOnly" to "true". The rollup panel won't be updated.
| bool CancelUpdateParticleViews | ( | ) | [pure virtual, inherited] |
Not supported for maxscript.
| bool UpdateOnHold | ( | ) | [pure virtual, inherited] |
Return true when in between PreUpdate and PostUpdate.
| void UpdateParticleAmountShown | ( | ) | [inline, virtual, inherited] |
| void ActionProceedBegin | ( | INode * | actionNode | ) | [inline, virtual, inherited] |
| void ActionProceedEnd | ( | INode * | actionNode | ) | [inline, virtual, inherited] |
| bool IsParticleViewInForeground | ( | ) | [inline, virtual, inherited] |
| PFExport static int NumActionClasses | ( | ) | [static, inherited] |
Public classes only.
| PFExport static ClassDesc * ActionClass | ( | int | index | ) | [static, inherited] |
| PFExport static MCHAR * ActionName | ( | int | index | ) | [static, inherited] |
| PFExport static int NumPViewItemClasses | ( | ) | [static, inherited] |
Public classes only.
| PFExport static ClassDesc * PViewItemClass | ( | int | index | ) | [static, inherited] |
| PFExport static MCHAR * PViewItemName | ( | int | index | ) | [static, inherited] |
| bool ParticleViewOpenCloseToggle | ( | ) | [pure virtual, inherited] |
Used for CUI shortcuts.
| bool ParticleFlowActivationToggle | ( | bool | selectedOnly =
false |
) | [pure virtual, inherited] |
Used for CUI shortcuts.
| int GetVacantSpace | ( | ) | [pure virtual, inherited] |
| void KeepMaterial | ( | Mtl * | mtl | ) | [pure virtual, inherited] |
The method is used to prevent automatic removal of non-used materials from the scene.
The method is used by Shape Instance operator. The operator creates combined materials on-the-fly to be assigned to particles. When the reference object for the operator is changed, the material is changed. The old material could be deleted because it doesn't have any more references in the scene. This may create a problem for undo/redo operations. To prevent that this method creates a reference dependency between PViewManager and the Material. Since PViewManager is not saved with the scene, the materials won't be saved either.
| PFExport static void RegisterModule | ( | Class_ID | moduleID | ) | [static, inherited] |
The method is used by a PFlow module to register itself with the system.
This way other PFlow modules can query whether a specific module is present/loaded with the system and act accordingly. Once a module is registered, it cannot be unregistered.
| PFExport static bool IsModuleRegistered | ( | Class_ID | moduleID | ) | [static, inherited] |
Returns true if a PFlow module was registered.
| FPInterfaceDesc * GetDesc | ( | ) | [inline, virtual, inherited] |
Implements FPInterface.
{ return GetDescByID(PVIEWMANAGER_INTERFACE); }
| PFExport IPViewManager * GetPViewManager | ( | ) |
Gets PViewManager from the scene.
| PFExport void DeletePFNode | ( | INode * | node | ) |
Deletes a PF-type INode.
The ParticleFlow INode has some properties that are different from a regular INode. Also, deleting a node by the methods cleans up the scene from associated elements, for example deleting a PF emitter also removes all global actions and exclusive actionLists downstream. There won't be any harm done if a regular INode is deleted by the method. The plug-in is able to classify the given node to choose the appropriate way of action.
There is a special relationship between an action list and an action.
The following four methods ensure the consistency in this relationship. Since PF particle system has a list of global action, the system can also be considered as an action list.
Ensures consistency in relationship between action list and action.
See AppendPFAction();
| PFExport bool RemovePFAction | ( | INode * | actionList, |
| int | index | ||
| ) |
Ensures consistency in relationship between action list and action.
See AppendPFAction();
Ensures consistency in relationship between action list and action.
See AppendPFAction();
| PFExport int GetPViewVacantSpace | ( | INode * | excludeNode = NULL |
) |
| PFExport int GetPViewMaximumZOrderIndex | ( | INode * | excludeNode = NULL |
) |
All items in PView are shown according to their Z order index.
Returns the highest Z order index amongst all particle systems and action lists.
| PFExport bool CompactPViewZOrder | ( | ) |
The Z order sequence may have some "holes".
The method makes the sequence to be more compact by eliminating these "holes". Returns true if there were "holes"; and false if it is already compact.
| PFExport void RegisterParticleFlowNotification | ( | ) |
ParticleFlow has to track creation of new PF items.
For ParticleFlow Shell: the system creates a default configuration and sets PView location. For ActionList: the system sets PView location. For Action: the system creates an ActionList that includes the Action, and sets PView location. To avoid this extra effort from the system side, use Suspend/Resume methods.
| PFExport void SuspendParticleFlowNotification | ( | ) |
Avoids extra effort for tracking.
| PFExport void ResumeParticleFlowNotification | ( | ) |
Avoids extra effort for tracking.
| PFExport bool IsParticleFlowNotificationSuspended | ( | ) |
Avoids extra effort for tracking.
| PFExport void ReleasePViewManager | ( | ) |
The method is used to release PViewManager when a scene is closed.
For internal use only.
| PFExport int GetPFInt | ( | IParamBlock2 * | pblock, |
| ParamID | id, | ||
| TimeValue | t = 0, |
||
| int | tabIndex = 0 |
||
| ) |
GetPFInt, GetPFFloat and GetPFTimeValue reinforce value boundaries set for parameter values.
Can be used instead of pblock()->GetInt and pblock()->GetFloat to be sure that the result values are stay inside the parameter boundaries no matter what.
| PFExport float GetPFFloat | ( | IParamBlock2 * | pblock, |
| ParamID | id, | ||
| TimeValue | t = 0, |
||
| int | tabIndex = 0 |
||
| ) |
| PFExport TimeValue GetPFTimeValue | ( | IParamBlock2 * | pblock, |
| ParamID | id, | ||
| TimeValue | t = 0, |
||
| int | tabIndex = 0 |
||
| ) |
| PFExport bool ValidateParticleFlows | ( | ) |
For internal use.
The method is used to make all ParticleFlow elements valid. The method traverses the scene to collect all ParticleFlow elements then it removes the invalid ones and fixes elements that are fixable. Returns true is the scene was valid, and false if the scene was invalid.
| PFExport int GetPFDefaultDisplay | ( | ) |
| PFExport void SetPFDefaultDisplay | ( | int | type | ) |
| PFExport void InitPFDefaultDisplay | ( | int | type | ) |
| PFExport int GetPFActionOrder | ( | ) |
| PFExport void SetPFActionOrder | ( | int | order | ) |
| PFExport void InitPFActionOrder | ( | int | order | ) |
| PFExport int GetPFUpdateType | ( | ) |
| PFExport void SetPFUpdateType | ( | int | type | ) |
| PFExport void InitPFUpdateType | ( | int | type | ) |
| PFExport int GetPFDynamicNames | ( | ) |
Names of actions in PView may have a dynamic suffix to reflect the most important settings of the action.
| PFExport void SetPFDynamicNames | ( | int | type | ) |
Names of actions in PView may have a dynamic suffix to reflect the most important settings of the action.
| PFExport void InitPFDynamicNames | ( | int | type | ) |
Names of actions in PView may have a dynamic suffix to reflect the most important settings of the action.
| PFExport void DisableParticleInvalidation | ( | ) |
Particle system and operators/tests may have reference object (i.e.
define an emitting area). An operator may require TM of a reference object at different moments. If the reference object has a complex controller, the action of requesting the state of the reference object, if the time is different from the current time, may inflict REFMSG_CHANGE message thus provoking invalidation of the whole particle system. To prevent that, at the moment of acquiring the reference object TMs, the operator should disable particle invalidation, and then enable the invalidation when it is done with the reference object.
| PFExport void EnableParticleInvalidation | ( | ) |
| PFExport bool IsAbleInvalidateParticles | ( | ) |
| PFExport void SetIgnoreEmitterTMChange | ( | ) |
| PFExport void ClearIgnoreEmitterTMChange | ( | ) |
| PFExport bool IsIgnoringEmitterTMChange | ( | ) |
| PFExport void SetIgnoreEmitterPropChange | ( | ) |
| PFExport void ClearIgnoreEmitterPropChange | ( | ) |
| PFExport bool IsIgnoringEmitterPropChange | ( | ) |
For more selective tuning in notification change.
| PFExport void SetIgnoreRefNodeChange | ( | ) |
| PFExport void ClearIgnoreRefNodeChange | ( | ) |
| PFExport bool IsIgnoringRefNodeChange | ( | ) |
| PFExport void SetPFProceedStatus | ( | ) |
When a particle system is in the process of calculation/evaluation, it is not advisable to invalidate particle containers.
This method sets the proceed status.
| PFExport void ClearPFProceedStatus | ( | ) |
When a particle system is in the process of calculation/evaluation, it is not advisable to invalidate particle containers.
This method clears the proceed status.
| PFExport bool IsPFProceeding | ( | ) |
When a particle system is in the process of calculation/evaluation, it is not advisable to invalidate particle containers.
This method checks if PF is proceeding.
| PFExport IPViewManager * GetPViewManager | ( | ) | [friend, inherited] |
| PFExport void ReleasePViewManager | ( | ) | [friend, inherited] |