Package 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>
public class PlanePlotType extends java.lang.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 Description PlanePlotType(Plotter<?>[] plotters, boolean has2dMetric)Constructor.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static PlanePlotTypegetInstance()Returns the sole instance of this class.PaperTypeSelectorgetPaperTypeSelector()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.SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect>getSurfaceFactory()Returns an object that can construct the plot surface including axis painting and geometry information.java.lang.StringtoString()
-
-
-
Constructor Detail
-
PlanePlotType
public PlanePlotType(Plotter<?>[] plotters, boolean has2dMetric)
Constructor.- Parameters:
plotters- available plotters for use with this plot typehas2dMetric- true if it may make sense to measure distances that are not parallel to either axis
-
-
Method Detail
-
getPointDataGeoms
public DataGeom[] getPointDataGeoms()
Description copied from interface:PlotTypeReturns a list of one or more geometry variants which describe how user-supplied point coordinates map to the data space. The geoms returned from this method will return true from theirDataGeom.hasPosition()method. If multiple values are returned, the first one may be used as some kind of default.- Specified by:
getPointDataGeomsin interfacePlotType<PlaneSurfaceFactory.Profile,PlaneAspect>- Returns:
- data geom option list
-
getPlotters
public Plotter<?>[] getPlotters()
Description copied from interface:PlotTypeReturns a list of plotters that can be used to paint data on the surface.- Specified by:
getPlottersin interfacePlotType<PlaneSurfaceFactory.Profile,PlaneAspect>- Returns:
- plotter list
-
getSurfaceFactory
public SurfaceFactory<PlaneSurfaceFactory.Profile,PlaneAspect> getSurfaceFactory()
Description copied from interface:PlotTypeReturns an object that can construct the plot surface including axis painting and geometry information.- Specified by:
getSurfaceFactoryin interfacePlotType<PlaneSurfaceFactory.Profile,PlaneAspect>- Returns:
- surface factory
-
getPaperTypeSelector
public PaperTypeSelector getPaperTypeSelector()
Description copied from interface:PlotTypeReturns an object which can provide graphics rendering functionality based on the required plot layers for this plot type.- Specified by:
getPaperTypeSelectorin interfacePlotType<PlaneSurfaceFactory.Profile,PlaneAspect>- Returns:
- paper type selector
-
toString
public java.lang.String toString()
- Overrides:
toStringin classjava.lang.Object
-
getInstance
public static PlanePlotType getInstance()
Returns the sole instance of this class.- Returns:
- singleton instance
-
-