Class ShapeMode
java.lang.Object
uk.ac.starlink.ttools.plot2.layer.ShapeMode
- All Implemented Interfaces:
ModePlotter.Mode
Defines how outlines defined by a ShapeForm are coloured in a plot.
This abstract class contains several implementations (inner classes).
It's rather crowded, should possibly be split into several files.
- Since:
- 19 Feb 2013
- Author:
- Mark Taylor
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Stamper implementation for auto transparency.static class
Stamper implementation for density mode.static class
Stamper implementation for flat colouring.static class
Stamper implementation for use with AuxShadingMode.static class
Stamper implementation for use with WeightedShadingMode. -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final ShapeMode
Auto density mode, no user settings.static final ShapeMode
Aux variable colouring mode.static final ShapeMode
Configurable density mode.static final ShapeMode
Simple flat mode for use with 2D plots.static final ShapeMode
Simple flat mode for use with 3D plots.static final ShapeMode
Flat RGB mode.static final ShapeMode[]
List of modes suitable for use with 2D plotting.static final ShapeMode[]
List of modes suitable for use with 3D plotting.Report key for nominal pixel size in square degrees.Report key for pixel X dimension in data coordinates.Report key for pixel Y dimension in data coordinates.static final ShapeMode
Transparency with automatic adjustment of opacity level.static final ShapeMode
Transparency with explicit opacity setting, suitable for 2D plots.static final ShapeMode
Transparency with explicit opacity setting, suitable for 3D plots.static final ShapeMode
Weighted density mode. -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic Icon
createColoredIcon
(Icon base, Shader shader, float value) Returns a wrapped icon whose painting is done in the context of a forground colour got by applying a given shader and shading value.abstract PlotLayer
createLayer
(ShapePlotter plotter, ShapeForm form, DataGeom geom, DataSpec dataSpec, Outliner outliner, Stamper stamper) Creates a plot layer.abstract Stamper
createStamper
(ConfigMap config) Returns an object which will do the work of colouring in shapes when supplied with the appropriate style information and data.abstract ConfigKey<?>[]
Returns style configuration keys associated with this mode.Coord[]
Returns the additional coordinates associated with this mode.abstract String
Returns a description of this mode as an XML string.Returns an icon to identify this mode in the GUI.Returns the user-directed name for this mode.boolean
Indicates whether the drawing produced by this mode willl return general interest report information to upstream plotting code.static String
Returns an XML reference to the given mode.
-
Field Details
-
AUTO
Auto density mode, no user settings. -
FLAT2D
Simple flat mode for use with 2D plots. -
FLAT3D
Simple flat mode for use with 3D plots. -
TRANSLUCENT
Transparency with automatic adjustment of opacity level. -
TRANSPARENT2D
Transparency with explicit opacity setting, suitable for 2D plots. -
TRANSPARENT3D
Transparency with explicit opacity setting, suitable for 3D plots. -
DENSITY
Configurable density mode. -
AUX
Aux variable colouring mode. -
WEIGHTED
Weighted density mode. -
IRGB
Flat RGB mode. -
MODES_2D
List of modes suitable for use with 2D plotting. -
MODES_3D
List of modes suitable for use with 3D plotting. -
REPKEY_XPIX
Report key for pixel X dimension in data coordinates. -
REPKEY_YPIX
Report key for pixel Y dimension in data coordinates. -
REPKEY_SKYPIX
Report key for nominal pixel size in square degrees.
-
-
Constructor Details
-
ShapeMode
Constructor.- Parameters:
name
- mode nameicon
- mode iconextraCoords
- data coordinates associated with this mode (not positional ones)hasReports
- whether plot reports containing genera-interest plot information are generated
-
-
Method Details
-
getModeName
Description copied from interface:ModePlotter.Mode
Returns the user-directed name for this mode.- Specified by:
getModeName
in interfaceModePlotter.Mode
- Returns:
- mode name
-
getModeIcon
Description copied from interface:ModePlotter.Mode
Returns an icon to identify this mode in the GUI.- Specified by:
getModeIcon
in interfaceModePlotter.Mode
- Returns:
- mode icon
-
hasReports
public boolean hasReports()Indicates whether the drawing produced by this mode willl return general interest report information to upstream plotting code.- Returns:
- true if the plot report may contain interesting information
-
getModeDescription
Returns a description of this mode as an XML string. The return value should be one or more <p> elements.- Returns:
- XML description of mode
-
getExtraCoords
Returns the additional coordinates associated with this mode.- Returns:
- array of non-positional coordinates associated with colouring
-
getConfigKeys
Returns style configuration keys associated with this mode. These keys will be used in the config map supplied tocreateStamper(uk.ac.starlink.ttools.plot2.config.ConfigMap)
.- Returns:
- array of config keys for mode
-
createStamper
Returns an object which will do the work of colouring in shapes when supplied with the appropriate style information and data. The significant keys in the supplied config map are those given bygetConfigKeys()
.- Parameters:
config
- configuration map from which values for this mode's config keys will be extracted- Returns:
- new stamper object
-
createLayer
public abstract PlotLayer createLayer(ShapePlotter plotter, ShapeForm form, DataGeom geom, DataSpec dataSpec, Outliner outliner, Stamper stamper) Creates a plot layer.- Parameters:
plotter
- plotterform
- shape formgeom
- data coordinate specificationdataSpec
- data specificationoutliner
- shape outlinerstamper
- shape stamper- Returns:
- new layer
-
createColoredIcon
Returns a wrapped icon whose painting is done in the context of a forground colour got by applying a given shader and shading value.- Parameters:
base
- base iconshader
- colour shadervalue
- value in range 0-1 at which shader should be applied- Returns:
- coloured icon
-
modeRef
Returns an XML reference to the given mode.- Parameters:
mode
- shape mode- Returns:
- <ref> element with content
mode.getModeName()
-