visad
Class FlowControl

java.lang.Object
  extended by visad.Control
      extended by visad.FlowControl
All Implemented Interfaces:
java.io.Serializable, java.lang.Cloneable
Direct Known Subclasses:
Flow1Control, Flow2Control

public abstract class FlowControl
extends Control

FlowControl is the VisAD abstract super-class for controlling Flow display scalars.

See Also:
Serialized Form

Field Summary
static int NH_ORIENTATION
          Northern Hemisphere orientation for wind barbs
static int SH_ORIENTATION
          Southern Hemisphere orientation for wind barbs
 
Constructor Summary
FlowControl(DisplayImpl d)
           
 
Method Summary
 java.lang.Object clone()
           
 void enableStreamlines(boolean flag)
           
 boolean equals(java.lang.Object o)
           
 float getArrowScale()
           
 int getBarbOrientation()
          Get barb orientation for wind barbs
 float getFlowScale()
          get scale length for flow vectors
 java.lang.String getSaveString()
          get a string that can be used to reconstruct this control later
 float getStepFactor()
           
 float getStreamlineDensity()
           
 void setArrowScale(float arrowScale)
           
 void setBarbOrientation(int orientation)
          set barb orientation for wind barbs (default is southern hemisphere)
 void setFlowScale(float scale)
          set scale length for flow vectors (default is 0.02f)
 void setSaveString(java.lang.String save)
          reconstruct this control using the specified save string
 void setStepFactor(float stepFactor)
           
 void setStreamlineDensity(float density)
           
 boolean streamlinesEnabled()
           
 void syncControl(Control rmt)
          copy the state of a remote control to this control
 
Methods inherited from class visad.Control
addControlListener, animation_string, changeControl, checkTicks, getDisplay, getDisplayRenderer, getInstanceNumber, incTick, nullControl, peekTicks, removeControlListener, resetTicks, setTicks, subCheckTicks, subPeekTicks, subResetTicks, subSetTicks, toString
 
Methods inherited from class java.lang.Object
finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

NH_ORIENTATION

public static final int NH_ORIENTATION
Northern Hemisphere orientation for wind barbs

See Also:
Constant Field Values

SH_ORIENTATION

public static final int SH_ORIENTATION
Southern Hemisphere orientation for wind barbs

See Also:
Constant Field Values
Constructor Detail

FlowControl

public FlowControl(DisplayImpl d)
Method Detail

setFlowScale

public void setFlowScale(float scale)
                  throws VisADException,
                         java.rmi.RemoteException
set scale length for flow vectors (default is 0.02f)

Throws:
VisADException
java.rmi.RemoteException

getFlowScale

public float getFlowScale()
get scale length for flow vectors


setBarbOrientation

public void setBarbOrientation(int orientation)
                        throws VisADException,
                               java.rmi.RemoteException
set barb orientation for wind barbs (default is southern hemisphere)

Parameters:
orientation - wind barb orientation (NH_ORIENTATION or SH_ORIENTATION);
Throws:
VisADException
java.rmi.RemoteException

getBarbOrientation

public int getBarbOrientation()
Get barb orientation for wind barbs

Returns:
orientation (false = northern hemisphere)

enableStreamlines

public void enableStreamlines(boolean flag)
                       throws VisADException,
                              java.rmi.RemoteException
Throws:
VisADException
java.rmi.RemoteException

setStreamlineDensity

public void setStreamlineDensity(float density)
                          throws VisADException,
                                 java.rmi.RemoteException
Throws:
VisADException
java.rmi.RemoteException

setArrowScale

public void setArrowScale(float arrowScale)
                   throws VisADException,
                          java.rmi.RemoteException
Throws:
VisADException
java.rmi.RemoteException

setStepFactor

public void setStepFactor(float stepFactor)
                   throws VisADException,
                          java.rmi.RemoteException
Throws:
VisADException
java.rmi.RemoteException

streamlinesEnabled

public boolean streamlinesEnabled()

getStreamlineDensity

public float getStreamlineDensity()

getArrowScale

public float getArrowScale()

getStepFactor

public float getStepFactor()

getSaveString

public java.lang.String getSaveString()
get a string that can be used to reconstruct this control later

Specified by:
getSaveString in class Control

setSaveString

public void setSaveString(java.lang.String save)
                   throws VisADException,
                          java.rmi.RemoteException
reconstruct this control using the specified save string

Specified by:
setSaveString in class Control
Throws:
VisADException
java.rmi.RemoteException

syncControl

public void syncControl(Control rmt)
                 throws VisADException
copy the state of a remote control to this control

Specified by:
syncControl in class Control
Throws:
VisADException

equals

public boolean equals(java.lang.Object o)
Overrides:
equals in class Control

clone

public java.lang.Object clone()
Overrides:
clone in class Control