Class SpotPlotter

  • All Implemented Interfaces:
    Plotter<SpotPlotter.SpotStyle>

    public class SpotPlotter
    extends AbstractPlotter<SpotPlotter.SpotStyle>
    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.

    Since:
    17 Feb 2013
    Author:
    Mark Taylor
    • Constructor Detail

      • SpotPlotter

        public SpotPlotter()
        Constructor.
    • Method Detail

      • getPlotterDescription

        public java.lang.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
      • createLayer

        public PlotLayer createLayer​(DataGeom geom,
                                     DataSpec dataSpec,
                                     SpotPlotter.SpotStyle style)
        Description copied from interface: Plotter
        Creates a PlotLayer based on the given geometry, data and style.

        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 the CoordGroup.getBasicPositionCount() or CoordGroup.getExtraPositionCount() method from this plotter's CoordGroup return 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.

        Parameters:
        geom - indicates base position coordinates and their mapping to points in the data space
        dataSpec - specifies the data required for the plot
        style - data style as obtained from createStyle
        Returns:
        new plot layer, or null if no drawing will take place