- Cal3D 0.9 API Reference -

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

# CalCoreSubMorphTarget Class Reference

The core sub morph target class. More...

`#include <coresubmorphtarget.h>`

List of all members.

## Public Member Functions

| CalCoreSubMorphTarget ()
| Constructs the core sub morph target instance.
virtual | ~CalCoreSubMorphTarget ()
| Destructs the core sub morph target instance.
bool | create ()
| Creates the core sub morph target instance.
void | destroy ()
| Destroys the core sub morph target instance.
int | getBlendVertexCount ()
| Returns the number of blend vertices.
std::vector< BlendVertex > & | getVectorBlendVertex ()
| Returns the blend vertex vector.
bool | reserve (int blendVertexCount)
| Reserves memory for the blend vertices.
bool | setBlendVertex (int vertexId, const BlendVertex &vertex)
| Sets a specified blend vertex.

## Protected Attributes

std::vector< BlendVertex > | m_vectorBlendVertex

## Detailed Description

The core sub morph target class.

## Constructor & Destructor Documentation

CalCoreSubMorphTarget::CalCoreSubMorphTarget | ( |  | ) |

| Constructs the core sub morph target instance. This function is the default constructor of the core sub morph target instance.

CalCoreSubMorphTarget::~CalCoreSubMorphTarget | ( |  | ) | `[virtual]`

| Destructs the core sub morph target instance. This function is the destructor of the core sub morph target instance.

## Member Function Documentation

bool CalCoreSubMorphTarget::create | ( |  | ) |

| Creates the core sub morph target instance. This function creates the core sub morph target instance.

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

void CalCoreSubMorphTarget::destroy | ( |  | ) |

| Destroys the core sub morph target instance. This function destroys all data stored in the core sub morph target instance and frees all allocated memory.

int CalCoreSubMorphTarget::getBlendVertexCount | ( |  | ) |

| Returns the number of blend vertices. This function returns the number of blend vertices in the core sub morph target instance.

Returns:
  The number of blend vertices.

std::vector< CalCoreSubMorphTarget::BlendVertex > & CalCoreSubMorphTarget::getVectorBlendVertex | ( |  | ) |

| Returns the blend vertex vector. This function returns the vector that contains all blend vertices of the core sub morph target instance.

Returns:
  A reference to the blend vertex vector.

bool CalCoreSubMorphTarget::reserve | ( | int | blendVertexCount | ) |

| Reserves memory for the blend vertices. This function reserves memory for the blend vertices of the core sub morph target instance.

Parameters:

  blendVertexCount | The number of blend vertices that this core sub morph target instance should be able to hold.

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

bool CalCoreSubMorphTarget::setBlendVertex | ( | int | blendVertexId,
|  | const BlendVertex & | blendVertex
| ) |

| Sets a specified blend vertex. This function sets a specified blend vertex in the core sub morph target instance.

Parameters:

  vertexId | The ID of the vertex.
  vertex | The vertex that should be set.

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

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

- coresubmorphtarget.h
- coresubmorphtarget.cpp

Generated at Wed Apr 7 16:57:17 2004 by The Cal3D Team with 1.3.6 © 1997-2001 Dimitri van Heesch