- Cal3D 0.11 API Reference -

Classes | Public Member Functions | List of all members
CalSubmesh Class Reference

Classes

struct  Face
 
struct  PhysicalProperty
 
struct  TangentSpace
 

Public Member Functions

 CalSubmesh (CalCoreSubmesh *coreSubmesh)
 
CalCoreSubmeshgetCoreSubmesh ()
 Provides access to the core submesh. More...
 
int getCoreMaterialId ()
 Returns the core material ID. More...
 
int getFaceCount ()
 Returns the number of faces. More...
 
int getFaces (CalIndex *pFaceBuffer)
 Provides access to the face data. More...
 
std::vector< CalVector > & getVectorNormal ()
 Returns the normal vector. More...
 
std::vector< std::vector
< TangentSpace > > & 
getVectorVectorTangentSpace ()
 Returns the tangent space vector-vector. More...
 
std::vector< PhysicalProperty > & getVectorPhysicalProperty ()
 Returns the physical property vector. More...
 
std::vector< CalVector > & getVectorVertex ()
 Returns the vertex vector. More...
 
int getVertexCount ()
 Returns the number of vertices. More...
 
bool hasInternalData ()
 Returns if the submesh instance handles vertex data internally. More...
 
void disableInternalData ()
 Disable internal data (and thus springs system) More...
 
void setCoreMaterialId (int coreMaterialId)
 Sets the core material ID. More...
 
void setLodLevel (float lodLevel)
 Sets the LOD level. More...
 
bool isTangentsEnabled (int mapId)
 Returns true if tangent vectors are enabled. More...
 
bool enableTangents (int mapId, bool enabled)
 Enables (and calculates) or disables the storage of tangent spaces. More...
 
std::vector< float > & getVectorWeight ()
 
void setMorphTargetWeight (int blendId, float weight)
 Sets weight of a morph target with the given id. More...
 
float getMorphTargetWeight (int blendId)
 Gets weight of a morph target with the given id. More...
 
float getBaseWeight ()
 Gets weight of the base vertices. More...
 
int getMorphTargetWeightCount ()
 Returns the number of weights. More...
 
std::vector< float > & getVectorMorphTargetWeight ()
 Returns the morph target weight vector. More...
 

Member Function Documentation

void CalSubmesh::disableInternalData ( )

Disable internal data (and thus springs system)

bool CalSubmesh::enableTangents ( int  mapId,
bool  enabled 
)

Enables (and calculates) or disables the storage of tangent spaces.

This function enables or disables the storage of tangent space bases.

float CalSubmesh::getBaseWeight ( )

Gets weight of the base vertices.

Returns
The weight of the base vertices.
int CalSubmesh::getCoreMaterialId ( )

Returns the core material ID.

This function returns the core material ID of the submesh instance.

Returns
One of the following values:
  • the ID of the core material
  • -1 if an error happend
CalCoreSubmesh * CalSubmesh::getCoreSubmesh ( )

Provides access to the core submesh.

This function returns the core submesh on which this submesh instance is based on.

Returns
One of the following values:
  • a pointer to the core submesh
  • 0 if an error happend
int CalSubmesh::getFaceCount ( )

Returns the number of faces.

This function returns the number of faces in the submesh instance.

Returns
The number of faces.
int CalSubmesh::getFaces ( CalIndex *  pFaceBuffer)

Provides access to the face data.

This function returns the face data (vertex indices) of the submesh instance. The LOD setting of the submesh instance is taken into account.

Parameters
pFaceBufferA pointer to the user-provided buffer where the face data is written to.
Returns
The number of faces written to the buffer.
float CalSubmesh::getMorphTargetWeight ( int  blendId)

Gets weight of a morph target with the given id.

Parameters
blendIdThe morph target id.
Returns
The weight of the morph target.
int CalSubmesh::getMorphTargetWeightCount ( )

Returns the number of weights.

This function returns the number of weights.

Returns
The number of weights.
std::vector< float > & CalSubmesh::getVectorMorphTargetWeight ( )

Returns the morph target weight vector.

This function returns the vector that contains all weights for each morph target instance.

Returns
A reference to the weight vector.
std::vector< CalVector > & CalSubmesh::getVectorNormal ( )

Returns the normal vector.

This function returns the vector that contains all normals of the submesh instance.

Returns
A reference to the normal vector.
std::vector< CalSubmesh::PhysicalProperty > & CalSubmesh::getVectorPhysicalProperty ( )

Returns the physical property vector.

This function returns the vector that contains all physical properties of the submesh instance.

Returns
A reference to the physical property vector.
std::vector< std::vector< CalSubmesh::TangentSpace > > & CalSubmesh::getVectorVectorTangentSpace ( )

Returns the tangent space vector-vector.

This function returns the vector that contains all tangent space bases of the submesh instance. This vector contains another vector because there can be more than one texture map at each vertex.

Returns
A reference to the tangent space vector-vector.
std::vector< CalVector > & CalSubmesh::getVectorVertex ( )

Returns the vertex vector.

This function returns the vector that contains all vertices of the submesh instance.

Returns
A reference to the vertex vector.
int CalSubmesh::getVertexCount ( )

Returns the number of vertices.

This function returns the number of vertices in the submesh instance.

Returns
The number of vertices.
bool CalSubmesh::hasInternalData ( )

Returns if the submesh instance handles vertex data internally.

This function returns wheter the submesh instance handles vertex data internally.

Returns
One of the following values:
  • true if vertex data is handled internally
  • false if not
bool CalSubmesh::isTangentsEnabled ( int  mapId)

Returns true if tangent vectors are enabled.

This function returns true if the submesh contains tangent vectors.

Returns
True if tangent vectors are enabled.
void CalSubmesh::setCoreMaterialId ( int  coreMaterialId)

Sets the core material ID.

This function sets the core material ID of the submesh instance.

Parameters
coreMaterialIdThe core material ID that should be set.
void CalSubmesh::setLodLevel ( float  lodLevel)

Sets the LOD level.

This function sets the LOD level of the submesh instance.

Parameters
lodLevelThe LOD level in the range [0.0, 1.0].
void CalSubmesh::setMorphTargetWeight ( int  blendId,
float  weight 
)

Sets weight of a morph target with the given id.

Parameters
blendIdThe morph target id.
weightThe weight to be set.

The documentation for this class was generated from the following files:

Generated at Sat Aug 16 2014 01:39:52 by The Cal3D Team with Doxygen 1.8.7