- Cal3D 0.11 API Reference - |
Public Member Functions | |
CalModel (CalCoreModel *pCoreModel) | |
Constructs the model instance. More... | |
~CalModel () | |
Destructs the model instance. More... | |
bool | attachMesh (int coreMeshId) |
Attachs a mesh. More... | |
bool | detachMesh (int coreMeshId) |
Detaches a mesh. More... | |
CalCoreModel * | getCoreModel () const |
Provides access to the core model. More... | |
CalMesh * | getMesh (int coreMeshId) const |
Provides access to an attached mesh. More... | |
CalMixer * | getMixer () const |
Returns the mixer. More... | |
CalAbstractMixer * | getAbstractMixer () const |
Returns the mixer. More... | |
void | setAbstractMixer (CalAbstractMixer *pMixer) |
Sets the mixer to a CalAbstractMixer subclass instance. More... | |
CalMorphTargetMixer * | getMorphTargetMixer () const |
Provides access to the morph target mixer. More... | |
CalPhysique * | getPhysique () const |
Provides access to the physique. More... | |
CalRenderer * | getRenderer () const |
Provides access to the renderer. More... | |
CalSkeleton * | getSkeleton () const |
Provides access to the skeleton. More... | |
CalSpringSystem * | getSpringSystem () const |
Provides access to the spring system. More... | |
CalBoundingBox & | getBoundingBox (bool precision=false) |
Returns the global bounding box of the model. More... | |
Cal::UserData | getUserData () const |
Provides access to the user data. More... | |
std::vector< CalMesh * > & | getVectorMesh () |
Returns the mesh vector. More... | |
void | setLodLevel (float lodLevel) |
Sets the LOD level. More... | |
void | setMaterialSet (int setId) |
Sets the material set. More... | |
void | setUserData (Cal::UserData userData) |
Stores user data. More... | |
void | update (float deltaTime) |
Updates the model instance. More... | |
void | disableInternalData () |
Disable internal data (and thus springs system) More... | |
CalModel::CalModel | ( | CalCoreModel * | pCoreModel | ) |
Constructs the model instance.
This function is the default constructor of the model instance.
CalModel::~CalModel | ( | ) |
Destructs the model instance.
This function is the destructor of the model instance.
bool CalModel::attachMesh | ( | int | coreMeshId | ) |
Attachs a mesh.
This function attachs a mesh to the model instance.
coreMeshId | The ID of the mesh that should be attached. |
bool CalModel::detachMesh | ( | int | coreMeshId | ) |
Detaches a mesh.
This function detaches a mesh from the model instance.
coreMeshId | The ID of the mesh that should be detached. |
void CalModel::disableInternalData | ( | ) |
Disable internal data (and thus springs system)
CalAbstractMixer * CalModel::getAbstractMixer | ( | ) | const |
Returns the mixer.
CalBoundingBox & CalModel::getBoundingBox | ( | bool | precision = false | ) |
Returns the global bounding box of the model.
This function returns the global bounding box of the model.
precision | : indicate if the function need to compute a correct bounding box |
CalCoreModel * CalModel::getCoreModel | ( | ) | const |
Provides access to the core model.
This function returns the core model on which this model instance is based on.
CalMesh * CalModel::getMesh | ( | int | coreMeshId | ) | const |
Provides access to an attached mesh.
This function returns the attached mesh with the given core mesh ID.
coreMeshId | The core mesh ID of the mesh that should be returned. |
CalMixer * CalModel::getMixer | ( | ) | const |
Returns the mixer.
If a mixer that is not an instance of CalMixer was set with the CalModel::setAbstractMixer method, an INVALID_MIXER_TYPE error (see CalError) is set and 0 is returned.
CalMorphTargetMixer * CalModel::getMorphTargetMixer | ( | ) | const |
Provides access to the morph target mixer.
This function returns the morph target mixer.
CalPhysique * CalModel::getPhysique | ( | ) | const |
Provides access to the physique.
This function returns the physique.
CalRenderer * CalModel::getRenderer | ( | ) | const |
Provides access to the renderer.
This function returns the renderer.
CalSkeleton * CalModel::getSkeleton | ( | ) | const |
Provides access to the skeleton.
This function returns the skeleton.
CalSpringSystem * CalModel::getSpringSystem | ( | ) | const |
Provides access to the spring system.
This function returns the spring system.
Cal::UserData CalModel::getUserData | ( | ) | const |
Provides access to the user data.
This function returns the user data stored in the model instance.
std::vector< CalMesh * > & CalModel::getVectorMesh | ( | ) |
Returns the mesh vector.
This function returns the vector that contains all attached meshes of the model instance.
void CalModel::setAbstractMixer | ( | CalAbstractMixer * | pMixer | ) |
Sets the mixer to a CalAbstractMixer subclass instance.
If a mixer was already set (with CalModel::setAbstractMixer or because the CalModel::create method created a CalMixer instance), its destroy method is called. The existing mixer is not deallocated, it is the responsibility of the caller to call the getAbstractMixer method and deallocate the returned instance if appropriate.
pMixer will be deallocated by cal3d if and only if the CalModel::destroy function is called.
The create method of pMixer is called.
pMixer may be null. After setting a null pointer, the caller MUST call CalModel::create or CalModel::setAbstractMixer with a non-null pointer before any other method is called.
pMixer | is a pointer to a CalAbstractMixer subclass instance. |
void CalModel::setLodLevel | ( | float | lodLevel | ) |
Sets the LOD level.
This function sets the LOD level of all attached meshes.
lodLevel | The LOD level in the range [0.0, 1.0]. |
void CalModel::setMaterialSet | ( | int | setId | ) |
Sets the material set.
This function sets the material set of all attached meshes.
setId | The ID of the material set. |
void CalModel::setUserData | ( | Cal::UserData | userData | ) |
Stores user data.
This function stores user data in the model instance.
userData | The user data that should be stored. |
void CalModel::update | ( | float | deltaTime | ) |
Updates the model instance.
This function updates the model instance for a given amount of time.
deltaTime | The elapsed time in seconds since the last update. |