- Cal3D 0.11 API Reference - |
Public Member Functions | |
CalCoreBone (const std::string &name) | |
Constructs the core bone instance. More... | |
bool | addChildId (int childId) |
Adds a child ID. More... | |
void | calculateState () |
Calculates the current state. More... | |
std::list< int > & | getListChildId () |
Returns the child ID list. More... | |
const std::string & | getNameInternal () |
void | setNameInternal (std::string &str) |
const std::list< int > & | getListChildId () const |
Returns the child ID list. More... | |
const std::string & | getName () const |
Returns the name. More... | |
void | setName (const std::string &name) |
Sets the name. More... | |
int | getParentId () const |
Returns the parent ID. More... | |
void | setName (char const *str) |
CalCoreSkeleton * | getCoreSkeleton () |
Provides access to the core skeleton. More... | |
const CalCoreSkeleton * | getCoreSkeleton () const |
Provides access to the core skeleton. More... | |
const CalQuaternion & | getRotation () const |
Returns the rotation. More... | |
const CalQuaternion & | getRotationAbsolute () const |
Returns the absolute rotation. More... | |
const CalQuaternion & | getRotationBoneSpace () const |
Returns the bone space rotation. More... | |
const CalVector & | getTranslation () const |
Returns the translation. More... | |
const CalVector & | getTranslationAbsolute () const |
Returns the absolute translation. More... | |
const CalVector & | getTranslationBoneSpace () const |
Returns the bone space translation. More... | |
Cal::UserData | getUserData () |
Provides access to the user data. More... | |
const Cal::UserData | getUserData () const |
Provides access to the user data. More... | |
void | setCoreSkeleton (CalCoreSkeleton *pCoreSkeleton) |
Sets the core skeleton. More... | |
void | setParentId (int parentId) |
Sets the parent ID. More... | |
void | setRotation (const CalQuaternion &rotation) |
Sets the rotation. More... | |
void | setRotationBoneSpace (const CalQuaternion &rotation) |
Sets the bone space rotation. More... | |
void | setTranslation (const CalVector &translation) |
Sets the translation. More... | |
void | setTranslationBoneSpace (const CalVector &translation) |
Sets the bone space translation. More... | |
void | setUserData (Cal::UserData userData) |
Stores user data. More... | |
void | initBoundingBox () |
void | calculateBoundingBox (CalCoreModel *pCoreModel) |
Calculates the bounding box. More... | |
CalBoundingBox & | getBoundingBox () |
Returns the current bounding box. More... | |
const CalBoundingBox & | getBoundingBox () const |
Returns the current bounding box. More... | |
void | getBoundingData (int planeId, CalVector &position) const |
bool | isBoundingBoxPrecomputed () const |
void | setBoundingBoxPrecomputed (bool inComputed) |
bool | updateBoundingBox (const CalVector &position) |
Updates the bounding box to include the given position. More... | |
void | scale (float factor) |
Scale the core bone. More... | |
bool | hasLightingData () |
void | getLightColor (CalVector &) |
void | setLightColor (CalVector const &) |
CalLightType | getLightType () |
void | setLightType (CalLightType) |
CalCoreBone::CalCoreBone | ( | const std::string & | name | ) |
Constructs the core bone instance.
This function is the default constructor of the core bone instance.
bool CalCoreBone::addChildId | ( | int | childId | ) |
Adds a child ID.
This function adds a core bone ID to the child ID list of the core bone instance.
childId | The ID of the core bone ID that shoud be added to the child ID list. |
void CalCoreBone::calculateBoundingBox | ( | CalCoreModel * | pCoreModel | ) |
Calculates the bounding box.
This function Calculates the bounding box of the core bone instance.
pCoreModel | The coreModel (needed for vertices data. |
void CalCoreBone::calculateState | ( | ) |
Calculates the current state.
This function calculates the current state (absolute translation and rotation) of the core bone instance and all its children.
CalBoundingBox & CalCoreBone::getBoundingBox | ( | ) |
Returns the current bounding box.
This function returns the current bounding box of the core bone instance.
const CalBoundingBox & CalCoreBone::getBoundingBox | ( | ) | const |
Returns the current bounding box.
This function returns the current bounding box of the core bone instance.
CalCoreSkeleton * CalCoreBone::getCoreSkeleton | ( | ) |
Provides access to the core skeleton.
This function returns the core skeleton.
const CalCoreSkeleton * CalCoreBone::getCoreSkeleton | ( | ) | const |
Provides access to the core skeleton.
This function returns the core skeleton.
std::list< int > & CalCoreBone::getListChildId | ( | ) |
Returns the child ID list.
This function returns the list that contains all child IDs of the core bone instance.
const std::list< int > & CalCoreBone::getListChildId | ( | ) | const |
Returns the child ID list.
This function returns the list that contains all child IDs of the core bone instance.
const std::string & CalCoreBone::getName | ( | void | ) | const |
Returns the name.
This function returns the name of the core bone instance.
int CalCoreBone::getParentId | ( | ) | const |
Returns the parent ID.
This function returns the parent ID of the core bone instance.
const CalQuaternion & CalCoreBone::getRotation | ( | ) | const |
Returns the rotation.
This function returns the relative rotation of the core bone instance.
const CalQuaternion & CalCoreBone::getRotationAbsolute | ( | ) | const |
Returns the absolute rotation.
This function returns the absolute rotation of the core bone instance.
const CalQuaternion & CalCoreBone::getRotationBoneSpace | ( | ) | const |
Returns the bone space rotation.
This function returns the rotation to bring a point into the core bone instance space.
const CalVector & CalCoreBone::getTranslation | ( | ) | const |
Returns the translation.
This function returns the relative translation of the core bone instance.
const CalVector & CalCoreBone::getTranslationAbsolute | ( | ) | const |
Returns the absolute translation.
This function returns the absolute translation of the core bone instance.
const CalVector & CalCoreBone::getTranslationBoneSpace | ( | ) | const |
Returns the bone space translation.
This function returns the translation to bring a point into the core bone instance space.
Cal::UserData CalCoreBone::getUserData | ( | ) |
Provides access to the user data.
This function returns the user data stored in the core bone instance.
const Cal::UserData CalCoreBone::getUserData | ( | ) | const |
Provides access to the user data.
This function returns the user data stored in the core bone instance.
void CalCoreBone::scale | ( | float | factor | ) |
Scale the core bone.
This function rescale all the data that are in the core bone instance and in his childs.
factor | A float with the scale factor |
void CalCoreBone::setCoreSkeleton | ( | CalCoreSkeleton * | pCoreSkeleton | ) |
Sets the core skeleton.
This function sets the core skeleton to which the core bone instance is attached to.
pCoreSkeleton | The core skeleton to which the core bone instance should be attached to. |
void CalCoreBone::setName | ( | const std::string & | name | ) |
Sets the name.
This function sets the name of the core bone instance.
strName | A string that should be used as the name of the core bone instance. |
void CalCoreBone::setParentId | ( | int | parentId | ) |
Sets the parent ID.
This function sets the parent ID of the core bone instance.
parentId | The ID of the parent that should be set. |
void CalCoreBone::setRotation | ( | const CalQuaternion & | rotation | ) |
Sets the rotation.
This function sets the relative rotation of the core bone instance.
rotation | The relative rotation to the parent as quaternion. |
void CalCoreBone::setRotationBoneSpace | ( | const CalQuaternion & | rotation | ) |
Sets the bone space rotation.
This function sets the rotation that brings a point into the core bone instance space.
rotation | The rotation that brings a point into bone space. |
void CalCoreBone::setTranslation | ( | const CalVector & | translation | ) |
Sets the translation.
This function sets the relative translation of the core bone instance.
translation | The relative translation to the parent as vector. |
void CalCoreBone::setTranslationBoneSpace | ( | const CalVector & | translation | ) |
Sets the bone space translation.
This function sets the translation that brings a point into the core bone instance space.
translation | The translation that brings a point into bone space. |
void CalCoreBone::setUserData | ( | Cal::UserData | userData | ) |
Stores user data.
This function stores user data in the core bone instance.
userData | The user data that should be stored. |
bool CalCoreBone::updateBoundingBox | ( | const CalVector & | position | ) |
Updates the bounding box to include the given position.
This function Updates the bounding box of the core bone instance to include a given position.
position | The position to be included in the bounding box |