- Cal3D 0.11 API Reference -

Public Member Functions | List of all members
CalCoreSkeleton Class Reference
Inheritance diagram for CalCoreSkeleton:
cal3d::RefCounted

Public Member Functions

int addCoreBone (CalCoreBone *pCoreBone)
 Adds a core bone. More...
 
void calculateState ()
 Calculates the current state. More...
 
CalCoreBonegetCoreBone (int coreBoneId)
 Provides access to a core bone. More...
 
const CalCoreBonegetCoreBone (int coreBoneId) const
 Provides access to a core bone. More...
 
CalCoreBonegetCoreBone (const std::string &strName)
 Provides access to a core bone. More...
 
const CalCoreBonegetCoreBone (const std::string &strName) const
 Provides access to a core bone. More...
 
int getCoreBoneId (const std::string &strName) const
 Returns the ID of a specified core bone. More...
 
bool mapCoreBoneName (int coreBoneId, const std::string &strName)
 
std::vector< int > & getVectorRootCoreBoneId ()
 
const std::vector< int > & getVectorRootCoreBoneId () const
 
std::vector< CalCoreBone * > & getVectorCoreBone ()
 
const std::vector< CalCoreBone * > & getVectorCoreBone () const
 
void calculateBoundingBoxes (CalCoreModel *pCoreModel)
 
void scale (float factor)
 
unsigned int getNumCoreBones () const
 
void setSceneAmbientColor (CalVector const &color)
 
void getSceneAmbientColor (CalVector &color) const
 
void setName (const std::string &name)
 
const std::string & getName (void) const
 
- Public Member Functions inherited from cal3d::RefCounted
int getRefCount () const
 

Additional Inherited Members

- Protected Member Functions inherited from cal3d::RefCounted
virtual ~RefCounted ()
 Protected so users of refcounted classes don't use std::auto_ptr or the delete operator. More...
 

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 happened
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 ( 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 happened
const CalCoreBone * CalCoreSkeleton::getCoreBone ( int  coreBoneId) const

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 happened
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 happened
const CalCoreBone * CalCoreSkeleton::getCoreBone ( const std::string &  strName) const

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 happened
int CalCoreSkeleton::getCoreBoneId ( const std::string &  strName) const

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 happened

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

Generated by The Cal3D Team with Doxygen 1.8.6