IPFAction Class Reference

#include <IPFAction.h>

Inheritance diagram for IPFAction:

Public Types
enum	{   kInit , kRelease , kChannelsUsed , kActivityInterval ,   kIsFertile , kIsNonExecutable , kSupportRand , kGetRand ,   kSetRand , kNewRand , kIsMaterialHolder , kGetMaterial ,   kSetMaterial , kSupportScriptWiring , kGetUseScriptWiring , kSetUseScriptWiring }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
	FN_5 (kInit, TYPE_bool, Init, TYPE_IOBJECT, TYPE_OBJECT, TYPE_INODE, TYPE_OBJECT_TAB_BR, TYPE_INODE_TAB_BR)
	FN_1 (kRelease, TYPE_bool, Release, TYPE_IOBJECT)
	VFN_2 (kChannelsUsed, ChannelsUsed, TYPE_INTERVAL_BR, TYPE_FPVALUE)
	FN_0 (kActivityInterval, TYPE_INTERVAL_BV, ActivityInterval)
	FN_0 (kIsFertile, TYPE_bool, IsFertile)
	FN_0 (kIsNonExecutable, TYPE_bool, IsNonExecutable)
	FN_0 (kSupportRand, TYPE_bool, SupportRand)
	FN_0 (kGetRand, TYPE_INT, GetRand)
	VFN_1 (kSetRand, SetRand, TYPE_INT)
	FN_0 (kNewRand, TYPE_INT, NewRand)
	FN_0 (kIsMaterialHolder, TYPE_bool, IsMaterialHolder)
	FN_0 (kGetMaterial, TYPE_MTL, GetMaterial)
	FN_1 (kSetMaterial, TYPE_bool, SetMaterial, TYPE_MTL)
	FN_0 (kSupportScriptWiring, TYPE_bool, SupportScriptWiring)
	FN_0 (kGetUseScriptWiring, TYPE_bool, GetUseScriptWiring)
	VFN_1 (kSetUseScriptWiring, SetUseScriptWiring, TYPE_bool)
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.
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 ()
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 BaseInterface *	GetInterface (Interface_ID id)
virtual FPInterfaceDesc *	GetDesc ()=0
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.
UtilExport BaseInterface *	GetInterface (Interface_ID id) override
virtual UtilExport Interface_ID	GetID ()
virtual LifetimeType	LifetimeControl ()
virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)
virtual BaseInterface *	AcquireInterface ()
virtual void	ReleaseInterface ()
virtual void	DeleteInterface ()
virtual BaseInterface *	CloneInterface (void *remapDir=nullptr)
Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor.
virtual UtilExport BaseInterface *	GetInterface (Interface_ID id)
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Static Public Member Functions
static PFExport int	NewRand (IParamBlock2 *pblock, ParamID randomSeedParamID)
	Alternative for PFExport int NewRand(); but not in FnPub interface.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator.
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator.
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary.
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary.
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc.

Additional Inherited Members
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

anonymous enum

Enumerator
kInit
kRelease
kChannelsUsed
kActivityInterval
kIsFertile
kIsNonExecutable
kSupportRand
kGetRand
kSetRand
kNewRand
kIsMaterialHolder
kGetMaterial
kSetMaterial
kSupportScriptWiring
kGetUseScriptWiring
kSetUseScriptWiring

         {  kInit, 
            kRelease,
            kChannelsUsed, // reserved for future use
            kActivityInterval,
            kIsFertile,
            kIsNonExecutable,
            kSupportRand,
            kGetRand,
            kSetRand,
            kNewRand,
            kIsMaterialHolder,
            kGetMaterial,
            kSetMaterial,
            kSupportScriptWiring,
            kGetUseScriptWiring,
            kSetUseScriptWiring
    }; 

Member Function Documentation

FN_5()

FN_5	(	kInit	,
		TYPE_bool	,
		Init	,
		TYPE_IOBJECT	,
		TYPE_OBJECT	,
		TYPE_INODE	,
		TYPE_OBJECT_TAB_BR	,
		TYPE_INODE_TAB_BR
	)

FN_1() [1/2]

FN_1	(	kRelease	,
		TYPE_bool	,
		Release	,
		TYPE_IOBJECT
	)

VFN_2()

VFN_2	(	kChannelsUsed	,
		ChannelsUsed	,
		TYPE_INTERVAL_BR	,
		TYPE_FPVALUE
	)

FN_0() [1/10]

FN_0	(	kActivityInterval	,
		TYPE_INTERVAL_BV	,
		ActivityInterval
	)

FN_0() [2/10]

FN_0	(	kIsFertile	,
		TYPE_bool	,
		IsFertile
	)

FN_0() [3/10]

FN_0	(	kIsNonExecutable	,
		TYPE_bool	,
		IsNonExecutable
	)

FN_0() [4/10]

FN_0	(	kSupportRand	,
		TYPE_bool	,
		SupportRand
	)

FN_0() [5/10]

FN_0	(	kGetRand	,
		TYPE_INT	,
		GetRand
	)

VFN_1() [1/2]

VFN_1	(	kSetRand	,
		SetRand	,
		TYPE_INT
	)

FN_0() [6/10]

FN_0	(	kNewRand	,
		TYPE_INT	,
		NewRand
	)

FN_0() [7/10]

FN_0	(	kIsMaterialHolder	,
		TYPE_bool	,
		IsMaterialHolder
	)

FN_0() [8/10]

FN_0	(	kGetMaterial	,
		TYPE_MTL	,
		GetMaterial
	)

FN_1() [2/2]

FN_1	(	kSetMaterial	,
		TYPE_bool	,
		SetMaterial	,
		TYPE_MTL
	)

FN_0() [9/10]

FN_0	(	kSupportScriptWiring	,
		TYPE_bool	,
		SupportScriptWiring
	)

FN_0() [10/10]

FN_0	(	kGetUseScriptWiring	,
		TYPE_bool	,
		GetUseScriptWiring
	)

VFN_1() [2/2]

VFN_1	(	kSetUseScriptWiring	,
		SetUseScriptWiring	,
		TYPE_bool
	)