- Cal3D 0.11 API Reference -

Public Member Functions | List of all members
CalCoreBone Class 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 & getName ()
 Returns the name. More...
 
int getParentId ()
 Returns the parent ID. More...
 
CalCoreSkeletongetCoreSkeleton ()
 Provides access to the core skeleton. More...
 
const CalQuaterniongetRotation ()
 Returns the rotation. More...
 
const CalQuaterniongetRotationAbsolute ()
 Returns the absolute rotation. More...
 
const CalQuaterniongetRotationBoneSpace ()
 Returns the bone space rotation. More...
 
const CalVectorgetTranslation ()
 Returns the translation. More...
 
const CalVectorgetTranslationAbsolute ()
 Returns the absolute translation. More...
 
const CalVectorgetTranslationBoneSpace ()
 Returns the bone space translation. More...
 
Cal::UserData getUserData ()
 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 calculateBoundingBox (CalCoreModel *pCoreModel)
 Calculates the bounding box. More...
 
CalBoundingBoxgetBoundingBox ()
 Returns the current bounding box. More...
 
void getBoundingData (int planeId, CalVector &position)
 
bool isBoundingBoxPrecomputed ()
 
void scale (float factor)
 Scale the core bone. More...
 

Constructor & Destructor Documentation

CalCoreBone::CalCoreBone ( const std::string &  name)

Constructs the core bone instance.

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

Member Function Documentation

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.

Parameters
childIdThe ID of the core bone ID that shoud be added to the child ID list.
Returns
One of the following values:
  • true if successful
  • false if an error happend
void CalCoreBone::calculateBoundingBox ( CalCoreModel pCoreModel)

Calculates the bounding box.

This function Calculates the bounding box of the core bone instance.

Parameters
pCoreModelThe 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.

Returns
bounding box.
CalCoreSkeleton * CalCoreBone::getCoreSkeleton ( )

Provides access to the core skeleton.

This function returns the core skeleton.

Returns
One of the following values:
  • a pointer to the core skeleton
  • 0 if an error happend
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.

Returns
A reference to the child ID list.
const std::string & CalCoreBone::getName ( void  )

Returns the name.

This function returns the name of the core bone instance.

Returns
The name as string.
int CalCoreBone::getParentId ( )

Returns the parent ID.

This function returns the parent ID of the core bone instance.

Returns
One of the following values:
  • the ID of the parent
  • -1 if the core bone instance is a root core bone
const CalQuaternion & CalCoreBone::getRotation ( )

Returns the rotation.

This function returns the relative rotation of the core bone instance.

Returns
The relative rotation to the parent as quaternion.
const CalQuaternion & CalCoreBone::getRotationAbsolute ( )

Returns the absolute rotation.

This function returns the absolute rotation of the core bone instance.

Returns
The absolute rotation to the parent as quaternion.
const CalQuaternion & CalCoreBone::getRotationBoneSpace ( )

Returns the bone space rotation.

This function returns the rotation to bring a point into the core bone instance space.

Returns
The rotation to bring a point into bone space.
const CalVector & CalCoreBone::getTranslation ( )

Returns the translation.

This function returns the relative translation of the core bone instance.

Returns
The relative translation to the parent as quaternion.
const CalVector & CalCoreBone::getTranslationAbsolute ( )

Returns the absolute translation.

This function returns the absolute translation of the core bone instance.

Returns
The absolute translation to the parent as quaternion.
const CalVector & CalCoreBone::getTranslationBoneSpace ( )

Returns the bone space translation.

This function returns the translation to bring a point into the core bone instance space.

Returns
The translation to bring a point into bone space.
Cal::UserData CalCoreBone::getUserData ( )

Provides access to the user data.

This function returns the user data stored in the core bone instance.

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.

Parameters
factorA 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.

Parameters
pCoreSkeletonThe core skeleton to which the core bone instance should be attached to.
void CalCoreBone::setParentId ( int  parentId)

Sets the parent ID.

This function sets the parent ID of the core bone instance.

Parameters
parentIdThe 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.

Parameters
rotationThe 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.

Parameters
rotationThe 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.

Parameters
translationThe 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.

Parameters
translationThe 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.

Parameters
userDataThe user data that should be stored.

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

Generated at Thu Sep 4 2014 00:32:53 by The Cal3D Team with Doxygen 1.8.7