SLAnimManager Class Reference

SLAnimManager is the central class for all animation handling. More...

#include <SLAnimManager.h>

Public Member Functions
	~SLAnimManager ()
	destructor More...
void	addSkeleton (SLAnimSkeleton *skel)
	Add a skeleton to the skeleton vector. More...
void	addNodeAnimation (SLAnimation *anim)
SLAnimation *	createNodeAnimation (SLfloat duration)
SLAnimation *	createNodeAnimation (const SLstring &name, SLfloat duration)
SLAnimation *	createNodeAnimation (const SLstring &name, SLfloat duration, SLbool enabled, SLEasingCurve easing, SLAnimLooping looping)
SLbool	hasNodeAnimations ()
SLVSkeleton &	skeletons ()
SLMAnimation &	animationNamesMap ()
SLMAnimPlayback &	animPlaybackNamesMap ()
SLVstring &	animationNames ()
SLVAnimPlayback &	animPlaybacks ()
SLAnimPlayback *	animPlaybackByName (const SLstring &name)
	Returns the playback of a node animation or skeleton by name if it exists. More...
SLAnimPlayback *	animPlaybackByIndex (SLuint ix)
SLAnimPlayback *	animPlaybacksBack ()
SLbool	update (SLfloat elapsedTimeSec)
	Advances the time of all enabled animation plays. More...
void	drawVisuals (SLSceneView *sv)
	Draws the animation visualizations. More...
void	clear ()
	Clears and deletes all node animations and skeletons. More...

Private Attributes
SLVSkeleton	_skeletons
	all skeleton instances More...
SLMAnimation	_animationNamesMap
	map name to animation More...
SLMAnimPlayback	_animPlaybackNamesMap
	map name to animation playbacks More...
SLVstring	_animationNames
	vector with all animation names More...
SLVAnimPlayback	_animPlaybacks
	vector with all animation playbacks More...

Detailed Description

SLAnimManager is the central class for all animation handling.

A single instance of this class is hold by the SLScene instance and is responsible for updating the enabled animations and to manage their life time. If keeps a list of all skeletons and node animations and also holds a list of all animation playback controllers. The update of all animations is done before the rendering of all SLSceneView in SLScene::updateIfAllViewsGotPainted by calling the SLAnimManager::update.

Definition at line 26 of file SLAnimManager.h.

Constructor & Destructor Documentation

~SLAnimManager()

SLAnimManager::~SLAnimManager

(

)

destructor

Definition at line 14 of file SLAnimManager.cpp.

{
    clear();
}

Member Function Documentation

addNodeAnimation()

void SLAnimManager::addNodeAnimation

(

SLAnimation *

anim

)

addSkeleton()

void SLAnimManager::addSkeleton

(

SLAnimSkeleton *

skel

)

Add a skeleton to the skeleton vector.

Definition at line 40 of file SLAnimManager.cpp.

{
    _skeletons.push_back(skel);
}

animationNames()

SLVstring& SLAnimManager::animationNames ( )

inline

Definition at line 46 of file SLAnimManager.h.

{ return _animationNames; }

animationNamesMap()

SLMAnimation& SLAnimManager::animationNamesMap ( )

inline

Definition at line 44 of file SLAnimManager.h.

{ return _animationNamesMap; }

animPlaybackByIndex()

SLAnimPlayback* SLAnimManager::animPlaybackByIndex ( SLuint  ix )

inline

Definition at line 49 of file SLAnimManager.h.

{ return _animPlaybacks[ix]; }

animPlaybackByName()

SLAnimPlayback * SLAnimManager::animPlaybackByName

(

const SLstring &

name

)

Returns the playback of a node animation or skeleton by name if it exists.

Definition at line 104 of file SLAnimManager.cpp.

{
    for(auto playback : _animPlaybacks)
    {
        if (playback->parentAnimation()->name() == name)
            return playback;
    }
 
 
    SL_WARN_MSG("*** SLAnimManager::animPlaybackByName: animation not found ***");
    return nullptr;
}

animPlaybackNamesMap()

SLMAnimPlayback& SLAnimManager::animPlaybackNamesMap ( )

inline

Definition at line 45 of file SLAnimManager.h.

{ return _animPlaybackNamesMap; }

animPlaybacks()

SLVAnimPlayback& SLAnimManager::animPlaybacks ( )

inline

Definition at line 47 of file SLAnimManager.h.

{ return _animPlaybacks; }

animPlaybacksBack()

SLAnimPlayback* SLAnimManager::animPlaybacksBack ( )

inline

Definition at line 50 of file SLAnimManager.h.

{ return _animPlaybacks.back(); }

clear()

void SLAnimManager::clear

(

)

Clears and deletes all node animations and skeletons.

Definition at line 21 of file SLAnimManager.cpp.

{
    for (const auto& it : _animationNamesMap)
        delete it.second;
    _animationNamesMap.clear();
 
    for (const auto& it : _animPlaybackNamesMap)
        delete it.second;
    _animPlaybackNamesMap.clear();
 
    for (auto* skeleton : _skeletons)
        delete skeleton;
    _skeletons.clear();
 
    _animationNames.clear();
    _animPlaybacks.clear();
}

createNodeAnimation() [1/3]

SLAnimation * SLAnimManager::createNodeAnimation	(	const SLstring &	name,
		SLfloat	duration
	)

Creates a new node animation

Parameters

name	the animation name
duration	length of the animation

Definition at line 84 of file SLAnimManager.cpp.

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

createNodeAnimation() [2/3]

SLAnimation * SLAnimManager::createNodeAnimation	(	const SLstring &	name,
		SLfloat	duration,
		SLbool	enabled,
		SLEasingCurve	easing,
		SLAnimLooping	looping
	)

Creates new SLAnimation istance for node animations. It will already create and set parameters for the respective SLAnimPlayback.

Definition at line 66 of file SLAnimManager.cpp.

{
    SLAnimation*    anim     = createNodeAnimation(name, duration);
    SLAnimPlayback* playback = animPlaybackByName(name);
    playback->enabled(enabled);
    playback->easing(easing);
    playback->loop(looping);
    return anim;
}

createNodeAnimation() [3/3]

SLAnimation * SLAnimManager::createNodeAnimation

(

SLfloat

duration

)

Creates a new node animation

Parameters

duration

length of the animation

Definition at line 48 of file SLAnimManager.cpp.

{
    SLuint             index = (SLuint)_animationNamesMap.size();
    std::ostringstream oss;
 
    do
    {
        oss.clear();
        oss << "Node_" << index;
        index++;
    } while (_animationNamesMap.find(oss.str()) != _animationNamesMap.end());
 
    return createNodeAnimation(oss.str(), duration);
}

drawVisuals()

void SLAnimManager::drawVisuals

(

SLSceneView *

sv

)

Draws the animation visualizations.

Definition at line 153 of file SLAnimManager.cpp.

{
    for (const auto& it : _animPlaybackNamesMap)
    {
        SLAnimPlayback* playback = it.second;
        playback->parentAnimation()->drawNodeVisuals(sv);
    }
 
    // skeletons are drawn from within SLSceneView per node
}

hasNodeAnimations()

SLbool SLAnimManager::hasNodeAnimations ( )

inline

Definition at line 41 of file SLAnimManager.h.

{ return (_animationNamesMap.size() > 0); }

skeletons()

SLVSkeleton& SLAnimManager::skeletons ( )

inline

Definition at line 43 of file SLAnimManager.h.

{ return _skeletons; }

update()

SLbool SLAnimManager::update

(

SLfloat

elapsedTimeSec

)

Advances the time of all enabled animation plays.

Definition at line 118 of file SLAnimManager.cpp.

{
    // reset the dirty flag on all skeletons
    for (auto* skeleton : _skeletons)
        skeleton->changed(false);
 
    SLbool updated = false;
 
    // advance time for node animations and apply them
    // @todo currently we can't blend between normal node animations because we
    // reset them per animation playback. so the last playback that affects a
    // node will have its animation applied.
    // We need to save the playback differently if we want to blend them.
 
    for (const auto& it : _animPlaybackNamesMap)
    {
        SLAnimPlayback* playback = it.second;
        if (playback->enabled())
        {
            playback->parentAnimation()->resetNodes();
            playback->advanceTime(elapsedTimeSec);
            playback->parentAnimation()->apply(playback->localTime(),
                                               playback->weight());
            updated = true;
        }
    }
 
    // update the skeletons separately
    for (auto* skeleton : _skeletons)
        updated |= skeleton->updateAnimations(elapsedTimeSec);
 
    return updated;
}

Member Data Documentation

_animationNames

SLVstring SLAnimManager::_animationNames

private

vector with all animation names

Definition at line 60 of file SLAnimManager.h.

_animationNamesMap

SLMAnimation SLAnimManager::_animationNamesMap

private

map name to animation

Definition at line 58 of file SLAnimManager.h.

_animPlaybackNamesMap

SLMAnimPlayback SLAnimManager::_animPlaybackNamesMap

private

map name to animation playbacks

Definition at line 59 of file SLAnimManager.h.

_animPlaybacks

SLVAnimPlayback SLAnimManager::_animPlaybacks

private

vector with all animation playbacks

Definition at line 61 of file SLAnimManager.h.

_skeletons

SLVSkeleton SLAnimManager::_skeletons

private

all skeleton instances

Definition at line 57 of file SLAnimManager.h.

---

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

• SLAnimManager.h
• SLAnimManager.cpp