com.jme3.system

Class AWTFrameProcessor

java.lang.Object

com.jme3.system.AWTFrameProcessor

All Implemented Interfaces:

SceneProcessor, java.beans.PropertyChangeListener, java.util.EventListener

public class AWTFrameProcessor
extends java.lang.Object
implements SceneProcessor, java.beans.PropertyChangeListener

A frame processor that enables to render JMonkey frame buffer onto an AWT component.

This class is based on the JavaFX original code provided by Alexander Brui (see JME3-FX)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AWTFrameProcessor.TransferMode

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Component	destination The destination of jMe frames.
protected java.beans.PropertyChangeListener	heightListener The height listener.
protected java.beans.PropertyChangeListener	rationListener The ration listener.
protected java.beans.PropertyChangeListener	widthListener The width listener.

Constructor Summary

Constructors

Constructor and Description
AWTFrameProcessor()

Method Summary

Modifier and Type	Method and Description
void	bind(java.awt.Component destination, Application application) Bind this processor.
void	bind(java.awt.Component destination, Application application, ViewPort viewPort) Bind this processor.
void	bind(java.awt.Component destination, Application application, ViewPort viewPort, boolean main) Bind this processor.
protected void	bindDestination(Application application, java.awt.Component destination) Bind this processor.
protected void	bindListeners()
void	cleanup() Called when the SP is removed from the RM.
protected AWTComponentRenderer	createFrameTransfer(FrameBuffer frameBuffer, int width, int height) Create a new frame transfer.
protected Application	getApplication() Gets the application.
protected int	getCameraAngle() Gets camera angle.
protected java.awt.Component	getDestination() Gets the current destination.
protected int	getDestinationHeight() Gets destination height.
protected int	getDestinationWidth() Gets destination width.
protected AWTComponentRenderer	getFrameTransfer() Gets the frame transfer.
protected RenderManager	getRenderManager() Gets the render manager.
AWTFrameProcessor.TransferMode	getTransferMode()
protected ViewPort	getViewPort() Gets the view port.
protected boolean	hasApplication() Checks of existing application.
protected boolean	hasDestination() Checks of existing destination.
void	initialize(RenderManager rm, ViewPort vp) Called in the render thread to initialize the scene processor.
boolean	isEnabled()
boolean	isInitialized()
boolean	isMain()
protected boolean	isPreserveRatio() Is preserve ratio.
protected void	notifyChangedHeight(java.lang.Number newValue) Notify about that the height was changed.
protected void	notifyChangedRatio(java.lang.Boolean newValue) Notify about that the ratio was changed.
protected void	notifyChangedWidth(java.lang.Number newValue) Notify about that the width was changed.
protected void	notifyComponentResized(int newWidth, int newHeight, boolean fixAspect) Handle resizing.
void	postFrame(FrameBuffer out) Called after a frame has been rendered and the queue flushed.
void	postQueue(RenderQueue rq) Called after the scene graph has been queued, but before it is flushed.
void	preFrame(float tpf) Called before a frame
void	propertyChange(java.beans.PropertyChangeEvent evt)
void	reshape()
void	reshape(ViewPort vp, int w, int h) Called when the resolution of the viewport has been changed.
protected void	reshapeCurrentViewPort(int width, int height) Reshape the current view port.
protected AWTComponentRenderer	reshapeInThread(int width, int height, boolean fixAspect) Reshape the current frame transfer for the new size.
protected void	setApplication(Application application) Sets the application.
protected void	setDestination(java.awt.Component destination) Sets the destination.
void	setEnabled(boolean enabled)
protected void	setFrameTransfer(AWTComponentRenderer frameTransfer) Sets the frame transfer.
void	setProfiler(AppProfiler profiler) Sets a profiler Instance for this processor.
void	setTransferMode(AWTFrameProcessor.TransferMode transferMode)
void	unbind() Unbind this processor from its current destination.
protected void	unbindDestination() Unbind this processor from destination.
protected void	unbindListeners()

Methods inherited from class java.lang.Object

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

Field Detail

widthListener

protected java.beans.PropertyChangeListener widthListener

The width listener.

heightListener

protected java.beans.PropertyChangeListener heightListener

The height listener.

rationListener

protected java.beans.PropertyChangeListener rationListener

The ration listener.

destination

protected volatile java.awt.Component destination

The destination of jMe frames.

Constructor Detail

AWTFrameProcessor

public AWTFrameProcessor()

Method Detail

initialize

public void initialize(RenderManager rm,
                       ViewPort vp)

Description copied from interface: SceneProcessor

Called in the render thread to initialize the scene processor.

Specified by:

initialize in interface SceneProcessor

Parameters:

rm - The render manager to which the SP was added to

vp - The viewport to which the SP is assigned

reshape

public void reshape(ViewPort vp,
                    int w,
                    int h)

Description copied from interface: SceneProcessor

Called when the resolution of the viewport has been changed.

Specified by:

reshape in interface SceneProcessor

Parameters:

vp - the affected ViewPort

w - the new width (in pixels)

h - the new height (in pixels)

isInitialized

public boolean isInitialized()

Specified by:

isInitialized in interface SceneProcessor

Returns:

True if initialize() has been called on this SceneProcessor, false if otherwise.

preFrame

public void preFrame(float tpf)

Description copied from interface: SceneProcessor

Called before a frame

Specified by:

preFrame in interface SceneProcessor

Parameters:

tpf - Time per frame

postQueue

public void postQueue(RenderQueue rq)

Description copied from interface: SceneProcessor

Called after the scene graph has been queued, but before it is flushed.

Specified by:

postQueue in interface SceneProcessor

Parameters:

rq - The render queue

postFrame

public void postFrame(FrameBuffer out)

Description copied from interface: SceneProcessor

Called after a frame has been rendered and the queue flushed.

Specified by:

postFrame in interface SceneProcessor

Parameters:

out - The FB to which the scene was rendered.

cleanup

public void cleanup()

Description copied from interface: SceneProcessor

Called when the SP is removed from the RM.

Specified by:

cleanup in interface SceneProcessor

setProfiler

public void setProfiler(AppProfiler profiler)

Description copied from interface: SceneProcessor

Sets a profiler Instance for this processor.

Specified by:

setProfiler in interface SceneProcessor

Parameters:

profiler - the profiler instance.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent evt)

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

notifyChangedRatio

protected void notifyChangedRatio(java.lang.Boolean newValue)

Notify about that the ratio was changed.

Parameters:

newValue - the new value of the ratio.

notifyChangedHeight

protected void notifyChangedHeight(java.lang.Number newValue)

Notify about that the height was changed.

Parameters:

newValue - the new value of the height.

notifyChangedWidth

protected void notifyChangedWidth(java.lang.Number newValue)

Notify about that the width was changed.

Parameters:

newValue - the new value of the width.

getApplication

protected Application getApplication()

Gets the application.

Returns:

the application.

setApplication

protected void setApplication(Application application)

Sets the application.

Parameters:

application - the application.

getDestination

protected java.awt.Component getDestination()

Gets the current destination.

Returns:

the current destination.

setDestination

protected void setDestination(java.awt.Component destination)

Sets the destination.

Parameters:

destination - the destination.

hasDestination

protected boolean hasDestination()

Checks of existing destination.

Returns:

true if destination is exists.

hasApplication

protected boolean hasApplication()

Checks of existing application.

Returns:

true if destination is exists.

getFrameTransfer

protected AWTComponentRenderer getFrameTransfer()

Gets the frame transfer.

Returns:

the file transfer.

setFrameTransfer

protected void setFrameTransfer(AWTComponentRenderer frameTransfer)

Sets the frame transfer.

Parameters:

frameTransfer - the file transfer.

getViewPort

protected ViewPort getViewPort()

Gets the view port.

Returns:

the view port.

getRenderManager

protected RenderManager getRenderManager()

Gets the render manager.

Returns:

the render manager.

isMain

public boolean isMain()

isEnabled

public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

notifyComponentResized

protected void notifyComponentResized(int newWidth,
                                      int newHeight,
                                      boolean fixAspect)

Handle resizing.

Parameters:

newWidth - the new width.

newHeight - the new height.

fixAspect - true if need to fix aspect.

reshape

public void reshape()

isPreserveRatio

protected boolean isPreserveRatio()

Is preserve ratio.

Returns:

is preserve ratio.

getDestinationWidth

protected int getDestinationWidth()

Gets destination width.

Returns:

the destination width.

getDestinationHeight

protected int getDestinationHeight()

Gets destination height.

Returns:

the destination height.

bind

public void bind(java.awt.Component destination,
                 Application application)

Bind this processor.

Parameters:

destination - the destination.

application - the application.

bind

public void bind(java.awt.Component destination,
                 Application application,
                 ViewPort viewPort)

Bind this processor.

Parameters:

destination - the destination.

application - the application.

viewPort - the view port.

bind

public void bind(java.awt.Component destination,
                 Application application,
                 ViewPort viewPort,
                 boolean main)

Bind this processor.

Parameters:

destination - the destination.

application - the application.

viewPort - the view port.

main - true if this processor is main.

unbind

public void unbind()

Unbind this processor from its current destination.

bindDestination

protected void bindDestination(Application application,
                               java.awt.Component destination)

Bind this processor.

Parameters:

application - the application.

destination - the destination.

unbindDestination

protected void unbindDestination()

Unbind this processor from destination.

bindListeners

protected void bindListeners()

unbindListeners

protected void unbindListeners()

reshapeInThread

protected AWTComponentRenderer reshapeInThread(int width,
                                               int height,
                                               boolean fixAspect)

Reshape the current frame transfer for the new size.

Parameters:

width - the width.

height - the height.

fixAspect - true if need to fix aspect ration.

Returns:

the new frame transfer.

createFrameTransfer

protected AWTComponentRenderer createFrameTransfer(FrameBuffer frameBuffer,
                                                   int width,
                                                   int height)

Create a new frame transfer.

Parameters:

frameBuffer - the frame buffer.

width - the width.

height - the height.

Returns:

the new frame transfer.

reshapeCurrentViewPort

protected void reshapeCurrentViewPort(int width,
                                      int height)

Reshape the current view port.

Parameters:

width - the width.

height - the height.

getCameraAngle

protected int getCameraAngle()

Gets camera angle.

Returns:

the camera angle.

getTransferMode

public AWTFrameProcessor.TransferMode getTransferMode()

setTransferMode

public void setTransferMode(AWTFrameProcessor.TransferMode transferMode)