Package uk.ac.starlink.ttools.plot2.task
Class ShapeFamilyLayerType
java.lang.Object
uk.ac.starlink.ttools.plot2.task.ShapeFamilyLayerType
- All Implemented Interfaces:
LayerType
LayerType that represents a family of ShapeModePlotters.
- Since:
- 15 Sep 2014
- Author:
- Mark Taylor
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionShapeFamilyLayerType
(ShapeForm form, List<ShapeModePlotter> plotters) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionuk.ac.starlink.task.ChoiceParameter<ShapeMode>
createShapeModeParameter
(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
(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.Returns a CoordGroup characteristic of this layer type.Coord[]
Returns a list of any non-positional coordinates associated with this layer.getName()
Returns the name of this layer type.Plotter<?>
getPlotter
(uk.ac.starlink.task.Environment env, String suffix) Acquires a Plotter for this layer type.Returns the fixed form associated with this layer type.Returns the family of plotters associated with this layer type.ConfigKey<?>[]
Returns the style keys associated with this layer type.Returns an XML description of this layer type.
-
Field Details
-
SHADING_PREFIX
Base name of associated Shading parameter.- See Also:
-
-
Constructor Details
-
ShapeFamilyLayerType
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 Details
-
getShapeForm
Returns the fixed form associated with this layer type.- Returns:
- form
-
getShapeModePlotters
Returns the family of plotters associated with this layer type.- Returns:
- plotters
-
getName
Description copied from interface:LayerType
Returns the name of this layer type. -
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
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, 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
-
getCoordGroup
Description copied from interface:LayerType
Returns a CoordGroup characteristic of this layer type. It is not guaranteed that the returned value will be identical to the CoordGroup of all the plotters that this type can return.- Specified by:
getCoordGroup
in interfaceLayerType
- Returns:
- best-efforts CoordGroup
-
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
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
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
-