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();
 
 

Author:

Nils Hoffman, Martin Pernollet

Field Summary

protected javax.media.opengl.GLPbuffer	glpBuffer
protected Renderer3d	renderer
protected View	view

Constructor Summary

OffscreenCanvas(IChartComponentFactory factory, Scene scene, Quality quality, javax.media.opengl.GLCapabilities capabilities, int width, int height)

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

Method Summary

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).
String	getDebugInfo()
javax.media.opengl.GLDrawable	getDrawable() Returns the GLDrawable associated with the canvas
javax.media.opengl.GLPbuffer	getGlpBuffer()
Renderer3d	getRenderer()
int	getRendererHeight() Provide the actual renderer height for the open gl camera settings, which is obtained after a resize event.
int	getRendererWidth() Provide the actual renderer width for the open gl camera settings, which is obtained after a resize event.
View	getView() Provide a reference to the View that renders into this canvas.
protected void	initGLPBuffer(javax.media.opengl.GLCapabilities capabilities, int width, int height)
protected void	initGLPBuffer(int width, int height)
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)

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 javax.media.opengl.GLPbuffer glpBuffer

Constructor Detail

OffscreenCanvas

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

OffscreenCanvas

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

Method Detail

initGLPBuffer

protected void initGLPBuffer(javax.media.opengl.GLCapabilities capabilities,
                             int width,
                             int height)

initGLPBuffer

protected void initGLPBuffer(int width,
                             int height)

getGlpBuffer

public javax.media.opengl.GLPbuffer getGlpBuffer()

getDrawable

public javax.media.opengl.GLDrawable 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()

Provide the actual renderer width for the open gl camera settings, which is obtained after a resize event.

Specified by:

getRendererWidth in interface ICanvas

getRendererHeight

public int getRendererHeight()

Provide the actual renderer height for the open gl camera settings, which is obtained after a resize event.

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