- Cal3D 0.11 API Reference -

Public Member Functions | Protected Member Functions
CalCoreMesh Class Reference
Inheritance diagram for CalCoreMesh:
cal3d::RefCounted

List of all members.

Public Member Functions

 CalCoreMesh ()
 Constructs the core mesh instance.
int addCoreSubmesh (CalCoreSubmesh *pCoreSubmesh)
 Adds a core submesh.
CalCoreSubmeshgetCoreSubmesh (int id)
 Provides access to a core submesh.
int getCoreSubmeshCount ()
 Returns the number of core submeshes.
std::vector< CalCoreSubmesh * > & getVectorCoreSubmesh ()
 Returns the core submesh vector.
int addAsMorphTarget (CalCoreMesh *pCoreMesh)
 Adds a core submesh.
void scale (float factor)
 Scale the Mesh.
void setFilename (const std::string &filename)
 Set the name of the file in which the core mesh is stored, if any.
const std::string & getFilename (void)
 Get the name of the file in which the core mesh is stored, if any.
void setName (const std::string &name)
 Set the symbolic name of the core mesh.
const std::string & getName (void)
 Get the symbolic name the core mesh.

Protected Member Functions

 ~CalCoreMesh ()
 Destructs the core mesh instance.

Constructor & Destructor Documentation

CalCoreMesh::~CalCoreMesh ( ) [protected]

Destructs the core mesh instance.

This function is the destructor of the core mesh instance.

Constructs the core mesh instance.

This function is the default constructor of the core mesh instance.


Member Function Documentation

Adds a core submesh.

This function adds a core mesh as a blend target. It adds appropriate CalCoreSubMorphTargets to each of the core sub meshes.

Parameters:
pCoreMeshA pointer to the core mesh that shoulb become a blend target.
Returns:
One of the following values:
  • the assigned morph target ID of the added blend target
  • -1 if an error happend

Adds a core submesh.

This function adds a core submesh to the core mesh instance.

Parameters:
pCoreSubmeshA pointer to the core submesh that should be added.
Returns:
One of the following values:
  • the assigned submesh ID of the added core submesh
  • -1 if an error happend

Provides access to a core submesh.

This function returns the core submesh with the given ID.

Parameters:
idThe ID of the core submesh that should be returned.
Returns:
One of the following values:
  • a pointer to the core submesh
  • 0 if an error happend

Returns the number of core submeshes.

This function returns the number of core submeshes in the core mesh instance.

Returns:
The number of core submeshes.
const std::string & CalCoreMesh::getFilename ( void  )

Get the name of the file in which the core mesh is stored, if any.

Returns:
One of the following values:
  • empty string if the mesh was not stored in a file
  • the path of the file
const std::string & CalCoreMesh::getName ( void  )

Get the symbolic name the core mesh.

Returns:
One of the following values:
  • empty string if the mesh was no associated to a symbolic name
  • the symbolic name

Returns the core submesh vector.

This function returns the vector that contains all core submeshes of the core mesh instance.

Returns:
A reference to the core submesh vector.
void CalCoreMesh::scale ( float  factor)

Scale the Mesh.

This function rescale all the data that are in the core mesh instance.

Parameters:
factorA float with the scale factor
void CalCoreMesh::setFilename ( const std::string &  filename)

Set the name of the file in which the core mesh is stored, if any.

Parameters:
filenameThe path of the file.
void CalCoreMesh::setName ( const std::string &  name)

Set the symbolic name of the core mesh.

Parameters:
nameA symbolic name.

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

Generated at Tue Sep 22 2015 20:46:45 by The Cal3D Team with Doxygen 1.7.6.1