IPFActionListMaterialHolder Class Reference

#include <IPFActionListMaterialHolder.h>

Inheritance diagram for IPFActionListMaterialHolder:

Public Types
enum	{   kIsMaterialHolder , kInheritsMaterial , kGetMaterial , kSetMaterial ,   kGetMaterialPriority , kGetStreamDepth , kSetStreamDepth , kUpdateMaterial ,   kUpdateMaterials , kUpdateMaterialsDownstream }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
	FN_0 (kIsMaterialHolder, TYPE_bool, IsMaterialHolder)
	FN_0 (kInheritsMaterial, TYPE_bool, InheritsMaterial)
	FN_0 (kGetMaterial, TYPE_MTL, GetMaterial)
	FN_1 (kSetMaterial, TYPE_bool, SetMaterial, TYPE_MTL)
	FN_0 (kGetMaterialPriority, TYPE_INT, GetMaterialPriority)
	FN_0 (kGetStreamDepth, TYPE_INT, GetStreamDepth)
	VFN_1 (kSetStreamDepth, SetStreamDepth, TYPE_INT)
	FN_1 (kUpdateMaterial, TYPE_bool, UpdateMaterial, TYPE_bool)
	FN_1 (kUpdateMaterials, TYPE_INT, UpdateMaterials, TYPE_bool)
	FN_1 (kUpdateMaterialsDownstream, TYPE_INT, UpdateMaterialsDownstream, TYPE_bool)
virtual bool	IsMaterialHolder () const
	If the ActionList has an associated material (either via material inheritance or from any actions at the action list, then return true.
virtual bool	InheritsMaterial () const
	Defines whether this action list depends on the upstream action lists to generate its material.
virtual bool	GenerateInheritedMaterial (void)
	Generates material as defined by inheritance.
virtual Mtl *	GetMaterial ()
	Returns a material for particles.
virtual bool	SetMaterial (Mtl *mtl)
	Return true if material was set successfully.
virtual int	GetMaterialPriority (void) const
	Returns material priority number.
virtual int	GetStreamDepth (void) const
	Returns stream depth index - shortest distance to pf source up stream.
virtual void	SetStreamDepth (int streamDepth)
	Sets stream depth index - shortest distance to pf source up stream.
virtual INodeTab &	UpStreamActionLists (void)=0
	Returns Tab of up-stream action list nodes (for read and write)
virtual INodeTab &	UpStreamMaterialActionLists (void)=0
	Returns Tab of up-stream action list nodes that are relevant for material inheritance re-generation (for read and write)
virtual void	SetVisited (bool visited)
	The method is used to implemented Visitor pattern in the actionList graph.
virtual bool	IsVisited (void) const
	The method is used to implemented Visitor pattern in the actionList graph.
virtual void	SetSortOrder (int index)
	The method is used to sort action lists to resolve material dependency for inheritance.
virtual int	GetSortOrder (void) const
	The method is used to sort action lists to resolve material dependency for inheritance.
virtual bool	UpdateMaterial (bool doReport)
	Returns whether the event material was updated.
virtual int	UpdateMaterials (bool doReport)
	Returns number of actionLists/events with materials updated.
virtual int	UpdateMaterialsDownstream (bool doReport)
	Returns number of actionLists/events with materials updated.
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 ()

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.
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.
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
kIsMaterialHolder
kInheritsMaterial
kGetMaterial
kSetMaterial
kGetMaterialPriority
kGetStreamDepth
kSetStreamDepth
kUpdateMaterial
kUpdateMaterials
kUpdateMaterialsDownstream

         {  kIsMaterialHolder,
            kInheritsMaterial,
            kGetMaterial,
            kSetMaterial,
            kGetMaterialPriority,
            kGetStreamDepth,
            kSetStreamDepth,
            kUpdateMaterial,
            kUpdateMaterials,
            kUpdateMaterialsDownstream
    }; 

Member Function Documentation

FN_0() [1/5]

FN_0	(	kIsMaterialHolder	,
		TYPE_bool	,
		IsMaterialHolder
	)

FN_0() [2/5]

FN_0	(	kInheritsMaterial	,
		TYPE_bool	,
		InheritsMaterial
	)

FN_0() [3/5]

FN_0	(	kGetMaterial	,
		TYPE_MTL	,
		GetMaterial
	)

FN_1() [1/4]

FN_1	(	kSetMaterial	,
		TYPE_bool	,
		SetMaterial	,
		TYPE_MTL
	)

FN_0() [4/5]

FN_0	(	kGetMaterialPriority	,
		TYPE_INT	,
		GetMaterialPriority
	)

FN_0() [5/5]

FN_0	(	kGetStreamDepth	,
		TYPE_INT	,
		GetStreamDepth
	)

VFN_1()

VFN_1	(	kSetStreamDepth	,
		SetStreamDepth	,
		TYPE_INT
	)

FN_1() [2/4]

FN_1	(	kUpdateMaterial	,
		TYPE_bool	,
		UpdateMaterial	,
		TYPE_bool
	)

FN_1() [3/4]

FN_1	(	kUpdateMaterials	,
		TYPE_INT	,
		UpdateMaterials	,
		TYPE_bool
	)

FN_1() [4/4]

FN_1	(	kUpdateMaterialsDownstream	,
		TYPE_INT	,
		UpdateMaterialsDownstream	,
		TYPE_bool
	)