com.bonzaiengine.animation

Class Animation

java.lang.Object

com.bonzaiengine.animation.Animation

All Implemented Interfaces:

java.lang.Cloneable

public class Animation
extends java.lang.Object
implements java.lang.Cloneable

See Also:

Model.addAnimation(Animation), AnimationContext.setAnimation(Animation), AnimNode.setAnimationName(String)

Field Summary

Fields

Modifier and Type	Field and Description
float	end Time in seconds of the last frame of this Animation
float	loop Time in seconds of the loop point.
float	loopDuration Duration in seconds of the loop between the end and loop time.
java.util.HashSet<java.lang.String>	morphMotions References to MorphMotion used to animate the MorphTargets.
java.lang.String	name This Animation name
java.lang.String	skeletonMotion Name of the JointMotion used for animating the Skeleton.
float	speed Speed factor of this Animation.
float	start Time in seconds of the first frame of this Animation

Constructor Summary

Constructors

Constructor and Description
Animation()

Method Summary

Modifier and Type	Method and Description
Animation	clone()
float	getLength()
float	getLengthInLoop()
float	getLoopTime()
float	getProgression(float time)
float	getTime(float progression)
boolean	isLoop()
static Animation	read(IByteInputStream in, java.lang.String[] strings)
java.lang.String	toString()
void	write(IByteOutputStream out, Array<java.lang.String> strings)

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

name

public java.lang.String name

This Animation name

start

public float start

Time in seconds of the first frame of this Animation

end

public float end

Time in seconds of the last frame of this Animation

loop

public float loop

Time in seconds of the loop point.
When the animation reach the end point, when looping is enabled the animation is rewinded to loop point, depending on the cases:

• loop >= end: No loop, stops at end (play once).
• loop < start: Loop and restart at start position.
• start <= loop < end: Loop and restart at loop position.

See Also:

loopDuration

loopDuration

public float loopDuration

Duration in seconds of the loop between the end and loop time.
When loop is enabled, the animation goes by default instantly to the loop point. This can be changed by specifying the a duration time to loopDuration.

speed

public float speed

Speed factor of this Animation.
Value of 1 will play the animation at regular speed. A value smaller/higher will respectively play it slower/faster. A value of 0 will prevent the animation change.
Default value: 1

skeletonMotion

public java.lang.String skeletonMotion

Name of the JointMotion used for animating the Skeleton.
Ignored if Model.skeleton is null

morphMotions

public final java.util.HashSet<java.lang.String> morphMotions

References to MorphMotion used to animate the MorphTargets.

Constructor Detail

Animation

public Animation()

Method Detail

read

public static final Animation read(IByteInputStream in,
                                   java.lang.String[] strings)
                            throws java.io.IOException

Throws:

java.io.IOException

write

public final void write(IByteOutputStream out,
                        Array<java.lang.String> strings)
                 throws java.io.IOException

Throws:

java.io.IOException

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public final Animation clone()

Overrides:

clone in class java.lang.Object

getLength

public final float getLength()

Returns:

length in seconds of this Animation,
equivalent to: end - start

getLengthInLoop

public final float getLengthInLoop()

Returns:

length in seconds of this Animation when looping,
equivalent to: end - getLoopTime() + loopDuration

getProgression

public final float getProgression(float time)

Parameters:

time - the time in seconds

Returns:

the progression of the specified time. Value returned is in the range of [0;1]

getTime

public final float getTime(float progression)

Parameters:

progression - value in range [0;1]

Returns:

the time in seconds of the specified progression.

isLoop

public final boolean isLoop()

Returns:

true if this Animation is looping

getLoopTime

public final float getLoopTime()

Returns:

the loop time in seconds of the loop point.
Return value is value if isLoop() return true