com.jme3.app

Class SimpleApplication

java.lang.Object

com.jme3.app.LegacyApplication

com.jme3.app.SimpleApplication

All Implemented Interfaces:

Application, SystemListener

public abstract class SimpleApplication
extends LegacyApplication

SimpleApplication is the base class for all jME3 Applications. SimpleApplication will display a statistics view using the StatsAppState AppState. It will display the current frames-per-second value on-screen in addition to the statistics. Several keys have special functionality in SimpleApplication:
Esc - Close the application.
C - Display the camera position and rotation in the console.
M - Display memory usage in the console.
A FlyCamAppState is by default attached as well and can be removed by calling stateManager.detach(stateManager.getState(FlyCamAppState.class));

Field Summary

Fields

Modifier and Type	Field and Description
protected FlyByCamera	flyCam
protected BitmapText	fpsText
protected BitmapFont	guiFont
protected Node	guiNode
static java.lang.String	INPUT_MAPPING_CAMERA_POS
static java.lang.String	INPUT_MAPPING_EXIT
static java.lang.String	INPUT_MAPPING_HIDE_STATS
static java.lang.String	INPUT_MAPPING_MEMORY
protected Node	rootNode
protected boolean	showSettings

Fields inherited from class com.jme3.app.LegacyApplication

assetManager, audioRenderer, cam, context, guiViewPort, inputEnabled, inputManager, joyInput, keyInput, listener, lostFocusBehavior, mouseInput, paused, prof, renderer, renderManager, settings, speed, stateManager, timer, touchInput, viewPort

Constructor Summary

Constructors

Constructor and Description
SimpleApplication()
SimpleApplication(AppState... initialStates)

Method Summary

Modifier and Type	Method and Description
FlyByCamera	getFlyByCamera() Retrieves flyCam
Node	getGuiNode() Retrieves guiNode
Node	getRootNode() Retrieves rootNode
float	getSpeed() Returns the application's speed.
void	initialize() Do not call manually.
boolean	isShowSettings()
protected BitmapFont	loadGuiFont() Creates the font that will be set to the guiFont field and subsequently set as the font for the stats text.
void	setDisplayFps(boolean show)
void	setDisplayStatView(boolean show)
void	setShowSettings(boolean showSettings) Toggles settings window to display at start-up
void	setSpeed(float speed) Changes the application's speed.
abstract void	simpleInitApp()
void	simpleRender(RenderManager rm)
void	simpleUpdate(float tpf)
void	start() Starts the application in display mode.
void	update() Do not call manually.

Methods inherited from class com.jme3.app.LegacyApplication

createCanvas, destroy, destroyInput, enqueue, enqueue, gainFocus, getAppProfiler, getAssetManager, getAudioRenderer, getCamera, getContext, getGuiViewPort, getInputManager, getListener, getLostFocusBehavior, getRenderer, getRenderManager, getStateManager, getTimer, getViewPort, handleError, isPauseOnLostFocus, loseFocus, requestClose, rescale, reshape, restart, runQueuedTasks, setAppProfiler, setAssetManager, setLostFocusBehavior, setPauseOnLostFocus, setSettings, setTimer, start, start, start, startCanvas, startCanvas, stop, stop

Methods inherited from class java.lang.Object

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

Field Detail

INPUT_MAPPING_EXIT

public static final java.lang.String INPUT_MAPPING_EXIT

See Also:

Constant Field Values

INPUT_MAPPING_CAMERA_POS

public static final java.lang.String INPUT_MAPPING_CAMERA_POS

See Also:

Constant Field Values

INPUT_MAPPING_MEMORY

public static final java.lang.String INPUT_MAPPING_MEMORY

See Also:

Constant Field Values

INPUT_MAPPING_HIDE_STATS

public static final java.lang.String INPUT_MAPPING_HIDE_STATS

See Also:

Constant Field Values

rootNode

protected Node rootNode

guiNode

protected Node guiNode

fpsText

protected BitmapText fpsText

guiFont

protected BitmapFont guiFont

flyCam

protected FlyByCamera flyCam

showSettings

protected boolean showSettings

Constructor Detail

SimpleApplication

public SimpleApplication()

SimpleApplication

public SimpleApplication(AppState... initialStates)

Method Detail

start

public void start()

Description copied from class: LegacyApplication

Starts the application in display mode.

Specified by:

start in interface Application

Overrides:

start in class LegacyApplication

See Also:

LegacyApplication.start(com.jme3.system.JmeContext.Type)

getSpeed

public float getSpeed()

Returns the application's speed.

Returns:

The speed of the application.

setSpeed

public void setSpeed(float speed)

Changes the application's speed. 0.0f prevents the application from updating.

Parameters:

speed - The speed to set.

getFlyByCamera

public FlyByCamera getFlyByCamera()

Retrieves flyCam

Returns:

flyCam Camera object

getGuiNode

public Node getGuiNode()

Retrieves guiNode

Returns:

guiNode Node object

getRootNode

public Node getRootNode()

Retrieves rootNode

Returns:

rootNode Node object

isShowSettings

public boolean isShowSettings()

setShowSettings

public void setShowSettings(boolean showSettings)

Toggles settings window to display at start-up

Parameters:

showSettings - Sets true/false

loadGuiFont

protected BitmapFont loadGuiFont()

Creates the font that will be set to the guiFont field and subsequently set as the font for the stats text.

Returns:

the loaded BitmapFont

initialize

public void initialize()

Description copied from class: LegacyApplication

Do not call manually. Callback from ContextListener.

Initializes the Application, by creating a display and default camera. If display settings are not specified, a default 640x480 display is created. Default values are used for the camera; perspective projection with 45° field of view, with near and far values 1 and 1000 units respectively.

Specified by:

initialize in interface SystemListener

Overrides:

initialize in class LegacyApplication

update

public void update()

Description copied from class: LegacyApplication

Do not call manually. Callback from ContextListener.

Specified by:

update in interface SystemListener

Overrides:

update in class LegacyApplication

setDisplayFps

public void setDisplayFps(boolean show)

setDisplayStatView

public void setDisplayStatView(boolean show)

simpleInitApp

public abstract void simpleInitApp()

simpleUpdate

public void simpleUpdate(float tpf)

simpleRender

public void simpleRender(RenderManager rm)