Class MarkForm
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.layer.MarkForm
-
- All Implemented Interfaces:
ModePlotter.Form
,ShapeForm
public abstract class MarkForm extends java.lang.Object implements ShapeForm
ShapeForm implementation that just draws a fixed-size marker for each position. One or more positions per tuple may be marked.- Since:
- 18 Feb 2013
- Author:
- Mark Taylor
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
MarkForm(int npos, java.lang.String name, javax.swing.Icon icon)
Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static javax.swing.Icon
createLegendIcon(MarkShape shape, int size)
Returns a legend icon suitable for a single marker.static MarkForm
createMarkForm(int npos)
Factory method to create an instance of this class.static Glyph
createMarkGlyph(MarkShape shape, int size, boolean isMultipix)
Creates a Glyph representing a marker.static Outliner
createMarkOutliner(MarkShape shape, int size)
Returns an outliner for use with single points.static Outliner
createMultiMarkOutliner(MarkShape shape, int size, int npos)
Returns an outliner for use with multiple points.boolean
equals(java.lang.Object o)
Coord[]
getExtraCoords()
Returns data coordinates additional to the basic position which are required to plot a point.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.int
getPositionCount()
Returns the number of data positions per tuple used by this form.int
hashCode()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface uk.ac.starlink.ttools.plot2.layer.ShapeForm
createOutliner, getConfigKeys
-
-
-
-
Method Detail
-
getPositionCount
public int getPositionCount()
Description copied from interface:ShapeForm
Returns the number of data positions per tuple used by this form.- Specified by:
getPositionCount
in interfaceShapeForm
- Returns:
- number of 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 interfaceModePlotter.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 interfaceModePlotter.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 interfaceShapeForm
- 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 interfaceShapeForm
- Returns:
- additional plot coordinates
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in classjava.lang.Object
-
createMarkForm
public static MarkForm createMarkForm(int npos)
Factory method to create an instance of this class.- Parameters:
npos
- number of positions per tuple- Returns:
- form instance
-
createMarkOutliner
public static Outliner createMarkOutliner(MarkShape shape, int size)
Returns an outliner for use with single points.- Parameters:
shape
- marker shapesize
- marker size- Returns:
- single-point outliner
-
createMultiMarkOutliner
public static Outliner createMultiMarkOutliner(MarkShape shape, int size, int npos)
Returns an outliner for use with multiple points.- Parameters:
shape
- marker shapesize
- marker sizenpos
- number of positions per tuple- Returns:
- multi-point outliner
-
createMarkGlyph
public static Glyph createMarkGlyph(MarkShape shape, int size, boolean isMultipix)
Creates a Glyph representing a marker.- Parameters:
shape
- marker shapesize
- marker sizeisMultipix
- if true, optimise for an instance that may have createPixer called multiple times- Returns:
- marker glyph
-
createLegendIcon
public static javax.swing.Icon createLegendIcon(MarkShape shape, int size)
Returns a legend icon suitable for a single marker.- Parameters:
shape
- marker shapesize
- marker size- Returns:
- legend icon
-
-