com.jme3.cinematic.events

Class GuiEvent

java.lang.Object

com.jme3.cinematic.events.AbstractCinematicEvent

com.jme3.cinematic.events.GuiEvent

All Implemented Interfaces:

CinematicEvent, Savable

Direct Known Subclasses:

SubtitleTrack

public class GuiEvent
extends AbstractCinematicEvent

A CinematicEvent associated with a Nifty screen.

Field Summary

Fields

Modifier and Type	Field and Description
protected de.lessvoid.nifty.Nifty	nifty associated Nifty instance (not null)
protected java.lang.String	screen name of the associated Nifty screen(not null)

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

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

Constructor Summary

Constructors

Constructor and Description
GuiEvent() No-argument constructor needed by SavableClassUtil.
GuiEvent(de.lessvoid.nifty.Nifty nifty, java.lang.String screen) Instantiate an event with the default initial duration (10) and mode (DontLoop).
GuiEvent(de.lessvoid.nifty.Nifty nifty, java.lang.String screen, float initialDuration) Instantiate an event the default mode (DontLoop).
GuiEvent(de.lessvoid.nifty.Nifty nifty, java.lang.String screen, float initialDuration, LoopMode loopMode) Instantiate an event with the specified initial duration and loop mode.
GuiEvent(de.lessvoid.nifty.Nifty nifty, java.lang.String screen, LoopMode loopMode) Instantiate an event with the default initial duration (10).

Method Summary

Modifier and Type	Method and Description
void	onPause() Invoked when the event is paused.
void	onPlay() Invoked when the event is started.
void	onStop() Invoked when the event is stopped.
void	onUpdate(float tpf) Invoked once per frame, provided the event is playing.
void	read(JmeImporter im) De-serialize this event, for example when loading from a J3O file.
void	setNifty(de.lessvoid.nifty.Nifty nifty) Alter the Nifty instance for this event.
void	setScreen(java.lang.String screen) Alter the screen for this event.
void	write(JmeExporter ex) Serialize this event, for example when saving to a J3O file.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

screen

protected java.lang.String screen

name of the associated Nifty screen(not null)

nifty

protected de.lessvoid.nifty.Nifty nifty

associated Nifty instance (not null)

Constructor Detail

GuiEvent

public GuiEvent()

No-argument constructor needed by SavableClassUtil. Do not invoke directly!

GuiEvent

public GuiEvent(de.lessvoid.nifty.Nifty nifty,
                java.lang.String screen)

Instantiate an event with the default initial duration (10) and mode (DontLoop).

Parameters:

nifty - the Nifty instance (not null, alias created)

screen - the name of the Nifty screen (not null)

GuiEvent

public GuiEvent(de.lessvoid.nifty.Nifty nifty,
                java.lang.String screen,
                float initialDuration)

Instantiate an event the default mode (DontLoop).

Parameters:

nifty - the Nifty instance (not null, alias created)

screen - the name of the Nifty screen (not null)

initialDuration - the initial duration (in seconds, ≥0)

GuiEvent

public GuiEvent(de.lessvoid.nifty.Nifty nifty,
                java.lang.String screen,
                LoopMode loopMode)

Instantiate an event with the default initial duration (10).

Parameters:

nifty - the Nifty instance (not null, alias created)

screen - the name of the Nifty screen (not null)

loopMode - the loop mode (not null)

GuiEvent

public GuiEvent(de.lessvoid.nifty.Nifty nifty,
                java.lang.String screen,
                float initialDuration,
                LoopMode loopMode)

Instantiate an event with the specified initial duration and loop mode.

Parameters:

nifty - the Nifty instance (not null, alias created)

screen - the name of the Nifty screen (not null)

initialDuration - the initial duration (in seconds, ≥0)

loopMode - the loop mode (not null)

Method Detail

onPlay

public void onPlay()

Invoked when the event is started.

Specified by:

onPlay in class AbstractCinematicEvent

onStop

public void onStop()

Invoked when the event is stopped.

Specified by:

onStop in class AbstractCinematicEvent

onPause

public void onPause()

Invoked when the event is paused.

Specified by:

onPause in class AbstractCinematicEvent

setNifty

public void setNifty(de.lessvoid.nifty.Nifty nifty)

Alter the Nifty instance for this event.

Parameters:

nifty - the new instance (not null)

setScreen

public void setScreen(java.lang.String screen)

Alter the screen for this event.

Parameters:

screen - the name of the new screen (not null)

onUpdate

public void onUpdate(float tpf)

Invoked once per frame, provided the event is playing.

Specified by:

onUpdate in class AbstractCinematicEvent

Parameters:

tpf - the time interval between frames (in seconds, ≥0)

write

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

Serialize this event, for example when saving to a J3O file.

Specified by:

write in interface Savable

Overrides:

write in class AbstractCinematicEvent

Parameters:

ex - exporter (not null)

Throws:

java.io.IOException - from exporter

read

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

De-serialize this event, for example when loading from a J3O file.

Specified by:

read in interface Savable

Overrides:

read in class AbstractCinematicEvent

Parameters:

im - importer (not null)

Throws:

java.io.IOException - from importer