IPViewManager Class Reference

#include <IPViewManager.h>

Inheritance diagram for IPViewManager:

Public Types
enum	{   kOpenParticleView, kUpdateParticleViews, kPreUpdateParticleViews, kPostUpdateParticleViews,   kUpdateOnHold, kNumActionClasses, kActionClass, kActionName,   kNumPViewItemClasses, kPViewItemClass, kPViewItemName, kParticleViewOpenCloseToggle,   kParticleFlowActivationToggle }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
	FN_1 (kOpenParticleView, TYPE_bool, OpenParticleView, TYPE_OBJECT)
	FN_1 (kUpdateParticleViews, TYPE_bool, UpdateParticleViews, TYPE_bool)
	FN_1 (kPreUpdateParticleViews, TYPE_bool, PreUpdateParticleViews, TYPE_bool)
	FN_1 (kPostUpdateParticleViews, TYPE_bool, PostUpdateParticleViews, TYPE_bool)
	FN_0 (kUpdateOnHold, TYPE_bool, UpdateOnHold)
	FN_0 (kNumActionClasses, TYPE_INT, NumActionClasses)
	FN_1 (kActionClass, TYPE_CLASS, ActionClass, TYPE_INT)
	FN_1 (kActionName, TYPE_STRING, ActionName, TYPE_INT)
	FN_0 (kNumPViewItemClasses, TYPE_INT, NumPViewItemClasses)
	FN_1 (kPViewItemClass, TYPE_CLASS, PViewItemClass, TYPE_INT)
	FN_1 (kPViewItemName, TYPE_STRING, PViewItemName, TYPE_INT)
	FN_0 (kParticleViewOpenCloseToggle, TYPE_bool, ParticleViewOpenCloseToggle)
	FN_1 (kParticleFlowActivationToggle, TYPE_bool, ParticleFlowActivationToggle, TYPE_bool)
virtual bool	OpenParticleView (Object *engine)=0
	Opens ParticleView for a given PFEngine. More...
virtual IParticleView *	GetActiveParticleView ()=0
	Returns the ParticleView which is currently open and shown in PView. More...
virtual bool	UpdateParticleViews (bool additionsOnly=false)=0
	If nothing was delete from PView then additionsOnly is set to true. More...
virtual bool	PreUpdateParticleViews (bool additionsOnly=false)=0
	If procedures between Pre. More...
virtual bool	PostUpdateParticleViews (bool additionsOnly=false)=0
	If procedures between Pre. More...
virtual bool	CancelUpdateParticleViews ()=0
	Not supported for maxscript. More...
virtual bool	UpdateOnHold ()=0
	Return true when in between PreUpdate and PostUpdate. More...
virtual void	UpdateParticleAmountShown ()
	Updates particle amount shown in PViews. More...
virtual void	ActionProceedBegin (INode *actionNode)
	Shows that an action starts the proceed. More...
virtual void	ActionProceedEnd (INode *actionNode)
	Shows that an action ends the proceed. More...
virtual bool	IsParticleViewInForeground ()
	Check if any ParticleView is a foreground window. More...
virtual bool	ParticleViewOpenCloseToggle ()=0
	Used for CUI shortcuts. More...
virtual bool	ParticleFlowActivationToggle (bool selectedOnly=false)=0
	Used for CUI shortcuts. More...
virtual int	GetVacantSpace ()=0
	Returns X coordinate of half-plane of space free from any PF item. More...
virtual void	KeepMaterial (Mtl *mtl)=0
	The method is used to prevent automatic removal of non-used materials from the scene. More...
FPInterfaceDesc *	GetDesc ()
Public Member Functions inherited from FPMixinInterface
	FPMixinInterface ()
virtual LifetimeType	LifetimeControl ()
virtual CoreExport bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
CoreExport	~FPMixinInterface ()
virtual BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDescByID (Interface_ID id)
virtual Interface_ID	GetID ()
Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPParams *params)
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)
virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)
virtual CoreExport FunctionID	FindFn (const MCHAR *name)
virtual CoreExport BOOL	IsEnabled (FunctionID actionID)
virtual CoreExport BOOL	IsChecked (FunctionID actionID)
virtual CoreExport BOOL	IsVisible (FunctionID actionID)
virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)
virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)
virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)
virtual ActionTable *	GetActionTable ()
virtual void	EnableActions (BOOL onOff)
Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=NULL)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

Static Public Member Functions
static PFExport int	NumActionClasses ()
	Public classes only. More...
static PFExport ClassDesc *	ActionClass (int index)
static PFExport const MCHAR *	ActionName (int index)
static PFExport int	NumPViewItemClasses ()
	Public classes only. More...
static PFExport ClassDesc *	PViewItemClass (int index)
static PFExport const MCHAR *	PViewItemName (int index)
static PFExport void	RegisterModule (Class_ID moduleID)
	The method is used by a PFlow module to register itself with the system. More...
static PFExport bool	IsModuleRegistered (Class_ID moduleID)
	Returns true if a PFlow module was registered. More...
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Protected Member Functions
PFExport	IPViewManager ()
virtual PFExport	~IPViewManager ()
virtual void	releaseManager ()=0
Protected Member Functions inherited from FPMixinInterface
	FPMixinInterface (const FPMixinInterface &rhs)
FPMixinInterface &	operator= (const FPMixinInterface &rhs)
Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Static Protected Attributes
static IPViewManager *	m_manager
static Tab< ClassEntry * >	m_actionClasses
static Tab< ClassEntry * >	m_pViewItemClasses
static Tab< Class_ID >	m_registeredModules

Friends
PFExport IPViewManager *	GetPViewManager ()
	friend PFExport void ReleasePViewManager(); More...
PFExport void	ReleasePViewManager ()

Additional Inherited Members
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Enumeration Documentation

anonymous enum

Enumerator
kOpenParticleView
kUpdateParticleViews
kPreUpdateParticleViews
kPostUpdateParticleViews
kUpdateOnHold
kNumActionClasses
kActionClass
kActionName
kNumPViewItemClasses
kPViewItemClass
kPViewItemName
kParticleViewOpenCloseToggle
kParticleFlowActivationToggle

         {  kOpenParticleView,
            kUpdateParticleViews,
            kPreUpdateParticleViews,
            kPostUpdateParticleViews,
            kUpdateOnHold,
            kNumActionClasses,
            kActionClass,
            kActionName,
            kNumPViewItemClasses,
            kPViewItemClass,
            kPViewItemName,
            kParticleViewOpenCloseToggle,
            kParticleFlowActivationToggle
    }; 

Constructor & Destructor Documentation

PFExport IPViewManager ( )

protected

virtual PFExport ~IPViewManager ( )

protectedvirtual

Member Function Documentation

FN_1	(	kOpenParticleView	,
		TYPE_bool	,
		OpenParticleView	,
		TYPE_OBJECT
	)

FN_1	(	kUpdateParticleViews	,
		TYPE_bool	,
		UpdateParticleViews	,
		TYPE_bool
	)

FN_1	(	kPreUpdateParticleViews	,
		TYPE_bool	,
		PreUpdateParticleViews	,
		TYPE_bool
	)

FN_1	(	kPostUpdateParticleViews	,
		TYPE_bool	,
		PostUpdateParticleViews	,
		TYPE_bool
	)

FN_0	(	kUpdateOnHold	,
		TYPE_bool	,
		UpdateOnHold
	)

FN_0	(	kNumActionClasses	,
		TYPE_INT	,
		NumActionClasses
	)

FN_1	(	kActionClass	,
		TYPE_CLASS	,
		ActionClass	,
		TYPE_INT
	)

FN_1	(	kActionName	,
		TYPE_STRING	,
		ActionName	,
		TYPE_INT
	)

FN_0	(	kNumPViewItemClasses	,
		TYPE_INT	,
		NumPViewItemClasses
	)

FN_1	(	kPViewItemClass	,
		TYPE_CLASS	,
		PViewItemClass	,
		TYPE_INT
	)

FN_1	(	kPViewItemName	,
		TYPE_STRING	,
		PViewItemName	,
		TYPE_INT
	)

FN_0	(	kParticleViewOpenCloseToggle	,
		TYPE_bool	,
		ParticleViewOpenCloseToggle
	)

FN_1	(	kParticleFlowActivationToggle	,
		TYPE_bool	,
		ParticleFlowActivationToggle	,
		TYPE_bool
	)

virtual void releaseManager ( )

protectedpure virtual

Member Data Documentation

IPViewManager* m_manager

staticprotected

Tab<ClassEntry*> m_actionClasses

staticprotected

Tab<ClassEntry*> m_pViewItemClasses

staticprotected

Tab<Class_ID> m_registeredModules

staticprotected