ucar.visad.display

Class RadarGrid

java.lang.Object

ucar.visad.display.Displayable

ucar.visad.display.CompositeDisplayable

ucar.visad.display.RadarGrid

public class RadarGrid
extends CompositeDisplayable

A class to support a standard radar grid display - range rings, radials and labels.

Version:

$Revision: 1.25 $

Author:

IDV Development Team

Field Summary

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
RadarGrid(double lat, double lon, java.awt.Color color) Construct a RadarGrid centered at specified lat/lon
RadarGrid(double lat, double lon, java.awt.Color color, visad.Unit distUnit) Construct a RadarGrid centered at specified lat/lon
RadarGrid(visad.georef.LatLonPoint llp, java.awt.Color color) Construct a RadarGrid centered at llp.
RadarGrid(visad.georef.LatLonPoint llp, java.awt.Color color, visad.Unit distUnit) Construct a RadarGrid centered at llp.

Method Summary

Modifier and Type	Method and Description
double	getCenterLatitude() Get the latitude of the center of radar range rings.
double	getCenterLongitude() Get the longitude of the center of radar range rings.
void	setAzimuthLineColor(java.awt.Color color) Set the color of the azimuth lines (radials).
void	setAzimuthLinesVisible(boolean visible) Set the visibility of the azimuth lines (radials)
void	setCenterPoint(double lat, double lon) Make a set of range rings and radials on this center location.
void	setCenterPoint(visad.georef.LatLonPoint llp) Set the point to center the radar grid on.
void	setCenterPointAndColors(double lat, double lon, java.awt.Color rrcolor, java.awt.Color radcolor, java.awt.Color lcolor) Set the center point and colors of the RadarGrid.
void	setColor(java.awt.Color color) Set the color of all part of the grid to one color.
void	setDisplayUnit(visad.Unit newUnit) Sets the unit on all contained children.
void	setDistanceUnit(visad.Unit newUnit) Set the distance unit
void	setFont(java.awt.Font f) Set the font on the labels
void	setLabelColor(java.awt.Color color) Set the color of the labels
void	setLabelLineWidth(float width) Set the width of the labels
void	setLabelSize(float size) Set the scaling size on the labels.
void	setLabelSpacing(double li) Set the spacing of radar range ring labels.
void	setLabelsVisible(boolean visible) Set the labels visible
void	setMaxRadius(double radius) Set the maximum radius of radar range rings
void	setRadialInterval(double inc) Set the interval of radials.
void	setRadialLineWidth(float width) Set the width of the labels
void	setRangeRingColor(java.awt.Color color) Set the color of the range rings.
void	setRangeRingLineWidth(float width) Set the width of the range rings
void	setRangeRingSpacing(double spacing, double max) Set the spacing and max value of radar range rings distance from center.
void	setRangeRingsVisible(boolean visible) Set the visibility of the range rings.

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, setColorPalette, setColorUnit, setConstantPosition, setDisplay, setDisplayable, setDisplayMaster, setLineWidth, setManipulable, setPointMode, setPointSize, setSelectedRange, setUseFastRendering, setUseTimesInAnimation, setVisible, setVisible, setVisible, toFront, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMaps, addDataReferences, addPropertyChangeListener, 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, 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

RadarGrid

public RadarGrid(visad.georef.LatLonPoint llp,
                 java.awt.Color color)
          throws visad.VisADException,
                 java.rmi.RemoteException

Construct a RadarGrid centered at llp.

Parameters:

llp - center point

color - color for the grid

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

RadarGrid

public RadarGrid(visad.georef.LatLonPoint llp,
                 java.awt.Color color,
                 visad.Unit distUnit)
          throws visad.VisADException,
                 java.rmi.RemoteException

Construct a RadarGrid centered at llp.

Parameters:

llp - center point

color - color for the grid

distUnit - distance unit

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

RadarGrid

public RadarGrid(double lat,
                 double lon,
                 java.awt.Color color)
          throws visad.VisADException,
                 java.rmi.RemoteException

Construct a RadarGrid centered at specified lat/lon

Parameters:

lat - center point latitude (degrees)

lon - center point longitude (degrees)

color - color for the grid

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

RadarGrid

public RadarGrid(double lat,
                 double lon,
                 java.awt.Color color,
                 visad.Unit distUnit)
          throws visad.VisADException,
                 java.rmi.RemoteException

Construct a RadarGrid centered at specified lat/lon

Parameters:

lat - center point latitude (degrees)

lon - center point longitude (degrees)

color - color for the grid

distUnit - distance unit

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

Method Detail

setColor

public void setColor(java.awt.Color color)
              throws visad.VisADException,
                     java.rmi.RemoteException

Set the color of all part of the grid to one color.

Overrides:

setColor in class CompositeDisplayable

Parameters:

color - color to use

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

setAzimuthLineColor

public void setAzimuthLineColor(java.awt.Color color)
                         throws visad.VisADException,
                                java.rmi.RemoteException

Set the color of the azimuth lines (radials).

Parameters:

color - color to use

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

setRangeRingColor

public void setRangeRingColor(java.awt.Color color)
                       throws visad.VisADException,
                              java.rmi.RemoteException

Set the color of the range rings.

Parameters:

color - color to use

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

setLabelColor

public void setLabelColor(java.awt.Color color)
                   throws visad.VisADException,
                          java.rmi.RemoteException

Set the color of the labels

Parameters:

color - Color for labels

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setLabelLineWidth

public void setLabelLineWidth(float width)
                       throws visad.VisADException,
                              java.rmi.RemoteException

Set the width of the labels

Parameters:

width - width in pixels

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setRangeRingLineWidth

public void setRangeRingLineWidth(float width)
                           throws visad.VisADException,
                                  java.rmi.RemoteException

Set the width of the range rings

Parameters:

width - width in pixels

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setRadialLineWidth

public void setRadialLineWidth(float width)
                        throws visad.VisADException,
                               java.rmi.RemoteException

Set the width of the labels

Parameters:

width - width in pixels

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setAzimuthLinesVisible

public void setAzimuthLinesVisible(boolean visible)
                            throws visad.VisADException,
                                   java.rmi.RemoteException

Set the visibility of the azimuth lines (radials)

Parameters:

visible - true to show

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

setRangeRingsVisible

public void setRangeRingsVisible(boolean visible)
                          throws visad.VisADException,
                                 java.rmi.RemoteException

Set the visibility of the range rings.

Parameters:

visible - true to show

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

setLabelsVisible

public void setLabelsVisible(boolean visible)
                      throws visad.VisADException,
                             java.rmi.RemoteException

Set the labels visible

Parameters:

visible - true to show the labels

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setCenterPoint

public void setCenterPoint(visad.georef.LatLonPoint llp)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Set the point to center the radar grid on.

Parameters:

llp - new point to center on.

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setCenterPoint

public void setCenterPoint(double lat,
                           double lon)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Make a set of range rings and radials on this center location. color is implicit from class member data set elsewhere as in cstr.

Parameters:

lat - in degrees

lon - in degrees east

Throws:

java.rmi.RemoteException

visad.VisADException

setCenterPointAndColors

public void setCenterPointAndColors(double lat,
                                    double lon,
                                    java.awt.Color rrcolor,
                                    java.awt.Color radcolor,
                                    java.awt.Color lcolor)
                             throws visad.VisADException,
                                    java.rmi.RemoteException

Set the center point and colors of the RadarGrid.

Parameters:

lat - latitude (degrees)

lon - longitude (degrees)

rrcolor - range ring color

radcolor - radial color

lcolor - label color

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

getCenterLatitude

public double getCenterLatitude()

Get the latitude of the center of radar range rings.

Returns:

the center latitude (in degrees)

getCenterLongitude

public double getCenterLongitude()

Get the longitude of the center of radar range rings.

Returns:

the center longitude (in degrees)

setRangeRingSpacing

public void setRangeRingSpacing(double spacing,
                                double max)
                         throws visad.VisADException,
                                java.rmi.RemoteException

Set the spacing and max value of radar range rings distance from center.

Parameters:

spacing - in kilometers

max - max radius in kilometers

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setMaxRadius

public void setMaxRadius(double radius)
                  throws visad.VisADException,
                         java.rmi.RemoteException

Set the maximum radius of radar range rings

Parameters:

radius - in kilometers

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setLabelSpacing

public void setLabelSpacing(double li)
                     throws visad.VisADException,
                            java.rmi.RemoteException

Set the spacing of radar range ring labels.

Parameters:

li - label increment in kilometers

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setRadialInterval

public void setRadialInterval(double inc)
                       throws visad.VisADException,
                              java.rmi.RemoteException

Set the interval of radials.

Parameters:

inc - angular degrees separation of radials

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setLabelSize

public void setLabelSize(float size)

Set the scaling size on the labels.

Parameters:

size - scaling size (0 - 1)

setFont

public void setFont(java.awt.Font f)
             throws visad.VisADException,
                    java.rmi.RemoteException

Set the font on the labels

Parameters:

f - The font

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

setDisplayUnit

public void setDisplayUnit(visad.Unit newUnit)
                    throws visad.VisADException,
                           java.rmi.RemoteException

Description copied from class: CompositeDisplayable

Sets the unit on all contained children.

Overrides:

setDisplayUnit in class CompositeDisplayable

Parameters:

newUnit - The display unit to use.

Throws:

visad.VisADException - if a VisADFailure occurs.

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

setDistanceUnit

public void setDistanceUnit(visad.Unit newUnit)
                     throws visad.VisADException,
                            java.rmi.RemoteException

Set the distance unit

Parameters:

newUnit - the new Unit

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - unit not a distance unit