IParticleChannel.h

Module description

Functions
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 ()
int	numRefs () const
int &	_numRefs ()

Variables
bool	m_isTransferable
bool	m_isPrivate
Object *	m_privateOwner
INode *	m_creatorAction
ULONG	m_creatorHandle
Interface_ID	m_readID
Interface_ID	m_writeID

Function Documentation

PFExport IParticleChannel

(

)

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

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.

IObject * Clone ( ) const

pure virtual

cloning; make a copy of the channel

IOResult Save ( ISave *  isave ) const

pure virtual

saving content of the channel to file

IOResult Load ( ILoad *  iload )

pure virtual

loading content of the channel from file

PFExport bool IsSimilarChannel

(

IObject *

channel

)

const

checks if the given IObject is a similar particle channel

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

PFExport void SetTransferable

(

bool

status

)

Set "transferable" status.

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.

PFExport Object * GetPrivateOwner

(

)

const

returns a "private owner" action of the channel

PFExport void SetPrivateOwner

(

Object *

action

)

sets a "private owner" action of the channel

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

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

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.

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.

PFExport DWORD GetWriteID_PartA

(

)

const

access write-interface ID of the wrapping channel

PFExport DWORD GetWriteID_PartB

(

)

const

access write-interface ID of the wrapping channel

PFExport void SetReadID	(	DWORD	interfaceID_PartA,
		DWORD	interfaceID_PartB
	)

set up read-interface ID of the wrapping channel

PFExport void SetWriteID	(	DWORD	interfaceID_PartA,
		DWORD	interfaceID_PartB
	)

set up write-interface ID of the wrapping channel

PFExport const Interface_ID & GetReadID

(

)

const

methods that are not in FnPub interface.

Access read-interface ID of the wrapping channel.

PFExport const Interface_ID & GetWriteID

(

)

const

access write-interface ID of the wrapping channel

PFExport void SetReadID

(

const Interface_ID &

id

)

set up read-interface ID of the wrapping channel

PFExport void SetWriteID

(

const Interface_ID &

id

)

set up write-interface ID of the wrapping channel

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

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

int MemoryUsed ( ) const

pure virtual

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

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNEL_INTERFACE); }

int numRefs ( ) const

inlineprotected

{ return m_numRefs; }

int& _numRefs ( )

inlineprotected

{ return m_numRefs; }

Variable Documentation

bool m_isTransferable

protected

bool m_isPrivate

protected

Object* m_privateOwner

mutableprotected

INode* m_creatorAction

mutableprotected

ULONG m_creatorHandle

protected

Interface_ID m_readID

protected

Interface_ID m_writeID

protected