ucar.visad.display
Class VolumeDisplayable

java.lang.Object
  ucar.visad.display.Displayable
      ucar.visad.display.DisplayableData
          ucar.visad.display.RGBDisplayable
              ucar.visad.display.VolumeDisplayable

All Implemented Interfaces:

GridDisplayable

public class VolumeDisplayable
extends RGBDisplayable
implements GridDisplayable

A class to support showing 3D gridded data as a volume in a DisplayMaster.

Version:

$Revision: 1.2 $

Author:

IDV Development Team

Nested Class Summary

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

DisplayableData.DragAdapter

Field Summary

Fields inherited from class ucar.visad.display.RGBDisplayable

COLOR_PALETTE, POLYGON_FILL, POLYGON_LINE, POLYGON_POINT, RGB_REAL_TYPE

Fields inherited from class ucar.visad.display.DisplayableData

LINE_WIDTH, MANIPULABLE, renderer, VISIBLE

Fields inherited from class ucar.visad.display.Displayable

DISPLAY, parent, SCALAR_MAP_SET

Constructor Summary

	VolumeDisplayable(String name) Constructs an instance with the supplied name.
	VolumeDisplayable(String name, RealType rgbRealType, float[][] colorPalette) Constructs from a name for the Displayable and the type of the RGB parameter.
protected	VolumeDisplayable(VolumeDisplayable that) Constructs from another instance.

Method Summary

Displayable	cloneForDisplay() Returns a clone of this instance suitable for another VisAD display.
void	loadData(FieldImpl field) Set the data into the Displayable; set RGB Type and SelectRange
void	loadData(FieldImpl field, int rgbIndex)
void	setColoredByAnother(boolean yesno) Set whether this GridDisplayable should have the data colored by another parameter.

Methods inherited from class ucar.visad.display.RGBDisplayable

getAutoScaleColorRange, getColorPalette, getCurvedSize, getPolygonMode, getRangeforColor, getRangeForColor, getRGBRealType, getSelectRealType, getUseRGBTypeForSelect, hasRange, hasSelectedRange, makeCurvedSizeMap, setAutoScaleColorRange, setColor, setColorPalette, setColorUnit, setCurvedSize, setDisplayUnit, setGreyPalette, setPolygonMode, setRange, setRangeForColor, setRangeForSelect, setRGBRealType, setScalarMaps, setSelectedRange, setSelectRealType, setUseRGBTypeForSelect, setVisADPalette, useDisplayUnitForColor

Methods inherited from class ucar.visad.display.DisplayableData

addAction, dataChange, destroy, getActive, getAnimationSet, getData, getDataRenderer, getLineWidth, getName, getPointSize, hasData, hasDataObject, isManipulable, isPickable, myAddConstantMaps, myAddDataReferences, myRemoveDataReferences, removeAction, setActive, setData, setDataReference, setDragAdapter, setLineWidth, setManipulable, setPickable, setPointMode, setPointSize, 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, setConstantPosition, setContourInfo, setDisplay, setDisplayActive, setDisplayInactive, setDisplayMaster, setOverrideAnimationSet, setOverrideAnimationSet, setParent, setRangeForColor, setScalarMapSet, setSelectedRange, setUseTimesInAnimation, toFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

VolumeDisplayable

public VolumeDisplayable(String name)
                  throws VisADException,
                         RemoteException

Constructs an instance with the supplied name.

Parameters:

name - a String identifier

Throws:

VisADException - from construction of super class

RemoteException - from construction of super class

VolumeDisplayable

public VolumeDisplayable(String name,
                         RealType rgbRealType,
                         float[][] colorPalette)
                  throws VisADException,
                         RemoteException

Constructs from a name for the Displayable and the type of the RGB parameter.

Parameters:

name - The name for the displayable.

rgbRealType - The type of the RGB parameter. May be null.

colorPalette - The initial colorPalette to use. May be null (Vis5D palette used as default).

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

VolumeDisplayable

protected VolumeDisplayable(VolumeDisplayable that)
                     throws VisADException,
                            RemoteException

Constructs from another instance. The following attributes are set from the other instance: color palette, the color RealType.

Parameters:

that - The other instance.

Throws:

VisADException - VisAD failure.

RemoteException - Java RMI failure.

Method Detail

loadData

public void loadData(FieldImpl field)
              throws VisADException,
                     RemoteException

Set the data into the Displayable; set RGB Type and SelectRange

Specified by:

loadData in interface GridDisplayable

Parameters:

field - a VisAD FlatField with a 3D nature

Throws:

VisADException - from construction of VisAd objects

RemoteException - from construction of VisAD objects

loadData

public void loadData(FieldImpl field,
                     int rgbIndex)
              throws VisADException,
                     RemoteException

Throws:

VisADException

RemoteException

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.

setColoredByAnother

public void setColoredByAnother(boolean yesno)

Set whether this GridDisplayable should have the data colored by another parameter. This implementation is a no-op.

Specified by:

setColoredByAnother in interface GridDisplayable

Parameters:

yesno - true if colored by another