com.jme3.cinematic.events

Class CameraEvent

java.lang.Object

com.jme3.cinematic.events.AbstractCinematicEvent

com.jme3.cinematic.events.CameraEvent

All Implemented Interfaces:

CinematicEvent, Savable

public class CameraEvent
extends AbstractCinematicEvent

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
CameraEvent()
CameraEvent(Cinematic parentEvent, java.lang.String cameraName)

Method Summary

Modifier and Type	Method and Description
void	forceStop() 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.
java.lang.String	getCameraName()
Cinematic	getCinematic()
void	initEvent(Application app, Cinematic cinematic) Initialize this event (called internally only).
void	onPause() Implement this method with code that you want to execute when the event is paused.
void	onPlay() Implement this method with code that you want to execute when the event is started.
void	onStop() Implement this method with code that you want to execute when the event is stopped.
void	onUpdate(float tpf) Implement this method with the code that you want to execute on update (only called when the event is playing).
void	play() Play this event.
void	read(JmeImporter im) used internally for serialization
void	setCameraName(java.lang.String cameraName)
void	setCinematic(Cinematic cinematic)
void	setTime(float time) Fast-forward the event to the given timestamp.
void	write(JmeExporter ex) used internally for serialization

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

addListener, dispose, getDuration, getInitialDuration, getLoopMode, getPlayState, getSpeed, getTime, internalUpdate, pause, removeListener, setInitialDuration, setLoopMode, setSpeed, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

CameraEvent

public CameraEvent()

CameraEvent

public CameraEvent(Cinematic parentEvent,
                   java.lang.String cameraName)

Method Detail

getCameraName

public java.lang.String getCameraName()

setCameraName

public void setCameraName(java.lang.String cameraName)

initEvent

public void initEvent(Application app,
                      Cinematic cinematic)

Description copied from class: AbstractCinematicEvent

Initialize this event (called internally only).

Specified by:

initEvent in interface CinematicEvent

Overrides:

initEvent in class AbstractCinematicEvent

Parameters:

app - ignored

cinematic - ignored

play

public void play()

Description copied from class: AbstractCinematicEvent

Play this event.

Specified by:

play in interface CinematicEvent

Overrides:

play in class AbstractCinematicEvent

onPlay

public void onPlay()

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

onUpdate

public void onUpdate(float tpf)

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()

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

onPause

public void onPause()

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

forceStop

public void forceStop()

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

setTime

public void setTime(float time)

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.

getCinematic

public Cinematic getCinematic()

setCinematic

public void setCinematic(Cinematic cinematic)

write

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

used internally for serialization

Specified by:

write in interface Savable

Overrides:

write in class AbstractCinematicEvent

Parameters:

ex - the exporter (not null)

Throws:

java.io.IOException - from the exporter

read

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

used internally for serialization

Specified by:

read in interface Savable

Overrides:

read in class AbstractCinematicEvent

Parameters:

im - the importer (not null)

Throws:

java.io.IOException - from the importer