ucar.visad.display
Class CrossHair

java.lang.Object
  ucar.visad.display.Displayable
      ucar.visad.display.DisplayableData
          ucar.visad.display.LineDrawing
              ucar.visad.display.PolarLineDrawing
                  ucar.visad.display.CrossHair

public class CrossHair
extends PolarLineDrawing

Provides support for a Displayable comprising a cross-hair.

Version:

$Revision: 1.11 $

Author:

Steven R. Emmerson

Field Summary

Fields inherited from class ucar.visad.display.LineDrawing

COLOR, LINE_STYLE, LINE_WIDTH, POINT_SIZE

Fields inherited from class ucar.visad.display.DisplayableData

MANIPULABLE, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

protected	CrossHair(CrossHair that) Constructs from another instance.
	CrossHair(String name, RealTupleType polarType) Constructs from a Displayable name and the type of the polar coordinate system.

Method Summary

void	addScalarMaps(LocalDisplay display) Adds this instance's ScalarMaps to a display.
Displayable	cloneForDisplay() Returns a clone of this instance suitable for another VisAD display.
boolean	equals(Object obj) Indicates if this CrossHair is semantically identical to another object.
void	setHairs(CrossHair crossHair) Sets the cross-hairs according to another CrossHair.
void	setHairs(Real maximum) Sets the cross-hairs according to the maximum distance from the center.

Methods inherited from class ucar.visad.display.PolarLineDrawing

getBearingIndex, getBearingIndex, getBearingType, getPolarType, getRangeIndex, getRangeType, hashCode

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, dataChange, destroy, getActive, getAnimationSet, getData, getDataRenderer, getName, hasData, hasDataObject, isManipulable, isPickable, myAddConstantMaps, myAddDataReferences, myRemoveDataReferences, removeAction, setActive, setData, setDataReference, setManipulable, setPickable, setPointMode, setUseFastRendering, setVisible, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, 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, setContourInfo, setDisplay, setDisplayActive, setDisplayInactive, setDisplayMaster, setDisplayUnit, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setRangeForColor, setRangeForColor, setScalarMapSet, setSelectedRange, setSelectedRange, setUseTimesInAnimation, toFront

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CrossHair

public CrossHair(String name,
                 RealTupleType polarType)
          throws RemoteException,
                 VisADException

Constructs from a Displayable name and the type of the polar coordinate system.

Parameters:

name - The name for the Displayable.

polarType - The type of the (rho, theta) polar coordinate system.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

CrossHair

protected CrossHair(CrossHair that)
             throws RemoteException,
                    VisADException

Constructs from another instance.

Parameters:

that - The other instance.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

Method Detail

setHairs

public void setHairs(Real maximum)
              throws VisADException,
                     RemoteException

Sets the cross-hairs according to the maximum distance from the center.

Parameters:

maximum - The maximum distance from the center.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

setHairs

public void setHairs(CrossHair crossHair)
              throws VisADException,
                     RemoteException

Sets the cross-hairs according to another CrossHair.

Parameters:

crossHair - The other cross-hair.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

equals

public boolean equals(Object obj)

Indicates if this CrossHair is semantically identical to another object.

Overrides:

equals in class PolarLineDrawing

Parameters:

obj - The other object.

Returns:

true if and only if this CrossHair is semantically identical to obj.

addScalarMaps

public void addScalarMaps(LocalDisplay display)

Adds this instance's ScalarMaps to a display. This implementation does nothing.

Parameters:

display - The display to which to add the ScalarMap-s.

cloneForDisplay

public Displayable cloneForDisplay()
                            throws RemoteException,
                                   VisADException

Returns a clone of this instance suitable for another VisAD display. Underlying data objects are not cloned.

Overrides:

cloneForDisplay in class DisplayableData

Returns:

A semi-deep clone of this instance.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.