IParticleChannelTabTVFace.h

Module description

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

Function Documentation

bool IsShared ( ) const

pure virtual

Checks whether 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

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

int GetValueIndex ( int  particleIndex ) const

pure virtual

Gets the value index of a particle.

const TabTVFace * GetValueByIndex ( int  valueIndex ) const

pure virtual

Gets the Tab of the valueIndex-th value.

const TabTVFace * GetValue ( int  particleIndex ) const

pure virtual

Gets the Tab for the particle specified by particleIndex.

const TabTVFace * GetValue ( ) const

pure virtual

Gets the global Tab<TVFace> for all particles.

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

FPInterfaceDesc * GetDesc ( )

inlinevirtual

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

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

Returns true if successful.

bool SetValue ( Tab< int > &  particleIndices, const TabTVFace *  value  )

pure virtual

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

Returns true if successful.

bool SetValue ( const TabTVFace *  value )

pure virtual

Copies Tab to be a global value for all particles.

Returns true if successful.

bool CopyValue ( int  fromParticle, int  toParticle  )

pure virtual

Copies tab value from fromParticle to toParticle.

bool CopyValue ( int  fromParticle, Tab< int > &  toParticles  )

pure virtual

Copies tab value from fromParticle to toParticles.

bool CopyValue ( int  fromParticle )

pure virtual

Copies tab value from fromParticle to all particles.

FPInterfaceDesc * GetDesc ( )

inlinevirtual

Remarks

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

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELTABTVFACEW_INTERFACE); }