- Cal3D 0.9 API Reference -

Main Page | Class Hierarchy | Alphabetical List | Class List | File List | Class Members | Related Pages

CalCoreMesh Class Reference

The core mesh class. More...

#include <coremesh.h>

List of all members.

Public Member Functions

 CalCoreMesh ()
 Constructs the core mesh instance.
virtual ~CalCoreMesh ()
 Destructs the core mesh instance.
int addCoreSubmesh (CalCoreSubmesh *pCoreSubmesh)
 Adds a core submesh.
bool create ()
 Creates the core mesh instance.
void destroy ()
 Destroys the core mesh instance.
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 Attributes

std::vector< CalCoreSubmesh * > m_vectorCoreSubmesh
std::string m_name
std::string m_filename


Detailed Description

The core mesh class.


Constructor & Destructor Documentation

CalCoreMesh::CalCoreMesh  ) 
 

Constructs the core mesh instance.

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

CalCoreMesh::~CalCoreMesh  )  [virtual]
 

Destructs the core mesh instance.

This function is the destructor of the core mesh instance.


Member Function Documentation

int CalCoreMesh::addAsMorphTarget CalCoreMesh pCoreMesh  ) 
 

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:
pCoreMesh A 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

int CalCoreMesh::addCoreSubmesh CalCoreSubmesh pCoreSubmesh  ) 
 

Adds a core submesh.

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

Parameters:
pCoreSubmesh A 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

bool CalCoreMesh::create  ) 
 

Creates the core mesh instance.

This function creates the core mesh instance.

Returns:
One of the following values:
  • true if successful
  • false if an error happend

void CalCoreMesh::destroy  ) 
 

Destroys the core mesh instance.

This function destroys all data stored in the core mesh instance and frees all allocated memory.

CalCoreSubmesh * CalCoreMesh::getCoreSubmesh int  id  ) 
 

Provides access to a core submesh.

This function returns the core submesh with the given ID.

Parameters:
id The 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

int CalCoreMesh::getCoreSubmeshCount  ) 
 

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

std::vector< CalCoreSubmesh * > & CalCoreMesh::getVectorCoreSubmesh  ) 
 

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:
factor A 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:
filename The path of the file.

void CalCoreMesh::setName const std::string &  name  ) 
 

Set the symbolic name of the core mesh.

Parameters:
name A symbolic name.


The documentation for this class was generated from the following files:
Generated at Thu Dec 2 20:28:27 2004 by The Cal3D Team with doxygen 1.3.9.1 © 1997-2001 Dimitri van Heesch