visad
Interface Display

All Superinterfaces:
Action, java.util.EventListener, ThingChangedListener
All Known Subinterfaces:
LocalDisplay, RemoteDisplay
All Known Implementing Classes:
DisplayImpl, DisplayImplJ2D, DisplayImplJ3D, RemoteDisplayImpl

public interface Display
extends Action

Display is the VisAD interface for displays. It is runnable.

The display architecture is based on three goals:

  1. Display data according to a set of mappings from RealType's (e.g., Latitude, Time, Pressure) to DisplayRealType's (e.g., XAxis, RGB, Animation).

  2. Allow user extensions, to define new DisplayRealType's, new DisplayRealTuple's (and hence new display CoordinateSsystem's), and new rendering algorithms.

  3. Support direct manipulation through 3-D user interface widgets embedded in 3-D data displays.


Field Summary
static DisplayRealType Alpha
          Alpha is transparency
static DisplayRealType Animation
          animation display scalar
static DisplayRealType Blue
           
static DisplayRealType CMY
           
static DisplayRealType[] components3c
          system intrinsic DisplayTupleType for 3D Cartesian Spatial Coordinates
static DisplayRealType[] components3s
           
static DisplayRealType[] componentscmy
           
static DisplayRealType[] componentscyl
          DisplayRealType array of CylRadius, CylAzimuth, CylZAxis for Cylindrical Coordinates
static DisplayRealType[] componentsflow1
          system intrinsic DisplayTupleType for first set of Flow components
static DisplayRealType[] componentsflow1s
           
static DisplayRealType[] componentsflow2
          system intrinsic DisplayTupleType for second set of Flow components
static DisplayRealType[] componentsflow2s
           
static DisplayRealType[] componentshsv
           
static DisplayRealType[] componentsrgb
          system intrinsic DisplayTupleType for RGB Color Coordinates
static DisplayRealType[] componentsso
          system intrinsic DisplayTupleType for Spatial Offset Coordinates
static DisplayRealType Cyan
           
static DisplayRealType CylAzimuth
          Cylindrical azimuth scalar
static DisplayRealType CylRadius
          Cylindrical radius scalar
static DisplayRealType CylZAxis
          Cylindrical ZAxis scalar
static CoordinateSystem DisplayCMYCoordSys
          system intrinsic DisplayTupleType for CMY Color Coordinates
static DisplayTupleType DisplayCMYTuple
           
static CoordinateSystem DisplayCylindricalCoordSys
          defines a CoordinateSystem with Reference DisplaySpatialCartesianTuple
static CoordinateSystem DisplayFlow1SphericalCoordSys
          system intrinsic DisplayTupleType for first set of 3D Spherical Flow Coordinates, this defines a CoordinateSystem with Reference DisplayFlow1Tuple
static DisplayTupleType DisplayFlow1SphericalTuple
           
static DisplayTupleType DisplayFlow1Tuple
           
static CoordinateSystem DisplayFlow2SphericalCoordSys
          system intrinsic DisplayTupleType for second set of 3D Spherical Flow Coordinates, this defines a CoordinateSystem with Reference DisplayFlow2Tuple
static DisplayTupleType DisplayFlow2SphericalTuple
           
static DisplayTupleType DisplayFlow2Tuple
           
static CoordinateSystem DisplayHSVCoordSys
          system intrinsic DisplayTupleType for HSV Color Coordinates
static DisplayTupleType DisplayHSVTuple
           
static DisplayRealType[] DisplayRealArray
          array of system intrinsic display scalars
static DisplayTupleType DisplayRGBTuple
           
static DisplayTupleType DisplaySpatialCartesianTuple
           
static DisplayTupleType DisplaySpatialCylindricalTuple
          System intrinsic DisplayTupleType for Cylindrical Coordinates
static DisplayTupleType DisplaySpatialOffsetTuple
           
static DisplayTupleType DisplaySpatialSphericalTuple
           
static CoordinateSystem DisplaySphericalCoordSys
          system intrinsic DisplayTupleType for 3D Spherical Spatial Coordinates, this defines a CoordinateSystem with Reference DisplaySpatialCartesianTuple
static DisplayRealType Flow1Azimuth
           
static DisplayRealType Flow1Elevation
           
static DisplayRealType Flow1Radial
           
static DisplayRealType Flow1X
          three flow display scalars
static DisplayRealType Flow1Y
           
static DisplayRealType Flow1Z
           
static DisplayRealType Flow2Azimuth
           
static DisplayRealType Flow2Elevation
           
static DisplayRealType Flow2Radial
           
static DisplayRealType Flow2X
          second set of three flow display scalars
static DisplayRealType Flow2Y
           
static DisplayRealType Flow2Z
           
static DisplayRealType Green
           
static DisplayRealType HSV
           
static DisplayRealType Hue
           
static DisplayRealType IsoContour
          iso-contour display scalar
static DisplayRealType Latitude
           
static DisplayRealType LineStyle
           
static DisplayRealType LineWidth
          point size, line width and line style - ConstantMap only
static DisplayRealType List
          list display scalar (default domain of DisplayField)
static DisplayRealType Longitude
           
static DisplayRealType Magenta
           
static DisplayRealType PointSize
           
static DisplayRealType Radius
           
static DisplayRealType Red
          color display scalars
static DisplayRealType RGB
           
static DisplayRealType RGBA
           
static DisplayRealType Saturation
           
static DisplayRealType SelectRange
          display scalar for selecting by a range of values
static DisplayRealType SelectValue
          display scalar for selecting by a single value
static DisplayRealType Shape
          shape display scalar WLH - this should be a DisplayEnumeratedType
static DisplayRealType ShapeScale
          scale for Shape
static DisplayRealType Text
          text display scalar WLH - this should be a DisplayTextType
static DisplayRealType TextureEnable
           
static DisplayRealType Value
           
static DisplayRealType XAxis
          spatial display scalars
static DisplayRealType XAxisOffset
          spatial offset display scalars
static DisplayRealType YAxis
           
static DisplayRealType YAxisOffset
           
static DisplayRealType Yellow
           
static DisplayRealType ZAxis
           
static DisplayRealType ZAxisOffset
           
 
Method Summary
 void addMap(ScalarMap map)
          link map to this Display; this method may not be invoked after any links to DataReferences have been made
 void addReference(DataReference ref, ConstantMap[] constant_maps)
          create link to DataReference; invokes ref.addThingChangedListener(ThingChangedListener l, long id)
 void addReferences(DataRenderer renderer, DataReference ref, ConstantMap[] constant_maps)
          create link to DataReference; invokes ref.addThingChangedListener(ThingChangedListener l, long id)
 void addSlave(RemoteSlaveDisplay display)
          links a slave display to this display
 void clearMaps()
          clear set of ScalarMap-s associated with this display
 void destroy()
          destroy this display
 java.util.Vector getConstantMapVector()
           
 boolean hasSlaves()
          whether there are any slave displays linked to this display
 void removeAllSlaves()
          removes all links between slave displays and this display
 void removeSlave(RemoteSlaveDisplay display)
          removes a link between a slave display and this display
 void sendMessage(MessageEvent msg)
          Send a message to all MessageListeners.
 
Methods inherited from interface visad.Action
addReference, getName, removeAllReferences, removeReference
 
Methods inherited from interface visad.ThingChangedListener
thingChanged
 

Field Detail

XAxis

static final DisplayRealType XAxis
spatial display scalars


YAxis

static final DisplayRealType YAxis

ZAxis

static final DisplayRealType ZAxis

Latitude

static final DisplayRealType Latitude

Longitude

static final DisplayRealType Longitude

Radius

static final DisplayRealType Radius

CylRadius

static final DisplayRealType CylRadius
Cylindrical radius scalar


CylAzimuth

static final DisplayRealType CylAzimuth
Cylindrical azimuth scalar


CylZAxis

static final DisplayRealType CylZAxis
Cylindrical ZAxis scalar


List

static final DisplayRealType List
list display scalar (default domain of DisplayField)


Red

static final DisplayRealType Red
color display scalars


Green

static final DisplayRealType Green

Blue

static final DisplayRealType Blue

RGB

static final DisplayRealType RGB

RGBA

static final DisplayRealType RGBA

Hue

static final DisplayRealType Hue

Saturation

static final DisplayRealType Saturation

Value

static final DisplayRealType Value

HSV

static final DisplayRealType HSV

Cyan

static final DisplayRealType Cyan

Magenta

static final DisplayRealType Magenta

Yellow

static final DisplayRealType Yellow

CMY

static final DisplayRealType CMY

Alpha

static final DisplayRealType Alpha
Alpha is transparency


Animation

static final DisplayRealType Animation
animation display scalar


SelectValue

static final DisplayRealType SelectValue
display scalar for selecting by a single value


SelectRange

static final DisplayRealType SelectRange
display scalar for selecting by a range of values


IsoContour

static final DisplayRealType IsoContour
iso-contour display scalar


Flow1X

static final DisplayRealType Flow1X
three flow display scalars


Flow1Y

static final DisplayRealType Flow1Y

Flow1Z

static final DisplayRealType Flow1Z

Flow1Elevation

static final DisplayRealType Flow1Elevation

Flow1Azimuth

static final DisplayRealType Flow1Azimuth

Flow1Radial

static final DisplayRealType Flow1Radial

Flow2X

static final DisplayRealType Flow2X
second set of three flow display scalars


Flow2Y

static final DisplayRealType Flow2Y

Flow2Z

static final DisplayRealType Flow2Z

Flow2Elevation

static final DisplayRealType Flow2Elevation

Flow2Azimuth

static final DisplayRealType Flow2Azimuth

Flow2Radial

static final DisplayRealType Flow2Radial

XAxisOffset

static final DisplayRealType XAxisOffset
spatial offset display scalars


YAxisOffset

static final DisplayRealType YAxisOffset

ZAxisOffset

static final DisplayRealType ZAxisOffset

Shape

static final DisplayRealType Shape
shape display scalar WLH - this should be a DisplayEnumeratedType


ShapeScale

static final DisplayRealType ShapeScale
scale for Shape


Text

static final DisplayRealType Text
text display scalar WLH - this should be a DisplayTextType


LineWidth

static final DisplayRealType LineWidth
point size, line width and line style - ConstantMap only


PointSize

static final DisplayRealType PointSize

LineStyle

static final DisplayRealType LineStyle

TextureEnable

static final DisplayRealType TextureEnable

DisplayRealArray

static final DisplayRealType[] DisplayRealArray
array of system intrinsic display scalars


components3c

static final DisplayRealType[] components3c
system intrinsic DisplayTupleType for 3D Cartesian Spatial Coordinates


DisplaySpatialCartesianTuple

static final DisplayTupleType DisplaySpatialCartesianTuple

DisplaySphericalCoordSys

static final CoordinateSystem DisplaySphericalCoordSys
system intrinsic DisplayTupleType for 3D Spherical Spatial Coordinates, this defines a CoordinateSystem with Reference DisplaySpatialCartesianTuple


components3s

static final DisplayRealType[] components3s

DisplaySpatialSphericalTuple

static final DisplayTupleType DisplaySpatialSphericalTuple

DisplayCylindricalCoordSys

static final CoordinateSystem DisplayCylindricalCoordSys
defines a CoordinateSystem with Reference DisplaySpatialCartesianTuple


componentscyl

static final DisplayRealType[] componentscyl
DisplayRealType array of CylRadius, CylAzimuth, CylZAxis for Cylindrical Coordinates


DisplaySpatialCylindricalTuple

static final DisplayTupleType DisplaySpatialCylindricalTuple
System intrinsic DisplayTupleType for Cylindrical Coordinates


componentsrgb

static final DisplayRealType[] componentsrgb
system intrinsic DisplayTupleType for RGB Color Coordinates


DisplayRGBTuple

static final DisplayTupleType DisplayRGBTuple

DisplayHSVCoordSys

static final CoordinateSystem DisplayHSVCoordSys
system intrinsic DisplayTupleType for HSV Color Coordinates


componentshsv

static final DisplayRealType[] componentshsv

DisplayHSVTuple

static final DisplayTupleType DisplayHSVTuple

DisplayCMYCoordSys

static final CoordinateSystem DisplayCMYCoordSys
system intrinsic DisplayTupleType for CMY Color Coordinates


componentscmy

static final DisplayRealType[] componentscmy

DisplayCMYTuple

static final DisplayTupleType DisplayCMYTuple

componentsflow1

static final DisplayRealType[] componentsflow1
system intrinsic DisplayTupleType for first set of Flow components


DisplayFlow1Tuple

static final DisplayTupleType DisplayFlow1Tuple

componentsflow2

static final DisplayRealType[] componentsflow2
system intrinsic DisplayTupleType for second set of Flow components


DisplayFlow2Tuple

static final DisplayTupleType DisplayFlow2Tuple

DisplayFlow1SphericalCoordSys

static final CoordinateSystem DisplayFlow1SphericalCoordSys
system intrinsic DisplayTupleType for first set of 3D Spherical Flow Coordinates, this defines a CoordinateSystem with Reference DisplayFlow1Tuple


componentsflow1s

static final DisplayRealType[] componentsflow1s

DisplayFlow1SphericalTuple

static final DisplayTupleType DisplayFlow1SphericalTuple

DisplayFlow2SphericalCoordSys

static final CoordinateSystem DisplayFlow2SphericalCoordSys
system intrinsic DisplayTupleType for second set of 3D Spherical Flow Coordinates, this defines a CoordinateSystem with Reference DisplayFlow2Tuple


componentsflow2s

static final DisplayRealType[] componentsflow2s

DisplayFlow2SphericalTuple

static final DisplayTupleType DisplayFlow2SphericalTuple

componentsso

static final DisplayRealType[] componentsso
system intrinsic DisplayTupleType for Spatial Offset Coordinates


DisplaySpatialOffsetTuple

static final DisplayTupleType DisplaySpatialOffsetTuple
Method Detail

addReference

void addReference(DataReference ref,
                  ConstantMap[] constant_maps)
                  throws VisADException,
                         java.rmi.RemoteException
create link to DataReference; invokes ref.addThingChangedListener(ThingChangedListener l, long id)

Throws:
VisADException
java.rmi.RemoteException

addReferences

void addReferences(DataRenderer renderer,
                   DataReference ref,
                   ConstantMap[] constant_maps)
                   throws VisADException,
                          java.rmi.RemoteException
create link to DataReference; invokes ref.addThingChangedListener(ThingChangedListener l, long id)

Throws:
VisADException
java.rmi.RemoteException

addMap

void addMap(ScalarMap map)
            throws VisADException,
                   java.rmi.RemoteException
link map to this Display; this method may not be invoked after any links to DataReferences have been made

Throws:
VisADException
java.rmi.RemoteException

clearMaps

void clearMaps()
               throws VisADException,
                      java.rmi.RemoteException
clear set of ScalarMap-s associated with this display

Throws:
VisADException
java.rmi.RemoteException

destroy

void destroy()
             throws VisADException,
                    java.rmi.RemoteException
destroy this display

Throws:
VisADException
java.rmi.RemoteException

getConstantMapVector

java.util.Vector getConstantMapVector()
                                      throws VisADException,
                                             java.rmi.RemoteException
Throws:
VisADException
java.rmi.RemoteException

sendMessage

void sendMessage(MessageEvent msg)
                 throws java.rmi.RemoteException
Send a message to all MessageListeners.

Parameters:
msg - Message being sent.
Throws:
java.rmi.RemoteException

addSlave

void addSlave(RemoteSlaveDisplay display)
              throws VisADException,
                     java.rmi.RemoteException
links a slave display to this display

Throws:
VisADException
java.rmi.RemoteException

removeSlave

void removeSlave(RemoteSlaveDisplay display)
                 throws VisADException,
                        java.rmi.RemoteException
removes a link between a slave display and this display

Throws:
VisADException
java.rmi.RemoteException

removeAllSlaves

void removeAllSlaves()
                     throws VisADException,
                            java.rmi.RemoteException
removes all links between slave displays and this display

Throws:
VisADException
java.rmi.RemoteException

hasSlaves

boolean hasSlaves()
                  throws VisADException,
                         java.rmi.RemoteException
whether there are any slave displays linked to this display

Throws:
VisADException
java.rmi.RemoteException