ucar.visad.display

Class PointProbe

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.CompositeDisplayable

ucar.visad.display.SelectorDisplayable

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

Constructors

Constructor and Description
PointProbe() Construct a point probe.
PointProbe(double x, double y, double z) Construct a point probe at the location specified
PointProbe(visad.RealTuple position) Construct a probe at the position specified.

Method Summary

Modifier and Type	Method and Description
float	getPointScale() Get the point scale
visad.RealTuple	getPosition() Get the position of the probe.
SelectorPoint	getSelectorPoint() Get the selector point
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(java.lang.String marker) Set the type of marker used for the probe.
void	setMarker(visad.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(visad.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, setManipulable, 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

PointProbe

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

Construct a point probe.

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

PointProbe

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

Construct a point probe at the location specified

Parameters:

x - x position

y - y position

z - z position

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

PointProbe

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

Construct a probe at the position specified.

Parameters:

position - position of the probe

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

Method Detail

getSelectorPoint

public SelectorPoint getSelectorPoint()

Get the selector point

Returns:

the selector point

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()

Get the point scale

Returns:

the point scale

setMarker

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

Set the type of marker used for the probe.

Parameters:

marker - marker as a VisADGeometryArray

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setMarker

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

Set the type of marker used for the probe.

Parameters:

marker - marker from ucar.visad.ShapeUtility

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

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

getPosition

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

Get the position of the probe.

Returns:

probe's position

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

Set the probe's x/y position

Parameters:

x - x position

y - y position

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setPosition

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

Set the probe's position.

Parameters:

position - position of the probe

Throws:

java.rmi.RemoteException

visad.VisADException