IParticleChannel Class Reference

#include <IParticleChannel.h>

Inheritance diagram for IParticleChannel:

Public Types
enum	{   kClone , kIsSimilarChannel , kIsTransferable , kSetTransferable ,   kIsPrivateChannel , kGetPrivateOwner , kSetPrivateOwner , kGetCreatorAction ,   kSetCreatorAction , kGetReadID_PartA , kGetReadID_PartB , kGetWriteID_PartA ,   kGetWriteID_PartB , kSetReadID , kSetWriteID }
enum	{   kChunkCount = 1000 , kChunkData = 1010 , kChunkGlobalCount = 1020 , kChunkSharedCount = 1021 ,   kChunkGlobalValue = 1030 , kChunkSharedValue = 1031 , kChunkReadID = 1040 , kChunkWriteID = 1050 ,   kChunkTransferable = 1055 , kChunkPrivate = 1056 , kChunkActionHandle = 1057 , kChunkValue1 = 1061 ,   kChunkValue2 = 1062 , kChunkValue3 = 1063 , kChunkValue4 = 1064 , kChunkValue5 = 1065 ,   kChunkValue6 = 1066 , kChunkValue7 = 1067 }
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Public Member Functions
	FN_0 (kClone, TYPE_IOBJECT, Clone)
	FN_1 (kIsSimilarChannel, TYPE_bool, IsSimilarChannel, TYPE_IOBJECT)
	FN_0 (kIsTransferable, TYPE_bool, IsTransferable)
	VFN_1 (kSetTransferable, SetTransferable, TYPE_bool)
	FN_0 (kIsPrivateChannel, TYPE_bool, IsPrivateChannel)
	FN_0 (kGetPrivateOwner, TYPE_OBJECT, GetPrivateOwner)
	VFN_1 (kSetPrivateOwner, SetPrivateOwner, TYPE_OBJECT)
	FN_0 (kGetCreatorAction, TYPE_INODE, GetCreatorAction)
	VFN_1 (kSetCreatorAction, SetCreatorAction, TYPE_INODE)
	FN_0 (kGetReadID_PartA, TYPE_DWORD, GetReadID_PartA)
	FN_0 (kGetReadID_PartB, TYPE_DWORD, GetReadID_PartB)
	FN_0 (kGetWriteID_PartA, TYPE_DWORD, GetWriteID_PartA)
	FN_0 (kGetWriteID_PartB, TYPE_DWORD, GetWriteID_PartB)
	VFN_2 (kSetReadID, SetReadID, TYPE_DWORD, TYPE_DWORD)
	VFN_2 (kSetWriteID, SetWriteID, TYPE_DWORD, TYPE_DWORD)
PFExport	IParticleChannel ()
PFExport	IParticleChannel (const Interface_ID &readID, const Interface_ID &writeID)
virtual Class_ID	GetClassID () const =0
	Returns the unique ID for the channel class. More...
virtual IObject *	Clone () const =0
	cloning; make a copy of the channel More...
virtual IOResult	Save (ISave *isave) const =0
	saving content of the channel to file More...
virtual IOResult	Load (ILoad *iload)=0
	loading content of the channel from file More...
PFExport bool	IsSimilarChannel (IObject *channel) const
	checks if the given IObject is a similar particle channel More...
PFExport bool	IsTransferable () const
	Get "transferable" status. More...
PFExport void	SetTransferable (bool status)
	Set "transferable" status. More...
PFExport bool	IsPrivateChannel () const
	A channel can be declared "private" by an action. More...
PFExport Object *	GetPrivateOwner () const
	returns a "private owner" action of the channel More...
PFExport void	SetPrivateOwner (Object *action)
	sets a "private owner" action of the channel More...
PFExport INode *	GetCreatorAction () const
	channel data can be viewed by different actions. More...
PFExport void	SetCreatorAction (INode *actionNode)
	channel data can be viewed by different actions. More...
PFExport DWORD	GetReadID_PartA () const
	Set/get a concrete channel ID for a generic data particle channel. More...
PFExport DWORD	GetReadID_PartB () const
	Set/get a concrete channel ID for a generic data particle channel. More...
PFExport DWORD	GetWriteID_PartA () const
	access write-interface ID of the wrapping channel More...
PFExport DWORD	GetWriteID_PartB () const
	access write-interface ID of the wrapping channel More...
PFExport void	SetReadID (DWORD interfaceID_PartA, DWORD interfaceID_PartB)
	set up read-interface ID of the wrapping channel More...
PFExport void	SetWriteID (DWORD interfaceID_PartA, DWORD interfaceID_PartB)
	set up write-interface ID of the wrapping channel More...
PFExport const Interface_ID &	GetReadID () const
	methods that are not in FnPub interface. More...
PFExport const Interface_ID &	GetWriteID () const
	access write-interface ID of the wrapping channel More...
PFExport void	SetReadID (const Interface_ID &id)
	set up read-interface ID of the wrapping channel More...
PFExport void	SetWriteID (const Interface_ID &id)
	set up write-interface ID of the wrapping channel More...
PFExport void	CloneChannelCore (IParticleChannel *getFrom)
	when cloning a channel, data about transferable, privateOwner, creatorAction, readID & write ID should be cloned. More...
PFExport void	UpdateCreatorHandle (IMergeManager *pMM)
	when cached channel data are merged the stored action creator handle could be invalid. More...
virtual int	MemoryUsed () const =0
	returns amount of memory used (in bytes) by the channel to store the information 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...
template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Protected Member Functions
int	numRefs () const
int &	_numRefs ()
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
bool	m_isTransferable
bool	m_isPrivate
Object *	m_privateOwner
INode *	m_creatorAction
ULONG	m_creatorHandle
Interface_ID	m_readID
Interface_ID	m_writeID
Protected Attributes inherited from FPMixinInterface
Tab< InterfaceNotifyCallback * > *	interfaceNotifyCBs

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 UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...
Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
kClone
kIsSimilarChannel
kIsTransferable
kSetTransferable
kIsPrivateChannel
kGetPrivateOwner
kSetPrivateOwner
kGetCreatorAction
kSetCreatorAction
kGetReadID_PartA
kGetReadID_PartB
kGetWriteID_PartA
kGetWriteID_PartB
kSetReadID
kSetWriteID

         {  kClone,
            kIsSimilarChannel,
            kIsTransferable,
            kSetTransferable,
            kIsPrivateChannel,
            kGetPrivateOwner,
            kSetPrivateOwner,
            kGetCreatorAction,
            kSetCreatorAction,
            kGetReadID_PartA,
            kGetReadID_PartB,
            kGetWriteID_PartA,
            kGetWriteID_PartB,
            kSetReadID,
            kSetWriteID
    };

anonymous enum

anonymous enum

Enumerator
kChunkCount
kChunkData
kChunkGlobalCount
kChunkSharedCount
kChunkGlobalValue
kChunkSharedValue
kChunkReadID
kChunkWriteID
kChunkTransferable
kChunkPrivate
kChunkActionHandle
kChunkValue1
kChunkValue2
kChunkValue3
kChunkValue4
kChunkValue5
kChunkValue6
kChunkValue7

         {  kChunkCount         = 1000,
            kChunkData          = 1010,
            kChunkGlobalCount   = 1020,
            kChunkSharedCount   = 1021,
            kChunkGlobalValue   = 1030,
            kChunkSharedValue   = 1031,
            kChunkReadID        = 1040,
            kChunkWriteID       = 1050,
            kChunkTransferable  = 1055,
            kChunkPrivate       = 1056,
            kChunkActionHandle  = 1057,
            kChunkValue1        = 1061,
            kChunkValue2        = 1062,
            kChunkValue3        = 1063,
            kChunkValue4        = 1064,
            kChunkValue5        = 1065,
            kChunkValue6        = 1066,
            kChunkValue7        = 1067
    };

Constructor & Destructor Documentation

IParticleChannel() [1/2]

PFExport IParticleChannel

(

)

IParticleChannel() [2/2]

PFExport IParticleChannel	(	const Interface_ID &	readID,
		const Interface_ID &	writeID
	)

Member Function Documentation

FN_0() [1/9]

FN_0	(	kClone	,
		TYPE_IOBJECT	,
		Clone
	)

FN_1()

FN_1	(	kIsSimilarChannel	,
		TYPE_bool	,
		IsSimilarChannel	,
		TYPE_IOBJECT
	)

FN_0() [2/9]

FN_0	(	kIsTransferable	,
		TYPE_bool	,
		IsTransferable
	)

VFN_1() [1/3]

VFN_1	(	kSetTransferable	,
		SetTransferable	,
		TYPE_bool
	)

FN_0() [3/9]

FN_0	(	kIsPrivateChannel	,
		TYPE_bool	,
		IsPrivateChannel
	)

FN_0() [4/9]

FN_0	(	kGetPrivateOwner	,
		TYPE_OBJECT	,
		GetPrivateOwner
	)

VFN_1() [2/3]

VFN_1	(	kSetPrivateOwner	,
		SetPrivateOwner	,
		TYPE_OBJECT
	)

FN_0() [5/9]

FN_0	(	kGetCreatorAction	,
		TYPE_INODE	,
		GetCreatorAction
	)

VFN_1() [3/3]

VFN_1	(	kSetCreatorAction	,
		SetCreatorAction	,
		TYPE_INODE
	)

FN_0() [6/9]

FN_0	(	kGetReadID_PartA	,
		TYPE_DWORD	,
		GetReadID_PartA
	)

FN_0() [7/9]

FN_0	(	kGetReadID_PartB	,
		TYPE_DWORD	,
		GetReadID_PartB
	)

FN_0() [8/9]

FN_0	(	kGetWriteID_PartA	,
		TYPE_DWORD	,
		GetWriteID_PartA
	)

FN_0() [9/9]

FN_0	(	kGetWriteID_PartB	,
		TYPE_DWORD	,
		GetWriteID_PartB
	)

VFN_2() [1/2]

VFN_2	(	kSetReadID	,
		SetReadID	,
		TYPE_DWORD	,
		TYPE_DWORD
	)

VFN_2() [2/2]

VFN_2	(	kSetWriteID	,
		SetWriteID	,
		TYPE_DWORD	,
		TYPE_DWORD
	)

GetClassID()

virtual Class_ID GetClassID ( ) const

pure virtual

Returns the unique ID for the channel class.

The ID is used for constructing the channel when loading since the channel class is not inherited from class Animatable.

Clone()

virtual IObject* Clone ( ) const

pure virtual

cloning; make a copy of the channel

Save()

virtual IOResult Save ( ISave *  isave ) const

pure virtual

saving content of the channel to file

Load()

virtual IOResult Load ( ILoad *  iload )

pure virtual

loading content of the channel from file

IsSimilarChannel()

PFExport bool IsSimilarChannel

(

IObject *

channel

)

const

checks if the given IObject is a similar particle channel

IsTransferable()

PFExport bool IsTransferable

(

)

const

Get "transferable" status.

If particle channel is transferable then it is transferred from one event to another; the data in the channel are glued to particles if particle channel is not transferable then while particles moves to another event, the particle channel is not

SetTransferable()

PFExport void SetTransferable

(

bool

status

)

Set "transferable" status.

IsPrivateChannel()

PFExport bool IsPrivateChannel

(

)

const

A channel can be declared "private" by an action.

when a channel is declared as a "private" a reference on a "private owner" is given then only the "private owner" action will be given access to this channel. the technique allows creating several channels with the same data-type (for example, position) in the container by different "private owner" actions Because of access to particle container, onle an action that created the channel can declare itself as a private owner.

GetPrivateOwner()

PFExport Object* GetPrivateOwner

(

)

const

returns a "private owner" action of the channel

SetPrivateOwner()

PFExport void SetPrivateOwner

(

Object *

action

)

sets a "private owner" action of the channel

GetCreatorAction()

PFExport INode* GetCreatorAction

(

)

const

channel data can be viewed by different actions.

however an action that created the channel is responsible for data initialization. therefore the action has to keep track how (by what action) the channel was created

SetCreatorAction()

PFExport void SetCreatorAction

(

INode *

actionNode

)

channel data can be viewed by different actions.

however an action that created the channel is responsible for data initialization. therefore the action has to keep track how (by what action) the channel was created

GetReadID_PartA()

PFExport DWORD GetReadID_PartA

(

)

const

Set/get a concrete channel ID for a generic data particle channel.

Access read-interface ID of the wrapping channel.

GetReadID_PartB()

PFExport DWORD GetReadID_PartB

(

)

const

Set/get a concrete channel ID for a generic data particle channel.

Access read-interface ID of the wrapping channel.

GetWriteID_PartA()

PFExport DWORD GetWriteID_PartA

(

)

const

access write-interface ID of the wrapping channel

GetWriteID_PartB()

PFExport DWORD GetWriteID_PartB

(

)

const

access write-interface ID of the wrapping channel

SetReadID() [1/2]

PFExport void SetReadID	(	DWORD	interfaceID_PartA,
		DWORD	interfaceID_PartB
	)

set up read-interface ID of the wrapping channel

SetWriteID() [1/2]

PFExport void SetWriteID	(	DWORD	interfaceID_PartA,
		DWORD	interfaceID_PartB
	)

set up write-interface ID of the wrapping channel

GetReadID()

PFExport const Interface_ID& GetReadID

(

)

const

methods that are not in FnPub interface.

Access read-interface ID of the wrapping channel.

GetWriteID()

PFExport const Interface_ID& GetWriteID

(

)

const

access write-interface ID of the wrapping channel

SetReadID() [2/2]

PFExport void SetReadID

(

const Interface_ID &

id

)

set up read-interface ID of the wrapping channel

SetWriteID() [2/2]

PFExport void SetWriteID

(

const Interface_ID &

id

)

set up write-interface ID of the wrapping channel

CloneChannelCore()

PFExport void CloneChannelCore

(

IParticleChannel *

getFrom

)

when cloning a channel, data about transferable, privateOwner, creatorAction, readID & write ID should be cloned.

the following method does that: it clones the core data from the given channel

UpdateCreatorHandle()

PFExport void UpdateCreatorHandle

(

IMergeManager *

pMM

)

when cached channel data are merged the stored action creator handle could be invalid.

the method lets the channel to update the action handle to the proper one

MemoryUsed()

virtual int MemoryUsed ( ) const

pure virtual

returns amount of memory used (in bytes) by the channel to store the information

GetDesc()

FPInterfaceDesc* GetDesc ( )

inlinevirtual

Remarks

Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNEL_INTERFACE); }

numRefs()

int numRefs ( ) const

inlineprotected

{ return m_numRefs; }

_numRefs()

int& _numRefs ( )

inlineprotected

{ return m_numRefs; }

Member Data Documentation

m_isTransferable

bool m_isTransferable

protected

m_isPrivate

bool m_isPrivate

protected

m_privateOwner

Object* m_privateOwner

mutableprotected

m_creatorAction

INode* m_creatorAction

mutableprotected

m_creatorHandle

ULONG m_creatorHandle

protected

m_readID

Interface_ID m_readID

protected

m_writeID

Interface_ID m_writeID

protected