- Cal3D 0.11 API Reference -

Public Member Functions
CalCoreSkeleton Class Reference
Inheritance diagram for CalCoreSkeleton:
cal3d::RefCounted

List of all members.

Public Member Functions

int addCoreBone (CalCoreBone *pCoreBone)
 Adds a core bone.
void calculateState ()
 Calculates the current state.
CalCoreBonegetCoreBone (int coreBoneId)
 Provides access to a core bone.
CalCoreBonegetCoreBone (const std::string &strName)
 Provides access to a core bone.
int getCoreBoneId (const std::string &strName)
 Returns the ID of a specified core bone.
bool mapCoreBoneName (int coreBoneId, const std::string &strName)
 Maps the name of a bone to a specific bone id.
std::vector< int > & getVectorRootCoreBoneId ()
 Returns the root core bone id list.
std::vector< CalCoreBone * > & getVectorCoreBone ()
 Returns the core bone vector.
void calculateBoundingBoxes (CalCoreModel *pCoreModel)
 Calculates bounding boxes.
void scale (float factor)
 Scale the core skeleton.

Member Function Documentation

int CalCoreSkeleton::addCoreBone ( CalCoreBone pCoreBone)

Adds a core bone.

This function adds a core bone to the core skeleton instance.

Parameters:
pCoreBoneA pointer to the core bone that should be added.
Returns:
One of the following values:
  • the assigned bone ID of the added core bone
  • -1 if an error happend
void CalCoreSkeleton::calculateBoundingBoxes ( CalCoreModel pCoreModel)

Calculates bounding boxes.

This function Calculates the bounding box of every bone in the core Skeleton.

Parameters:
pCoreModelThe coreModel (needed for vertices data).
void CalCoreSkeleton::calculateState ( )

Calculates the current state.

This function calculates the current state of the core skeleton instance by calculating all the core bone states.

CalCoreBone * CalCoreSkeleton::getCoreBone ( const std::string &  strName)

Provides access to a core bone.

This function returns the core bone with the given name.

Parameters:
strNameThe name of the core bone that should be returned.
Returns:
One of the following values:
  • a pointer to the core bone
  • 0 if an error happend
CalCoreBone * CalCoreSkeleton::getCoreBone ( int  coreBoneId)

Provides access to a core bone.

This function returns the core bone with the given ID.

Parameters:
coreBoneIdThe ID of the core bone that should be returned.
Returns:
One of the following values:
  • a pointer to the core bone
  • 0 if an error happend
int CalCoreSkeleton::getCoreBoneId ( const std::string &  strName)

Returns the ID of a specified core bone.

This function returns the ID of a specified core bone.

Parameters:
strNameThe name of the core bone that should be returned.
Returns:
One of the following values:
  • the ID of the core bone
  • -1 if an error happend
std::vector< CalCoreBone * > & CalCoreSkeleton::getVectorCoreBone ( )

Returns the core bone vector.

This function returns the vector that contains all core bones of the core skeleton instance.

Returns:
A reference to the core bone vector.
std::vector< int > & CalCoreSkeleton::getVectorRootCoreBoneId ( )

Returns the root core bone id list.

This function returns the list that contains all root core bone IDs of the core skeleton instance.

Returns:
A reference to the root core bone id list.
bool CalCoreSkeleton::mapCoreBoneName ( int  coreBoneId,
const std::string &  strName 
)

Maps the name of a bone to a specific bone id.

This function returns true or false depending on whether the mapping was successful or not. Note that it is possible to overwrite and existing mapping and no error will be given.

Parameters:
coreBoneIdThe id of the core bone to be associated with the name.
strNameThe name of the core bone that will be associated with the id.
Returns:
One of the following values:
  • true if the mapping was successful
  • false if an invalid ID was given
void CalCoreSkeleton::scale ( float  factor)

Scale the core skeleton.

This function rescale all the data that are in the core skeleton instance.

Parameters:
factorA float with the scale factor

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

Generated at Sat Jul 2 2011 13:53:45 by The Cal3D Team with Doxygen 1.7.4