ucar.visad.display

Class ContourLines

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.DisplayableData

ucar.visad.display.LineDrawing

ucar.visad.display.ContourLines

Direct Known Subclasses:

BackgroundContours, Contour2DDisplayable

public abstract class ContourLines
extends LineDrawing

Provides support for a Displayable that comprises a set of contour lines.

Instances of this class have the following bound properties:

Name	Type	Access	Default	Description
contourLevels	ContourLevels	set/get	no contour levels	The displayed contour levels associated with this instance.
labeling	boolean	set/is	false	Whether or not the contour lines should be labeled.
contourRealType	visad.RealType	set/get	null	The VisAD type of the contoured quantity.
colorFill	boolean	set/get	null	Whether or not the contour lines are color filled.

Version:

$Revision: 1.30 $

Author:

Steven R. Emmerson

Nested Class Summary

Nested classes/interfaces inherited from class ucar.visad.display.DisplayableData

DisplayableData.DragAdapter

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COLOR_FILL The name of the "color fill" property.
static java.lang.String	CONTOUR_LEVELS The name of the "contour levels" property.
static java.lang.String	CONTOUR_REAL_TYPE The name of the "contour real-type" property.
static java.lang.String	LABELING The name of the "labeling" property.

Fields inherited from class ucar.visad.display.LineDrawing

COLOR, LINE_STYLE, LINE_WIDTH, POINT_SIZE

Fields inherited from class ucar.visad.display.DisplayableData

MANIPULABLE, renderer, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

Constructors

Constructor and Description
ContourLines(ContourLines that) Constructs from another instance.
ContourLines(java.lang.String name, visad.RealType contourRealType) Constructs from a name for the Displayable and the type of the contour parameter.

Method Summary

Modifier and Type	Method and Description
boolean	getColorFillEnabled() Ask if color filled contours are enabled.
ContourLevels	getContourLevels() Returns the contour levels.
visad.RealType	getContourRealType() Returns the RealType of the contoured parameter.
float[]	getContourValues() Gets the contour values.
int	getDashedStyle() Set the dashed style.
boolean	isLabeling() Returns the labeling of contour lines.
void	setColorFill(boolean yesorno) Set whether the contours should be displayed as color-filled contours.
void	setContourInfo(ContourInfo contourInfo) Set appropriate contour levels info
void	setContourInterval(float inter, float base, float min, float max) Sets the contour values, with interval, min, max, base.
void	setContourInterval(float inter, float base, float min, float max, boolean dash) Sets the contour values, with interval, min, max, base and dash.
void	setContourLevels(ContourLevels contourLevels) Sets the contour values.
protected void	setContourRealType(visad.RealType realType) Sets the RealType of the contoured parameter.
void	setDashedStyle(int style) Set the dashed style.
void	setDisplayUnit(visad.Unit unit) Set the units for the displayed range
void	setFont(java.lang.Object font, int size, boolean align) Set the font
void	setLabelFreq(int freq) Set the label frequency
void	setLabeling(boolean on) Sets the labeling of contour lines.
void	setLabelSkip(int skip) Set the label skip
protected void	setRange(float min, float max) Sets the range of contour values.
protected void	setScalarMaps(ScalarMapSet maps) Sets the set of ScalarMap-s of this instance.

Methods inherited from class ucar.visad.display.LineDrawing

getColor, getLineStyle, getLineWidth, getPointSize, setColor, setHSV, setHSV, setLineStyle, setLineWidth, setPointSize, setRGB, setRGB, setRGBA, setRGBA

Methods inherited from class ucar.visad.display.DisplayableData

addAction, cloneForDisplay, dataChange, destroy, getActive, getAnimationSet, getData, getDataRenderer, getName, hasData, hasDataObject, isManipulable, isPickable, myAddConstantMaps, myAddDataReferences, myRemoveDataReferences, removeAction, setActive, setData, setDataReference, setDragAdapter, setManipulable, setPickable, setPointMode, setUseFastRendering, setVisible, showme, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, destroyDisplayable, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getDestroyed, getDisplay, getDisplayMaster, getDisplayUnit, getPointMode, getScalarMap, getScalarMap, getScalarMap, getScalarMapSet, getUseFastRendering, getUseTimesInAnimation, getVisible, isActive, isUnitCompatible, isVisible, logException, removeConstantMap, removeDataReferences, removePropertyChangeListener, removePropertyChangeListener, removeScalarMap, replaceScalarMap, setAdjustFlow, setColorPalette, setColorPalette, setColorUnit, setConstantPosition, setDisplay, setDisplayActive, setDisplayInactive, setDisplayMaster, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setRangeForColor, setRangeForColor, setScalarMapSet, setSelectedRange, setSelectedRange, setUseTimesInAnimation, toFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CONTOUR_LEVELS

public static final java.lang.String CONTOUR_LEVELS

The name of the "contour levels" property.

See Also:

Constant Field Values

LABELING

public static final java.lang.String LABELING

The name of the "labeling" property.

See Also:

Constant Field Values

CONTOUR_REAL_TYPE

public static final java.lang.String CONTOUR_REAL_TYPE

The name of the "contour real-type" property.

See Also:

Constant Field Values

COLOR_FILL

public static final java.lang.String COLOR_FILL

The name of the "color fill" property.

See Also:

Constant Field Values

Constructor Detail

ContourLines

public ContourLines(java.lang.String name,
                    visad.RealType contourRealType)
             throws visad.VisADException,
                    java.rmi.RemoteException

Constructs from a name for the Displayable and the type of the contour parameter. The contour levels will be the VisAD default and the lines will not be labeled.

Parameters:

name - The name for the displayable.

contourRealType - The type of the contour parameter. May be null.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

ContourLines

public ContourLines(ContourLines that)
             throws visad.VisADException,
                    java.rmi.RemoteException

Constructs from another instance. The following attributes are set from the other instance: contour levels, labeling, the contour RealType, the range minimum, and the range maximum.

Parameters:

that - The other instance.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

Method Detail

setContourRealType

protected void setContourRealType(visad.RealType realType)
                           throws java.rmi.RemoteException,
                                  visad.VisADException

Sets the RealType of the contoured parameter.

Parameters:

realType - The RealType of the contoured parameter. May not be null.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getContourRealType

public visad.RealType getContourRealType()

Returns the RealType of the contoured parameter.

Returns:

The RealType of the contoured parameter. May be null.

setRange

protected void setRange(float min,
                        float max)
                 throws java.rmi.RemoteException,
                        visad.VisADException

Sets the range of contour values.

Parameters:

min - The minimum contour value.

max - The maximum contour value.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setContourLevels

public final void setContourLevels(ContourLevels contourLevels)
                            throws java.rmi.RemoteException,
                                   visad.VisADException

Sets the contour values. This method fires a PropertyChangeEvent for CONTOUR_LEVELS.

Parameters:

contourLevels - The contour values.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

See Also:

CONTOUR_LEVELS

setContourInterval

public final void setContourInterval(float inter,
                                     float base,
                                     float min,
                                     float max)
                              throws java.rmi.RemoteException,
                                     visad.VisADException

Sets the contour values, with interval, min, max, base. This method fires a PropertyChangeEvent for CONTOUR_LEVELS.

Parameters:

inter - The contour interval.

min - The minimum contour value.

max - The maximum contour value.

base - The base contour value.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

See Also:

CONTOUR_LEVELS

setContourInterval

public final void setContourInterval(float inter,
                                     float base,
                                     float min,
                                     float max,
                                     boolean dash)
                              throws java.rmi.RemoteException,
                                     visad.VisADException

Sets the contour values, with interval, min, max, base and dash. This method fires a PropertyChangeEvent for CONTOUR_LEVELS.

Parameters:

inter - The contour interval.

min - The minimum contour value.

max - The maximum contour value.

base - The base contour value.

dash - Whether or not to draw dashed lines for contours less than the base contour value.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

See Also:

CONTOUR_LEVELS

setScalarMaps

protected void setScalarMaps(ScalarMapSet maps)
                      throws visad.BadMappingException

Sets the set of ScalarMap-s of this instance. The ScalarMap-s of this instance will be added to the set before the SCALAR_MAP_SET property is set. This method fires a PropertyChangeEvent for SCALAR_MAP_SET with null for the old value and the new set of ScalarMap-s for the new Value. Intermediate subclasses that have their own ScalarMap-s should override this method and invoke super.setScalarMaps(ScalarMapSet).

Parameters:

maps - The set of ScalarMap-s to be added.

Throws:

visad.BadMappingException - The RealType of the contour parameter has not been set or its ScalarMap is already in the set.

getContourLevels

public final ContourLevels getContourLevels()

Returns the contour levels.

Returns:

The Contour levels. The default value is an empty set of levels.

getContourValues

public final float[] getContourValues()
                               throws visad.VisADException

Gets the contour values.

Returns:

The contour values.

Throws:

visad.VisADException - VisAD failure.

setContourInfo

public void setContourInfo(ContourInfo contourInfo)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Set appropriate contour levels info

Overrides:

setContourInfo in class Displayable

Parameters:

contourInfo - Contains contour and labeling information

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setColorFill

public void setColorFill(boolean yesorno)
                  throws visad.VisADException,
                         java.rmi.RemoteException

Set whether the contours should be displayed as color-filled contours.

Parameters:

yesorno - true for color fill

Throws:

visad.VisADException - unable to set this

java.rmi.RemoteException - unable to set this on remote display

getColorFillEnabled

public boolean getColorFillEnabled()

Ask if color filled contours are enabled.

Returns:

true if using color-filled contours.

setLabeling

public final void setLabeling(boolean on)
                       throws visad.VisADException,
                              java.rmi.RemoteException

Sets the labeling of contour lines.

Parameters:

on - Whether or not the contour lines should be labeled.

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

isLabeling

public final boolean isLabeling()

Returns the labeling of contour lines.

Returns:

true if and only if the contour lines should be labeled.

setDisplayUnit

public void setDisplayUnit(visad.Unit unit)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Set the units for the displayed range

Overrides:

setDisplayUnit in class Displayable

Parameters:

unit - Unit for display

Throws:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

setLabelFreq

public void setLabelFreq(int freq)
                  throws java.rmi.RemoteException,
                         visad.VisADException

Set the label frequency

Parameters:

freq - label frequency

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - Problem setting the dashed style

setLabelSkip

public void setLabelSkip(int skip)
                  throws java.rmi.RemoteException,
                         visad.VisADException

Set the label skip

Parameters:

skip - label skip

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - Problem setting the dashed style

setDashedStyle

public void setDashedStyle(int style)
                    throws java.rmi.RemoteException,
                           visad.VisADException

Set the dashed style.

Parameters:

style - dashed line style

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - Problem setting the dashed style

setFont

public void setFont(java.lang.Object font,
                    int size,
                    boolean align)
             throws java.rmi.RemoteException,
                    visad.VisADException

Set the font

Parameters:

font - the font name/weight

size - the label (font) size

align - _more_

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - Problem setting the dashed style

getDashedStyle

public int getDashedStyle()

Set the dashed style.

Returns:

dashed line style