com.jme3.animation

Class AnimChannel

java.lang.Object

com.jme3.animation.AnimChannel

Deprecated.

@Deprecated
public final class AnimChannel
extends java.lang.Object

AnimChannel provides controls, such as play, pause, fast forward, etc, for an animation. The animation channel may influence the entire model or specific bones of the model's skeleton. A single model may have multiple animation channels influencing various parts of its body. For example, a character model may have an animation channel for its feet, and another for its torso, and the animations for each channel are controlled independently.

Constructor Summary

Constructors

Constructor and Description
AnimChannel() Deprecated.
AnimChannel(AnimControl control) Deprecated.

Method Summary

Modifier and Type	Method and Description
void	addAllBones() Deprecated. Add all the bones of the model's skeleton to be influenced by this animation channel.
void	addBone(Bone bone) Deprecated. Add a single bone to be influenced by this animation channel.
void	addBone(java.lang.String name) Deprecated. Add a single bone to be influenced by this animation channel.
void	addFromRootBone(Bone bone) Deprecated. Add bones to be influenced by this animation channel, starting from the given bone and going toward its children.
void	addFromRootBone(java.lang.String name) Deprecated. Add bones to be influenced by this animation channel, starting from the given named bone and going toward its children.
void	addToRootBone(Bone bone) Deprecated. Add bones to be influenced by this animation channel starting from the given bone and going toward the root bone.
void	addToRootBone(java.lang.String name) Deprecated. Add bones to be influenced by this animation channel starting from the given bone name and going toward the root bone.
java.lang.String	getAnimationName() Deprecated.
float	getAnimMaxTime() Deprecated.
AnimControl	getControl() Deprecated. Returns the parent control of this AnimChannel.
LoopMode	getLoopMode() Deprecated.
float	getSpeed() Deprecated.
float	getTime() Deprecated.
void	reset(boolean rewind) Deprecated.
void	setAnim(java.lang.String name) Deprecated. Set the current animation that is played by this AnimChannel.
void	setAnim(java.lang.String name, float blendTime) Deprecated. Set the current animation that is played by this AnimChannel.
void	setLoopMode(LoopMode loopMode) Deprecated.
void	setSpeed(float speed) Deprecated.
void	setTime(float time) Deprecated.

Methods inherited from class java.lang.Object

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

Constructor Detail

AnimChannel

public AnimChannel()

Deprecated.

AnimChannel

public AnimChannel(AnimControl control)

Deprecated.

Method Detail

getControl

public AnimControl getControl()

Deprecated.

Returns the parent control of this AnimChannel.

Returns:

the parent control of this AnimChannel.

See Also:

AnimControl

getAnimationName

public java.lang.String getAnimationName()

Deprecated.

Returns:

The name of the currently playing animation, or null if none is assigned.

See Also:

setAnim(java.lang.String)

getLoopMode

public LoopMode getLoopMode()

Deprecated.

Returns:

The loop mode currently set for the animation. The loop mode determines what will happen to the animation once it finishes playing. For more information, see the LoopMode enum class.

See Also:

LoopMode, setLoopMode(com.jme3.animation.LoopMode)

setLoopMode

public void setLoopMode(LoopMode loopMode)

Deprecated.

Parameters:

loopMode - Set the loop mode for the channel. The loop mode determines what will happen to the animation once it finishes playing. For more information, see the LoopMode enum class.

See Also:

LoopMode

getSpeed

public float getSpeed()

Deprecated.

Returns:

The speed that is assigned to the animation channel. The speed is a scale value starting from 0.0, at 1.0 the animation will play at its default speed.

See Also:

setSpeed(float)

setSpeed

public void setSpeed(float speed)

Deprecated.

Parameters:

speed - Set the speed of the animation channel. The speed is a scale value starting from 0.0, at 1.0 the animation will play at its default speed.

getTime

public float getTime()

Deprecated.

Returns:

The time of the currently playing animation. The time starts at 0 and continues on until getAnimMaxTime().

See Also:

setTime(float)

setTime

public void setTime(float time)

Deprecated.

Parameters:

time - Set the time of the currently playing animation, the time is clamped from 0 to getAnimMaxTime().

getAnimMaxTime

public float getAnimMaxTime()

Deprecated.

Returns:

The length of the currently playing animation, or zero if no animation is playing.

See Also:

getTime()

setAnim

public void setAnim(java.lang.String name,
                    float blendTime)

Deprecated.

Set the current animation that is played by this AnimChannel.

This resets the time to zero, and optionally blends the animation over blendTime seconds with the currently playing animation. Notice that this method will reset the control's speed to 1.0.

Parameters:

name - The name of the animation to play

blendTime - The blend time over which to blend the new animation with the old one. If zero, then no blending will occur and the new animation will be applied instantly.

setAnim

public void setAnim(java.lang.String name)

Deprecated.

Set the current animation that is played by this AnimChannel.

See setAnim(java.lang.String, float). The blendTime argument by default is 150 milliseconds.

Parameters:

name - The name of the animation to play

addAllBones

public void addAllBones()

Deprecated.

Add all the bones of the model's skeleton to be influenced by this animation channel.

addBone

public void addBone(java.lang.String name)

Deprecated.

Add a single bone to be influenced by this animation channel.

Parameters:

name - the name of the Bone to be influenced

addBone

public void addBone(Bone bone)

Deprecated.

Add a single bone to be influenced by this animation channel.

Parameters:

bone - the Bone to be influenced

addToRootBone

public void addToRootBone(java.lang.String name)

Deprecated.

Add bones to be influenced by this animation channel starting from the given bone name and going toward the root bone.

Parameters:

name - the name of the Bone to use as a starting point

addToRootBone

public void addToRootBone(Bone bone)

Deprecated.

Add bones to be influenced by this animation channel starting from the given bone and going toward the root bone.

Parameters:

bone - the Bone to use as a starting point

addFromRootBone

public void addFromRootBone(java.lang.String name)

Deprecated.

Add bones to be influenced by this animation channel, starting from the given named bone and going toward its children.

Parameters:

name - the name of the Bone to use as a starting point

addFromRootBone

public void addFromRootBone(Bone bone)

Deprecated.

Add bones to be influenced by this animation channel, starting from the given bone and going toward its children.

Parameters:

bone - the Bone to use as a starting point

reset

public void reset(boolean rewind)

Deprecated.