- Cal3D 0.11 API Reference -

Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
CalCoreAnimatedMorph Class Reference

The core animatedMorph class. More...

#include <coreanimatedmorph.h>

Public Member Functions

virtual ~CalCoreAnimatedMorph ()
 Destructs the core animatedMorph instance.
 
const std::string & getName () const
 
void setName (const std::string &name)
 
bool addCoreTrack (CalCoreMorphTrack *pCoreTrack)
 Adds a core track.
 
bool create ()
 Creates the core animatedMorph instance.
 
void destroy ()
 Destroys the core animatedMorph instance.
 
CalCoreMorphTrackgetCoreTrack (const unsigned int &trackId)
 Provides access to a core track.
 
float getDuration () const
 Returns the duration.
 
std::list< CalCoreMorphTrack > & getListCoreTrack ()
 Returns the core track list.
 
const std::list< CalCoreMorphTrack > & getListCoreTrack () const
 Returns the core track list.
 
void setDuration (float duration)
 Sets the duration.
 
void scale (float factor)
 Scale the core animatedMorph.
 
void removeZeroScaleTracks ()
 

Static Public Member Functions

static int getNumCoreAnimatedMorphs ()
 

Protected Attributes

std::string m_name
 
float m_duration
 
std::list< CalCoreMorphTrackm_listCoreTrack
 
std::list< CalCoreMorphTrack * > m_tracksToDelete
 

Detailed Description

The core animatedMorph class.

Constructor & Destructor Documentation

◆ ~CalCoreAnimatedMorph()

CalCoreAnimatedMorph::~CalCoreAnimatedMorph ( )
virtual

Destructs the core animatedMorph instance.

This function is the destructor of the core animatedMorph instance.

Member Function Documentation

◆ addCoreTrack()

bool CalCoreAnimatedMorph::addCoreTrack ( CalCoreMorphTrack * pCoreTrack)

Adds a core track.

This function adds a core track to the core animatedMorph instance.

Parameters
pCoreTrackA pointer to the core track that should be added.
Returns
One of the following values:
  • true if successful
  • false if an error happend

◆ create()

bool CalCoreAnimatedMorph::create ( )

Creates the core animatedMorph instance.

This function creates the core animatedMorph instance.

Returns
One of the following values:
  • true if successful
  • false if an error happend

◆ destroy()

void CalCoreAnimatedMorph::destroy ( )

Destroys the core animatedMorph instance.

This function destroys all data stored in the core animatedMorph instance and frees all allocated memory.

◆ getCoreTrack()

CalCoreMorphTrack * CalCoreAnimatedMorph::getCoreTrack ( const unsigned int & name)

Provides access to a core track.

This function returns the core track for a given bone ID.

Parameters
coreBoneIdThe core bone ID of the core track that should be returned.
Returns
One of the following values:
  • a pointer to the core track
  • 0 if an error happend

◆ getDuration()

float CalCoreAnimatedMorph::getDuration ( ) const

Returns the duration.

This function returns the duration of the core animatedMorph instance.

Returns
The duration in seconds.

◆ getListCoreTrack() [1/2]

std::list< CalCoreMorphTrack > & CalCoreAnimatedMorph::getListCoreTrack ( )

Returns the core track list.

This function returns the list that contains all core tracks of the core animatedMorph instance.

Returns
A reference to the core track list.

◆ getListCoreTrack() [2/2]

const std::list< CalCoreMorphTrack > & CalCoreAnimatedMorph::getListCoreTrack ( ) const

Returns the core track list.

This function returns the list that contains all core tracks of the core animatedMorph instance.

Returns
A reference to the core track list.

◆ scale()

void CalCoreAnimatedMorph::scale ( float factor)

Scale the core animatedMorph.

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

Parameters
factorA float with the scale factor

◆ setDuration()

void CalCoreAnimatedMorph::setDuration ( float duration)

Sets the duration.

This function sets the duration of the core animatedMorph instance.

Parameters
durationThe duration in seconds that should be set.

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

Generated by The Cal3D Team with Doxygen 1.10.0