Application (jMonkeyEngine3)

All Known Implementing Classes:

CubeField, HelloAnimation, HelloAssets, HelloAudio, HelloCollision, HelloEffects, HelloInput, HelloJME3, HelloLoop, HelloMaterial, HelloNode, HelloOpenCL, HelloPhysics, HelloPicking, HelloTerrain, HelloTerrainCollision, LegacyApplication, PBRTerrainAdvancedTest, PBRTerrainTest, RefEnv, RollingTheMonkey, SimpleApplication, TerrainFractalGridTest, TerrainGridAlphaMapTest, TerrainGridSerializationTest, TerrainGridTest, TerrainGridTileLoaderTest, TerrainTest, TerrainTestAdvanced, TerrainTestAndroid, TerrainTestCollision, TerrainTestModifyHeight, TerrainTestReadWrite, TerrainTestTile, TestAlphaToCoverage, TestAmbient, TestAnimationFactory, TestAnimMigration, TestAnimMorphSerialization, TestAnimSerialization, TestAnisotropicFilter, TestAppStateLifeCycle, TestAppStates, TestArmature, TestAspectFov, TestAspectRatio, TestAssetLinkNode, TestAttachDriver, TestAttachGhostObject, TestAttachmentsNode, TestAwtPanels, TestBackgroundImage, TestBareBonesApp, 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, TestIssue1692, 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, VRApplication, WorldOfInception
```
public interface Application
```
The Application interface represents the minimum exposed capabilities of a concrete jME3 application.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`<V> java.util.concurrent.Future<V>`	`enqueue(java.util.concurrent.Callable<V> callable)` Enqueues a task/callable object to execute in the jME3 rendering thread.
`void`	`enqueue(java.lang.Runnable runnable)` Enqueues a runnable object to execute in the jME3 rendering thread.
`AppProfiler`	`getAppProfiler()` Returns the current AppProfiler hook, or null if none is set.
`AssetManager`	`getAssetManager()`
`AudioRenderer`	`getAudioRenderer()`
`Camera`	`getCamera()`
`JmeContext`	`getContext()`
`ViewPort`	`getGuiViewPort()`
`InputManager`	`getInputManager()`
`Listener`	`getListener()`
`LostFocusBehavior`	`getLostFocusBehavior()` Determine the application's behavior when unfocused.
`Renderer`	`getRenderer()`
`RenderManager`	`getRenderManager()`
`AppStateManager`	`getStateManager()`
`Timer`	`getTimer()`
`ViewPort`	`getViewPort()`
`boolean`	`isPauseOnLostFocus()` Returns true if pause on lost focus is enabled, false otherwise.
`void`	`restart()` Restarts the context, applying any changed settings.
`void`	`setAppProfiler(AppProfiler prof)` Sets an AppProfiler hook that will be called back for specific steps within a single update frame.
`void`	`setLostFocusBehavior(LostFocusBehavior lostFocusBehavior)` Changes the application's behavior when unfocused.
`void`	`setPauseOnLostFocus(boolean pauseOnLostFocus)` Enables or disables pause on lost focus.
`void`	`setSettings(AppSettings settings)` Set the display settings to define the display created.
`void`	`setTimer(Timer timer)` Sets the Timer implementation that will be used for calculating frame times.
`void`	`start()` Starts the application.
`void`	`start(boolean waitFor)` Starts the application.
`void`	`stop()` Requests the context to close, shutting down the main loop and making necessary cleanup operations.
`void`	`stop(boolean waitFor)` Requests the context to close, shutting down the main loop and making necessary cleanup operations.

- Method Detail
  - getLostFocusBehavior
```
LostFocusBehavior getLostFocusBehavior()
```
    Determine the application's behavior when unfocused.
    
    Returns:
    
    The lost focus behavior of the application.
  - setLostFocusBehavior
```
void setLostFocusBehavior(LostFocusBehavior lostFocusBehavior)
```
    Changes the application's behavior when unfocused. By default, the application will throttle the update loop so as not to use 100% of the CPU when it is out of focus, e.g. alt-tabbed, minimized, or obstructed by another window.
    
    Parameters:
    
    lostFocusBehavior - The new lost focus behavior to use.
    
    See Also:
    
    LostFocusBehavior
  - isPauseOnLostFocus
```
boolean isPauseOnLostFocus()
```
    Returns true if pause on lost focus is enabled, false otherwise.
    
    Returns:
    
    true if pause on lost focus is enabled
    
    See Also:
    
    getLostFocusBehavior()
  - setPauseOnLostFocus
```
void setPauseOnLostFocus(boolean pauseOnLostFocus)
```
    Enables or disables pause on lost focus.
    By default, pause on lost focus is enabled. If enabled, the application will stop updating when it loses focus or becomes inactive (e.g. alt-tab). For online or real-time applications, this might not be preferable, so this feature should be disabled. For other applications, it is best to keep it enabled so that CPU is not used unnecessarily.
    
    Parameters:
    
    pauseOnLostFocus - True to enable pause on lost focus, false otherwise.
    
    See Also:
    
    setLostFocusBehavior(com.jme3.app.LostFocusBehavior)
  - setSettings
```
void setSettings(AppSettings settings)
```
    Set the display settings to define the display created.
    Examples of display parameters include display pixel width and height, color bit depth, z-buffer bits, anti-aliasing samples, and update frequency. If this method is called while the application is already running, then restart() must be called to apply the settings to the display.
    
    Parameters:
    
    settings - The settings to set.
  - setTimer
```
void setTimer(Timer timer)
```
    Sets the Timer implementation that will be used for calculating frame times. By default, Application will use the Timer as returned by the current JmeContext implementation.
    
    Parameters:
    
    timer - the desired timer (alias created)
  - getTimer
```
Timer getTimer()
```
  - getAssetManager
```
AssetManager getAssetManager()
```
    Returns:
    
    The asset manager for this application.
  - getInputManager
```
InputManager getInputManager()
```
    Returns:
    
    the input manager.
  - getStateManager
```
AppStateManager getStateManager()
```
    Returns:
    
    the app state manager
  - getRenderManager
```
RenderManager getRenderManager()
```
    Returns:
    
    the render manager
  - getRenderer
```
Renderer getRenderer()
```
    Returns:
    
    The renderer for the application
  - getAudioRenderer
```
AudioRenderer getAudioRenderer()
```
    Returns:
    
    The audio renderer for the application
  - getListener
```
Listener getListener()
```
    Returns:
    
    The listener object for audio
  - getContext
```
JmeContext getContext()
```
    Returns:
    
    The display context for the application
  - getCamera
```
Camera getCamera()
```
    Returns:
    
    The main camera for the application
  - start
```
void start()
```
    Starts the application. A bug occurring when using LWJGL3 prevents this method from returning until after the application is stopped.
  - start
```
void start(boolean waitFor)
```
    Starts the application. A bug occurring when using LWJGL3 prevents this method from returning until after the application is stopped.
    
    Parameters:
    
    waitFor - true→wait for the context to be initialized, false→don't wait
  - setAppProfiler
```
void setAppProfiler(AppProfiler prof)
```
    Sets an AppProfiler hook that will be called back for specific steps within a single update frame. Value defaults to null.
    
    Parameters:
    
    prof - the profiler to use (alias created) or null for none (default=null)
  - getAppProfiler
```
AppProfiler getAppProfiler()
```
    Returns the current AppProfiler hook, or null if none is set.
    
    Returns:
    
    the pre-existing instance, or null if none
  - restart
```
void restart()
```
    Restarts the context, applying any changed settings.
    Changes to the AppSettings of this Application are not applied immediately; calling this method forces the context to restart, applying the new settings.
  - stop
```
void stop()
```
    Requests the context to close, shutting down the main loop and making necessary cleanup operations. Same as calling stop(false)
    
    See Also:
    
    stop(boolean)
  - stop
```
void stop(boolean waitFor)
```
    Requests the context to close, shutting down the main loop and making necessary cleanup operations. After the application has stopped, it cannot be used anymore.
    
    Parameters:
    
    waitFor - true→wait for the context to be fully destroyed, true→don't wait
  - enqueue
```
<V> java.util.concurrent.Future<V> enqueue(java.util.concurrent.Callable<V> callable)
```
    Enqueues a task/callable object to execute in the jME3 rendering thread.
    Callables are executed right at the beginning of the main loop. They are executed even if the application is currently paused or out of focus.
    
    Type Parameters:
    
    V - type of result returned by the Callable
    
    Parameters:
    
    callable - The callable to run in the main jME3 thread
    
    Returns:
    
    a new instance
  - enqueue
```
void enqueue(java.lang.Runnable runnable)
```
    Enqueues a runnable object to execute in the jME3 rendering thread.
    Runnables are executed right at the beginning of the main loop. They are executed even if the application is currently paused or out of focus.
    
    Parameters:
    
    runnable - The runnable to run in the main jME3 thread
  - getGuiViewPort
```
ViewPort getGuiViewPort()
```
    Returns:
    
    The GUI viewport. Which is used for the on screen statistics and FPS.
  - getViewPort
```
ViewPort getViewPort()
```

Interface Application

Method Summary

Method Detail

getLostFocusBehavior

setLostFocusBehavior

isPauseOnLostFocus

setPauseOnLostFocus

setSettings

setTimer

getTimer

getAssetManager

getInputManager

getStateManager

getRenderManager

getRenderer

getAudioRenderer

getListener

getContext

getCamera

start

start

setAppProfiler

getAppProfiler

restart

stop

stop

enqueue

enqueue

getGuiViewPort

getViewPort