uk.ac.starlink.ttools.plot2.layer

Class AreaForm<DG extends DataGeom>

java.lang.Object

uk.ac.starlink.ttools.plot2.layer.AreaForm<DG>

All Implemented Interfaces:

ModePlotter.Form, ShapeForm

public abstract class AreaForm<DG extends DataGeom>
extends Object
implements ShapeForm

ShapeForm that can plot Area coordinates as shapes on a plane or sky plot.

Since:

27 Mar 2020

Author:

Mark Taylor

Field Summary

Fields

Modifier and Type	Field and Description
static AreaForm<PlaneDataGeom>	PLANE_INSTANCE Instance for use with Plane plot.
static ConfigKey<PolygonShape>	POLYSHAPE_KEY Config key for polygon painting mode option.
static ConfigKey<Integer>	POLYTHICK_KEY Config key for polygon painting line thickness.
static FloatingCoord	RADIAL_COORD Coordinate for specifying radial coordinate.
static AreaForm<SkyDataGeom>	SKY_INSTANCE Instance for use with Sky plot.
static AreaForm<SphereDataGeom>	SPHERE_INSTANCE Instance for use with Sphere plot.

Method Summary

Modifier and Type	Method and 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.
protected abstract PolygonOutliner	createOutliner(PolygonShape polyShape, int minSize, MarkerShape minShape) Constructs a PolygonOutliner from a glypher for this form.
AreaCoord<DG>	getAreaCoord() Returns the coordinate associated with this form.
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.
String	getFormDescription() Returns a description of this mode as an XML string.
Icon	getFormIcon() Returns an icon to identify this form in the GUI.
String	getFormName() Returns the user-directed name for this form.

Methods inherited from class java.lang.Object

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

Field Detail

RADIAL_COORD

public static final FloatingCoord RADIAL_COORD

Coordinate for specifying radial coordinate.

PLANE_INSTANCE

public static final AreaForm<PlaneDataGeom> PLANE_INSTANCE

Instance for use with Plane plot.

SKY_INSTANCE

public static final AreaForm<SkyDataGeom> SKY_INSTANCE

Instance for use with Sky plot.

SPHERE_INSTANCE

public static final AreaForm<SphereDataGeom> SPHERE_INSTANCE

Instance for use with Sphere plot.

POLYSHAPE_KEY

public static final ConfigKey<PolygonShape> POLYSHAPE_KEY

Config key for polygon painting mode option.

POLYTHICK_KEY

public static final ConfigKey<Integer> POLYTHICK_KEY

Config key for polygon painting line thickness.

Method Detail

getFormName

public 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 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 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

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

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

getConfigKeys

public ConfigKey<?>[] getConfigKeys()

Description copied from interface: ShapeForm

Returns style configuration keys specific to this form. These keys will be used in the config map supplied to ShapeForm.createOutliner(uk.ac.starlink.ttools.plot2.config.ConfigMap).

Specified by:

getConfigKeys in interface ShapeForm

Returns:

config keys

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

createOutliner

protected abstract PolygonOutliner createOutliner(PolygonShape polyShape,
                                                  int minSize,
                                                  MarkerShape minShape)

Constructs a PolygonOutliner from a glypher for this form.

Parameters:

polyShape - glyph painter

minSize - threshold size for replacment markers

minShape - shape for replacement markers

Returns:

new outliner

getAreaCoord

public AreaCoord<DG> getAreaCoord()

Returns the coordinate associated with this form.

Returns:

coord

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