Functions

IParticleChannelMap.h

Functions

bool  IsShared () const
  check out if some particles have shared mapping data.
virtual bool  IsUVVertShared () const =0
  check out if some particles have shared UVVert data.
virtual bool  IsTVFaceShared () const =0
  check out if some particles have shared TVFace data.
virtual int  GetUVVertCount () const =0
  get total number of actual TabUVVert values in the channel
virtual int  GetUVVertIndex (int particleIndex) const =0
  get the TabUVVert value index of a particle
virtual const TabUVVert *  GetUVVertByIndex (int valueIndex) const =0
  get TabUVVert of the valueIndex-th value
virtual const TabUVVert *  GetUVVert (int particleIndex) const =0
  get TabUVVert of a particle with the specified index
virtual const TabUVVert *  GetUVVert () const =0
  get global TabUVVert value for all particles.
virtual int  GetTVFaceCount () const =0
  get total number of actual TabTVFace values in the channel
virtual int  GetTVFaceIndex (int particleIndex) const =0
  may return NULL.
virtual const TabTVFace *  GetTVFaceByIndex (int valueIndex) const =0
  get TabTVFace of the valueIndex-th value.
virtual const TabTVFace *  GetTVFace (int particleIndex) const =0
  get TabTVFace of a particle with the specified index.
virtual const TabTVFace *  GetTVFace () const =0
  get global TabTVFace value for all particles.
virtual void  Apply (Mesh *mesh, int particleIndex, int mp) const =0
  apply content of the channel to the mesh [mesh] at mapping channel [mp]
FPInterfaceDesc GetDesc ()

Function Documentation

bool IsShared ( ) const [inline, inherited]

check out if some particles have shared mapping data.

if it's true then there is no need to get a mapping for each particle

{ return (IsUVVertShared() || IsTVFaceShared()); }
bool IsUVVertShared ( ) const [pure virtual, inherited]

check out if some particles have shared UVVert data.

if it's true then there is no need to get a UVVert data for each particle

bool IsTVFaceShared ( ) const [pure virtual, inherited]

check out if some particles have shared TVFace data.

if it's true then there is no need to get a TVFace data for each particle

int GetUVVertCount ( ) const [pure virtual, inherited]

get total number of actual TabUVVert values in the channel

int GetUVVertIndex ( int  particleIndex ) const [pure virtual, inherited]

get the TabUVVert value index of a particle

const TabUVVert * GetUVVertByIndex ( int  valueIndex ) const [pure virtual, inherited]

get TabUVVert of the valueIndex-th value

const TabUVVert * GetUVVert ( int  particleIndex ) const [pure virtual, inherited]

get TabUVVert of a particle with the specified index

const TabUVVert * GetUVVert ( ) const [pure virtual, inherited]

get global TabUVVert value for all particles.

the method returns the TabUVVert value of the first particle if it is local or shared

int GetTVFaceCount ( ) const [pure virtual, inherited]

get total number of actual TabTVFace values in the channel

int GetTVFaceIndex ( int  particleIndex ) const [pure virtual, inherited]

may return NULL.

for different TabUVVert values it has different meanings. if TabUVVert has a single UVVert value then the particle has a planar TVFace data and all vertices of the particles have the same UVVert value. if TabUVVert has the same number of UVVert values as the particle mesh vertices number then the particle has a planar TVFace data and there is one-to-one correspondence between UVVerts and vertices of the particle. get the TabTVFace value index of a particle.

const TabTVFace * GetTVFaceByIndex ( int  valueIndex ) const [pure virtual, inherited]

get TabTVFace of the valueIndex-th value.

See GetTVFaceIndex(int particleIndex).

const TabTVFace * GetTVFace ( int  particleIndex ) const [pure virtual, inherited]

get TabTVFace of a particle with the specified index.

See GetTVFaceIndex(int particleIndex).

const TabTVFace * GetTVFace ( ) const [pure virtual, inherited]

get global TabTVFace value for all particles.

the method returns the TabTVFace value of the first particle if it is local or shared. See GetTVFaceIndex(int particleIndex).

void Apply ( Mesh mesh,
int  particleIndex,
int  mp 
) const [pure virtual, inherited]

apply content of the channel to the mesh [mesh] at mapping channel [mp]

FPInterfaceDesc * GetDesc ( ) [inline, virtual, inherited]
Remarks:
Returns a pointer to the class which contains the interface metadata.

Implements FPInterface.

{ return GetDescByID(PARTICLECHANNELMAPR_INTERFACE); }