- Cal3D 0.9 API Reference -

             

---

CalCoreMesh Class Reference

The core mesh class. More...

#include <coremesh.h>

List of all members.

Public Methods
	CalCoreMesh ()
	Constructs the core mesh instance. More...
virtual	~CalCoreMesh ()
	Destructs the core mesh instance. More...
int	addCoreSubmesh (CalCoreSubmesh *pCoreSubmesh)
	Adds a core submesh. More...
bool	create ()
	Creates the core mesh instance. More...
void	destroy ()
	Destroys the core mesh instance. More...
CalCoreSubmesh *	getCoreSubmesh (int id)
	Provides access to a core submesh. More...
int	getCoreSubmeshCount ()
	Returns the number of core submeshes. More...
std::vector< CalCoreSubmesh * > &	getVectorCoreSubmesh ()
	Returns the core submesh vector. More...
int	addAsMorphTarget (CalCoreMesh *pCoreMesh)
	Adds a core submesh. More...
Protected Attributes
std::vector< CalCoreSubmesh * >	m_vectorCoreSubmesh

---

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.

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.

---

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

• coremesh.h
• coremesh.cpp

---

Generated at Sun Oct 12 18:38:49 2003 by The Cal3D Team with 1.2.14 © 1997-2001 Dimitri van Heesch