ucar.visad.display

Class LineProbe

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.CompositeDisplayable

ucar.visad.display.SelectorDisplayable

ucar.visad.display.LineProbe

public class LineProbe
extends SelectorDisplayable

Class for a probe.

Version:

$Revision: 1.20 $

Author:

Don Murray

Field Summary

Fields inherited from class ucar.visad.display.SelectorDisplayable

PROPERTY_POSITION

Fields inherited from class ucar.visad.display.CompositeDisplayable

cnt, label

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

Constructors

Constructor and Description
LineProbe() Default Constructor
LineProbe(double x, double y, double z) Construct a new LineProbe using the x, y, and z positions
LineProbe(visad.RealTuple position) Construct a new LineProbe at the position
LineProbe(visad.RealTuple position, visad.Real constant) Construct a new LineProbe at the position using a constant Z value
LineProbe(visad.RealTuple position, visad.RealTuple fixedEndPoint, visad.Real constant) Create a new line probe

Method Summary

Modifier and Type	Method and Description
float	getPointScale() Get the point's scale
visad.RealTuple	getPosition() Get the position of the SelectorPoint.
SelectorPoint	getSelectorPoint() Get the selector point
void	setAutoSize(boolean yesorno) Set whether the marker should automatically resize as the display is zoomed.
void	setManipulable(boolean manip) set if linprobe can be moved by the user with mouse cursor or not
void	setMarker(java.lang.String markerText) Set the marker text for this selector point
void	setMarker(visad.VisADGeometryArray marker) Set the marker for this selector point
void	setPointSize(float newSize) Set the size (scale) of the ShapeControl.
void	setPosition(double x, double y) Sets the position of the probe.
void	setPosition(visad.RealTuple position) Sets the position of the probe.

Methods inherited from class ucar.visad.display.SelectorDisplayable

addPropertyChangeListener, getAutoSize, getFiringEvent, getOkToFireEvents, getPointSize, notifyListenersOfMove, removePropertyChangeListener, setOkToFireEvents

Methods inherited from class ucar.visad.display.CompositeDisplayable

addConstantMap, addDisplayable, addListDataListener, clearDisplayables, cloneForDisplay, debug, destroy, destroyAll, displayableCount, fireListDataContentsChanged, fireListDataIntervalAdded, fireListDataIntervalRemoved, getAnimationSet, getDisplayable, indexOf, iterator, lastDisplayable, myAddDataReferences, myRemoveDataReferences, removeDisplayable, removeDisplayable, removeListDataListener, setAdjustFlow, setColor, setColorPalette, setColorUnit, setConstantPosition, setDisplay, setDisplayable, setDisplayMaster, setDisplayUnit, setLineWidth, setPointMode, setSelectedRange, setUseFastRendering, setUseTimesInAnimation, setVisible, setVisible, setVisible, toFront, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMaps, addDataReferences, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, destroyDisplayable, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getData, getDestroyed, getDisplay, getDisplayMaster, getDisplayUnit, getPointMode, getScalarMap, getScalarMap, getScalarMap, getScalarMapSet, getUseFastRendering, getUseTimesInAnimation, getVisible, hasDataObject, isActive, isUnitCompatible, isVisible, logException, myAddConstantMaps, removeConstantMap, removeDataReferences, removePropertyChangeListener, removeScalarMap, replaceScalarMap, setColorPalette, setContourInfo, setDisplayActive, setDisplayInactive, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setRangeForColor, setRangeForColor, setScalarMapSet, setSelectedRange

Methods inherited from class java.lang.Object

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

Constructor Detail

LineProbe

public LineProbe()
          throws visad.VisADException,
                 java.rmi.RemoteException

Default Constructor

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

LineProbe

public LineProbe(double x,
                 double y,
                 double z)
          throws visad.VisADException,
                 java.rmi.RemoteException

Construct a new LineProbe using the x, y, and z positions

Parameters:

x - x position

y - y position

z - z position

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

LineProbe

public LineProbe(visad.RealTuple position)
          throws visad.VisADException,
                 java.rmi.RemoteException

Construct a new LineProbe at the position

Parameters:

position - x/y position for the probe

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

LineProbe

public LineProbe(visad.RealTuple position,
                 visad.Real constant)
          throws visad.VisADException,
                 java.rmi.RemoteException

Construct a new LineProbe at the position using a constant Z value

Parameters:

position - x/y position for the probe

constant - z position of the selector point

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

LineProbe

public LineProbe(visad.RealTuple position,
                 visad.RealTuple fixedEndPoint,
                 visad.Real constant)
          throws visad.VisADException,
                 java.rmi.RemoteException

Create a new line probe

Parameters:

position - the starting position

fixedEndPoint - a fixed end point

constant - constant value

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - VisAD Exception

Method Detail

setManipulable

public void setManipulable(boolean manip)
                    throws visad.VisADException,
                           java.rmi.RemoteException

set if linprobe can be moved by the user with mouse cursor or not

Overrides:

setManipulable in class CompositeDisplayable

Parameters:

manip - boolean true if can move

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

getPosition

public visad.RealTuple getPosition()
                            throws visad.VisADException,
                                   java.rmi.RemoteException

Get the position of the SelectorPoint.

Returns:

position in XY space

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

getSelectorPoint

public SelectorPoint getSelectorPoint()

Get the selector point

Returns:

the point

setAutoSize

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

Set whether the marker should automatically resize as the display is zoomed.

Overrides:

setAutoSize in class SelectorDisplayable

Parameters:

yesorno - true to automatically resize the marker.

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setPosition

public void setPosition(double x,
                        double y)
                 throws visad.VisADException,
                        java.rmi.RemoteException

Sets the position of the probe. This method fires a PropertyChangeEvent for SelectorDisplayable.PROPERTY_POSITION.

This implementation uses setPosition(RealTuple) to actually set the position of the probe.

Parameters:

x - The X-axis position for the probe.

y - The Y-axis position for the probe.

Throws:

visad.VisADException - if a VisAD failure occurs.

java.rmi.RemoteException - if a Java RMI failure occurs.

setPosition

public void setPosition(visad.RealTuple position)
                 throws visad.VisADException,
                        java.rmi.RemoteException

Sets the position of the probe. This method fires a PropertyChangeEvent for SelectorDisplayable.PROPERTY_POSITION.

Parameters:

position - The position of the probe.

Throws:

visad.VisADException - if position.getType().equals( RealTupleType.SpatialCartesian2DTuple) is false or if another VisAD failure occurs.

java.rmi.RemoteException - if a Java RMI failure occurs.

See Also:

RealTupleType.SpatialCartesian2DTuple

setMarker

public void setMarker(java.lang.String markerText)
               throws visad.VisADException,
                      java.rmi.RemoteException

Set the marker text for this selector point

Parameters:

markerText - VisADGeometryArray for marker

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setMarker

public void setMarker(visad.VisADGeometryArray marker)
               throws visad.VisADException,
                      java.rmi.RemoteException

Set the marker for this selector point

Parameters:

marker - VisADGeometryArray for marker

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setPointSize

public void setPointSize(float newSize)
                  throws visad.VisADException,
                         java.rmi.RemoteException

Set the size (scale) of the ShapeControl. Usually done to set the initial size.

Overrides:

setPointSize in class SelectorDisplayable

Parameters:

newSize - size to use.

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

getPointScale

public float getPointScale()

Get the point's scale

Returns:

the scale of the point