|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.layer.AbstractPlotter<SpotPlotter.SpotStyle>
uk.ac.starlink.ttools.plot2.layer.SpotPlotter
public class SpotPlotter
Fairly minimal example plotter implementation. It paints a fixed-size marker, for which the only style configuration option is colour. Admittedly, it's not all that simple.
This implements most of the required interfaces more or less from
scratch to show what's going on.
Reusing infrastructure from some other existing plotters
(e.g. subclassing ShapeForm
) may be more sensible
where appropriate.
Nested Class Summary | |
---|---|
static class |
SpotPlotter.SpotStyle
Style implementation for spots. |
Constructor Summary | |
---|---|
SpotPlotter()
Constructor. |
Method Summary | |
---|---|
PlotLayer |
createLayer(DataGeom geom,
DataSpec dataSpec,
SpotPlotter.SpotStyle style)
Creates a PlotLayer based on the given geometry, data and style. |
SpotPlotter.SpotStyle |
createStyle(ConfigMap config)
Creates a style that can be used when creating a plot layer. |
String |
getPlotterDescription()
Returns an XML description of this plotter. |
ConfigKey[] |
getStyleKeys()
Returns the configuration keys used to configure style for this plotter. |
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 |
---|
public SpotPlotter()
Method Detail |
---|
public String getPlotterDescription()
Plotter
Note: really this should appear at the LayerType level.
public ConfigKey[] getStyleKeys()
Plotter
Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
method.
public SpotPlotter.SpotStyle createStyle(ConfigMap config)
Plotter
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)
.
config
- map of style configuration items
public PlotLayer createLayer(DataGeom geom, DataSpec dataSpec, SpotPlotter.SpotStyle style)
Plotter
The style
parameter is the result of a call to
Plotter.createStyle(uk.ac.starlink.ttools.plot2.config.ConfigMap)
.
The dataSpec
parameter must contain the coordinates
defined by this plotter's CoordGroup.
The pointDataGeom
parameter is only used if
getCoordGroup()
.
getPositionCount
returns a non-zero value,
otherwise the plot does not have point positions.
It is legal to supply null for any of the parameters; if insufficient data is supplied to generate a plot, then the method should return null.
Creating a layer should be cheap; layers may be created and not used.
geom
- indicates base position coordinates and their
mapping to points in the data space;
if non-null, the data geom's
DataGeom.hasPosition()
method will return truedataSpec
- specifies the data required for the plotstyle
- data style as obtained from createStyle
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |