ucar.visad.display
Class RingSet

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

public class RingSet
extends PolarLineDrawing

Provides support for a set of evenly-spaced, concentric rings (ie: a "bullseye").

Version:

$Revision: 1.13 $

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	RingSet(RingSet that) Constructs from another instance.
	RingSet(String name, RealTupleType polarType) Constructs from a name and a vector space.
	RingSet(String name, RealTupleType polarType, Color color) Constructs from a name and a vector space and Color.

Method Summary

void	addScalarMaps(LocalDisplay display) Adds this instance's ScalarMaps to a given LocalDisplay.
Displayable	cloneForDisplay() Returns a clone of this instance suitable for another VisAD display.
static SampledSet	newUnionSet(RealTupleType polarType, Gridded1DSet values) Creates a set of rings from a vector space and a set of distances.
void	setRingValues(Linear1DSet ringValues) Sets the distances of the rings from a set of evenly-spaced values.
void	setRingValues(Real rangeInc, Real rangeMax) Sets the distances of the rings from an interval and a maximum distance.
void	setRingValues(RingSet that) Sets the ring distances of this instance from another instance.

Methods inherited from class ucar.visad.display.PolarLineDrawing

equals, 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

RingSet

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

Constructs from a name and a vector space. Rings are white.

Parameters:

name - The name for this instance.

polarType - The vector space for this instance.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

RingSet

public RingSet(String name,
               RealTupleType polarType,
               Color color)
        throws RemoteException,
               VisADException

Constructs from a name and a vector space and Color.

Parameters:

name - The name for this instance.

polarType - The vector space for this instance.

color - ring color

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

RingSet

protected RingSet(RingSet that)
           throws RemoteException,
                  VisADException

Constructs from another instance.

Parameters:

that - The other instance.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

Method Detail

setRingValues

public void setRingValues(Linear1DSet ringValues)
                   throws VisADException,
                          RemoteException

Sets the distances of the rings from a set of evenly-spaced values.

Parameters:

ringValues - The distances for the rings.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

setRingValues

public void setRingValues(Real rangeInc,
                          Real rangeMax)
                   throws VisADException,
                          RemoteException

Sets the distances of the rings from an interval and a maximum distance.

Parameters:

rangeInc - The ring interval.

rangeMax - The maximum distance to be displayed.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

newUnionSet

public static SampledSet newUnionSet(RealTupleType polarType,
                                     Gridded1DSet values)
                              throws VisADException,
                                     RemoteException

Creates a set of rings from a vector space and a set of distances.

Parameters:

polarType - The polar vector-space.

values - The set of distances.

Returns:

The set of rings.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

setRingValues

public void setRingValues(RingSet that)
                   throws TypeException,
                          VisADException,
                          RemoteException

Sets the ring distances of this instance from another instance.

Parameters:

that - The other instance.

Throws:

TypeException - if a necessary VisAD RealType couldn't be created.

VisADException - VisAD failure.

RemoteException - Java RMI failure.

addScalarMaps

public void addScalarMaps(LocalDisplay display)

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

Parameters:

display - The LocalDisplay to which to add this instance's ScalarMaps.

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.