org.jzy3d.plot3d.rendering.canvas

Interface ICanvas

All Known Subinterfaces:

IScreenCanvas

All Known Implementing Classes:

CanvasAWT, CanvasNewtAwt, CanvasSwing, OffscreenCanvas, VoidCanvas

public interface ICanvas

A ICanvas represent the target component for rendering OpenGL. It might be displayed on the screen in a GUI (IScreenCanvas), or simply be an offscreen component able to export an image OffscreenCanvas.

See Also:

IScreenCanvas}

Method Summary

Modifier and Type	Method and Description
void	addKeyController(java.lang.Object o) A generic interface for mouse listener to remain Windowing toolkit independant.
void	addMouseController(java.lang.Object o) A generic interface for mouse listener to remain Windowing toolkit independant.
void	dispose() Performs all required cleanup when destroying a Canvas.
void	forceRepaint() Invoked when a user requires the Canvas to be repainted (e.g.
java.lang.String	getDebugInfo()
com.jogamp.opengl.GLDrawable	getDrawable() Returns the GLDrawable associated with the canvas
Renderer3d	getRenderer()
int	getRendererHeight() Returns the renderer's height, i.e.
int	getRendererWidth() Returns the renderer's width, i.e.
View	getView() Returns a reference to the held view.
void	removeKeyController(java.lang.Object o) A generic interface for key listener to remain Windowing toolkit independant.
void	removeMouseController(java.lang.Object o) A generic interface for key listener to remain Windowing toolkit independant.
com.jogamp.opengl.util.texture.TextureData	screenshot() Returns an image with the current renderer's size
com.jogamp.opengl.util.texture.TextureData	screenshot(java.io.File file)
void	setPixelScale(float[] scale) Defines pixel scale.

Method Detail

getView

View getView()

Returns a reference to the held view.

getDrawable

com.jogamp.opengl.GLDrawable getDrawable()

Returns the GLDrawable associated with the canvas

getRendererWidth

int getRendererWidth()

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

getRendererHeight

int getRendererHeight()

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

getRenderer

Renderer3d getRenderer()

forceRepaint

void forceRepaint()

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

screenshot

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

Returns an image with the current renderer's size

screenshot

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

Throws:

java.io.IOException

dispose

void dispose()

Performs all required cleanup when destroying a Canvas.

addMouseController

void addMouseController(java.lang.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.

addKeyController

void addKeyController(java.lang.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.

removeMouseController

void removeMouseController(java.lang.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.

removeKeyController

void removeKeyController(java.lang.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.

getDebugInfo

java.lang.String getDebugInfo()

setPixelScale

void setPixelScale(float[] scale)

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 })

See Also:

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