uk.ac.starlink.ttools.plot2.layer
Class LinePlotter

java.lang.Object
  extended by uk.ac.starlink.ttools.plot2.layer.AbstractPlotter<S>
      extended by uk.ac.starlink.ttools.plot2.layer.SimpleDecalPlotter<LineStyle>
          extended by uk.ac.starlink.ttools.plot2.layer.LinePlotter
All Implemented Interfaces:
Plotter<LineStyle>

public class LinePlotter
extends SimpleDecalPlotter<LineStyle>

Plotter that plots a line between data points.

Since:
15 Feb 2013
Author:
Mark Taylor

Constructor Summary
LinePlotter()
          Constructor.
 
Method Summary
 LineStyle createStyle(ConfigMap config)
          Creates a style that can be used when creating a plot layer.
protected  LayerOpt getLayerOpt(LineStyle style)
          Indicates the layer optimisation options that apply to a given style.
 String getPlotterDescription()
          Returns an XML description of this plotter.
 ConfigKey[] getStyleKeys()
          Returns the configuration keys used to configure style for this plotter.
protected  void paintData2D(Surface surface, DataStore dataStore, DataGeom geom, DataSpec dataSpec, LineStyle style, Graphics g, PaperType paperType)
          Called during Decal painting to perform the actual plot.
 
Methods inherited from class uk.ac.starlink.ttools.plot2.layer.SimpleDecalPlotter
createLayer
 
Methods inherited from class uk.ac.starlink.ttools.plot2.layer.AbstractPlotter
getCoordGroup, getPlotterIcon, getPlotterName, hasReports
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LinePlotter

public LinePlotter()
Constructor.

Method Detail

getPlotterDescription

public String getPlotterDescription()
Description copied from interface: Plotter
Returns an XML description of this plotter.

Note: really this should appear at the LayerType level.

Returns:
one or more <p> elements

getStyleKeys

public ConfigKey[] getStyleKeys()
Description copied from interface: Plotter
Returns the configuration keys used to configure style for this plotter. The keys in the return value are used in the map supplied to the Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap) method.

Returns:
keys used when creating a style for this plotter.

createStyle

public LineStyle createStyle(ConfigMap config)
Description copied from interface: Plotter
Creates a style that can be used when creating a plot layer. The keys that are significant in the supplied config map are those returned by Plotter.getStyleKeys(). The return value can be used as input to Plotter.createLayer(uk.ac.starlink.ttools.plot2.DataGeom, uk.ac.starlink.ttools.plot2.data.DataSpec, S).

Parameters:
config - map of style configuration items
Returns:
plotter-specific plot style

getLayerOpt

protected LayerOpt getLayerOpt(LineStyle style)
Description copied from class: SimpleDecalPlotter
Indicates the layer optimisation options that apply to a given style.

Specified by:
getLayerOpt in class SimpleDecalPlotter<LineStyle>
Parameters:
style - plot style
Returns:
layer options

paintData2D

protected void paintData2D(Surface surface,
                           DataStore dataStore,
                           DataGeom geom,
                           DataSpec dataSpec,
                           LineStyle style,
                           Graphics g,
                           PaperType paperType)
Description copied from class: SimpleDecalPlotter
Called during Decal painting to perform the actual plot.

Specified by:
paintData2D in class SimpleDecalPlotter<LineStyle>
Parameters:
surface - plot surface
dataStore - data storage object
geom - data geometry
style - plot style
g - graphics context
paperType - paper type


Copyright © 2015 Central Laboratory of the Research Councils. All Rights Reserved.