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

Nested Class Summary

Nested classes/interfaces inherited from class ucar.visad.display.DisplayableData

DisplayableData.DragAdapter

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, renderer, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

Constructors

Constructor and Description
ShapeDisplayable(ShapeDisplayable that) Construct a ShapeDisplayable from another instance
ShapeDisplayable(java.lang.String name, visad.RealTuple initialValue) Construct a ShapeDisplayable for the pointType specified with the specified intial value.
ShapeDisplayable(java.lang.String name, visad.RealTupleType pointType) Construct a ShapeDisplayable for the pointType specified.
ShapeDisplayable(java.lang.String name, java.lang.String markerText) Construct a ShapeDisplayable.
ShapeDisplayable(java.lang.String name, java.lang.String markerText, visad.RealTuple initialValue) Construct a ShapeDisplayable.
ShapeDisplayable(java.lang.String name, visad.VisADGeometryArray marker) Construct a ShapeDisplayable for the pointType specified.
ShapeDisplayable(java.lang.String name, visad.VisADGeometryArray marker, visad.RealTuple initialValue) Construct a ShapeDisplayable for the pointType specified with the

Method Summary

Modifier and Type	Method and Description
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.
visad.VisADGeometryArray	getMarker() Get the marker for this selector point
visad.RealTuple	getPoint() Get the current point.
float	getScale() Get the scale of the ShapeControl.
visad.RealType	getShapeType() Get the shape type
static visad.VisADGeometryArray	reduce(visad.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(java.lang.String markerText) Set the marker text for this selector point
void	setMarker(visad.VisADGeometryArray marker) Set the marker for this selector point
void	setMarker(visad.VisADGeometryArray[] marker) Set the marker
void	setMarker(visad.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(visad.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, setDragAdapter, setManipulable, setPickable, setPointMode, setUseFastRendering, setVisible, showme, toString

Methods inherited from class ucar.visad.display.Displayable

addConstantMap, addConstantMaps, addDataReferences, addPropertyChangeListener, addPropertyChangeListener, addRefsInvoked, addScalarMap, addScalarMaps, applyColorUnit, applyDisplayUnit, checkUnit, combineConstantMaps, destroyDisplayable, firePropertyChange, firePropertyChange, fireScalarMapSetChange, getColorUnit, getConstantMaps, getDestroyed, 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(java.lang.String name,
                        visad.VisADGeometryArray marker)
                 throws visad.VisADException,
                        java.rmi.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:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(java.lang.String name,
                        visad.RealTupleType pointType)
                 throws visad.VisADException,
                        java.rmi.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:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(java.lang.String name,
                        visad.RealTuple initialValue)
                 throws visad.VisADException,
                        java.rmi.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:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(java.lang.String name,
                        java.lang.String markerText)
                 throws visad.VisADException,
                        java.rmi.RemoteException

Construct a ShapeDisplayable.

Parameters:

name - name of this ShapeDisplayable

markerText - text for the marker

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(java.lang.String name,
                        java.lang.String markerText,
                        visad.RealTuple initialValue)
                 throws visad.VisADException,
                        java.rmi.RemoteException

Construct a ShapeDisplayable.

Parameters:

name - name of this ShapeDisplayable

markerText - text for the marker

initialValue - RealTuple position for point

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(java.lang.String name,
                        visad.VisADGeometryArray marker,
                        visad.RealTuple initialValue)
                 throws visad.VisADException,
                        java.rmi.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:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

ShapeDisplayable

public ShapeDisplayable(ShapeDisplayable that)
                 throws visad.VisADException,
                        java.rmi.RemoteException

Construct a ShapeDisplayable from another instance

Parameters:

that - other instance

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

Method Detail

setPoint

public void setPoint(visad.RealTuple value)
              throws visad.VisADException,
                     java.rmi.RemoteException

Set the point.

Parameters:

value - new value for this point

Throws:

visad.VisADException - VisAD error

java.rmi.RemoteException - remote error

cloneForDisplay

public Displayable cloneForDisplay()
                            throws visad.VisADException,
                                   java.rmi.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:

visad.VisADException - VisAD failure.

java.rmi.RemoteException - Java RMI failure.

getPoint

public visad.RealTuple getPoint()

Get the current point.

Returns:

the current value for this point

setMarker

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

Set the marker text for this selector point

Parameters:

markerText - VisADGeometryArray for marker

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setMarker

public void setMarker(visad.VisADGeometryArray marker,
                      double x,
                      double y,
                      double z)
               throws visad.VisADException,
                      java.rmi.RemoteException

Set the marker for this selector point

Parameters:

marker - VisADGeometryArray for marker

x - X location

y - Y location

z - Z location

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setPoint

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

Set the location

Parameters:

x - x

y - y

z - z

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setMarker

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

Set the marker for this selector point

Parameters:

marker - VisADGeometryArray for marker

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

setMarker

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

Set the marker

Parameters:

marker - the marker as a geometry array

Throws:

java.rmi.RemoteException - Java RMI Exception

visad.VisADException - VisAD Exception

setPointSize

public void setPointSize(float newSize)
                  throws visad.VisADException,
                         java.rmi.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:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

getScale

public float getScale()

Get the scale of the ShapeControl.

Returns:

current scale;

getMarker

public visad.VisADGeometryArray getMarker()

Get the marker for this selector point

Returns:

VisADGeometryArray for marker

setAutoSize

public void setAutoSize(boolean yesorno)
                 throws visad.VisADException,
                        java.rmi.RemoteException

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

Parameters:

yesorno - true to automatically resize the marker.

Throws:

java.rmi.RemoteException - Java RMI error

visad.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 visad.VisADException,
                          java.rmi.RemoteException

Called when the data changes.

Overrides:

dataChange in class DisplayableData

Throws:

java.rmi.RemoteException - Java RMI error

visad.VisADException - problem creating VisAD object

reduce

public static visad.VisADGeometryArray reduce(visad.VisADGeometryArray marker)

Reduce the size of the marker

Parameters:

marker - marker to reduce

Returns:

reduced marker

getShapeType

public visad.RealType getShapeType()

Get the shape type

Returns:

The shape type