Package uk.ac.starlink.ttools.plot2.layer

Class SizeForm

  • All Implemented Interfaces:
    ModePlotter.Form, ShapeForm
    public class SizeForm
extends java.lang.Object
implements ShapeForm
    ShapeForm implementation that draws shaped markers of a size given by an additional data coordinate. Auto-scaling is provided. Singleton class.
    Since:
    18 Feb 2013
    Author:
    Mark Taylor

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SizeForm.SizeOutliner
      Outliner implementation for use with SizeForm.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DataGeom adjustGeom​(DataGeom geom, DataSpec dataSpec, ShapeStyle style)
      Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment.
      Outliner createOutliner​(ConfigMap config)
      Returns an object which will do the work of drawing shapes when supplied with the appropriate style information and data.
      int getBasicPositionCount()
      Returns the number of basic data positions per tuple used by this form.
      ConfigKey<?>[] getConfigKeys()
      Returns style configuration keys specific to this form.
      Coord[] getExtraCoords()
      Returns data coordinates additional to the basic position which are required to plot a point.
      int getExtraPositionCount()
      Returns the number of extra coordinates that can be interpreted as positions.
      java.lang.String getFormDescription()
      Returns a description of this mode as an XML string.
      javax.swing.Icon getFormIcon()
      Returns an icon to identify this form in the GUI.
      java.lang.String getFormName()
      Returns the user-directed name for this form.
      static SizeForm getInstance()
      Returns the sole instance of this class.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getBasicPositionCount

        public int getBasicPositionCount()
        Description copied from interface: ShapeForm
        Returns the number of basic data positions per tuple used by this form.
        Specified by:
        getBasicPositionCount in interface ShapeForm
        Returns:
        number of basic sets of positional coordinates

      • getFormName

        public java.lang.String getFormName()
        Description copied from interface: ModePlotter.Form
        Returns the user-directed name for this form.
        Specified by:
        getFormName in interface ModePlotter.Form
        Returns:
        form name

      • getFormIcon

        public javax.swing.Icon getFormIcon()
        Description copied from interface: ModePlotter.Form
        Returns an icon to identify this form in the GUI.
        Specified by:
        getFormIcon in interface ModePlotter.Form
        Returns:
        form icon

      • getFormDescription

        public java.lang.String getFormDescription()
        Description copied from interface: ShapeForm
        Returns a description of this mode as an XML string. The return value should be one or more <p> elements.
        Specified by:
        getFormDescription in interface ShapeForm
        Returns:
        XML description of form

      • getExtraCoords

        public Coord[] getExtraCoords()
        Description copied from interface: ShapeForm
        Returns data coordinates additional to the basic position which are required to plot a point.
        Specified by:
        getExtraCoords in interface ShapeForm
        Returns:
        additional plot coordinates

      • getExtraPositionCount

        public int getExtraPositionCount()
        Description copied from interface: ShapeForm
        Returns the number of extra coordinates that can be interpreted as positions.
        Specified by:
        getExtraPositionCount in interface ShapeForm
        Returns:
        number of positional extra coordinates

      • adjustGeom

        public DataGeom adjustGeom​(DataGeom geom,
                           DataSpec dataSpec,
                           ShapeStyle style)
        Description copied from interface: ShapeForm
        Provides a DataGeom to be used by the layer this form makes, given a DataGeom that characterises the plotting environment. The output should be similar to the input, for instance implementing the same plotType-specific DataGeom subtype.

        In most cases the supplied DataGeom instance can be returned unchanged, but instances with special requirements may want to adjust how the data is interpreted.

        Specified by:
        adjustGeom in interface ShapeForm
        Parameters:
        geom - context geom
        dataSpec - data specification with which the geom will be used
        style - style with which the geom will be used
        Returns:
        geom to use for data interpretation, the same or similar to the input

      • createOutliner

        public Outliner createOutliner​(ConfigMap config)
        Description copied from interface: ShapeForm
        Returns an object which will do the work of drawing shapes when supplied with the appropriate style information and data. The significant keys in the supplied config map are those given by ShapeForm.getConfigKeys().
        Specified by:
        createOutliner in interface ShapeForm
        Parameters:
        config - configuration map from which values for this form's config keys will be extracted
        Returns:
        new outliner object

      • getInstance

        public static SizeForm getInstance()
        Returns the sole instance of this class.
        Returns:
        singleton instance