visad
Interface AnimationControl

All Superinterfaces:
AVControl
All Known Implementing Classes:
AnimationControlJ2D, AnimationControlJ3D, DownRoundingAnimationControlJ3D

public interface AnimationControl
extends AVControl

AnimationControl is the VisAD interface for controlling Animation display scalars.


Method Summary
 int getCurrent()
          get the current ordinal step number
 boolean getDirection()
          Get the animation direction.
 boolean getOn()
          return true if automatic stepping is on
 Set getSet()
          get Set of RealType values for animation steps
 long getStep()
          Return the dwell time for the current step
 long[] getSteps()
          return an array of the dwell times for all the steps.
 void init()
           
 void run()
           
 void setCurrent(double value)
          set the current step by the value of the RealType mapped to Display.Animation
 void setCurrent(int c)
          set the current ordinal step number = c
 void setDirection(boolean dir)
          Set the animation direction.
 void setOn(boolean o)
          Set automatic stepping on or off.
 void setSet(Set s)
           
 void setSet(Set s, boolean noChange)
          changeControl(!noChange) to not trigger re-transform, used by ScalarMap.setRange
 void setStep(int st)
          Set the dwell rate between animation steps to a constant value
 void setSteps(int[] steps)
          set the dwell time for individual steps.
 void stop()
           
 void takeStep()
          advance one step (forward or backward)
 void toggle()
          toggle automatic stepping between off and on
 
Methods inherited from interface visad.AVControl
addControlListener, clearSwitches, getSaveString, removeControlListener, setSaveString
 

Method Detail

stop

void stop()

run

void run()

setCurrent

void setCurrent(int c)
                throws VisADException,
                       java.rmi.RemoteException
set the current ordinal step number = c

Throws:
VisADException
java.rmi.RemoteException

setCurrent

void setCurrent(double value)
                throws VisADException,
                       java.rmi.RemoteException
set the current step by the value of the RealType mapped to Display.Animation

Throws:
VisADException
java.rmi.RemoteException

getCurrent

int getCurrent()
get the current ordinal step number


setDirection

void setDirection(boolean dir)
                  throws VisADException,
                         java.rmi.RemoteException
Set the animation direction.

Parameters:
dir - true for forward, false for backward
Throws:
VisADException - Couldn't create necessary VisAD object. The direction remains unchanged.
java.rmi.RemoteException - Java RMI exception

getDirection

boolean getDirection()
Get the animation direction.

Returns:
true for forward, false for backward

getStep

long getStep()
Return the dwell time for the current step


getSteps

long[] getSteps()
return an array of the dwell times for all the steps.


setStep

void setStep(int st)
             throws VisADException,
                    java.rmi.RemoteException
Set the dwell rate between animation steps to a constant value

Parameters:
st - dwell time in milliseconds
Throws:
VisADException - Couldn't create necessary VisAD object. The dwell time remains unchanged.
java.rmi.RemoteException - Java RMI exception

setSteps

void setSteps(int[] steps)
              throws VisADException,
                     java.rmi.RemoteException
set the dwell time for individual steps.

Parameters:
steps - an array of dwell rates for each step in the animation If the length of the array is less than the number of frames in the animation, the subsequent step values will be set to the value of the last step.
Throws:
VisADException - Couldn't create necessary VisAD object. The dwell times remain unchanged.
java.rmi.RemoteException - Java RMI exception

takeStep

void takeStep()
              throws VisADException,
                     java.rmi.RemoteException
advance one step (forward or backward)

Throws:
VisADException - Couldn't create necessary VisAD object. No step is taken.
java.rmi.RemoteException - Java RMI exception

init

void init()
          throws VisADException
Throws:
VisADException

getSet

Set getSet()
get Set of RealType values for animation steps


setSet

void setSet(Set s)
            throws VisADException,
                   java.rmi.RemoteException
Throws:
VisADException
java.rmi.RemoteException

setSet

void setSet(Set s,
            boolean noChange)
            throws VisADException,
                   java.rmi.RemoteException
changeControl(!noChange) to not trigger re-transform, used by ScalarMap.setRange

Throws:
VisADException
java.rmi.RemoteException

getOn

boolean getOn()
return true if automatic stepping is on


setOn

void setOn(boolean o)
           throws VisADException,
                  java.rmi.RemoteException
Set automatic stepping on or off.

Parameters:
o - true = turn stepping on, false = turn stepping off
Throws:
VisADException - Couldn't create necessary VisAD object. No change in automatic stepping occurs.
java.rmi.RemoteException - Java RMI exception

toggle

void toggle()
            throws VisADException,
                   java.rmi.RemoteException
toggle automatic stepping between off and on

Throws:
VisADException - Couldn't create necessary VisAD object. No change in automatic stepping occurs.
java.rmi.RemoteException - Java RMI exception