com.jme3.app.state

Class AWTComponentAppState

java.lang.Object

com.jme3.app.state.AbstractAppState

com.jme3.app.state.AWTComponentAppState

All Implemented Interfaces:

AppState

public class AWTComponentAppState
extends AbstractAppState

An app state dedicated to the rendering of a JMonkey application within an AWT component.

Field Summary

Fields inherited from class com.jme3.app.state.AbstractAppState

initialized

Constructor Summary

Constructors

Constructor and Description
AWTComponentAppState(java.awt.Component component) Create a new app state dedicated to the rendering of a JMonkey application within the given AWT component.

Method Summary

Modifier and Type	Method and Description
void	cleanup() Called by AppStateManager when transitioning this AppState from terminating to detached.
java.awt.Component	getComponent() Get the AWT component that is used as rendering output.
AWTFrameProcessor.TransferMode	getTransferMode() Get the transfer mode that is used by the underlying frame processor.
void	initialize(AppStateManager stateManager, Application app) Called by AppStateManager when transitioning this AppState from initializing to running. This will happen on the next iteration through the update loop after AppStateManager.attach(com.jme3.app.state.AppState) was called.
void	setComponent(java.awt.Component component) Set the AWT component that is used as rendering output.
void	setEnabled(boolean enabled) Enable or disable the functionality of the AppState.
void	setTransferMode(AWTFrameProcessor.TransferMode mode) Set the transfer mode that is used by the underlying frame processor.
void	stateAttached(AppStateManager stateManager) Called by AppStateManager.attach(com.jme3.app.state.AppState) when transitioning this AppState from detached to initializing.
void	update(float tpf) Called to update the AppState.

Methods inherited from class com.jme3.app.state.AbstractAppState

getId, isEnabled, isInitialized, postRender, render, setId, stateDetached

Methods inherited from class java.lang.Object

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

Constructor Detail

AWTComponentAppState

public AWTComponentAppState(java.awt.Component component)

Create a new app state dedicated to the rendering of a JMonkey application within the given AWT component.

Parameters:

component - the component that is used as rendering output.

Method Detail

initialize

public void initialize(AppStateManager stateManager,
                       Application app)

Description copied from interface: AppState

Called by AppStateManager when transitioning this AppState from initializing to running.
This will happen on the next iteration through the update loop after AppStateManager.attach(com.jme3.app.state.AppState) was called.

AppStateManager will call this only from the update loop inside the rendering thread. This means is it safe to modify the scene graph from this method.

Specified by:

initialize in interface AppState

Overrides:

initialize in class AbstractAppState

Parameters:

stateManager - The state manager

app - The application

stateAttached

public void stateAttached(AppStateManager stateManager)

Description copied from interface: AppState

Called by AppStateManager.attach(com.jme3.app.state.AppState) when transitioning this AppState from detached to initializing.

There is no assumption about the thread from which this function is called, therefore it is unsafe to modify the scene graph from this method. Please use AppState.initialize(com.jme3.app.state.AppStateManager, com.jme3.app.Application) instead.

Specified by:

stateAttached in interface AppState

Overrides:

stateAttached in class AbstractAppState

Parameters:

stateManager - State manager to which the state was attached to.

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: AppState

Enable or disable the functionality of the AppState. The effect of this call depends on implementation. An AppState starts as being enabled by default. A disabled AppStates does not get calls to AppState.update(float), AppState.render(RenderManager), or AppState.postRender() from its AppStateManager.

Specified by:

setEnabled in interface AppState

Overrides:

setEnabled in class AbstractAppState

Parameters:

enabled - activate the AppState or not.

update

public void update(float tpf)

Description copied from interface: AppState

Called to update the AppState. This method will be called every render pass if the AppState is both attached and enabled.

Specified by:

update in interface AppState

Overrides:

update in class AbstractAppState

Parameters:

tpf - Time since the last call to update(), in seconds.

cleanup

public void cleanup()

Description copied from interface: AppState

Called by AppStateManager when transitioning this AppState from terminating to detached. This method is called the following render pass after the AppState has been detached and is always called once and only once for each time initialize() is called. Either when the AppState is detached or when the application terminates (if it terminates normally).

Specified by:

cleanup in interface AppState

Overrides:

cleanup in class AbstractAppState

getComponent

public java.awt.Component getComponent()

Get the AWT component that is used as rendering output.

Returns:

the AWT component that is used as rendering output.

See Also:

setComponent(Component)

setComponent

public void setComponent(java.awt.Component component)

Set the AWT component that is used as rendering output.

Parameters:

component - the AWT component that is used as rendering output.

See Also:

getComponent()

getTransferMode

public AWTFrameProcessor.TransferMode getTransferMode()

Get the transfer mode that is used by the underlying frame processor.

Returns:

the transfer mode that is used by the underlying frame processor.

See Also:

setTransferMode(com.jme3.system.AWTFrameProcessor.TransferMode)

setTransferMode

public void setTransferMode(AWTFrameProcessor.TransferMode mode)

Set the transfer mode that is used by the underlying frame processor.

Parameters:

mode - the transfer mode that is used by the underlying frame processor.

See Also:

getTransferMode()