Package org.jzy3d.plot3d.rendering.legends.colorbars

Class AWTColorbarLegend

java.lang.Object

org.jzy3d.plot3d.rendering.view.AbstractViewportManager

org.jzy3d.plot3d.rendering.view.AWTImageViewport

org.jzy3d.plot3d.rendering.legends.AWTLegend

org.jzy3d.plot3d.rendering.legends.colorbars.AWTColorbarLegend

All Implemented Interfaces:

IDrawableListener, IColorbarLegend, ILegend, IImageViewport

public class AWTColorbarLegend
extends AWTLegend
implements IColorbarLegend

Handle a colorbar rendered as an AWT BufferedImage.

Content and coloring

A colorbar is configured with

• a colormap defined by the input Drawable if it is IMultiColorable and if it has a ColorMapper defined.
• a set of axis ticks defined and formated by
  invalid @link

  IAxisLayout

  .

Layout

The size of the colorbar image is driven by

• AWTLegend.setViewPort(int, int, float, float) which indicates the canvas dimension on screen and the slice that the colorbar should occupy. The image width will be imageWidth = width * (right - left). The viewport is set by ViewAndColorbarsLayout.

The position of the colorbar is defined by ViewAndColorbarsLayout which render the prepared image at the layout given position for this colorbar (which is defined with left/right parameters). Schema sources

Rendering path

EmulGL and Native have different rendering pathes

• Native chart have their colorbar image rendered by render(IPainter).
• EmulGL chart have their colorbar image rendered by AWT as bypassed by
  invalid @link

  EmulGLViewAndColorbarLayout

  , which customize the way pixel scale should be handled for rendering such image in a good layoout

Schema sources

Nested Class Summary

Nested classes/interfaces inherited from class org.jzy3d.plot3d.rendering.view.AWTImageViewport

AWTImageViewport.ImageLayout

Field Summary

Fields

Modifier and Type	Field	Description
protected int	askedHeight
protected int	askedWidth
protected int	choosenHeight
protected int	choosenWidth
protected static final int	DEFAULT_MARGIN_HEIGHT
protected Font	font
protected ITickProvider	provider
protected ITickRenderer	renderer

Fields inherited from class org.jzy3d.plot3d.rendering.legends.AWTLegend

background, drawable, foreground, imageGenerator, minimumDimension

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

image, imageData, imageHeight, imageWidth, margin, pixelScale

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

applyWindowsHiDPIWorkaround, lastViewPort, mode, screenBottom, screenGridDisplayed, screenHeight, screenLeft, screenSquaredDim, screenWidth, screenXOffset, screenYOffset

Constructor Summary

Constructors

Constructor	Description
AWTColorbarLegend(Drawable parent, Chart chart)
AWTColorbarLegend(Drawable parent, AxisLayout layout)
AWTColorbarLegend(Drawable parent, AxisLayout layout, Color foreground)
AWTColorbarLegend(Drawable parent, AxisLayout layout, Color foreground, Color background)
AWTColorbarLegend(Drawable parent, ITickProvider provider, ITickRenderer renderer)
AWTColorbarLegend(Drawable parent, ITickProvider provider, ITickRenderer renderer, Color foreground, Color background)

Method Summary

Modifier and Type	Method	Description
int	getChoosenHeight()
int	getChoosenWidth()
Font	getFont()
int	getHeight()
AWTColorbarImageGenerator	getImageGenerator()
Dimension	getMinimumDimension()	Return the minimum size for this graphic.
int	getWidth()
protected void	initImageGenerator(Drawable parent, ITickProvider provider, ITickRenderer renderer)
boolean	isEmulGLUnscale()
void	render(IPainter painter)	Renders the picture into the window, according to the viewport settings.
void	setEmulGLUnscale(boolean emulGLUnscale)
void	setFont(Font font)	Update image generator font
void	setMargin(Margin margin)	Update image according to new margin.
BufferedImage	toImage(int width, int height)
protected BufferedImage	toImage(int width, int height, Margin margin, Coord2d pixelScale)	Generate an image for this dimension, margin and pixel scale.
void	updateImage()	Recompute the picture, using last used dimensions.
void	updateMinimumDimension(IPainter painter)	Pre process an ideal width for the colorbar based on text width and other settings
void	updatePixelScale(Coord2d pixelScale)	Update the image with pixel scale if scale changed

Methods inherited from class org.jzy3d.plot3d.rendering.legends.AWTLegend

dispose, drawableChanged, getBackground, getForeground, saveImage, setBackground, setForeground, setGeneratorColors, setMinimumDimension, setMinimumWidth, setViewPort

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

computeLayout, getImage, getMargin, getPixelScale, renderImage, setImage, setImage, setImage

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

apply_WindowsHiDPI_Workaround, apply_WindowsHiDPI_Workaround, applyViewport, applyViewportRectangle, applyViewportSquared, getLastViewPort, getRectangle, getScreenBottom, getScreenHeight, getScreenLeft, getScreenWidth, getScreenXOffset, getScreenYOffset, getSliceWidth, getViewPort, getViewportMode, getWindowsHiDPIScale_Workaround, isApplyWindowsHiDPIWorkaround, isScreenGridDisplayed, renderSubScreenGrid, setApplyWindowsHiDPIWorkaround, setScreenGridDisplayed, setScreenXOffset, setScreenYOffset, setViewPort, setViewPort, setViewportMode

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jzy3d.plot3d.rendering.legends.colorbars.IColorbarLegend

drawableChanged, getMargin, setMinimumDimension

Methods inherited from interface org.jzy3d.plot3d.rendering.view.IImageViewport

getLastViewPort, getPixelScale, getSliceWidth, getViewportMode, setViewPort, setViewPort, setViewportMode

Methods inherited from interface org.jzy3d.plot3d.rendering.legends.ILegend

getMargin

Field Details

provider

protected ITickProvider provider

renderer

protected ITickRenderer renderer

askedWidth

protected int askedWidth

askedHeight

protected int askedHeight

choosenWidth

protected int choosenWidth

choosenHeight

protected int choosenHeight

font

protected Font font

DEFAULT_MARGIN_HEIGHT

protected static final int DEFAULT_MARGIN_HEIGHT

See Also:

• Constant Field Values

Constructor Details

AWTColorbarLegend

public AWTColorbarLegend(Drawable parent,
 Chart chart)

AWTColorbarLegend

public AWTColorbarLegend(Drawable parent,
 AxisLayout layout)

AWTColorbarLegend

public AWTColorbarLegend(Drawable parent,
 AxisLayout layout,
 Color foreground)

AWTColorbarLegend

public AWTColorbarLegend(Drawable parent,
 AxisLayout layout,
 Color foreground,
 Color background)

AWTColorbarLegend

public AWTColorbarLegend(Drawable parent,
 ITickProvider provider,
 ITickRenderer renderer)

AWTColorbarLegend

public AWTColorbarLegend(Drawable parent,
 ITickProvider provider,
 ITickRenderer renderer,
 Color foreground,
 Color background)

Method Details

initImageGenerator

protected void initImageGenerator(Drawable parent,
 ITickProvider provider,
 ITickRenderer renderer)

getMinimumDimension

public Dimension getMinimumDimension()

Description copied from class: AWTImageViewport

Return the minimum size for this graphic.

Specified by:

getMinimumDimension in interface IColorbarLegend

Specified by:

getMinimumDimension in interface IImageViewport

Overrides:

getMinimumDimension in class AWTLegend

render

public void render(IPainter painter)

Description copied from interface: IImageViewport

Renders the picture into the window, according to the viewport settings. If the picture is bigger than the viewport, it is simply centered in it, otherwise, it is scaled in order to fit into the viewport.

Specified by:

render in interface IColorbarLegend

Specified by:

render in interface IImageViewport

Overrides:

render in class AWTImageViewport

updateMinimumDimension

public void updateMinimumDimension(IPainter painter)

Pre process an ideal width for the colorbar based on text width and other settings

Specified by:

updateMinimumDimension in interface ILegend

toImage

public BufferedImage toImage(int width,
 int height)

Specified by:

toImage in class AWTLegend

toImage

protected BufferedImage toImage(int width,
 int height,
 Margin margin,
 Coord2d pixelScale)

Generate an image for this dimension, margin and pixel scale. If running on a HiDPI screen, width and height parameter will grow.

updateImage

public void updateImage()

Description copied from interface: ILegend

Recompute the picture, using last used dimensions.

Specified by:

updateImage in interface ILegend

Overrides:

updateImage in class AWTLegend

setMargin

public void setMargin(Margin margin)

Update image according to new margin.

Specified by:

setMargin in interface IColorbarLegend

Overrides:

setMargin in class AWTImageViewport

updatePixelScale

public void updatePixelScale(Coord2d pixelScale)

Update the image with pixel scale if scale changed

Specified by:

updatePixelScale in interface IImageViewport

Overrides:

updatePixelScale in class AWTImageViewport

setFont

public void setFont(Font font)

Update image generator font

Specified by:

setFont in interface ILegend

getFont

public Font getFont()

Specified by:

getFont in interface ILegend

getImageGenerator

public AWTColorbarImageGenerator getImageGenerator()

getWidth

public int getWidth()

Specified by:

getWidth in interface ILegend

getHeight

public int getHeight()

Specified by:

getHeight in interface ILegend

getChoosenWidth

public int getChoosenWidth()

getChoosenHeight

public int getChoosenHeight()

isEmulGLUnscale

public boolean isEmulGLUnscale()

setEmulGLUnscale

public void setEmulGLUnscale(boolean emulGLUnscale)