com.jme3.system

Class AWTComponentRenderer

java.lang.Object

com.jme3.system.AWTComponentRenderer

public class AWTComponentRenderer
extends java.lang.Object

This class enables to update graphics of an AWT component with the result of JMonkey 3D rendering.

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

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	byteBuffer The byte buffer.
protected static int	DISPOSED_STATE The constant DISPOSED_STATE.
protected static int	DISPOSING_STATE The constant DISPOSING_STATE.
protected FrameBuffer	frameBuffer The Frame buffer.
protected java.nio.ByteBuffer	frameByteBuffer The Frame byte buffer.
protected int	frameCount How many frames need to write else.
protected java.util.concurrent.atomic.AtomicInteger	frameState The Frame state.
protected int[]	imageByteBuffer The image byte buffer.
protected java.util.concurrent.atomic.AtomicInteger	imageState The Image state.
protected java.awt.Graphics	pixelWriter The Pixel writer.
protected byte[]	prevImageByteBuffer The prev image byte buffer.
protected static int	RUNNING_STATE The constant RUNNING_STATE.
protected AWTFrameProcessor.TransferMode	transferMode The transfer mode.
protected static int	WAITING_STATE The constant WAITING_STATE.

Constructor Summary

Constructors

Constructor and Description
AWTComponentRenderer(java.awt.Component destination, AWTFrameProcessor.TransferMode transferMode, FrameBuffer frameBuffer, int width, int height) Create a new component renderer attached to the given destination.
AWTComponentRenderer(java.awt.Component destination, int width, int height, AWTFrameProcessor.TransferMode transferMode) Create a new component renderer attached to the given destination.

Method Summary

Modifier and Type	Method and Description
void	copyFrameBufferToImage(RenderManager renderManager) Copy the JMonkey frame buffer that has been rendered by the JMonkey engine and schedule the rendering of the component.
void	dispose() Dispose this renderer.
protected java.awt.Graphics	getGraphics(java.awt.Component destination) Get the graphics context of the given component.
int	getHeight() Get the height of the area to render.
protected int[]	getImageByteBuffer() Get the image byte buffer.
protected byte[]	getPrevImageByteBuffer() Get the previous image byte buffer.
int	getWidth() Get the width of the area to render.
void	init(Renderer renderer, boolean main) Initialize the component renderer.
protected void	writeFrame() Write the current rendered frame to the component graphics context.

Methods inherited from class java.lang.Object

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

Field Detail

RUNNING_STATE

protected static final int RUNNING_STATE

The constant RUNNING_STATE.

See Also:

Constant Field Values

WAITING_STATE

protected static final int WAITING_STATE

The constant WAITING_STATE.

See Also:

Constant Field Values

DISPOSING_STATE

protected static final int DISPOSING_STATE

The constant DISPOSING_STATE.

See Also:

Constant Field Values

DISPOSED_STATE

protected static final int DISPOSED_STATE

The constant DISPOSED_STATE.

See Also:

Constant Field Values

frameState

protected final java.util.concurrent.atomic.AtomicInteger frameState

The Frame state.

imageState

protected final java.util.concurrent.atomic.AtomicInteger imageState

The Image state.

frameBuffer

protected final FrameBuffer frameBuffer

The Frame buffer.

pixelWriter

protected final java.awt.Graphics pixelWriter

The Pixel writer.

frameByteBuffer

protected final java.nio.ByteBuffer frameByteBuffer

The Frame byte buffer.

transferMode

protected final AWTFrameProcessor.TransferMode transferMode

The transfer mode.

byteBuffer

protected final byte[] byteBuffer

The byte buffer.

imageByteBuffer

protected final int[] imageByteBuffer

The image byte buffer.

prevImageByteBuffer

protected final byte[] prevImageByteBuffer

The prev image byte buffer.

frameCount

protected int frameCount

How many frames need to write else.

Constructor Detail

AWTComponentRenderer

public AWTComponentRenderer(java.awt.Component destination,
                            int width,
                            int height,
                            AWTFrameProcessor.TransferMode transferMode)

Create a new component renderer attached to the given destination. The graphics of the destination are updated with the JMonkeyEngine rendering result.

Parameters:

destination - the AWT component to use as target of the JMonkeyEngine rendering.

width - the width of the component in pixels.

height - the height of the component in pixels.

transferMode - the rendering mode that can be AWTFrameProcessor.TransferMode.ALWAYS if the component has to be rendered at each update or AWTFrameProcessor.TransferMode.ON_CHANGES if the component has to be rendered only when changes are occurring.

AWTComponentRenderer

public AWTComponentRenderer(java.awt.Component destination,
                            AWTFrameProcessor.TransferMode transferMode,
                            FrameBuffer frameBuffer,
                            int width,
                            int height)

Create a new component renderer attached to the given destination. The graphics of the destination are updated with the JMonkeyEngine rendering result.

Parameters:

destination - the AWT component to use as target of the JMonkeyEngine rendering.

transferMode - the rendering mode that can be AWTFrameProcessor.TransferMode.ALWAYS if the component has to be rendered at each update or AWTFrameProcessor.TransferMode.ON_CHANGES if the component has to be rendered only when changes are occurring.

frameBuffer - the JMonkey frame buffer to use (if null is passed, a new default frame buffer is created)

width - the width of the component in pixels.

height - the height of the component in pixels.

Method Detail

init

public void init(Renderer renderer,
                 boolean main)

Initialize the component renderer.

Parameters:

renderer - the JMonkey renderer to use.

main - true if the attached frame buffer is the main one or false otherwise.

getGraphics

protected java.awt.Graphics getGraphics(java.awt.Component destination)

Get the graphics context of the given component.

Parameters:

destination - the AWT component used for rendering (not null)

Returns:

the graphics context of the given component.

getWidth

public int getWidth()

Get the width of the area to render.

Returns:

the width of the area to render.

See Also:

getHeight()

getHeight

public int getHeight()

Get the height of the area to render.

Returns:

the height of the area to render.

See Also:

getWidth()

copyFrameBufferToImage

public void copyFrameBufferToImage(RenderManager renderManager)

Copy the JMonkey frame buffer that has been rendered by the JMonkey engine and schedule the rendering of the component.

Parameters:

renderManager - the JMonkey render manager.

writeFrame

protected void writeFrame()

Write the current rendered frame to the component graphics context.

getImageByteBuffer

protected int[] getImageByteBuffer()

Get the image byte buffer.

Returns:

the image byte buffer.

getPrevImageByteBuffer

protected byte[] getPrevImageByteBuffer()

Get the previous image byte buffer.

Returns:

the previous image byte buffer.

dispose

public void dispose()

Dispose this renderer. The underlying frame buffer is also disposed.