|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectuk.ac.starlink.ttools.plot2.layer.ShapeMode
public abstract class ShapeMode
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.
Nested Class Summary | |
---|---|
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. |
Field Summary | |
---|---|
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 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. |
Constructor Summary | |
---|---|
ShapeMode(String name,
Icon icon,
Coord[] extraCoords)
Constructor. |
Method Summary | |
---|---|
static 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[] |
getConfigKeys()
Returns style configuration keys assocaited with this mode. |
Coord[] |
getExtraCoords()
Returns the additional coordinates associated with this mode. |
abstract String |
getModeDescription()
Returns a description of this mode as an XML string. |
Icon |
getModeIcon()
Returns an icon to identify this mode in the GUI. |
String |
getModeName()
Returns the user-directed name for this mode. |
static String |
modeRef(ShapeMode mode)
Returns an XML reference to the given mode. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
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[] MODES_2D
public static final ShapeMode[] MODES_3D
Constructor Detail |
---|
public ShapeMode(String name, Icon icon, Coord[] extraCoords)
name
- mode nameicon
- mode iconextraCoords
- data coordinates associated with this mode
(not positional ones)Method Detail |
---|
public String getModeName()
ModePlotter.Mode
getModeName
in interface ModePlotter.Mode
public Icon getModeIcon()
ModePlotter.Mode
getModeIcon
in interface ModePlotter.Mode
public abstract 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 extracted
public 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 stamper
public static Icon createColoredIcon(Icon base, Shader shader, float value)
base
- base iconshader
- colour shadervalue
- value in range 0-1 at which shader should be applied
public static String modeRef(ShapeMode mode)
mode
- shape mode
mode.getModeName()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |