SLAnimSkeleton keeps track of a skeletons joints and animations. More...

#include <SLAnimSkeleton.h>

Public Member Functions
	SLAnimSkeleton ()

	~SLAnimSkeleton ()

SLJoint *	createJoint (SLuint id)

SLJoint *	createJoint (const SLstring &name, SLuint id)

SLAnimation *	createAnimation (SLAnimManager &aniMan, const SLstring &name, SLfloat duration)

void	loadAnimation (const SLstring &file)

void	addAnimation (SLAnimation *anim)

void	getJointMatrices (SLVMat4f &jointWM)

void	reset ()

SLAnimPlayback *	animPlayback (const SLstring &name)

SLMAnimation	animations ()

SLint	numAnimations () const

SLJoint *	getJoint (SLuint id)

SLJoint *	getJoint (const SLstring &name)

SLint	numJoints () const

const SLVJoint &	joints () const

SLJoint *	rootJoint ()

SLbool	changed () const

const SLVec3f &	minOS ()

const SLVec3f &	maxOS ()

void	rootJoint (SLJoint *joint)

void	changed (SLbool changed)

SLbool	updateAnimations (SLfloat elapsedTimeSec)

Protected Member Functions
void	updateMinMax ()

Protected Attributes
SLJoint *	_rootJoint
	pointer to the root joint of skeleton More...

SLVJoint	_joints
	joint vector for fast access and index to joint mapping More...

SLMAnimation	_animations
	map of animations for this skeleton More...

SLMAnimPlayback	_animPlaybacks
	map of animation playbacks for this skeleton More...

SLbool	_changed
	did this skeleton change this frame (attribute for skeleton instance) More...

SLVec3f	_minOS
	min point in os for this skeleton (attribute for skeleton instance) More...

SLVec3f	_maxOS
	max point in os for this skeleton (attribute for skeleton instance) More...

SLbool	_minMaxOutOfDate
	dirty flag aabb rebuild More...

Detailed Description

SLAnimSkeleton keeps track of a skeletons joints and animations.

An SLAnimSkeleton is used to animate a hierarchical object like a human being. An SLAnimSkeleton keeps track of its bones (SLJoints) in a tree structure and points with _root to the root node of the skeleton hierarchy. An SLAnimSkeleton is not actively transforming any SLNode in the scenegraph. It just keeps track of its transformed SLJoint. A mesh that is associated with a skeleton transforms all its vertices every frame by the joint weights. Every vertex of a mesh has weights for four joints by which it can be influenced.

SLAnimations for this skeleton are also kept in this class. The SLAnimations have tracks corresponding to the individual SLJoints in the skeleton.

Note: The current implementation doesn't support multiple instances of the same skeleton animation. It is however not that far away from supporting it. Currently the SLAnimSkeleton class keeps both a SLAnimation map and an SLAnimPlayback map. We can split this into two classes by creating an SLSkeletonInstance class we that keeps the SLAnimPlayback map that references its parent SLAnimSkeleton we would be able to create multiple SLSkeletonInstance instances that use the same SLAnimations but with different states.

This leaves the problem of SLMesh that is not able to be instantiated without copying the data into a completely separate SLMesh. But the solution for SLMesh would take the same approach by creating a mesh instance class that is able to use SLSkeletonInstance.

Note: The current version of the SLAssimpImporter only supports the loading of a single animation. This limitation is mainly because there are very few 3D programs that make use of the possibility to export multiple animations in a single file. This means we would need to extend our importer to be able to load more animations for an already loaded skeleton.

Definition at line 54 of file SLAnimSkeleton.h.

Constructor & Destructor Documentation

◆ SLAnimSkeleton()

SLAnimSkeleton::SLAnimSkeleton ( )

Constructor

Definition at line 17 of file SLAnimSkeleton.cpp.

                                : _rootJoint(nullptr),
                                    _minOS(-1, -1, -1),
                                    _maxOS(1, 1, 1),
                                    _minMaxOutOfDate(true)
 {
 }

◆ ~SLAnimSkeleton()

SLAnimSkeleton::~SLAnimSkeleton ( )

Destructor

Definition at line 27 of file SLAnimSkeleton.cpp.

 {
     delete _rootJoint;
     for (auto it : _animations) delete it.second;
     for (auto it : _animPlaybacks) delete it.second;
 }

Member Function Documentation

◆ addAnimation()

void SLAnimSkeleton::addAnimation ( SLAnimation * anim )

◆ animations()

SLMAnimation SLAnimSkeleton::animations ( )

inline

Definition at line 71 of file SLAnimSkeleton.h.

71 { return _animations; }

◆ animPlayback()

SLAnimPlayback * SLAnimSkeleton::animPlayback ( const SLstring & name )

Returns an animation state by name.

Definition at line 62 of file SLAnimSkeleton.cpp.

 {
     if (_animPlaybacks.find(name) != _animPlaybacks.end())
         return _animPlaybacks[name];
     SL_WARN_MSG("*** Playback found in SLAnimSkeleton::getNodeAnimPlayack ***");
     return nullptr;
 }

◆ changed() [1/2]

SLbool SLAnimSkeleton::changed ( ) const

inline

Definition at line 78 of file SLAnimSkeleton.h.

78 { return _changed; }

SLAnimSkeleton::_changed

SLbool _changed

did this skeleton change this frame (attribute for skeleton instance)

Definition: SLAnimSkeleton.h:99

◆ changed() [2/2]

void SLAnimSkeleton::changed ( SLbool changed )

inline

Definition at line 84 of file SLAnimSkeleton.h.

     {
         _changed         = changed;
         _minMaxOutOfDate = true;
     }

◆ createAnimation()

SLAnimation * SLAnimSkeleton::createAnimation	(	SLAnimManager &	aniMan,
		const SLstring &	name,
		SLfloat	duration
	)

Create a nw animation owned by this skeleton.

Definition at line 99 of file SLAnimSkeleton.cpp.

 {
     assert(_animations.find(name) == _animations.end() &&
            "animation with same name already exists!");
  
     SLAnimation* anim = new SLAnimation(name, duration);
     _animations[name] = anim;
  
     SLAnimPlayback* play = new SLAnimPlayback(anim);
     _animPlaybacks[name] = play;
  
     // Add node animation to the combined vector
     aniMan.animationNames().push_back(name);
     aniMan.animPlaybacks().push_back(play);
  
     return anim;
 }

◆ createJoint() [1/2]

SLJoint * SLAnimSkeleton::createJoint	(	const SLstring &	name,
		SLuint	id
	)

Creates a new joint owned by this skeleton.

Definition at line 45 of file SLAnimSkeleton.cpp.

 {
     SLJoint* result = new SLJoint(name, id, this);
  
     assert((id >= _joints.size() ||
             (id < _joints.size() && _joints[id] == nullptr)) &&
            "Trying to create a joint with an already existing id.");
  
     if (_joints.size() <= id)
         _joints.resize(id + 1);
  
     _joints[id] = result;
     return result;
 }

◆ createJoint() [2/2]

SLJoint * SLAnimSkeleton::createJoint ( SLuint id )

Creates a new joint owned by this skeleton with a default name.

Definition at line 36 of file SLAnimSkeleton.cpp.

 {
     std::ostringstream oss;
     oss << "Joint " << id;
     return createJoint(oss.str(), id);
 }

◆ getJoint() [1/2]

SLJoint * SLAnimSkeleton::getJoint ( const SLstring & name )

returns an SLJoint by name.

Definition at line 80 of file SLAnimSkeleton.cpp.

 {
     if (!_rootJoint) return nullptr;
     SLJoint* result = _rootJoint->find<SLJoint>(name);
     return result;
 }

◆ getJoint() [2/2]

SLJoint * SLAnimSkeleton::getJoint ( SLuint id )

Returns an SLJoint by it's internal id.

Definition at line 72 of file SLAnimSkeleton.cpp.

 {
     assert(id < _joints.size() && "Index out of bounds");
     return _joints[id];
 }

◆ getJointMatrices()

void SLAnimSkeleton::getJointMatrices ( SLVMat4f & jointWM )

Fills a SLMat4f array with the final joint matrices for this skeleton.

Definition at line 89 of file SLAnimSkeleton.cpp.

 {
     for (SLuint i = 0; i < _joints.size(); i++)
     {
         jointWM[i] = _joints[i]->updateAndGetWM() * _joints[i]->offsetMat();
     }
 }

◆ joints()

const SLVJoint& SLAnimSkeleton::joints ( ) const

inline

Definition at line 76 of file SLAnimSkeleton.h.

76 { return _joints; }

◆ loadAnimation()

void SLAnimSkeleton::loadAnimation ( const SLstring & file )

◆ maxOS()

const SLVec3f & SLAnimSkeleton::maxOS ( )

getter for current the current max object space vertex.

Definition at line 173 of file SLAnimSkeleton.cpp.

 {
     if (_minMaxOutOfDate)
         updateMinMax();
  
     return _maxOS;
 }

◆ minOS()

const SLVec3f & SLAnimSkeleton::minOS ( )

getter for current the current min object space vertex.

Definition at line 163 of file SLAnimSkeleton.cpp.

 {
     if (_minMaxOutOfDate)
         updateMinMax();
  
     return _minOS;
 }

◆ numAnimations()

SLint SLAnimSkeleton::numAnimations ( ) const

inline

Definition at line 72 of file SLAnimSkeleton.h.

72 { return (SLint)_animations.size(); }

SLint

int SLint

Definition: SL.h:170

◆ numJoints()

SLint SLAnimSkeleton::numJoints ( ) const

inline

Definition at line 75 of file SLAnimSkeleton.h.

75 { return (SLint)_joints.size(); }

◆ reset()

void SLAnimSkeleton::reset ( )

Resets all joints.

Definition at line 119 of file SLAnimSkeleton.cpp.

 {
     // update all joints
     for (auto j : _joints)
         j->resetToInitialState();
 }

◆ rootJoint() [1/2]

SLJoint* SLAnimSkeleton::rootJoint ( )

inline

Definition at line 77 of file SLAnimSkeleton.h.

77 { return _rootJoint; }

◆ rootJoint() [2/2]

void SLAnimSkeleton::rootJoint ( SLJoint * joint )

inline

Definition at line 83 of file SLAnimSkeleton.h.

83 { _rootJoint = joint; }

◆ updateAnimations()

SLbool SLAnimSkeleton::updateAnimations ( SLfloat elapsedTimeSec )

Updates the skeleton based on its active animation states

Definition at line 128 of file SLAnimSkeleton.cpp.

 {
     SLbool animated = false;
  
     for (auto it : _animPlaybacks)
     {
         SLAnimPlayback* pb = it.second;
         if (pb->enabled())
         {
             pb->advanceTime(elapsedTimeSec);
             animated |= pb->changed();
         }
     }
  
     // return if nothing changed
     if (!animated)
         return false;
  
     // reset the skeleton and apply all enabled animations
     reset();
  
     for (auto it : _animPlaybacks)
     {
         SLAnimPlayback* pb = it.second;
         if (pb->enabled())
         {
             pb->parentAnimation()->apply(this, pb->localTime(), pb->weight());
             pb->changed(false); // remove changed dirty flag from the pb again
         }
     }
     return true;
 }

◆ updateMinMax()

void SLAnimSkeleton::updateMinMax ( )

protected

Calculate the current min and max values in local space based on joint radii.

Definition at line 184 of file SLAnimSkeleton.cpp.

 {
     // recalculate the new min and max os based on bone radius
     SLbool firstSet = false;
     for (auto joint : _joints)
     {
         SLfloat r = joint->radius();
  
         // ignore joints with a zero radius
         if (r == 0.0f)
             continue;
  
         SLVec3f jointPos = joint->updateAndGetWM().translation();
         SLVec3f curMin   = jointPos - SLVec3f(r, r, r);
         SLVec3f curMax   = jointPos + SLVec3f(r, r, r);
  
         if (!firstSet)
         {
             _minOS   = curMin;
             _maxOS   = curMax;
             firstSet = true;
         }
         else
         {
             _minOS.x = std::min(_minOS.x, curMin.x);
             _minOS.y = std::min(_minOS.y, curMin.y);
             _minOS.z = std::min(_minOS.z, curMin.z);
  
             _maxOS.x = std::max(_maxOS.x, curMax.x);
             _maxOS.y = std::max(_maxOS.y, curMax.y);
             _maxOS.z = std::max(_maxOS.z, curMax.z);
         }
     }
     _minMaxOutOfDate = false;
 }

Member Data Documentation

◆ _animations

SLMAnimation SLAnimSkeleton::_animations

protected

map of animations for this skeleton

Definition at line 97 of file SLAnimSkeleton.h.

◆ _animPlaybacks

SLMAnimPlayback SLAnimSkeleton::_animPlaybacks

protected

map of animation playbacks for this skeleton

Definition at line 98 of file SLAnimSkeleton.h.

◆ _changed

SLbool SLAnimSkeleton::_changed

protected

did this skeleton change this frame (attribute for skeleton instance)

Definition at line 99 of file SLAnimSkeleton.h.

◆ _joints

SLVJoint SLAnimSkeleton::_joints

protected

joint vector for fast access and index to joint mapping

Definition at line 96 of file SLAnimSkeleton.h.

◆ _maxOS

SLVec3f SLAnimSkeleton::_maxOS

protected

max point in os for this skeleton (attribute for skeleton instance)

Definition at line 101 of file SLAnimSkeleton.h.

◆ _minMaxOutOfDate

SLbool SLAnimSkeleton::_minMaxOutOfDate

protected

dirty flag aabb rebuild

Definition at line 102 of file SLAnimSkeleton.h.

◆ _minOS

SLVec3f SLAnimSkeleton::_minOS

protected

min point in os for this skeleton (attribute for skeleton instance)

Definition at line 100 of file SLAnimSkeleton.h.

◆ _rootJoint

SLJoint* SLAnimSkeleton::_rootJoint

protected

pointer to the root joint of skeleton

Definition at line 95 of file SLAnimSkeleton.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SLAnimSkeleton()

◆ ~SLAnimSkeleton()

Member Function Documentation

◆ addAnimation()

◆ animations()

◆ animPlayback()

◆ changed() [1/2]

◆ changed() [2/2]

◆ createAnimation()

◆ createJoint() [1/2]

◆ createJoint() [2/2]

◆ getJoint() [1/2]

◆ getJoint() [2/2]

◆ getJointMatrices()

◆ joints()

◆ loadAnimation()

◆ maxOS()

◆ minOS()

◆ numAnimations()

◆ numJoints()

◆ reset()

◆ rootJoint() [1/2]

◆ rootJoint() [2/2]

◆ updateAnimations()

◆ updateMinMax()

Member Data Documentation

◆ _animations

◆ _animPlaybacks

◆ _changed

◆ _joints

◆ _maxOS

◆ _minMaxOutOfDate

◆ _minOS

◆ _rootJoint