SLAnimation Class Reference

SLAnimation is the base container for all animation data. More...

#include <SLAnimation.h>

Public Member Functions
	SLAnimation (const SLstring &name, SLfloat duration)
	~SLAnimation ()
SLfloat	nextKeyframeTime (SLfloat time)
SLfloat	prevKeyframeTime (SLfloat time)
SLbool	affectsNode (SLNode *node)
void	apply (SLfloat time, SLfloat weight=1.0f, SLfloat scale=1.0f)
void	applyToNode (SLNode *node, SLfloat time, SLfloat weight=1.0f, SLfloat scale=1.0f)
void	apply (SLAnimSkeleton *skel, SLfloat time, SLfloat weight=1.0f, SLfloat scale=1.0f)
void	resetNodes ()
void	drawNodeVisuals (SLSceneView *sv)
SLNodeAnimTrack *	createNodeAnimTrack ()
SLNodeAnimTrack *	createNodeAnimTrack (SLuint trackID)
SLNodeAnimTrack *	createNodeAnimTrackForTranslation (SLNode *target, const SLVec3f &endPos)
SLNodeAnimTrack *	createNodeAnimTrackForRotation (SLNode *target, SLfloat angleDeg1, const SLVec3f &axis)
SLNodeAnimTrack *	createNodeAnimTrackForRotation2 (SLNode *target, SLfloat angleDeg0, SLfloat angleDeg1, const SLVec3f &axis)
SLNodeAnimTrack *	createNodeAnimTrackForRotation3 (SLNode *target, SLfloat angleDeg0, SLfloat angleDeg1, SLfloat angleDeg2, const SLVec3f &axis)
SLNodeAnimTrack *	createNodeAnimTrackForRotation4 (SLNode *target, SLfloat angleDeg0, SLfloat angleDeg1, SLfloat angleDeg2, SLfloat angleDeg3, const SLVec3f &axis)
SLNodeAnimTrack *	createNodeAnimTrackForRotation360 (SLNode *target, const SLVec3f &axis)
SLNodeAnimTrack *	createNodeAnimTrackForScaling (SLNode *target, const SLVec3f &endScale)
SLNodeAnimTrack *	createNodeAnimTrackForEllipse (SLNode *target, SLfloat radiusA, SLAxis axisA, SLfloat radiusB, SLAxis axisB)
const SLstring &	name ()
SLfloat	lengthSec () const
void	name (const SLstring &name)
void	lengthSec (SLfloat lengthSec)

Protected Attributes
SLstring	_name
	name of the animation More...
SLfloat	_lengthSec
	duration of the animation in seconds More...
SLMNodeAnimTrack	_nodeAnimTracks
	map of all the node tracks in this animation More...

Detailed Description

SLAnimation is the base container for all animation data.

SLAnimation is a container for multiple SLAnimTrack that build an animation. E.g. a walk animation would consist of all the SLAnimTrack that make a SLAnimSkeleton walk. It also knows the length of the animation.

An animation for a SLAnimSkeleton with n joints must consist of 1 to n SLNodeAnimTrack. The SLAnimation class keeps a map with index -> SLNodeAnimTrack pairs, the index for the SLNodeAnimTrack must match the index of a bone in the target SLAnimSkeleton. This method allows us to animate multiple identical, or similar SLSkeletons with the same SLAnimation.

Definition at line 32 of file SLAnimation.h.

Constructor & Destructor Documentation

SLAnimation()

SLAnimation::SLAnimation	(	const SLstring &	name,
		SLfloat	duration
	)

Constructor

Definition at line 16 of file SLAnimation.cpp.

  : _name(name), _lengthSec(duration)
{
}

~SLAnimation()

SLAnimation::~SLAnimation

(

)

Destructor

Definition at line 23 of file SLAnimation.cpp.

{
    for (auto it : _nodeAnimTracks)
        delete it.second;
}

Member Function Documentation

affectsNode()

SLbool SLAnimation::affectsNode

(

SLNode *

node

)

Returns true if node is the animationTarget of any of the SLNodeAnimationTracks in this animation.

Definition at line 83 of file SLAnimation.cpp.

{
    for (auto it : _nodeAnimTracks)
        if (it.second->animatedNode() == node)
            return true;
 
    return false;
}

apply() [1/2]

void SLAnimation::apply	(	SLAnimSkeleton *	skel,
		SLfloat	time,
		SLfloat	weight = 1.0f,
		SLfloat	scale = 1.0f
	)

Applies all the tracks to their respective joints in the passed in skeleton.

Definition at line 140 of file SLAnimation.cpp.

{
    for (auto it : _nodeAnimTracks)
    {
        SLJoint* joint = skel->getJoint(it.first);
        it.second->applyToNode(joint, time, weight, scale);
    }
}

apply() [2/2]

void SLAnimation::apply	(	SLfloat	time,
		SLfloat	weight = 1.0f,
		SLfloat	scale = 1.0f
	)

Applies all animation tracks for the passed in timestamp, weight and scale.

Definition at line 121 of file SLAnimation.cpp.

{
    for (auto it : _nodeAnimTracks)
        it.second->apply(time, weight, scale);
}

applyToNode()

void SLAnimation::applyToNode	(	SLNode *	node,
		SLfloat	time,
		SLfloat	weight = 1.0f,
		SLfloat	scale = 1.0f
	)

Applies all node tracks of this animation on a single node

Definition at line 129 of file SLAnimation.cpp.

{
    for (auto it : _nodeAnimTracks)
        it.second->applyToNode(node, time, weight, scale);
}

createNodeAnimTrack() [1/2]

SLNodeAnimTrack * SLAnimation::createNodeAnimTrack

(

)

Creates a new SLNodeAnimationTrack with the next free handle.

Definition at line 94 of file SLAnimation.cpp.

{
    SLuint freeIndex = 0;
 
    auto it = _nodeAnimTracks.begin();
    for (; it != _nodeAnimTracks.end() && freeIndex == it->first; ++it, ++freeIndex)
    {
    }
 
    return createNodeAnimTrack(freeIndex);
}

createNodeAnimTrack() [2/2]

SLNodeAnimTrack * SLAnimation::createNodeAnimTrack

(

SLuint

trackID

)

Creates a new SLNodeAnimationTrack with the passed in track id.

Definition at line 108 of file SLAnimation.cpp.

{
    // track with same handle already exists
    if (_nodeAnimTracks.find(trackID) != _nodeAnimTracks.end())
        return nullptr;
 
    _nodeAnimTracks[trackID] = new SLNodeAnimTrack(this);
 
    return _nodeAnimTracks[trackID];
}

createNodeAnimTrackForEllipse()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForEllipse	(	SLNode *	target,
		SLfloat	radiusA,
		SLAxis	axisA,
		SLfloat	radiusB,
		SLAxis	axisB
	)

Specialized SLNodeAnimationTrack creator for an elliptic node animation

Definition at line 309 of file SLAnimation.cpp.

{
    assert(axisA != axisB && radiusA > 0 && radiusB > 0);
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
 
    /* The ellipse is defined by 5 keyframes: A,B,C,D and again A
 
        c2----B----c1
    c3                 c0
    |                   |
    |         |         |
    C       --0--       A
    |         |         |
    |                   |
    c4                 c7
        c5----D----c6
    */
 
    SLVec3f A(0, 0, 0);
    A.comp[axisA] = radiusA;
    SLVec3f B(0, 0, 0);
    B.comp[axisB] = radiusB;
    SLVec3f C(0, 0, 0);
    C.comp[axisA] = -radiusA;
    SLVec3f D(0, 0, 0);
    D.comp[axisB] = -radiusB;
 
    // Control points with the magic factor kappa for control points
    SLfloat k = 0.5522847498f;
 
    SLVVec3f controls;
    controls.resize(8);
    for (SLuint i = 0; i < controls.size(); ++i)
        controls[i].set(0, 0, 0);
    controls[0].comp[axisA] = radiusA;
    controls[0].comp[axisB] = k * radiusB;
    controls[1].comp[axisB] = radiusB;
    controls[1].comp[axisA] = k * radiusA;
    controls[2].comp[axisB] = radiusB;
    controls[2].comp[axisA] = k * -radiusA;
    controls[3].comp[axisA] = -radiusA;
    controls[3].comp[axisB] = k * radiusB;
    controls[4].comp[axisA] = -radiusA;
    controls[4].comp[axisB] = k * -radiusB;
    controls[5].comp[axisB] = -radiusB;
    controls[5].comp[axisA] = k * -radiusA;
    controls[6].comp[axisB] = -radiusB;
    controls[6].comp[axisA] = k * radiusA;
    controls[7].comp[axisA] = radiusA;
    controls[7].comp[axisB] = k * -radiusB;
 
    // Add keyframes
    SLfloat t4 = lengthSec() / 4.0f;
    track->createNodeKeyframe(0.0f * t4)->translation(A);
    track->createNodeKeyframe(1.0f * t4)->translation(B);
    track->createNodeKeyframe(2.0f * t4)->translation(C);
    track->createNodeKeyframe(3.0f * t4)->translation(D);
    track->createNodeKeyframe(4.0f * t4)->translation(A);
 
    // Build curve data w. cumulated times
    SLVVec4f points;
    points.resize((SLulong)track->numKeyframes());
    for (SLuint i = 0; i < (SLuint)track->numKeyframes(); ++i)
    {
        SLTransformKeyframe* kf = (SLTransformKeyframe*)track->keyframe((SLint)i);
        points[i].set(kf->translation().x,
                      kf->translation().y,
                      kf->translation().z,
                      kf->time());
    }
 
    // create curve and delete temp arrays again
    track->interpolationCurve(new SLCurveBezier(points, controls));
    track->translationInterpolation(AI_bezier);
 
    return track;
}

createNodeAnimTrackForRotation()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForRotation	(	SLNode *	target,
		SLfloat	angleDeg,
		const SLVec3f &	axis
	)

Specialized SLNodeAnimationTrack creator for a two keyframe rotation animation from 0° to angleDeg.

Definition at line 184 of file SLAnimation.cpp.

{
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
    track->createNodeKeyframe(0.0f);
    track->createNodeKeyframe(lengthSec())->rotation(SLQuat4f(angleDeg, axis));
    return track;
}

createNodeAnimTrackForRotation2()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForRotation2	(	SLNode *	target,
		SLfloat	angleDeg0,
		SLfloat	angleDeg1,
		const SLVec3f &	axis
	)

Specialized SLNodeAnimationTrack creator for 2 keyframes at angleDeg0 and angleDeg1.

Definition at line 199 of file SLAnimation.cpp.

{
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
 
    SLTransformKeyframe* frame0 = track->createNodeKeyframe(0.0f);
    frame0->rotation(SLQuat4f(angleDeg0, axis));
 
    SLTransformKeyframe* frame1 = track->createNodeKeyframe(lengthSec());
    frame1->rotation(SLQuat4f(angleDeg1, axis));
 
    return track;
}

createNodeAnimTrackForRotation3()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForRotation3	(	SLNode *	target,
		SLfloat	angleDeg0,
		SLfloat	angleDeg1,
		SLfloat	angleDeg2,
		const SLVec3f &	axis
	)

Specialized SLNodeAnimationTrack creator for 3 keyframes at angleDeg0, angleDeg1 and angleDeg2.

Definition at line 220 of file SLAnimation.cpp.

{
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
 
    SLTransformKeyframe* frame0 = track->createNodeKeyframe(0.0f);
    frame0->rotation(SLQuat4f(angleDeg0, axis));
 
    SLTransformKeyframe* frame1 = track->createNodeKeyframe(lengthSec() * 0.5f);
    frame1->rotation(SLQuat4f(angleDeg1, axis));
 
    SLTransformKeyframe* frame2 = track->createNodeKeyframe(lengthSec());
    frame2->rotation(SLQuat4f(angleDeg2, axis));
 
    return track;
}

createNodeAnimTrackForRotation360()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForRotation360	(	SLNode *	target,
		const SLVec3f &	axis
	)

Specialized SLNodeAnimationTrack creator for a 360 deg. node rotation track with 3 keyframes from 0° to 180° to 360°.

Definition at line 274 of file SLAnimation.cpp.

{
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
 
    SLTransformKeyframe* frame0 = track->createNodeKeyframe(0.0f);
    frame0->rotation(SLQuat4f(0.0f, axis));
 
    SLTransformKeyframe* frame1 = track->createNodeKeyframe(lengthSec() * 0.5f);
    frame1->rotation(SLQuat4f(180.0f, axis));
 
    SLTransformKeyframe* frame2 = track->createNodeKeyframe(lengthSec());
    frame2->rotation(SLQuat4f(360.0f, axis));
 
    return track;
}

createNodeAnimTrackForRotation4()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForRotation4	(	SLNode *	target,
		SLfloat	angleDeg0,
		SLfloat	angleDeg1,
		SLfloat	angleDeg2,
		SLfloat	angleDeg3,
		const SLVec3f &	axis
	)

Specialized SLNodeAnimationTrack creator for 4 keyframes at angleDeg0, angleDeg1, angleDeg2 and angleDeg3.

Definition at line 245 of file SLAnimation.cpp.

{
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
 
    SLTransformKeyframe* frame0 = track->createNodeKeyframe(0.0f);
    frame0->rotation(SLQuat4f(angleDeg0, axis));
 
    SLTransformKeyframe* frame1 = track->createNodeKeyframe(lengthSec() * 0.3333f);
    frame1->rotation(SLQuat4f(angleDeg1, axis));
 
    SLTransformKeyframe* frame2 = track->createNodeKeyframe(lengthSec() * 0.6666f);
    frame2->rotation(SLQuat4f(angleDeg2, axis));
 
    SLTransformKeyframe* frame3 = track->createNodeKeyframe(lengthSec());
    frame3->rotation(SLQuat4f(angleDeg3, axis));
 
    return track;
}

createNodeAnimTrackForScaling()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForScaling	(	SLNode *	target,
		const SLVec3f &	endScale
	)

Specialized SLNodeAnimationTrack creator for a two keyframe scaling animation

Definition at line 295 of file SLAnimation.cpp.

{
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
    track->createNodeKeyframe(0.0f);
    track->createNodeKeyframe(lengthSec())->scale(endScale);
    return track;
}

createNodeAnimTrackForTranslation()

SLNodeAnimTrack * SLAnimation::createNodeAnimTrackForTranslation	(	SLNode *	target,
		const SLVec3f &	endPos
	)

Specialized SLNodeAnimationTrack creator for a two keyframe translation animation

Definition at line 170 of file SLAnimation.cpp.

{
    SLNodeAnimTrack* track = createNodeAnimTrack();
    target->setInitialState();
    track->animatedNode(target);
    track->createNodeKeyframe(0.0f);
    track->createNodeKeyframe(lengthSec())->translation(endPos);
    return track;
}

drawNodeVisuals()

void SLAnimation::drawNodeVisuals

(

SLSceneView *

sv

)

Draws the visualizations of all node tracks

Definition at line 154 of file SLAnimation.cpp.

{
    for (auto it : _nodeAnimTracks)
        it.second->drawVisuals(sv);
}

lengthSec() [1/2]

SLfloat SLAnimation::lengthSec ( ) const

inline

Definition at line 72 of file SLAnimation.h.

{ return _lengthSec; }

lengthSec() [2/2]

void SLAnimation::lengthSec

(

SLfloat

lengthSec

)

Setter for the animation length

Definition at line 31 of file SLAnimation.cpp.

{
    _lengthSec = lengthSec;
}

name() [1/2]

const SLstring& SLAnimation::name ( )

inline

Definition at line 71 of file SLAnimation.h.

{ return _name; }

name() [2/2]

void SLAnimation::name ( const SLstring &  name )

inline

Definition at line 75 of file SLAnimation.h.

{ _name = name; }

nextKeyframeTime()

SLfloat SLAnimation::nextKeyframeTime

(

SLfloat

time

)

Returns the timestamp for the next keyframe in all of the tracks.

Definition at line 38 of file SLAnimation.cpp.

{
    // find the closest keyframe time to the right
    SLfloat         result = _lengthSec;
    SLAnimKeyframe* kf1;
    SLAnimKeyframe* kf2;
 
    for (auto it : _nodeAnimTracks)
    {
        it.second->getKeyframesAtTime(time, &kf1, &kf2);
        if (kf2->time() < result && kf2->time() >= time)
            result = kf2->time();
    }
 
    return result;
}

prevKeyframeTime()

SLfloat SLAnimation::prevKeyframeTime

(

SLfloat

time

)

Returns the timestamp for the previous keyframe in all of the tracks.

Definition at line 57 of file SLAnimation.cpp.

{
    // find the closest keyframe time to the right
    SLfloat         result = 0.0;
    SLAnimKeyframe* kf1;
    SLAnimKeyframe* kf2;
 
    // shift the time a little bit to the left or else the getKeyframesAtTime function
    // would return the same keyframe over and over again
    time -= 0.01f;
    if (time <= 0.0f)
        return 0.0f;
 
    for (auto it : _nodeAnimTracks)
    {
        it.second->getKeyframesAtTime(time, &kf1, &kf2);
        if (kf1->time() > result && kf1->time() <= time)
            result = kf1->time();
    }
 
    return result;
}

resetNodes()

void SLAnimation::resetNodes

(

)

Resets all default animation targets to their initial state.

Definition at line 162 of file SLAnimation.cpp.

{
    for (auto it : _nodeAnimTracks)
        it.second->animatedNode()->resetToInitialState();
}

Member Data Documentation

_lengthSec

SLfloat SLAnimation::_lengthSec

protected

duration of the animation in seconds

Definition at line 80 of file SLAnimation.h.

_name

SLstring SLAnimation::_name

protected

name of the animation

Definition at line 79 of file SLAnimation.h.

_nodeAnimTracks

SLMNodeAnimTrack SLAnimation::_nodeAnimTracks

protected

map of all the node tracks in this animation

Definition at line 81 of file SLAnimation.h.

---

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

• SLAnimation.h
• SLAnimation.cpp