IParticleChannelTabUVVert.h

Module description

Functions
virtual bool	IsShared () const =0
	Check whether some particles have shared Tab<UVVert>. 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 TabUVVert *	GetValue (int particleIndex) const =0
	Gets the Tab for a particle with index particleIndex. More...
virtual const TabUVVert *	GetValue () const =0
	Gets the global Tab<UVVert> for all particles. More...
FPInterfaceDesc *	GetDesc ()
virtual bool	SetValue (int particleIndex, const TabUVVert *value)=0
	Copies Tab to be a local value for particle with index "particleIndex". More...
virtual bool	SetValue (int particleIndex, UVVert value)=0
	Creates a Tab of size one from the UVVert value and copies the Tab to be a local value for particle with index "particleIndex". More...
virtual bool	SetValue (Tab< int > &particleIndices, const TabUVVert *value)=0
	Copies Tab to be a shared value for particles with indices in "particleIndices". More...
virtual bool	SetValue (Tab< int > &particleIndices, UVVert value)=0
	Creates a Tab of size one from the UVVert value and copies the Tab to be a shared value for particles with indices in "particleIndices". More...
virtual bool	SetValue (const TabUVVert *value)=0
	Copies Tab to be a global value for all particles. More...
virtual bool	SetValue (UVVert value)=0
	Creates a Tab of size one from the UVVert value and copies the Tab to be a global values for all particles. More...
virtual bool	CopyValue (int fromParticle, int toParticle)=0
	Copies the Tab value from fromParticle to toParticle. More...
virtual bool	CopyValue (int fromParticle, Tab< int > &toParticles)=0
	Copies the Tab value from fromParticle to toParticles. More...
virtual bool	CopyValue (int fromParticle)=0
	Copies the Tab value from fromParticle to all particles. More...
FPInterfaceDesc *	GetDesc ()

Function Documentation

bool IsShared ( ) const

pure virtual

Check whether some particles have shared Tab<UVVert>.

If 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 TabUVVert * GetValue ( int  particleIndex ) const

pure virtual

Gets the Tab for a particle with index particleIndex.

const TabUVVert * GetValue ( ) const

pure virtual

Gets the global Tab<UVVert> 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(PARTICLECHANNELTABUVVERTR_INTERFACE); }

bool SetValue ( int  particleIndex, const TabUVVert *  value  )

pure virtual

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

Returns true if successful.

bool SetValue ( int  particleIndex, UVVert  value  )

pure virtual

Creates a Tab of size one from the UVVert value and copies the Tab to be a local value for particle with index "particleIndex".

Returns true if successful

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

pure virtual

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

Returns true if successful.

bool SetValue ( Tab< int > &  particleIndices, UVVert  value  )

pure virtual

Creates a Tab of size one from the UVVert value and copies the Tab to be a shared value for particles with indices in "particleIndices".

Returns true if successful.

bool SetValue ( const TabUVVert *  value )

pure virtual

Copies Tab to be a global value for all particles.

Returns true if successful.

bool SetValue ( UVVert  value )

pure virtual

Creates a Tab of size one from the UVVert value and copies the Tab to be a global values for all particles.

Returns true if successful.

bool CopyValue ( int  fromParticle, int  toParticle  )

pure virtual

Copies the Tab value from fromParticle to toParticle.

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

pure virtual

Copies the Tab value from fromParticle to toParticles.

bool CopyValue ( int  fromParticle )

pure virtual

Copies the 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(PARTICLECHANNELTABUVVERTW_INTERFACE); }