IPViewManager.h File Reference

Interface for ParticleView manager and an access method to get the PViewManager from the scene. More...

#include "PFExport.h"
#include "../ifnpub.h"

Classes
class	IPViewManager

Macros
#define	PVIEWMANAGER_INTERFACE   Interface_ID(0x74f93d07, 0x1eb34500)
#define	GetPViewManagerInterface(obj)   ((IPViewManager*)obj->GetInterface(PVIEWMANAGER_INTERFACE))
#define	PFTOOLSBOX1_MODULE_CLASSID   Class_ID(0x13410824, 0x88cd3e26)
#define	PFTOOLSBOX1CHANNELS_MODULE_CLASSID   Class_ID(0x00358976, 0xf7f26da4)

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
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)

Detailed Description

Interface for ParticleView manager and an access method to get the PViewManager from the scene.

There is a single PViewManager in the scene that gives us access to all Particle Views

Macro Definition Documentation

PVIEWMANAGER_INTERFACE

#define PVIEWMANAGER_INTERFACE   Interface_ID(0x74f93d07, 0x1eb34500)

GetPViewManagerInterface

#define GetPViewManagerInterface

(

obj

)

((IPViewManager*)obj->GetInterface(PVIEWMANAGER_INTERFACE))

PFTOOLSBOX1_MODULE_CLASSID

#define PFTOOLSBOX1_MODULE_CLASSID   Class_ID(0x13410824, 0x88cd3e26)

PFTOOLSBOX1CHANNELS_MODULE_CLASSID

#define PFTOOLSBOX1CHANNELS_MODULE_CLASSID   Class_ID(0x00358976, 0xf7f26da4)

Enumeration Type Documentation

anonymous enum

anonymous enum

Enumerator
kPFDefaultDisplay_global
kPFDefaultDisplay_local

{ kPFDefaultDisplay_global, kPFDefaultDisplay_local };

anonymous enum

anonymous enum

Enumerator
kPFActionOrder_globalsFirst
kPFActionOrder_localsFirst

{ kPFActionOrder_globalsFirst, kPFActionOrder_localsFirst };

anonymous enum

anonymous enum

Enumerator
kPFUpdateType_complete
kPFUpdateType_forward

{ kPFUpdateType_complete, kPFUpdateType_forward };

anonymous enum

anonymous enum

Enumerator
kPFDynamicNames_no
kPFDynamicNames_yes

{ kPFDynamicNames_no, kPFDynamicNames_yes };

anonymous enum

anonymous enum

Enumerator
kPViewActionListHorSpace

{ kPViewActionListHorSpace=20 };

Function Documentation

GetPViewManager()

PFExport IPViewManager * GetPViewManager

(

)

Gets PViewManager from the scene.

CreatePFNode()

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.

DeletePFNode()

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.

AppendPFAction()

PFExport bool AppendPFAction	(	INode *	actionList,
		INode *	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.

InsertPFAction()

PFExport bool InsertPFAction	(	INode *	actionList,
		INode *	action,
		int	indexAt
	)

Ensures consistency in relationship between action list and action.

See AppendPFAction();

RemovePFAction() [1/2]

PFExport bool RemovePFAction	(	INode *	actionList,
		int	index
	)

Ensures consistency in relationship between action list and action.

See AppendPFAction();

RemovePFAction() [2/2]

PFExport bool RemovePFAction	(	INode *	actionList,
		INode *	action
	)

Ensures consistency in relationship between action list and action.

See AppendPFAction();

GetPViewVacantSpace()

PFExport int GetPViewVacantSpace

(

INode *

excludeNode = NULL

)

Returns X coordinate of half-plane of space free from any PF item.

The method is usually used to calculate (x,y) location of newly created PF systems. If given node is not NULL, then the node is excluded from consideration while looking for free PView space.

GetPViewMaximumZOrderIndex()

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.

CompactPViewZOrder()

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.

RegisterParticleFlowNotification()

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.

SuspendParticleFlowNotification()

PFExport void SuspendParticleFlowNotification

(

)

Avoids extra effort for tracking.

See RegisterParticleFlowNotification();

ResumeParticleFlowNotification()

PFExport void ResumeParticleFlowNotification

(

)

Avoids extra effort for tracking.

See RegisterParticleFlowNotification();

IsParticleFlowNotificationSuspended()

PFExport bool IsParticleFlowNotificationSuspended

(

)

Avoids extra effort for tracking.

See RegisterParticleFlowNotification();

ReleasePViewManager()

PFExport void ReleasePViewManager

(

)

The method is used to release PViewManager when a scene is closed.

For internal use only.

GetPFInt()

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.

GetPFFloat()

PFExport float GetPFFloat	(	IParamBlock2 *	pblock,
		ParamID	id,
		TimeValue	t = 0,
		int	tabIndex = 0
	)

See GetPFInt();.

GetPFTimeValue()

PFExport TimeValue GetPFTimeValue	(	IParamBlock2 *	pblock,
		ParamID	id,
		TimeValue	t = 0,
		int	tabIndex = 0
	)

See GetPFInt();.

ValidateParticleFlows()

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.

GetPFDefaultDisplay()

PFExport int GetPFDefaultDisplay

(

)

SetPFDefaultDisplay()

PFExport void SetPFDefaultDisplay

(

int

type

)

InitPFDefaultDisplay()

PFExport void InitPFDefaultDisplay

(

int

type

)

GetPFActionOrder()

PFExport int GetPFActionOrder

(

)

SetPFActionOrder()

PFExport void SetPFActionOrder

(

int

order

)

InitPFActionOrder()

PFExport void InitPFActionOrder

(

int

order

)

GetPFUpdateType()

PFExport int GetPFUpdateType

(

)

SetPFUpdateType()

PFExport void SetPFUpdateType

(

int

type

)

InitPFUpdateType()

PFExport void InitPFUpdateType

(

int

type

)

GetPFDynamicNames()

PFExport int GetPFDynamicNames

(

)

Names of actions in PView may have a dynamic suffix to reflect the most important settings of the action.

SetPFDynamicNames()

PFExport void SetPFDynamicNames

(

int

type

)

Names of actions in PView may have a dynamic suffix to reflect the most important settings of the action.

InitPFDynamicNames()

PFExport void InitPFDynamicNames

(

int

type

)

Names of actions in PView may have a dynamic suffix to reflect the most important settings of the action.

DisableParticleInvalidation()

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.

EnableParticleInvalidation()

PFExport void EnableParticleInvalidation

(

)

See DisableParticleInvalidation();.

IsAbleInvalidateParticles()

PFExport bool IsAbleInvalidateParticles

(

)

See DisableParticleInvalidation();.

SetIgnoreEmitterTMChange()

PFExport void SetIgnoreEmitterTMChange

(

)

See DisableParticleInvalidation();.

ClearIgnoreEmitterTMChange()

PFExport void ClearIgnoreEmitterTMChange

(

)

See DisableParticleInvalidation();.

IsIgnoringEmitterTMChange()

PFExport bool IsIgnoringEmitterTMChange

(

)

See DisableParticleInvalidation();.

SetIgnoreEmitterPropChange()

PFExport void SetIgnoreEmitterPropChange

(

)

See DisableParticleInvalidation();.

ClearIgnoreEmitterPropChange()

PFExport void ClearIgnoreEmitterPropChange

(

)

See DisableParticleInvalidation();.

IsIgnoringEmitterPropChange()

PFExport bool IsIgnoringEmitterPropChange

(

)

For more selective tuning in notification change.

SetIgnoreRefNodeChange()

PFExport void SetIgnoreRefNodeChange

(

)

See DisableParticleInvalidation();.

ClearIgnoreRefNodeChange()

PFExport void ClearIgnoreRefNodeChange

(

)

See DisableParticleInvalidation();.

IsIgnoringRefNodeChange()

PFExport bool IsIgnoringRefNodeChange

(

)

See DisableParticleInvalidation();.

SetPFProceedStatus()

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.

ClearPFProceedStatus()

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.

IsPFProceeding()

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.

GetPFObject()

PFExport Object * GetPFObject

(

Object *

obj

)