uk.ac.starlink.ttools.plot2.geom

Class PlanePlotType

java.lang.Object

uk.ac.starlink.ttools.plot2.geom.PlanePlotType

All Implemented Interfaces:

PlotType<PlaneSurfaceFactory.Profile,PlaneAspect>

Direct Known Subclasses:

MatrixPlotType

public class PlanePlotType
extends Object
implements PlotType<PlaneSurfaceFactory.Profile,PlaneAspect>

Defines the characteristics of a plot on a 2-dimensional plane.

This is a singleton class, see getInstance().

Since:

19 Feb 2013

Author:

Mark Taylor

Constructor Summary

Constructors

Constructor and Description
PlanePlotType(PlaneSurfaceFactory surfFact, Plotter<?>[] plotters) Constructor.

Method Summary

Modifier and Type	Method and Description
GangerFactory<PlaneSurfaceFactory.Profile,PlaneAspect>	getGangerFactory() Returns the object that controls how multi-zone plots are arranged.
static PlanePlotType	getInstance() Returns the sole instance of this class.
PaperTypeSelector	getPaperTypeSelector() Returns an object which can provide graphics rendering functionality based on the required plot layers for this plot type.
Plotter<?>[]	getPlotters() Returns a list of plotters that can be used to paint data on the surface.
DataGeom[]	getPointDataGeoms() Returns a list of one or more geometry variants which describe how user-supplied point coordinates map to the data space.
PlaneSurfaceFactory	getSurfaceFactory() Returns an object that can construct the plot surface including axis painting and geometry information.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PlanePlotType

public PlanePlotType(PlaneSurfaceFactory surfFact,
                     Plotter<?>[] plotters)

Constructor.

Parameters:

surfFact - surface factory

plotters - available plotters for use with this plot type

Method Detail

getPointDataGeoms

public DataGeom[] getPointDataGeoms()

Description copied from interface: PlotType

Returns a list of one or more geometry variants which describe how user-supplied point coordinates map to the data space. If multiple values are returned, the first one may be used as some kind of default.

Specified by:

getPointDataGeoms in interface PlotType<PlaneSurfaceFactory.Profile,PlaneAspect>

Returns:

data geom option list

getPlotters

public Plotter<?>[] getPlotters()

Description copied from interface: PlotType

Returns a list of plotters that can be used to paint data on the surface.

Specified by:

getPlotters in interface PlotType<PlaneSurfaceFactory.Profile,PlaneAspect>

Returns:

plotter list

getSurfaceFactory

public PlaneSurfaceFactory getSurfaceFactory()

Description copied from interface: PlotType

Returns an object that can construct the plot surface including axis painting and geometry information.

Specified by:

getSurfaceFactory in interface PlotType<PlaneSurfaceFactory.Profile,PlaneAspect>

Returns:

surface factory

getGangerFactory

public GangerFactory<PlaneSurfaceFactory.Profile,PlaneAspect> getGangerFactory()

Description copied from interface: PlotType

Returns the object that controls how multi-zone plots are arranged.

Specified by:

getGangerFactory in interface PlotType<PlaneSurfaceFactory.Profile,PlaneAspect>

Returns:

ganger factory

getPaperTypeSelector

public PaperTypeSelector getPaperTypeSelector()

Description copied from interface: PlotType

Returns an object which can provide graphics rendering functionality based on the required plot layers for this plot type.

Specified by:

getPaperTypeSelector in interface PlotType<PlaneSurfaceFactory.Profile,PlaneAspect>

Returns:

paper type selector

toString

public String toString()

Overrides:

toString in class Object

getInstance

public static PlanePlotType getInstance()

Returns the sole instance of this class.

Returns:

singleton instance