org.jzy3d.plot3d.rendering.legends
Class Legend

java.lang.Object
  org.jzy3d.plot3d.rendering.view.ImageViewport
      org.jzy3d.plot3d.rendering.legends.Legend

All Implemented Interfaces:

IDrawableListener

Direct Known Subclasses:

ColorbarLegend

public abstract class Legend
extends ImageViewport
implements IDrawableListener

A Legend represent information concerning a AbstractDrawable that may be displayed as a metadata in the ChartView. The constructor of a Legend registers itself as listener of its parent AbstractDrawable, and unregister itself when it is disposed. When defining a concrete Legend, one should:

• override the toImage(int width, int height) method, that defines the picture representation.
• override the drawableChanged(DrawableChangedEvent e) method, that must select events that actually triggers an image update.

Last, a Legend optimizes rendering by :

• storing current image dimension,
• computing a new image only if the required Legend dimensions changed.

Author:

Martin Pernollet

Field Summary

protected ViewPort	lastViewPort
protected AbstractDrawable	parent
protected float	ratioHeight
protected float	ratioWidth
protected boolean	screenGridDisplayed
protected int	screenHeight
protected int	screenLeft
protected int	screenRight
protected int	screenSquaredDim
protected int	screenWidth
protected int	screenXOffset
protected int	screenYOffset
protected boolean	stretchToFill

Fields inherited from class org.jzy3d.plot3d.rendering.view.ImageViewport

imageHeight, imageObj, imageWidth

Constructor Summary

Legend(AbstractDrawable parent)

Method Summary

protected void	applyViewPort(javax.media.opengl.GL2 gl, javax.media.opengl.glu.GLU glu) Apply the GL viewport according to the settings given to setViewPort.
void	dispose()
abstract void	drawableChanged(DrawableChangedEvent e)
ViewPort	getLastViewPort()
Rectangle	getRectangle() Returns the (x,y) offset that was applied to make this AbstractViewport stand in the appropriate canvas part.
boolean	getStretchToFill()
void	saveImage()
void	setScreenGridDisplayed(boolean status) Set the status of the screen grid.
void	setStretchToFill(boolean status) Set the status of the stretching mode (activated or not).
void	setViewPort(int width, int height) Set the view port (size of the renderer).
void	setViewPort(int width, int height, float left, float right) Defines viewport dimensions, and precompute an image if required (i.e. if the viewport dimension have changed
void	setViewPort(ViewPort viewport)
abstract Image	toImage(int width, int height)
void	updateImage() Recompute the picture, using last used dimensions.

Methods inherited from class org.jzy3d.plot3d.rendering.view.ImageViewport

getImage, getMinimumSize, getPreferedSize, render, setImage, setImage, setImage

Methods inherited from class java.lang.Object

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

Field Detail

parent

protected AbstractDrawable parent

lastViewPort

protected ViewPort lastViewPort

screenLeft

protected int screenLeft

screenRight

protected int screenRight

screenXOffset

protected int screenXOffset

screenYOffset

protected int screenYOffset

screenWidth

protected int screenWidth

screenHeight

protected int screenHeight

screenSquaredDim

protected int screenSquaredDim

screenGridDisplayed

protected boolean screenGridDisplayed

stretchToFill

protected boolean stretchToFill

ratioWidth

protected float ratioWidth

ratioHeight

protected float ratioHeight

Constructor Detail

Legend

public Legend(AbstractDrawable parent)

Method Detail

dispose

public void dispose()

toImage

public abstract Image toImage(int width,
                              int height)

drawableChanged

public abstract void drawableChanged(DrawableChangedEvent e)

Specified by:

drawableChanged in interface IDrawableListener

setViewPort

public void setViewPort(int width,
                        int height,
                        float left,
                        float right)

Defines viewport dimensions, and precompute an image if required (i.e. if the viewport dimension have changed

Parameters:

width - the width of the target window.

height - the height of the target window.

left - the width's ratio where this subscreen starts in the target window.

right - the width's ratio where this subscreen stops in the target window.

updateImage

public void updateImage()

Recompute the picture, using last used dimensions.

saveImage

public void saveImage()

setStretchToFill

public void setStretchToFill(boolean status)

Set the status of the stretching mode (activated or not). Stretching consist in displaying the projection into the full screen slice (i.e. viewport).

Parameters:

status -

getStretchToFill

public boolean getStretchToFill()

setViewPort

public void setViewPort(int width,
                        int height)

Set the view port (size of the renderer).

Parameters:

width - the width of the target window.

height - the height of the target window.

setViewPort

public void setViewPort(ViewPort viewport)

getLastViewPort

public ViewPort getLastViewPort()

applyViewPort

protected void applyViewPort(javax.media.opengl.GL2 gl,
                             javax.media.opengl.glu.GLU glu)

Apply the GL viewport according to the settings given to setViewPort. If the screen grid was activated, the grid is rendered prior to the viewport definition. After a call to applyViewPort, one can query the offset that was applied to the viewport relative to the canvas. Indeed, when the stretchToFill option is disabled, the viewport is computed so that the content appears in a squared subpart of the canvas.

Parameters:

gl -

glu -

getRectangle

public Rectangle getRectangle()

Returns the (x,y) offset that was applied to make this AbstractViewport stand in the appropriate canvas part. and the actual width and height of the viewport. Only relevant after a call to applyViewPort.

setScreenGridDisplayed

public void setScreenGridDisplayed(boolean status)

Set the status of the screen grid.

Parameters:

status - the grid is displayed if status is set to true