SimpleApplication (jMonkeyEngine3)

java.lang.Object
- com.jme3.app.LegacyApplication
- - com.jme3.app.SimpleApplication

All Implemented Interfaces:

Application, SystemListener

Direct Known Subclasses:

CubeField, HelloAnimation, HelloAssets, HelloAudio, HelloCollision, HelloEffects, HelloInput, HelloJME3, HelloLoop, HelloMaterial, HelloNode, HelloOpenCL, HelloPhysics, HelloPicking, HelloTerrain, HelloTerrainCollision, PBRTerrainAdvancedTest, PBRTerrainTest, RefEnv, RollingTheMonkey, TerrainFractalGridTest, TerrainGridAlphaMapTest, TerrainGridSerializationTest, TerrainGridTest, TerrainGridTileLoaderTest, TerrainTest, TerrainTestAdvanced, TerrainTestAndroid, TerrainTestCollision, TerrainTestModifyHeight, TerrainTestReadWrite, TerrainTestTile, TestAlphaToCoverage, TestAmbient, TestAnimationFactory, TestAnimMigration, TestAnimMorphSerialization, TestAnimSerialization, TestAnisotropicFilter, TestAppStateLifeCycle, TestArmature, TestAspectFov, TestAspectRatio, TestAssetLinkNode, TestAttachDriver, TestAttachGhostObject, TestAttachmentsNode, TestAwtPanels, TestBackgroundImage, TestBaseAnimSerialization, TestBatchLod, TestBatchNode, TestBatchNodeCluster, TestBatchNodeTower, TestBetterCharacter, TestBillboard, TestBitmapFont, TestBitmapFontAlignment, TestBitmapFontLayout, TestBitmapText3D, TestBlendEquations, TestBloom, TestBloomAlphaThreshold, TestBoneRagdoll, TestBox, TestBrickTower, TestBrickWall, TestBumpModel, TestCameraMotionPath, TestCameraNode, TestCartoonEdge, TestCcd, TestChangeAppIcon, TestChaseCamera, TestChaseCameraAppState, TestCinematic, TestCollisionGroups, TestCollisionListener, TestCollisionShapeFactory, TestColorApp, TestColoredTexture, TestComboMoves, TestConeVSFrustum, TestContextRestart, TestContextSwitching, TestContrastAdjustment, TestControls, TestCrossHatch, TestCursor, TestCustomAnim, TestCustomMesh, TestCylinder, TestDebugShapes, TestDepthFuncChange, TestDepthOfField, TestDepthStencil, TestDirectionalLightShadow, TestDoppler, TestEnqueueRunnable, TestEnvironmentMapping, TestEverything, TestExpandingTorus, TestExplosionEffect, TestFancyCar, TestFBOPassthrough, TestFog, TestGeometryShader, TestGhostObject, TestGimpactShape, TestGltfLoading, TestGltfUnlit, TestHoveringTank, TestHoverTank, TestHWSkinning, TestHWSkinningOld, TestImageRaster, TestInconsistentCompareDetection, TestInstancedNodeAttachDetachWithPicking, TestInstancedNodeAttachDetachWithShadowFilter, TestInstanceNode, TestInstanceNodeWithLight, TestIssue1013, TestIssue1120, TestIssue1125, TestIssue1340, TestIssue1395, TestIssue37, TestIssue801, TestIssue877, TestIssue883, TestIssue99, TestJaime, TestJoystick, TestKinematicAddToPhysicsSpaceIssue, TestLeakingGL, TestLightControl2Directional, TestLightControl2Spot, TestLightControlDirectional, TestLightControlSpot, TestLightingFog, TestLightRadius, TestLightScattering, TestLineWidth, TestLineWidthRenderState, TestLoadDds, TestLoadKtx, TestLocalPhysics, TestLodGeneration, TestLodStress, TestManyLights, TestManyLightsSingle, TestMatParamOverride, TestMipMapGen, TestModelExportingCloning, TestMonkeyHead, TestMorph, TestMotionPath, TestMousePick, TestMovingParticle, TestMultipleApplications, TestMultiplesFilters, TestMultiPostWater, TestMultiRenderTarget, TestMultiViews, TestMultiViewsFilters, TestMusicStreaming, TestNiftyExamples, TestNiftyGui, TestNiftyToMesh, TestNormalMapping, TestObbVsBounds, TestObjGroupsLoading, TestObjLoading, TestOgg, TestOgreAnim, TestOgreComplexAnim, TestOgreConvert, TestOgreLoading, TestOnlineJar, TestOpenCLLibraries, TestOrtho, TestParallax, TestParallaxPBR, TestParallelProjection, TestParticleExportingCloning, TestPBRDirectLighting, TestPBRLighting, TestPhysicsCar, TestPhysicsCharacter, TestPhysicsHingeJoint, TestPhysicsRayCast, TestPhysicsReadWrite, TestPointDirectionalAndSpotLightShadows, TestPointLightShadows, TestPointSprite, TestPosterization, TestPostFilters, TestPostFiltersCompositing, TestPostWater, TestPostWaterLake, TestQ3, TestRagDoll, TestRagdollCharacter, TestRayCasting, TestRefreshFlagBug, TestReleaseDirectMemory, TestRenderToCubemap, TestRenderToMemory, TestRenderToTexture, TestResizableApp, TestReverb, TestRtlBitmapText, TestSafeCanvas, TestSaveGame, TestSceneLoading, TestSceneStress, TestSceneWater, TestShaderNodes, TestShaderNodesStress, TestShadowBug, TestShadowsPerf, TestSimpleBumps, TestSimpleLighting, TestSimplePhysics, TestSimpleWater, TestSkeletonControlRefresh, TestSkyLoading, TestSkyRotation, TestSoftParticles, TestSoftwareMouse, TestSpatialAnim, TestSphere, TestSplitScreen, TestSpotLight, TestSpotLightShadows, TestSpotLightTerrain, TestSSAO, TestSSAO2, TestSweepTest, TestTangentCube, TestTangentGen, TestTangentGenBadUV, TestTangentSpace, TestTessellationShader, TestTexture3D, TestTexture3DLoading, TestTextureArray, TestTextureArrayCompressed, TestTextureAtlas, TestToneMapFilter, TestTransparentCartoonEdge, TestTransparentShadow, TestTransparentSSAO, TestTriangleCollision, TestTwoSideLighting, TestUnshadedModel, TestUrlLoading, TestUseAfterFree, TestUserData, TestVertexBufferSharing, TestWalkingChar, TestWav, TestWriteToTexture, TestZOrder, WorldOfInception
```
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)

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

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`FlyByCamera`	`getFlyByCamera()` Retrieves flyCam
`Node`	`getGuiNode()` Retrieves guiNode
`Node`	`getRootNode()` Retrieves rootNode
`float`	`getSpeed()` Returns the applications 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 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, 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 applications speed.
    
    Returns:
    
    The speed of the application.
  - setSpeed
```
public void setSpeed(float speed)
```
    Changes the application 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)
```

Class SimpleApplication

Field Summary

Fields inherited from class com.jme3.app.LegacyApplication

Constructor Summary

Method Summary

Methods inherited from class com.jme3.app.LegacyApplication

Methods inherited from class java.lang.Object

Field Detail

INPUT_MAPPING_EXIT

INPUT_MAPPING_CAMERA_POS

INPUT_MAPPING_MEMORY

INPUT_MAPPING_HIDE_STATS

rootNode

guiNode

fpsText

guiFont

flyCam

showSettings

Constructor Detail

SimpleApplication

SimpleApplication

Method Detail

start

getSpeed

setSpeed

getFlyByCamera

getGuiNode

getRootNode

isShowSettings

setShowSettings

loadGuiFont

initialize

update

setDisplayFps

setDisplayStatView

simpleInitApp

simpleUpdate

simpleRender