ucar.visad.display
Class PointProbe

java.lang.Object
  extended by ucar.visad.display.Displayable
      extended by ucar.visad.display.CompositeDisplayable
          extended by ucar.visad.display.SelectorDisplayable
              extended by ucar.visad.display.PointProbe

public class PointProbe
extends SelectorDisplayable

Class for a probe.

Version:
$Revision: 1.11 $
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
PointProbe()
          Construct a point probe.
PointProbe(double x, double y, double z)
          Construct a point probe at the location specified
PointProbe(RealTuple position)
          Construct a probe at the position specified.
 
Method Summary
 float getPointScale()
          _more_
 RealTuple getPosition()
          Get the position of the probe.
 void setAutoSize(boolean yesorno)
          Set whether the marker should automatically resize as the display is zoomed.
 void setFixed(boolean x, boolean y, boolean z)
          Set if any of the axis movements are fixed
 void setMarker(String marker)
          Set the type of marker used for the probe.
 void setMarker(VisADGeometryArray marker)
          Set the type of marker used for the probe.
 void setPosition(double x, double y)
          Set the probe's x/y position
 void setPosition(RealTuple position)
          Set the probe's position.
 
Methods inherited from class ucar.visad.display.SelectorDisplayable
addPropertyChangeListener, getAutoSize, getFiringEvent, getOkToFireEvents, getPointSize, notifyListenersOfMove, removePropertyChangeListener, setOkToFireEvents, setPointSize
 
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, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getData, 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

PointProbe

public PointProbe()
           throws VisADException,
                  RemoteException
Construct a point probe.

Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

PointProbe

public PointProbe(double x,
                  double y,
                  double z)
           throws VisADException,
                  RemoteException
Construct a point probe at the location specified

Parameters:
x - x position
y - y position
z - z position
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

PointProbe

public PointProbe(RealTuple position)
           throws VisADException,
                  RemoteException
Construct a probe at the position specified.

Parameters:
position - position of the probe
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object
Method Detail

setFixed

public void setFixed(boolean x,
                     boolean y,
                     boolean z)
Set if any of the axis movements are fixed

Parameters:
x - x fixed
y - y fixed
z - z fixed

getPointScale

public float getPointScale()
_more_

Returns:
_more_

setMarker

public void setMarker(VisADGeometryArray marker)
               throws VisADException,
                      RemoteException
Set the type of marker used for the probe.

Parameters:
marker - marker as a VisADGeometryArray
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

setMarker

public void setMarker(String marker)
               throws VisADException,
                      RemoteException
Set the type of marker used for the probe.

Parameters:
marker - marker from ucar.visad.ShapeUtility
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

setAutoSize

public void setAutoSize(boolean yesorno)
                 throws VisADException,
                        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:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

getPosition

public RealTuple getPosition()
                      throws VisADException,
                             RemoteException
Get the position of the probe.

Returns:
probe's position
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

setPosition

public void setPosition(double x,
                        double y)
                 throws VisADException,
                        RemoteException
Set the probe's x/y position

Parameters:
x - x position
y - y position
Throws:
RemoteException - Java RMI error
VisADException - problem creating VisAD object

setPosition

public void setPosition(RealTuple position)
                 throws VisADException,
                        RemoteException
Set the probe's position.

Parameters:
position - position of the probe
Throws:
RemoteException
VisADException