com.bonzaiengine.model

Class AnimationContext

java.lang.Object

com.bonzaiengine.model.AnimationContext

public final class AnimationContext
extends java.lang.Object

Method Summary

Modifier and Type	Method and Description
Animation	getAnimation()
double	getAnimationContextTime()
Timeline	getAnimationTimeline()
AnimGraph	getAnimGraph()
boolean	isAnimated()
void	setAnimation(Animation animation) Set an Animation to be used for keyframe, skeletal and morph animation.
void	setAnimationTime(float trackTime) Helper to set the Animation time.
void	setAnimGraph(AnimGraph animGraph)
void	setTracks(AnimationTrack[] tracks, Animation[] animations, double duration) Animations and tracks array must be the same size
boolean	update(long timePassedMs) Update AnimationTrack time

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setAnimation

public final void setAnimation(Animation animation)

Set an Animation to be used for keyframe, skeletal and morph animation.
An AnimGraph will be internally created with a single AnimNode.
If the specified Animation has loop, the duration will be set to -1 (infinite duration). If not, the duration will be set to the Animation duration,and will therefore stops at end.

Parameters:

animation - an Animation

getAnimation

public final Animation getAnimation()

Returns:

the Animation set with setAnimation(Animation).

getAnimationTimeline

public final Timeline getAnimationTimeline()

getAnimationContextTime

public final double getAnimationContextTime()

setAnimationTime

public final void setAnimationTime(float trackTime)

Helper to set the Animation time.
This will set the specified animation time to the keyframe AnimNode of the AnimGraph created from setAnimation(Animation).
Note: we recommend to use AnimGraph api directly.

Parameters:

trackTime - seek to the specified time

See Also:

setAnimation(Animation), getAnimation(), AnimGraph.setKeyFrameTime(float), AnimNode

setTracks

public final void setTracks(AnimationTrack[] tracks,
                            Animation[] animations,
                            double duration)

Animations and tracks array must be the same size

Parameters:

tracks - animation tracks

animations - animations lists

duration - duration of the timeline

setAnimGraph

public final void setAnimGraph(AnimGraph animGraph)

getAnimGraph

public final AnimGraph getAnimGraph()

Returns:

the AnimGraph, or null if isAnimated() returns false

isAnimated

public final boolean isAnimated()

Returns:

true if there an Animation, an AnimGraph or AnimationTrack has been set.

update

public final boolean update(long timePassedMs)

Update AnimationTrack time

Parameters:

timePassedMs - time passed in millisecond since the last update(long)

Returns:

true if the state of this AnimationContext was changed