Package uk.ac.starlink.ttools.plot2.task
Class ShapeFamilyLayerType
- java.lang.Object
-
- uk.ac.starlink.ttools.plot2.task.ShapeFamilyLayerType
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SHADING_PREFIX
Base name of associated Shading parameter.
-
Constructor Summary
Constructors Constructor Description ShapeFamilyLayerType(ShapeForm form, java.util.List<ShapePlotter.ShapeModePlotter> plotters)
Constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description uk.ac.starlink.task.ChoiceParameter<ShapeMode>
createShapeModeParameter(java.lang.String suffix)
Returns the ShapeMode parameter that is required alongside this LayerType in order to determine the Plotter to use.uk.ac.starlink.task.Parameter<?>[]
getAssociatedParameters(java.lang.String suffix)
Returns a list of zero or more additional parameters associated with this layer type that may be required to turn it into the specification of an actual Plotter object.Coord[]
getExtraCoords()
Returns a list of any non-positional coordinates associated with this layer.java.lang.String
getName()
Returns the name of this layer type.Plotter<?>
getPlotter(uk.ac.starlink.task.Environment env, java.lang.String suffix)
Acquires a Plotter for this layer type.int
getPositionCount()
Returns the number of coordinate positions associated with this layer.ShapeForm
getShapeForm()
Returns the fixed form associated with this layer type.ShapePlotter.ShapeModePlotter[]
getShapeModePlotters()
Returns the family of plotters associated with this layer type.ConfigKey<?>[]
getStyleKeys()
Returns the style keys associated with this layer type.java.lang.String
getXmlDescription()
Returns an XML description of this layer type.
-
-
-
Field Detail
-
SHADING_PREFIX
public static final java.lang.String SHADING_PREFIX
Base name of associated Shading parameter.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ShapeFamilyLayerType
public ShapeFamilyLayerType(ShapeForm form, java.util.List<ShapePlotter.ShapeModePlotter> plotters)
Constructor.- Parameters:
form
- shape formplotters
- list of plotters with the given Form; this list may be adjusted during the life of the object (with care)
-
-
Method Detail
-
getShapeForm
public ShapeForm getShapeForm()
Returns the fixed form associated with this layer type.- Returns:
- form
-
getShapeModePlotters
public ShapePlotter.ShapeModePlotter[] getShapeModePlotters()
Returns the family of plotters associated with this layer type.- Returns:
- plotters
-
getName
public java.lang.String getName()
Description copied from interface:LayerType
Returns the name of this layer type.
-
getXmlDescription
public java.lang.String getXmlDescription()
Description copied from interface:LayerType
Returns an XML description of this layer type.- Specified by:
getXmlDescription
in interfaceLayerType
- Returns:
- one or more <p> elements
-
getAssociatedParameters
public uk.ac.starlink.task.Parameter<?>[] getAssociatedParameters(java.lang.String suffix)
Description copied from interface:LayerType
Returns a list of zero or more additional parameters associated with this layer type that may be required to turn it into the specification of an actual Plotter object.- Specified by:
getAssociatedParameters
in interfaceLayerType
- Parameters:
suffix
- layer suffix string for use in the execution environment- Returns:
- zero or more associated parameters, for documentation purposes
-
getPlotter
public Plotter<?> getPlotter(uk.ac.starlink.task.Environment env, java.lang.String suffix) throws uk.ac.starlink.task.TaskException
Description copied from interface:LayerType
Acquires a Plotter for this layer type.- Specified by:
getPlotter
in interfaceLayerType
- Parameters:
env
- execution environmentsuffix
- layer suffix string- Returns:
- plotter
- Throws:
uk.ac.starlink.task.TaskException
-
getPositionCount
public int getPositionCount()
Description copied from interface:LayerType
Returns the number of coordinate positions associated with this layer.- Specified by:
getPositionCount
in interfaceLayerType
- Returns:
- DataGeom-type positional coordinate multiplicity
-
getExtraCoords
public Coord[] getExtraCoords()
Description copied from interface:LayerType
Returns a list of any non-positional coordinates associated with this layer.- Specified by:
getExtraCoords
in interfaceLayerType
- Returns:
- zero or more non-positional coordinates
-
getStyleKeys
public ConfigKey<?>[] getStyleKeys()
Description copied from interface:LayerType
Returns the style keys associated with this layer type.- Specified by:
getStyleKeys
in interfaceLayerType
- Returns:
- zero or more style keys associated with every layer produced by this type
-
createShapeModeParameter
public uk.ac.starlink.task.ChoiceParameter<ShapeMode> createShapeModeParameter(java.lang.String suffix)
Returns the ShapeMode parameter that is required alongside this LayerType in order to determine the Plotter to use.- Parameters:
suffix
- layer suffix- Returns:
- shape mode choice parameter
-
-