com.jme3.cinematic.events

Class AnimationEvent

java.lang.Object

com.jme3.cinematic.events.AbstractCinematicEvent

com.jme3.cinematic.events.AnimationEvent

All Implemented Interfaces:

CinematicEvent, Savable

Direct Known Subclasses:

AnimationTrack

Deprecated.

@Deprecated
public class AnimationEvent
extends AbstractCinematicEvent

An event based on an animation of a model. The model has to hold an AnimControl with valid animation (bone or spatial animations). It helps to schedule the playback of an animation on a model in a Cinematic.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	animationName Deprecated.
protected float	blendTime Deprecated.
protected AnimChannel	channel Deprecated.
protected int	channelIndex Deprecated.
protected Cinematic	cinematic Deprecated.
protected Spatial	model Deprecated.
static java.lang.String	MODEL_CHANNELS Deprecated.
protected java.lang.String	modelName Deprecated.
static int	SAVABLE_VERSION Deprecated.

Fields inherited from class com.jme3.cinematic.events.AbstractCinematicEvent

initialDuration, listeners, loopMode, playState, resuming, speed, time

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AnimationEvent() Deprecated. used for serialization don't call directly use one of the following constructors
	AnimationEvent(Spatial model, java.lang.String animationName) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, float initialDuration) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, float initialDuration, float blendTime) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, float initialDuration, int channelIndex) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, float initialDuration, LoopMode loopMode) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, float initialDuration, LoopMode loopMode, float blendTime) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, float initialDuration, LoopMode loopMode, int channelIndex) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, int channelIndex) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, LoopMode loopMode) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, LoopMode loopMode, float blendTime) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, LoopMode loopMode, int channelIndex) Deprecated. creates an animation event
	AnimationEvent(Spatial model, java.lang.String animationName, LoopMode loopMode, int channelIndex, float blendTime) Deprecated. creates an animation event

Method Summary

Modifier and Type	Method and Description
void	dispose() Deprecated. method called when an event is removed from a cinematic this method should remove any reference to any external objects.
void	forceStop() Deprecated. Implement this method if the event needs different handling when stopped naturally (when the event reach its end), or when it was force-stopped during playback.
void	initEvent(Application app, Cinematic cinematic) Deprecated. Initialize this event (called internally only).
void	onPause() Deprecated. Implement this method with code that you want to execute when the event is paused.
void	onPlay() Deprecated. Implement this method with code that you want to execute when the event is started.
void	onStop() Deprecated. Implement this method with code that you want to execute when the event is stopped.
void	onUpdate(float tpf) Deprecated. Implement this method with the code that you want to execute on update (only called when the event is playing).
void	read(JmeImporter im) Deprecated. Used for serialization only.
void	setLoopMode(LoopMode loopMode) Deprecated. Sets the loopMode of the animation.
void	setSpeed(float speed) Deprecated. Sets the speed of the animation.
void	setTime(float time) Deprecated. Fast-forward the event to the given timestamp.
void	write(JmeExporter ex) Deprecated. Used for serialization only.

Methods inherited from class com.jme3.cinematic.events.AbstractCinematicEvent

addListener, getDuration, getInitialDuration, getLoopMode, getPlayState, getSpeed, getTime, internalUpdate, pause, play, removeListener, setInitialDuration, stop

Methods inherited from class java.lang.Object

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

Field Detail

SAVABLE_VERSION

public static final int SAVABLE_VERSION

Deprecated.

See Also:

Constant Field Values

MODEL_CHANNELS

public static final java.lang.String MODEL_CHANNELS

Deprecated.

See Also:

Constant Field Values

channel

protected AnimChannel channel

Deprecated.

animationName

protected java.lang.String animationName

Deprecated.

model

protected Spatial model

Deprecated.

modelName

protected java.lang.String modelName

Deprecated.

blendTime

protected float blendTime

Deprecated.

channelIndex

protected int channelIndex

Deprecated.

cinematic

protected Cinematic cinematic

Deprecated.

Constructor Detail

AnimationEvent

protected AnimationEvent()

Deprecated.

used for serialization don't call directly use one of the following constructors

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      float initialDuration)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

initialDuration - the initial duration of the event

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      LoopMode loopMode)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

loopMode - the loopMode

See Also:

LoopMode

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      float initialDuration,
                      LoopMode loopMode)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

initialDuration - the initial duration of the event

loopMode - the loopMode

See Also:

LoopMode

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      float initialDuration,
                      float blendTime)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

initialDuration - the initial duration of the event

blendTime - the time during the animation are gonna be blended

See Also:

AnimChannel.setAnim(java.lang.String, float)

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      LoopMode loopMode,
                      float blendTime)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

loopMode - the loopMode

blendTime - the time during the animation are gonna be blended

See Also:

LoopMode, AnimChannel.setAnim(java.lang.String, float)

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      float initialDuration,
                      LoopMode loopMode,
                      float blendTime)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

initialDuration - the initial duration of the event

loopMode - the loopMode

blendTime - the time during the animation are gonna be blended

See Also:

LoopMode, AnimChannel.setAnim(java.lang.String, float)

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      LoopMode loopMode,
                      int channelIndex)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

loopMode - the loopMode

channelIndex - the index of the channel default is 0. Events on the same channelIndex will use the same channel.

See Also:

LoopMode

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      int channelIndex)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

channelIndex - the index of the channel default is 0. Events on the same channelIndex will use the same channel.

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      LoopMode loopMode,
                      int channelIndex,
                      float blendTime)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

channelIndex - the index of the channel default is 0. Events on the

blendTime - the time during the animation are gonna be blended same channelIndex will use the same channel.

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      float initialDuration,
                      int channelIndex)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

initialDuration - the initial duration of the event

channelIndex - the index of the channel default is 0. Events on the same channelIndex will use the same channel.

AnimationEvent

public AnimationEvent(Spatial model,
                      java.lang.String animationName,
                      float initialDuration,
                      LoopMode loopMode,
                      int channelIndex)

Deprecated.

creates an animation event

Parameters:

model - the model on which the animation will be played

animationName - the name of the animation to play

initialDuration - the initial duration of the event

loopMode - the loopMode

channelIndex - the index of the channel default is 0. Events on the same channelIndex will use the same channel.

See Also:

LoopMode

Method Detail

initEvent

public void initEvent(Application app,
                      Cinematic cinematic)

Deprecated.

Description copied from class: AbstractCinematicEvent

Initialize this event (called internally only).

Specified by:

initEvent in interface CinematicEvent

Overrides:

initEvent in class AbstractCinematicEvent

Parameters:

app - the application

cinematic - the cinematic

setTime

public void setTime(float time)

Deprecated.

Description copied from class: AbstractCinematicEvent

Fast-forward the event to the given timestamp. Time=0 is the start of the event.

Specified by:

setTime in interface CinematicEvent

Overrides:

setTime in class AbstractCinematicEvent

Parameters:

time - the time to fast forward to.

onPlay

public void onPlay()

Deprecated.

Description copied from class: AbstractCinematicEvent

Implement this method with code that you want to execute when the event is started.

Specified by:

onPlay in class AbstractCinematicEvent

setSpeed

public void setSpeed(float speed)

Deprecated.

Description copied from class: AbstractCinematicEvent

Sets the speed of the animation. At speed = 1, the animation will last initialDuration seconds, At speed = 2, the animation will last initialDuration/2...

Specified by:

setSpeed in interface CinematicEvent

Overrides:

setSpeed in class AbstractCinematicEvent

onUpdate

public void onUpdate(float tpf)

Deprecated.

Description copied from class: AbstractCinematicEvent

Implement this method with the code that you want to execute on update (only called when the event is playing).

Specified by:

onUpdate in class AbstractCinematicEvent

Parameters:

tpf - time per frame

onStop

public void onStop()

Deprecated.

Description copied from class: AbstractCinematicEvent

Implement this method with code that you want to execute when the event is stopped.

Specified by:

onStop in class AbstractCinematicEvent

forceStop

public void forceStop()

Deprecated.

Description copied from class: AbstractCinematicEvent

Implement this method if the event needs different handling when stopped naturally (when the event reach its end), or when it was force-stopped during playback. By default, this method just calls regular stop().

Specified by:

forceStop in interface CinematicEvent

Overrides:

forceStop in class AbstractCinematicEvent

onPause

public void onPause()

Deprecated.

Description copied from class: AbstractCinematicEvent

Implement this method with code that you want to execute when the event is paused.

Specified by:

onPause in class AbstractCinematicEvent

setLoopMode

public void setLoopMode(LoopMode loopMode)

Deprecated.

Description copied from class: AbstractCinematicEvent

Sets the loopMode of the animation.

Specified by:

setLoopMode in interface CinematicEvent

Overrides:

setLoopMode in class AbstractCinematicEvent

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

write

public void write(JmeExporter ex)
           throws java.io.IOException

Deprecated.

Description copied from class: AbstractCinematicEvent

Used for serialization only.

Specified by:

write in interface Savable

Overrides:

write in class AbstractCinematicEvent

Parameters:

ex - exporter

Throws:

java.io.IOException

read

public void read(JmeImporter im)
          throws java.io.IOException

Deprecated.

Description copied from class: AbstractCinematicEvent

Used for serialization only.

Specified by:

read in interface Savable

Overrides:

read in class AbstractCinematicEvent

Parameters:

im - importer

Throws:

java.io.IOException

dispose

public void dispose()

Deprecated.

Description copied from interface: CinematicEvent

method called when an event is removed from a cinematic this method should remove any reference to any external objects.

Specified by:

dispose in interface CinematicEvent

Overrides:

dispose in class AbstractCinematicEvent