ModePlotter.Mode
public abstract class ShapeMode extends java.lang.Object implements ModePlotter.Mode
Modifier and Type | Class | Description |
---|---|---|
static class |
ShapeMode.AutoTransparentStamper |
Stamper implementation for auto transparency.
|
static class |
ShapeMode.DensityStamper |
Stamper implementation for density mode.
|
static class |
ShapeMode.FlatStamper |
Stamper implementation for flat colouring.
|
static class |
ShapeMode.ShadeStamper |
Stamper implementation for use with AuxShadingMode.
|
static class |
ShapeMode.WeightStamper |
Stamper implementation for use with WeightedShadingMode.
|
Modifier and Type | Field | Description |
---|---|---|
static ShapeMode |
AUTO |
Auto density mode, no user settings.
|
static ShapeMode |
AUX |
Aux variable colouring mode.
|
static ShapeMode |
DENSITY |
Configurable density mode.
|
static ShapeMode |
FLAT2D |
Simple flat mode for use with 2D plots.
|
static ShapeMode |
FLAT3D |
Simple flat mode for use with 3D plots.
|
static ShapeMode[] |
MODES_2D |
List of modes suitable for use with 2D plotting.
|
static ShapeMode[] |
MODES_3D |
List of modes suitable for use with 3D plotting.
|
static ReportKey<java.lang.Double> |
REPKEY_SKYPIX |
Report key for nominal pixel size in square degrees.
|
static ReportKey<java.lang.Double> |
REPKEY_XPIX |
Report key for pixel X dimension in data coordinates.
|
static ReportKey<java.lang.Double> |
REPKEY_YPIX |
Report key for pixel Y dimension in data coordinates.
|
static ShapeMode |
TRANSLUCENT |
Transparency with automatic adjustment of opacity level.
|
static ShapeMode |
TRANSPARENT2D |
Transparency with explicit opacity setting, suitable for 2D plots.
|
static ShapeMode |
TRANSPARENT3D |
Transparency with explicit opacity setting, suitable for 3D plots.
|
static ShapeMode |
WEIGHTED |
Weighted density mode.
|
Constructor | Description |
---|---|
ShapeMode(java.lang.String name,
javax.swing.Icon icon,
Coord[] extraCoords,
boolean hasReports) |
Constructor.
|
Modifier and Type | Method | Description |
---|---|---|
static javax.swing.Icon |
createColoredIcon(javax.swing.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[] |
getConfigKeys() |
Returns style configuration keys associated with this mode.
|
Coord[] |
getExtraCoords() |
Returns the additional coordinates associated with this mode.
|
abstract java.lang.String |
getModeDescription() |
Returns a description of this mode as an XML string.
|
javax.swing.Icon |
getModeIcon() |
Returns an icon to identify this mode in the GUI.
|
java.lang.String |
getModeName() |
Returns the user-directed name for this mode.
|
boolean |
hasReports() |
Indicates whether the drawing produced by this mode willl return
general interest report information to upstream plotting code.
|
static java.lang.String |
modeRef(ShapeMode mode) |
Returns an XML reference to the given mode.
|
public static final ShapeMode AUTO
public static final ShapeMode FLAT2D
public static final ShapeMode FLAT3D
public static final ShapeMode TRANSLUCENT
public static final ShapeMode TRANSPARENT2D
public static final ShapeMode TRANSPARENT3D
public static final ShapeMode DENSITY
public static final ShapeMode AUX
public static final ShapeMode WEIGHTED
public static final ShapeMode[] MODES_2D
public static final ShapeMode[] MODES_3D
public static final ReportKey<java.lang.Double> REPKEY_XPIX
public static final ReportKey<java.lang.Double> REPKEY_YPIX
public static final ReportKey<java.lang.Double> REPKEY_SKYPIX
public ShapeMode(java.lang.String name, javax.swing.Icon icon, Coord[] extraCoords, boolean hasReports)
name
- mode nameicon
- mode iconextraCoords
- data coordinates associated with this mode
(not positional ones)hasReports
- whether plot reports containing genera-interest
plot information are generatedpublic java.lang.String getModeName()
ModePlotter.Mode
getModeName
in interface ModePlotter.Mode
public javax.swing.Icon getModeIcon()
ModePlotter.Mode
getModeIcon
in interface ModePlotter.Mode
public boolean hasReports()
public abstract java.lang.String getModeDescription()
public Coord[] getExtraCoords()
public abstract ConfigKey[] getConfigKeys()
createStamper(uk.ac.starlink.ttools.plot2.config.ConfigMap)
.public abstract Stamper createStamper(ConfigMap config)
getConfigKeys()
.config
- configuration map from which values for this mode's
config keys will be extractedpublic abstract PlotLayer createLayer(ShapePlotter plotter, ShapeForm form, DataGeom geom, DataSpec dataSpec, Outliner outliner, Stamper stamper)
plotter
- plotterform
- shape formgeom
- data coordinate specificationdataSpec
- data specificationoutliner
- shape outlinerstamper
- shape stamperpublic static javax.swing.Icon createColoredIcon(javax.swing.Icon base, Shader shader, float value)
base
- base iconshader
- colour shadervalue
- value in range 0-1 at which shader should be appliedpublic static java.lang.String modeRef(ShapeMode mode)
mode
- shape modemode.getModeName()
Copyright © 2018 Central Laboratory of the Research Councils. All Rights Reserved.