IParticleChannelTabTVFace.h

Functions
virtual bool	IsShared () const =0
	Check out if some particles have shared Tab<TVFace>.
virtual int	GetValueCount () const =0
	Get total number of actual Tabs (values) in the channel.
virtual int	GetValueIndex (int particleIndex) const =0
	Get the value index of a particle.
virtual const TabTVFace *	GetValueByIndex (int valueIndex) const =0
	Get Tab of the valueIndex-th value.
virtual const TabTVFace *	GetValue (int particleIndex) const =0
	Get Tab for particle with index.
virtual const TabTVFace *	GetValue () const =0
	Get global Tab<TVFace> for all particles.
FPInterfaceDesc *	GetDesc ()
virtual bool	SetValue (int particleIndex, const TabTVFace *value)=0
	Copies Tab to be a local value for particle with index "particleIndex".
virtual bool	SetValue (Tab< int > &particleIndices, const TabTVFace *value)=0
	Copies Tab to be a shared value with indices in "particleIndices".
virtual bool	SetValue (const TabTVFace *value)=0
	Copies Tab to be a global values for all particles.
virtual bool	CopyValue (int fromParticle, int toParticle)=0
	Copy tab value from fromParticle to toParticle.
virtual bool	CopyValue (int fromParticle, Tab< int > &toParticles)=0
	Copy tab value from fromParticle to toParticles.
virtual bool	CopyValue (int fromParticle)=0
	Copy tab value from fromParticle to all particles.
FPInterfaceDesc *	GetDesc ()

---

Function Documentation

bool IsShared

(

)

const [pure virtual, inherited]

Search for all occurrences

Check out if some particles have shared Tab<TVFace>.

If it's true then there is no need to get a Tab for each particle.

int GetValueCount

(

)

const [pure virtual, inherited]

Search for all occurrences

Get total number of actual Tabs (values) in the channel.

int GetValueIndex

(

int

particleIndex

)

const [pure virtual, inherited]

Search for all occurrences

Get the value index of a particle.

const TabTVFace * GetValueByIndex

(

int

valueIndex

)

const [pure virtual, inherited]

Search for all occurrences

Get Tab of the valueIndex-th value.

const TabTVFace * GetValue

(

int

particleIndex

)

const [pure virtual, inherited]

Search for all occurrences

Get Tab for particle with index.

const TabTVFace * GetValue

(

)

const [pure virtual, inherited]

Search for all occurrences

Get global Tab<TVFace> for all particles.

The method returns the Tab of the first particle if it is local or shared.

FPInterfaceDesc * GetDesc

(

)

[inline, virtual, inherited]

Search for all occurrences

Remarks:

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELTABTVFACER_INTERFACE); }

bool SetValue	(	int	particleIndex,
		const TabTVFace *	value
	)		[pure virtual, inherited]

Search for all occurrences

Copies Tab to be a local value for particle with index "particleIndex".

Returns true if successful.

bool SetValue	(	Tab< int > &	particleIndices,
		const TabTVFace *	value
	)		[pure virtual, inherited]

Search for all occurrences

Copies Tab to be a shared value with indices in "particleIndices".

Returns true if successful.

bool SetValue

(

const TabTVFace *

value

)

[pure virtual, inherited]

Search for all occurrences

Copies Tab to be a global values for all particles.

Returns true if successful.

bool CopyValue	(	int	fromParticle,
		int	toParticle
	)		[pure virtual, inherited]

Search for all occurrences

Copy tab value from fromParticle to toParticle.

bool CopyValue	(	int	fromParticle,
		Tab< int > &	toParticles
	)		[pure virtual, inherited]

Search for all occurrences

Copy tab value from fromParticle to toParticles.

bool CopyValue

(

int

fromParticle

)

[pure virtual, inherited]

Search for all occurrences

Copy tab value from fromParticle to all particles.

FPInterfaceDesc * GetDesc

(

)

[inline, virtual, inherited]

Search for all occurrences

Remarks:

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELTABTVFACEW_INTERFACE); }