visad

Class ContourControl

java.lang.Object

visad.Control

visad.ContourControl

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class ContourControl
extends Control

ContourControl is the VisAD class for controlling IsoContour display scalars.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static int	EVERY_NTH_DEFAULT
static int	EVERY_NTH_MAX
static int	EVERY_NTH_MIN
static int	LABEL_FREQ_HI
static int	LABEL_FREQ_LO
static int	LABEL_FREQ_MED

Constructor Summary

Constructors

Constructor and Description
ContourControl(DisplayImpl d) Construct a new ContourControl for the display

Method Summary

Modifier and Type	Method and Description
void	addProjectionControlListener(ControlListener cl, ProjectionControl pcntrl) remove previous projListener from pcntrl, and save cl as new projListener
java.lang.Object	clone()
boolean	contourFilled()
void	enableContours(boolean on) set contour enable
void	enableLabels(boolean on) set label enable
boolean	equals(java.lang.Object o) Indicates whether or not this instance equals an Object
boolean	getAlignLabels()
boolean	getAutoSizeLabels()
int	getDashedStyle() Get the line style for lines that are styled.
int	getEveryNth()
static double	getInitScale()
byte[]	getLabelColor() Gets the label color.
java.lang.Object	getLabelFont() Get contour label font
int	getLabelFreq()
double	getLabelSize()
float[]	getLevels(float[] lowhibase, boolean[] dashes) get 'new' descriptors for 2-D contour lines
void	getMainContours(boolean[] bvalues, float[] fvalues) get parameters for IsoContour depictions
boolean	getPublicSet()
java.lang.String	getSaveString()
void	nullControl() End this control (called by ScalarMap.nullDisplay()).
void	reLabel() If zoom scale has changed sufficiently, re-transform in order to recompute labels.
void	setAlignLabels(boolean flag) Set the contour label alignment policy
void	setAutoScaleLabels(boolean flag) set enable for label auto-size
void	setContourFill(boolean flag)
void	setContourInterval(float interval, float low, float hi, float ba) Sets the parameters for contour iso-lines.
void	setContourLimits(float low, float hi) Set low and high iso-line levels
void	setDashedStyle(int style) Set the line style to apply to dashed lines.
void	setEveryNth(int lineCount) Set how often we label lines
void	setLabelColor(byte[] color) Sets the color for label.
void	setLabelColor(byte[] color, boolean change) Sets the label color.
void	setLabelFont(java.lang.Object font) Set the contour label Font
void	setLabelFreq(int freq) set label frequency
void	setLabelSize(double factor) set size for label auto-size
void	setLevels(float[] levels, float base, boolean dash) Set arbitrary levels for 2-D contour lines; levels below base are dashed if dash == true
void	setSaveString(java.lang.String save) reconstruct this ContourControl using the specified save string
void	setSurfaceValue(float value) Set level for iso-surfaces
void	setSurfaceValue(float value, boolean setLevels) Set level for iso-surfaces
void	syncControl(Control rmt) copy the state of a remote control to this control

Methods inherited from class visad.Control

addControlListener, animation_string, changeControl, checkTicks, getDisplay, getDisplayRenderer, getInstanceNumber, incTick, peekTicks, removeControlListener, resetTicks, setTicks, subCheckTicks, subPeekTicks, subResetTicks, subSetTicks, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

LABEL_FREQ_LO

public static final int LABEL_FREQ_LO

See Also:

Constant Field Values

LABEL_FREQ_MED

public static final int LABEL_FREQ_MED

See Also:

Constant Field Values

LABEL_FREQ_HI

public static final int LABEL_FREQ_HI

See Also:

Constant Field Values

EVERY_NTH_MIN

public static final int EVERY_NTH_MIN

See Also:

Constant Field Values

EVERY_NTH_DEFAULT

public static final int EVERY_NTH_DEFAULT

See Also:

Constant Field Values

EVERY_NTH_MAX

public static final int EVERY_NTH_MAX

See Also:

Constant Field Values

Constructor Detail

ContourControl

public ContourControl(DisplayImpl d)

Construct a new ContourControl for the display

Parameters:

d - Display to associate with this

Method Detail

setSurfaceValue

public void setSurfaceValue(float value)
                     throws VisADException,
                            java.rmi.RemoteException

Set level for iso-surfaces

Parameters:

value - value of the iso-surface to display

Throws:

VisADException - VisAD error

java.rmi.RemoteException - Java RMI failure.

setSurfaceValue

public void setSurfaceValue(float value,
                            boolean setLevels)
                     throws VisADException,
                            java.rmi.RemoteException

Set level for iso-surfaces

Parameters:

value - value of the iso-surface to display

setLevels - true if this should be used for contour levels

Throws:

VisADException - VisAD error

java.rmi.RemoteException - Java RMI failure.

setContourInterval

public void setContourInterval(float interval,
                               float low,
                               float hi,
                               float ba)
                        throws VisADException,
                               java.rmi.RemoteException

Sets the parameters for contour iso-lines. This method invokes the ControlListener.controlChanged(ControlEvent) method of all registered listeners;

Parameters:

interval - The contour interval. Must be non-zero. If negative, then contour lines below the base will be dashed. Must not be NaN.

low - The minimum contour value. No contour line less than this value will be drawn. Must not be NaN.

hi - The maximum contour value. No contour line greater than this value will be drawn. Must not be NaN.

ba - The base contour value. The contour lines will be integer multiples of the interval away from this value. Must not be NaN.

Throws:

VisADException - The interval is zero or too small.

java.rmi.RemoteException - Java RMI failure.

setContourLimits

public void setContourLimits(float low,
                             float hi)
                      throws VisADException,
                             java.rmi.RemoteException

Set low and high iso-line levels

Parameters:

low - The minimum contour value. No contour line less than this value will be drawn. Must not be NaN.

hi - The maximum contour value. No contour line greater than this value will be drawn. Must not be NaN.

Throws:

VisADException - VisAD error

java.rmi.RemoteException - Java RMI failure.

getPublicSet

public boolean getPublicSet()

Returns:

boolean indicating whether levels have been set by other than auto-scale

setLevels

public void setLevels(float[] levels,
                      float base,
                      boolean dash)
               throws VisADException,
                      java.rmi.RemoteException

Set arbitrary levels for 2-D contour lines; levels below base are dashed if dash == true

Parameters:

levels - An array of contour values to display.

base - The base contour value for dashing. Levels below base are dashed if dash is true

dash - flag for making dashed contours below the base contour value.

Throws:

VisADException - VisAD error

java.rmi.RemoteException - Java RMI failure.

getLevels

public float[] getLevels(float[] lowhibase,
                         boolean[] dashes)

get 'new' descriptors for 2-D contour lines

Parameters:

lowhibase - must be dimensioned float[3], where lowhibase[0] used to return low limit lowhibase[1] used to return high limit lowhibase[2] used to return base

dashes - must be dimensioned boolean[1], where dashed[0] used to return dash enable

Returns:

float[] array of levels for contour curves

enableLabels

public void enableLabels(boolean on)
                  throws VisADException,
                         java.rmi.RemoteException

set label enable

Parameters:

on - new value for label enable

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

enableContours

public void enableContours(boolean on)
                    throws VisADException,
                           java.rmi.RemoteException

set contour enable

Parameters:

on - new value for contour enable

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

getMainContours

public void getMainContours(boolean[] bvalues,
                            float[] fvalues)
                     throws VisADException

get parameters for IsoContour depictions

Parameters:

bvalues - must be dimensioned boolean[2], where bvalues[0] used to return contour enable bvalues[1] used to return label enable

fvalues - must be dimensioned float[5], where fvalues[0] used to return level for iso-surface fvalues[1] used to return interval for iso-lines fvalues[2] used to return low limit for iso-lines fvalues[3] used to return high limit for iso-lines fvalues[4] used to return base for iso-lines

Throws:

VisADException - a VisAD error occurred

setContourFill

public void setContourFill(boolean flag)
                    throws VisADException,
                           java.rmi.RemoteException

Throws:

VisADException

java.rmi.RemoteException

contourFilled

public boolean contourFilled()

Returns:

contourFill enable

getInitScale

public static double getInitScale()

Returns:

initial scale for label auto-size

setAutoScaleLabels

public void setAutoScaleLabels(boolean flag)

set enable for label auto-size

Parameters:

flag - new value for label auto-size enable

getAutoSizeLabels

public boolean getAutoSizeLabels()

Returns:

label auto-size enable

setAlignLabels

public void setAlignLabels(boolean flag)
                    throws java.rmi.RemoteException,
                           VisADException

Set the contour label alignment policy

Parameters:

flag - true: labels follow the contour line, false: labels are horizontal, default: true

Throws:

VisADException

java.rmi.RemoteException

getAlignLabels

public boolean getAlignLabels()

setLabelColor

public void setLabelColor(byte[] color)
                   throws java.rmi.RemoteException,
                          VisADException

Sets the color for label.

Parameters:

color - RGB color array, if null label takes contour color

Throws:

VisADException

java.rmi.RemoteException

setLabelColor

public void setLabelColor(byte[] color,
                          boolean change)
                   throws java.rmi.RemoteException,
                          VisADException

Sets the label color.

Parameters:

color - RGB color array, if null label takes contour color

change - If false, no ControlEvent is fired.

Throws:

java.rmi.RemoteException

VisADException

getLabelColor

public byte[] getLabelColor()

Gets the label color.

Returns:

label color as RGB array, null if not set

setLabelFont

public void setLabelFont(java.lang.Object font)
                  throws java.rmi.RemoteException,
                         VisADException

Set the contour label Font

Parameters:

font - can be java.awt.Font or visad.util.HersheyFont. The former are rendered as filled polygons which can exhibit co-planar artifacts, the latter as lines which will always be visible, front or back, on co-planar surfaces. Can be null, the default, which results in the Times Roman HersheyFont.

Throws:

VisADException

java.rmi.RemoteException

getLabelFont

public java.lang.Object getLabelFont()

Get contour label font

Returns:

label font

setLabelFreq

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

set label frequency

Parameters:

freq - how many labels to attempt per line

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

getLabelFreq

public int getLabelFreq()

Returns:

label frequency (number per line)

getEveryNth

public int getEveryNth()

Returns:

the everyNth

setEveryNth

public void setEveryNth(int lineCount)
                 throws VisADException,
                        java.rmi.RemoteException

Set how often we label lines

Parameters:

lineCount - how many lines to skip before next labeled line

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

setLabelSize

public void setLabelSize(double factor)
                  throws VisADException,
                         java.rmi.RemoteException

set size for label auto-size

Parameters:

factor - new size for label auto-size

Throws:

VisADException - a VisAD error occurred

java.rmi.RemoteException - an RMI error occurred

getLabelSize

public double getLabelSize()

Returns:

size for label auto-size

getDashedStyle

public int getDashedStyle()

Get the line style for lines that are styled.

Returns:

One of the line style constants from GraphicsModeControl.

setDashedStyle

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

Set the line style to apply to dashed lines.

Parameters:

style - One of the line style constants from GraphicsModeControl.

Throws:

java.rmi.RemoteException

VisADException

getSaveString

public java.lang.String getSaveString()

Specified by:

getSaveString in class Control

Returns:

String representation of this ContourControl

setSaveString

public void setSaveString(java.lang.String save)
                   throws VisADException,
                          java.rmi.RemoteException

reconstruct this ContourControl using the specified save string

Specified by:

setSaveString in class Control

Parameters:

save - - String representation for reconstruction

Throws:

VisADException - if a VisAD error occurs

java.rmi.RemoteException - if an RMI error occurs

addProjectionControlListener

public void addProjectionControlListener(ControlListener cl,
                                         ProjectionControl pcntrl)

remove previous projListener from pcntrl, and save cl as new projListener

Parameters:

cl - new ControlListener for projListener

pcntrl - ProjectionControl

syncControl

public void syncControl(Control rmt)
                 throws VisADException

copy the state of a remote control to this control

Specified by:

syncControl in class Control

Parameters:

rmt - remote Control whose state is copied

Throws:

VisADException - if a VisAD error occurs

equals

public boolean equals(java.lang.Object o)

Indicates whether or not this instance equals an Object

Overrides:

equals in class Control

Parameters:

o - an Object

Returns:

true if and only if this instance is equal to o

clone

public java.lang.Object clone()

Overrides:

clone in class Control

Returns:

a copy of this ContourControl

reLabel

public void reLabel()
             throws VisADException,
                    java.rmi.RemoteException

If zoom scale has changed sufficiently, re-transform in order to recompute labels. No action is taken if setContourFill(boolean) has been set.

Throws:

VisADException - if a VisAD error occurs

java.rmi.RemoteException - if an RMI error occurs

nullControl

public void nullControl()

End this control (called by ScalarMap.nullDisplay()). Override to remove zoom control listener.

Overrides:

nullControl in class Control