org.jzy3d.plot3d.rendering.canvas

Class OffscreenCanvas

java.lang.Object

org.jzy3d.plot3d.rendering.canvas.OffscreenCanvas

All Implemented Interfaces:

ICanvas

public class OffscreenCanvas
extends Object
implements ICanvas

An ICanvas implementation able to render the chart in an offscreen canvas, meaning no frame or GUI is needed to get a chart. Subsequently, one will wish to generate chart images by calling:

 
 chart.screenshot();
 
 

Note that the GLCapabilities are modified while an instance of OffscreenCanvas is modified.

Author:

Nils Hoffman, Martin Pernollet

Field Summary

Fields

Modifier and Type	Field and Description
protected com.jogamp.opengl.GLCapabilities	capabilities
protected com.jogamp.opengl.GLOffscreenAutoDrawable	glpBuffer
protected Renderer3d	renderer
protected View	view

Constructor Summary

Constructors

Constructor and Description
OffscreenCanvas(IChartComponentFactory factory, Scene scene, Quality quality, com.jogamp.opengl.GLCapabilities capabilities, int width, int height)
OffscreenCanvas(IChartComponentFactory factory, Scene scene, Quality quality, com.jogamp.opengl.GLCapabilities capabilities, int width, int height, boolean traceGL, boolean debugGL)

Method Summary

Modifier and Type	Method and Description
void	addKeyController(Object o) A generic interface for mouse listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible mouse listener.
void	addMouseController(Object o) A generic interface for mouse listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible mouse listener.
void	dispose() Performs all required cleanup when destroying a Canvas.
void	forceRepaint() Invoked when a user requires the Canvas to be repainted (e.g. a non 3d layer has changed).
com.jogamp.opengl.GLCapabilities	getCapabilities()
String	getDebugInfo()
com.jogamp.opengl.GLOffscreenAutoDrawable	getDrawable() Returns the GLDrawable associated with the canvas
com.jogamp.opengl.GLOffscreenAutoDrawable	getGlpBuffer() Deprecated.
Renderer3d	getRenderer()
int	getRendererHeight() Returns the renderer's height, i.e. the display height.
int	getRendererWidth() Returns the renderer's width, i.e. the display width.
View	getView() Provide a reference to the View that renders into this canvas.
void	initBuffer(com.jogamp.opengl.GLCapabilities capabilities, int width, int height) Initialize a GLPBuffer with desired capabilities.
void	removeKeyController(Object o) A generic interface for key listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible key listener.
void	removeMouseController(Object o) A generic interface for key listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible key listener.
com.jogamp.opengl.util.texture.TextureData	screenshot() Returns an image with the current renderer's size
com.jogamp.opengl.util.texture.TextureData	screenshot(File file)
void	setPixelScale(float[] scale) Defines pixel scale.

Methods inherited from class java.lang.Object

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

Field Detail

view

protected View view

renderer

protected Renderer3d renderer

glpBuffer

protected com.jogamp.opengl.GLOffscreenAutoDrawable glpBuffer

capabilities

protected com.jogamp.opengl.GLCapabilities capabilities

Constructor Detail

OffscreenCanvas

public OffscreenCanvas(IChartComponentFactory factory,
                       Scene scene,
                       Quality quality,
                       com.jogamp.opengl.GLCapabilities capabilities,
                       int width,
                       int height)

OffscreenCanvas

public OffscreenCanvas(IChartComponentFactory factory,
                       Scene scene,
                       Quality quality,
                       com.jogamp.opengl.GLCapabilities capabilities,
                       int width,
                       int height,
                       boolean traceGL,
                       boolean debugGL)

Method Detail

initBuffer

public void initBuffer(com.jogamp.opengl.GLCapabilities capabilities,
                       int width,
                       int height)

Initialize a GLPBuffer with desired capabilities. Can be called several time to reset buffer dimensions.

Parameters:

capabilities -

width -

height -

setPixelScale

public void setPixelScale(float[] scale)

Description copied from interface: ICanvas

Defines pixel scale. On MacOS Retina displays, a X*Y chart uses a (X*2)*(Y*2) viewport. This makes some calculation based on viewport (such as Camera.screenToModel(com.jogamp.opengl.GL, com.jogamp.opengl.glu.GLU, org.jzy3d.maths.Coord3d) output wrong result. When running on Retina display, those two options fixed buggy mouse selections on Retina:

• setPixelScale(new float[]{0.5f,0.5f})
• setPixelScale(new float[] { ScalableSurface.IDENTITY_PIXELSCALE, ScalableSurface.IDENTITY_PIXELSCALE })

Specified by:

setPixelScale in interface ICanvas

See Also:

ScalableSurface#setSurfaceScale(float[])} in JOGL javadoc for more informations

getGlpBuffer

@Deprecated
public com.jogamp.opengl.GLOffscreenAutoDrawable getGlpBuffer()

Deprecated.

getDrawable

public com.jogamp.opengl.GLOffscreenAutoDrawable getDrawable()

Description copied from interface: ICanvas

Returns the GLDrawable associated with the canvas

Specified by:

getDrawable in interface ICanvas

dispose

public void dispose()

Description copied from interface: ICanvas

Performs all required cleanup when destroying a Canvas.

Specified by:

dispose in interface ICanvas

forceRepaint

public void forceRepaint()

Description copied from interface: ICanvas

Invoked when a user requires the Canvas to be repainted (e.g. a non 3d layer has changed).

Specified by:

forceRepaint in interface ICanvas

screenshot

public com.jogamp.opengl.util.texture.TextureData screenshot()

Description copied from interface: ICanvas

Returns an image with the current renderer's size

Specified by:

screenshot in interface ICanvas

screenshot

public com.jogamp.opengl.util.texture.TextureData screenshot(File file)
                                                      throws IOException

Specified by:

screenshot in interface ICanvas

Throws:

IOException

getView

public View getView()

Provide a reference to the View that renders into this canvas.

Specified by:

getView in interface ICanvas

getRendererWidth

public int getRendererWidth()

Description copied from interface: ICanvas

Returns the renderer's width, i.e. the display width.

Specified by:

getRendererWidth in interface ICanvas

getRendererHeight

public int getRendererHeight()

Description copied from interface: ICanvas

Returns the renderer's height, i.e. the display height.

Specified by:

getRendererHeight in interface ICanvas

getRenderer

public Renderer3d getRenderer()

Specified by:

getRenderer in interface ICanvas

getDebugInfo

public String getDebugInfo()

Specified by:

getDebugInfo in interface ICanvas

addMouseController

public void addMouseController(Object o)

Description copied from interface: ICanvas

A generic interface for mouse listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible mouse listener.

Specified by:

addMouseController in interface ICanvas

addKeyController

public void addKeyController(Object o)

Description copied from interface: ICanvas

A generic interface for mouse listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible mouse listener.

Specified by:

addKeyController in interface ICanvas

removeMouseController

public void removeMouseController(Object o)

Description copied from interface: ICanvas

A generic interface for key listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible key listener.

Specified by:

removeMouseController in interface ICanvas

removeKeyController

public void removeKeyController(Object o)

Description copied from interface: ICanvas

A generic interface for key listener to remain Windowing toolkit independant. * Implementation of this method should simply cast the input assuming it will correspond to canvas-compatible key listener.

Specified by:

removeKeyController in interface ICanvas

getCapabilities

public com.jogamp.opengl.GLCapabilities getCapabilities()