ucar.visad.display
Class ShapeDisplayable

java.lang.Object
  ucar.visad.display.Displayable
      ucar.visad.display.DisplayableData
          ucar.visad.display.LineDrawing
              ucar.visad.display.ShapeDisplayable

public class ShapeDisplayable
extends LineDrawing

Displayable to encompass a manipulable point that can be moved around the display. If you want to limit the movement to one axis, then construct the RealTuple with one element whose RealType corresponds to that axis.

Version:

$Revision: 1.7 $

Author:

Don Murray

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

ShapeDisplayable(ShapeDisplayable that)
Construct a ShapeDisplayable from another instance

ShapeDisplayable(String name, RealTuple initialValue)
Construct a ShapeDisplayable for the pointType specified with the specified intial value.

ShapeDisplayable(String name, RealTupleType pointType)
Construct a ShapeDisplayable for the pointType specified.

ShapeDisplayable(String name, String markerText)
Construct a ShapeDisplayable.

ShapeDisplayable(String name, String markerText, RealTuple initialValue)
Construct a ShapeDisplayable.

ShapeDisplayable(String name, VisADGeometryArray marker)
Construct a ShapeDisplayable for the pointType specified.

ShapeDisplayable(String name, VisADGeometryArray marker, RealTuple initialValue)
Construct a ShapeDisplayable for the pointType specified with the

Method Summary

Displayable	cloneForDisplay() Returns a clone of this instance suitable for another VisAD display.
protected void	dataChange() Called when the data changes.
boolean	getAutoSize() Get whether the marker is automatically resized as the display is zoomed.
VisADGeometryArray	getMarker() Get the marker for this selector point
RealTuple	getPoint() Get the current point.
float	getScale() Get the scale of the ShapeControl.
RealType	getShapeType() Get the shape type
static VisADGeometryArray	reduce(VisADGeometryArray marker) Reduce the size of the marker
void	setAutoSize(boolean yesorno) Set whether the marker should automatically resize as the display is zoomed.
void	setMarker(String markerText) Set the marker text for this selector point
void	setMarker(VisADGeometryArray marker) Set the marker for this selector point
void	setMarker(VisADGeometryArray[] marker)
void	setMarker(VisADGeometryArray marker, double x, double y, double z) Set the marker for this selector point
void	setPoint(double x, double y, double z) Set the location
void	setPoint(RealTuple value) Set the point.
void	setPointSize(float newSize) Set the size (scale) of the ShapeControl.

Methods inherited from class ucar.visad.display.LineDrawing

getColor, getLineStyle, getLineWidth, getPointSize, setColor, setHSV, setHSV, setLineStyle, setLineWidth, setRGB, setRGB, setRGBA, setRGBA

Methods inherited from class ucar.visad.display.DisplayableData

addAction, 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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ShapeDisplayable

public ShapeDisplayable(String name,
                        VisADGeometryArray marker)
                 throws VisADException,
                        RemoteException

Construct a ShapeDisplayable for the pointType specified. Initial value is set to 0.

Parameters:

name - name of this ShapeDisplayable

marker - The marker to use

Throws:

VisADException - VisAD error

RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(String name,
                        RealTupleType pointType)
                 throws VisADException,
                        RemoteException

Construct a ShapeDisplayable for the pointType specified. Initial value is set to 0.

Parameters:

name - name of this ShapeDisplayable

pointType - RealType that the point should map to

Throws:

VisADException - VisAD error

RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(String name,
                        RealTuple initialValue)
                 throws VisADException,
                        RemoteException

Construct a ShapeDisplayable for the pointType specified with the specified intial value.

Parameters:

name - name of this ShapeDisplayable

initialValue - RealTuple position for point

Throws:

VisADException - VisAD error

RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(String name,
                        String markerText)
                 throws VisADException,
                        RemoteException

Construct a ShapeDisplayable.

Parameters:

name - name of this ShapeDisplayable

markerText - text for the marker

Throws:

VisADException - VisAD error

RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(String name,
                        String markerText,
                        RealTuple initialValue)
                 throws VisADException,
                        RemoteException

Construct a ShapeDisplayable.

Parameters:

name - name of this ShapeDisplayable

markerText - text for the marker

initialValue - RealTuple position for point

Throws:

VisADException - VisAD error

RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(String name,
                        VisADGeometryArray marker,
                        RealTuple initialValue)
                 throws VisADException,
                        RemoteException

Construct a ShapeDisplayable for the pointType specified with the

Parameters:

name - name of this ShapeDisplayable

marker - Shape to use for maker

initialValue - RealTuple position for point

Throws:

VisADException - VisAD error

RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(ShapeDisplayable that)
                 throws VisADException,
                        RemoteException

Construct a ShapeDisplayable from another instance

Parameters:

that - other instance

Throws:

VisADException - VisAD error

RemoteException - remote error

Method Detail

setPoint

public void setPoint(RealTuple value)
              throws VisADException,
                     RemoteException

Set the point.

Parameters:

value - new value for this point

Throws:

VisADException - VisAD error

RemoteException - remote error

cloneForDisplay

public Displayable cloneForDisplay()
                            throws VisADException,
                                   RemoteException

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.

getPoint

public RealTuple getPoint()

Get the current point.

Returns:

the current value for this point

setMarker

public void setMarker(String markerText)
               throws VisADException,
                      RemoteException

Set the marker text for this selector point

Parameters:

markerText - VisADGeometryArray for marker

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setMarker

public void setMarker(VisADGeometryArray marker,
                      double x,
                      double y,
                      double z)
               throws VisADException,
                      RemoteException

Set the marker for this selector point

Parameters:

marker - VisADGeometryArray for marker

x - X location

y - Y location

z - Z location

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setPoint

public void setPoint(double x,
                     double y,
                     double z)
              throws VisADException,
                     RemoteException

Set the location

Parameters:

x - x

y - y

z - z

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setMarker

public void setMarker(VisADGeometryArray marker)
               throws VisADException,
                      RemoteException

Set the marker for this selector point

Parameters:

marker - VisADGeometryArray for marker

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

setMarker

public void setMarker(VisADGeometryArray[] marker)
               throws VisADException,
                      RemoteException

Throws:

VisADException

RemoteException

setPointSize

public void setPointSize(float newSize)
                  throws VisADException,
                         RemoteException

Set the size (scale) of the ShapeControl. Usually done to set the initial size.

Overrides:

setPointSize in class LineDrawing

Parameters:

newSize - size to use.

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

getScale

public float getScale()

Get the scale of the ShapeControl.

Returns:

current scale;

getMarker

public VisADGeometryArray getMarker()

Get the marker for this selector point

Returns:

VisADGeometryArray for marker

setAutoSize

public void setAutoSize(boolean yesorno)
                 throws VisADException,
                        RemoteException

Set whether the marker should automatically resize as the display is zoomed.

Parameters:

yesorno - true to automatically resize the marker.

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

getAutoSize

public boolean getAutoSize()

Get whether the marker is automatically resized as the display is zoomed.

Returns:

true if marker is automatically resized.

dataChange

protected void dataChange()
                   throws VisADException,
                          RemoteException

Called when the data changes.

Overrides:

dataChange in class DisplayableData

Throws:

RemoteException - Java RMI error

VisADException - problem creating VisAD object

reduce

public static VisADGeometryArray reduce(VisADGeometryArray marker)

Reduce the size of the marker

Parameters:

marker - marker to reduce

Returns:

reduced marker

getShapeType

public RealType getShapeType()

Get the shape type

Returns:

The shape type