Package noaa.coastwatch.render

Class EarthDataPlot

java.lang.Object

noaa.coastwatch.render.EarthDataPlot

All Implemented Interfaces:

Renderable

public class EarthDataPlot
extends Object
implements Renderable

The earth data plot class is used for rendering earth data with legends. The plot uses an earth data view and earth data information object to render a data plot showing the view, its associated view legend (if any), and an earth data information legend with icon and context map. The plot is laid out as follows:

   +------------------------------------+
   |               border               |
   |  +----------------+  +--+  +----+  |
   |  |                |  |  |  |    |  |
   |  |                |  |  |  |    |  |
   |  |                |  |  |  |    |  |
   |  |                |  View  |Info|  |
   |  |Earth data view | legend legend  |
   |  |                |  |  |  |    |  |
   |  |                |  |  |  |    |  |
   |  |                |  |  |  |    |  |
   |  |                |  |  |  |    |  |
   |  |                |  |  |  |    |  |
   |  +----------------+  +--+  +----+  |
   |               border               |
   +------------------------------------+
 

Since:

3.1.1

Author:

Peter Hollemans

Constructor Summary

Constructors

Constructor	Description
EarthDataPlot(EarthDataView view, EarthDataInfo info, IconElement icon, Color fore, Color back, Font font)	Creates a new earth data plot from the specified parameters.

Method Summary

Modifier and Type	Method	Description
Dimension	getSize(Graphics2D g)	Gets the rendered plot size.
void	render(Graphics2D g)	Renders the plot to the graphics device.

Methods inherited from class java.lang.Object

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

Constructor Details

EarthDataPlot

public EarthDataPlot(EarthDataView view,
 EarthDataInfo info,
 IconElement icon,
 Color fore,
 Color back,
 Font font)

Creates a new earth data plot from the specified parameters.

Parameters:

view - the data view for rendering in the main plot area.

info - the info for the earth data information legend. If null, no info legend is drawn.

icon - the icon for the the info legend. This parameter can be null if info is null.

fore - the foreground drawing color for legend annotations.

back - the background drawing color for legends, or null for no backgrounds.

font - the font for legend annotations, or null for the default legend fonts.

See Also:

• DataColorScale
• EarthPlotInfo

Method Details

getSize

public Dimension getSize(Graphics2D g)

Gets the rendered plot size.

Specified by:

getSize in interface Renderable

Parameters:

g - the graphics context to be used for rendering. This is used to determine the total rendering size from font information and so on.

Returns:

the total rendered dimensions.

render

public void render(Graphics2D g)

Renders the plot to the graphics device.

Specified by:

render in interface Renderable

Parameters:

g - the graphics device for rendering.