IPFSystem Class Reference

#include <IPFSystem.h>

Inheritance diagram for IPFSystem:

Public Types
enum	{   kGetMultiplier, kGetBornAllowance, kHasEmitter, kGetEmitterType,   kGetEmitterDimensions, kGetEmitterGeometry, kIsEmitterGeometryAnimated, kSetRenderState,   kIsRenderState, kGetIntegrationStep, kGetUpdateType, kNumParticlesSelected,   kGetSelectedParticleID, kIsParticleSelected, kNumActionListsSelected, kGetSelectedActionList,   kIsActionListSelected, kIsRunningScript }
enum	{   kEmitterType_none = -1, kEmitterType_rectangle = 0, kEmitterType_circle, kEmitterType_box,   kEmitterType_sphere, kEmitterType_mesh }
enum	{ kPFUpdateType_complete, kPFUpdateType_forward }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease, immediateRelease, wantsRelease, serverControlled }

Public Member Functions
	FN_1 (kGetMultiplier, TYPE_FLOAT, GetMultiplier, TYPE_TIMEVALUE)
	FN_0 (kGetBornAllowance, TYPE_INT, GetBornAllowance)
	FN_0 (kHasEmitter, TYPE_bool, HasEmitter)
	FN_1 (kGetEmitterType, TYPE_INT, GetEmitterType, TYPE_TIMEVALUE)
	VFN_2 (kGetEmitterDimensions, GetEmitterDimensions, TYPE_TIMEVALUE, TYPE_FLOAT_TAB_BR)
	FN_1 (kGetEmitterGeometry, TYPE_MESH, GetEmitterGeometry, TYPE_TIMEVALUE)
	FN_0 (kIsEmitterGeometryAnimated, TYPE_bool, IsEmitterGeometryAnimated)
	VFN_1 (kSetRenderState, SetRenderState, TYPE_bool)
	FN_0 (kIsRenderState, TYPE_bool, IsRenderState)
	FN_0 (kGetIntegrationStep, TYPE_TIMEVALUE, GetIntegrationStep)
	FN_0 (kGetUpdateType, TYPE_INT, GetUpdateType)
	FN_0 (kNumParticlesSelected, TYPE_INT, NumParticlesSelected)
	FN_1 (kGetSelectedParticleID, TYPE_INDEX, GetSelectedParticleID, TYPE_INDEX)
	FN_1 (kIsParticleSelected, TYPE_bool, IsParticleSelected, TYPE_INDEX)
	FN_0 (kNumActionListsSelected, TYPE_INT, NumActionListsSelected)
	FN_1 (kGetSelectedActionList, TYPE_INODE, GetSelectedActionList, TYPE_INDEX)
	FN_1 (kIsActionListSelected, TYPE_bool, IsActionListSelected, TYPE_INODE)
	FN_0 (kIsRunningScript, TYPE_bool, IsRunningScript)
virtual float	GetMultiplier (TimeValue time)=0
	Returns multiplier coefficient to generate particles. More...
virtual int	GetBornAllowance ()=0
	Returns number of particles allowed to be generated at current time. More...
virtual bool	HasEmitter ()
	PF System has an icon that can be used as an emitter for particles. More...
virtual int	GetEmitterType (TimeValue time)
virtual void	GetEmitterDimensions (TimeValue time, Tab< float > &dimensions)
	Returns spacial dimensions of the emitter icon. More...
virtual Mesh *	GetEmitterGeometry (TimeValue time)
	Returns emitter geometry in form of mesh. More...
virtual bool	IsEmitterGeometryAnimated ()
	If the emitter mesh is geometry-animated, return "true" in the following method. More...
virtual void	SetRenderState (bool renderState=true)=0
	PF System has two states: render and viewport. More...
virtual bool	IsRenderState () const =0
	Works with SetRenderState. More...
virtual TimeValue	GetIntegrationStep () const =0
	PF System has an integration step parameter that defines granularity in proceeding particles in time. More...
virtual int	GetUpdateType () const
	PF system has different modes for update. More...
virtual int	NumParticlesSelected () const
	PF system may select sub-components. More...
virtual int	GetSelectedParticleID (int i) const
	Returns born ID of the i-th selected particle. More...
virtual bool	IsParticleSelected (int id) const
	Verifies if a particle with the given born ID is selected or not. More...
virtual int	NumActionListsSelected () const
	Returns amount of selected action lists. More...
virtual INode *	GetSelectedActionList (int i) const
	Returns node of the i-th selected action list. More...
virtual bool	IsActionListSelected (INode *inode) const
	Verifies if an action list is selected or not. More...
virtual bool	IsRunningScript () const
	Returns true if the particle system is in the process of runnint Every Step or Final Step scripts. More...
virtual bool	IsCopyClone () const
	For internal use. More...
virtual void	ResetCopyClone ()
	Works with IsCopyClone. 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...

Additional Inherited Members
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...
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface
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)
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

Member Enumeration Documentation

anonymous enum

Enumerator
kGetMultiplier
kGetBornAllowance
kHasEmitter
kGetEmitterType
kGetEmitterDimensions
kGetEmitterGeometry
kIsEmitterGeometryAnimated
kSetRenderState
kIsRenderState
kGetIntegrationStep
kGetUpdateType
kNumParticlesSelected
kGetSelectedParticleID
kIsParticleSelected
kNumActionListsSelected
kGetSelectedActionList
kIsActionListSelected
kIsRunningScript

         {  kGetMultiplier,
            kGetBornAllowance,
            kHasEmitter,
            kGetEmitterType,
            kGetEmitterDimensions,
            kGetEmitterGeometry,
            kIsEmitterGeometryAnimated,
            kSetRenderState,
            kIsRenderState,
            kGetIntegrationStep,
            kGetUpdateType,
            kNumParticlesSelected,
            kGetSelectedParticleID,
            kIsParticleSelected,
            kNumActionListsSelected,
            kGetSelectedActionList,
            kIsActionListSelected,
            kIsRunningScript,
    }; 

Member Function Documentation

FN_1	(	kGetMultiplier	,
		TYPE_FLOAT	,
		GetMultiplier	,
		TYPE_TIMEVALUE
	)

FN_0	(	kGetBornAllowance	,
		TYPE_INT	,
		GetBornAllowance
	)

FN_0	(	kHasEmitter	,
		TYPE_bool	,
		HasEmitter
	)

FN_1	(	kGetEmitterType	,
		TYPE_INT	,
		GetEmitterType	,
		TYPE_TIMEVALUE
	)

VFN_2	(	kGetEmitterDimensions	,
		GetEmitterDimensions	,
		TYPE_TIMEVALUE	,
		TYPE_FLOAT_TAB_BR
	)

FN_1	(	kGetEmitterGeometry	,
		TYPE_MESH	,
		GetEmitterGeometry	,
		TYPE_TIMEVALUE
	)

FN_0	(	kIsEmitterGeometryAnimated	,
		TYPE_bool	,
		IsEmitterGeometryAnimated
	)

VFN_1	(	kSetRenderState	,
		SetRenderState	,
		TYPE_bool
	)

FN_0	(	kIsRenderState	,
		TYPE_bool	,
		IsRenderState
	)

FN_0	(	kGetIntegrationStep	,
		TYPE_TIMEVALUE	,
		GetIntegrationStep
	)

FN_0	(	kGetUpdateType	,
		TYPE_INT	,
		GetUpdateType
	)

FN_0	(	kNumParticlesSelected	,
		TYPE_INT	,
		NumParticlesSelected
	)

FN_1	(	kGetSelectedParticleID	,
		TYPE_INDEX	,
		GetSelectedParticleID	,
		TYPE_INDEX
	)

FN_1	(	kIsParticleSelected	,
		TYPE_bool	,
		IsParticleSelected	,
		TYPE_INDEX
	)

FN_0	(	kNumActionListsSelected	,
		TYPE_INT	,
		NumActionListsSelected
	)

FN_1	(	kGetSelectedActionList	,
		TYPE_INODE	,
		GetSelectedActionList	,
		TYPE_INDEX
	)

FN_1	(	kIsActionListSelected	,
		TYPE_bool	,
		IsActionListSelected	,
		TYPE_INODE
	)

FN_0	(	kIsRunningScript	,
		TYPE_bool	,
		IsRunningScript
	)