Documentation of 'visad.Control' Java class
Control
Skip navigation links
visad

Class Control

    • Constructor Detail

      • Control

        public Control(DisplayImpl d)
        construct a Control for the given DisplayImpl
        Parameters:
        d - - DisplayImpl this Control is associated with

    • Method Detail

      • getDisplayRenderer

        public DisplayRenderer getDisplayRenderer()
        Returns:
        DisplayRenderer assciated with this Control

      • changeControl

        public void changeControl(boolean tick)
                   throws VisADException,
                          java.rmi.RemoteException
        invoked every time values of this Control change
        Parameters:
        tick - true to notify the Display for possible re-transform
        Throws:
        VisADException
        java.rmi.RemoteException

      • addControlListener

        public void addControlListener(ControlListener listener)
        add a ControlListener
        Parameters:
        listener - ControlListener to add

      • removeControlListener

        public void removeControlListener(ControlListener listener)
        remove a ControlListener
        Parameters:
        listener - ControlListener to remove

      • nullControl

        public void nullControl()
        end this control (called by ScalarMap.nullDisplay())

      • incTick

        public long incTick()
        increment long counter NewTick: NewTick > OldTick indicates that there is event in this Control that the DisplayImpl must process; this method is invoked every time Control changes
        Returns:
        incremented value of NewTick counter

      • setTicks

        public void setTicks()
        set tickFlag if NewTick > OldTick, and reset OldTick = NewTick also invoke subSetTicks() to propagate to any sub-Controls

      • peekTicks

        public boolean peekTicks(DataRenderer r,
                         DataDisplayLink link)
        peek at future value of checkTicks()
        Parameters:
        r - DataRenderer to check if changes to this Control require re-transform
        link - DataDisplayLink involved in decision whether changes to this Control require re-transform
        Returns:
        true if checkTicks() will return true after next setTicks()

      • checkTicks

        public boolean checkTicks(DataRenderer r,
                          DataDisplayLink link)
        check if this Control changed and requires re-Transform
        Parameters:
        r - DataRenderer to check if changes to this Control require re-transform
        link - DataDisplayLink involved in decision whether changes to this Control require re-transform
        Returns:
        true if Control changed and requires re-Transform

      • resetTicks

        public void resetTicks()
        reset tickFlag and propagate to sub-Controls

      • subSetTicks

        public void subSetTicks()
        run setTicks on any sub-Controls; this default for no sub-Controls

      • subCheckTicks

        public boolean subCheckTicks(DataRenderer r,
                             DataDisplayLink link)
        run checkTicks on any sub-Controls this default for no sub-Controls
        Parameters:
        r - DataRenderer to check if changes to this Control require re-transform
        link - DataDisplayLink involved in decision whether changes to this Control require re-transform
        Returns:
        'logical or' of values from checkTicks on sub-Controls

      • subPeekTicks

        public boolean subPeekTicks(DataRenderer r,
                            DataDisplayLink link)
        run peekTicks on any sub-Controls this default for no sub-Controls
        Parameters:
        r - DataRenderer to check if changes to this Control require re-transform
        link - DataDisplayLink involved in decision whether changes to this Control require re-transform
        Returns:
        'logical or' of values from peekTicks on sub-Controls

      • subResetTicks

        public void subResetTicks()
        run resetTicks on any sub-Controls this default for no sub-Controls

      • animation_string

        public void animation_string(RealType real,
                             Set set,
                             double value,
                             int current)
                      throws VisADException
        build String representation of current animation step and pass it to DisplayRenderer.setAnimationString() called by java3d.AnimationControlJ3D and java2d.AnimationControlJ2D
        Parameters:
        real - - RealType mapped to Display.Animation
        set - - Set from AnimationSetControl
        value - - real value associated with current animation step
        current - - index of current animation step
        Throws:
        VisADException - a VisAD error occurred

      • getInstanceNumber

        public int getInstanceNumber()
        Returns:
        'instance number' (index + 1 ?) of this Control in display.ControlVector

      • getDisplay

        public DisplayImpl getDisplay()
        Returns:
        DisplayImpl associated with this Control

      • getSaveString

        public abstract java.lang.String getSaveString()
        Returns:
        String representation of this Control

      • setSaveString

        public abstract void setSaveString(java.lang.String save)
                            throws VisADException,
                                   java.rmi.RemoteException
        reconstruct this Control using the specified save string
        Parameters:
        save - - String representation for reconstruction
        Throws:
        VisADException - if a VisAD error occurs
        java.rmi.RemoteException - if an RMI error occurs

      • syncControl

        public abstract void syncControl(Control rmt)
                          throws VisADException
        copy the state of a remote control to this control
        Parameters:
        rmt - remote Control whose state is copied
        Throws:
        VisADException - if a VisAD error occurs

      • clone

        public java.lang.Object clone()
        Overrides:
        clone in class java.lang.Object
        Returns:
        a copy of this Control

      • equals

        public boolean equals(java.lang.Object o)
        Indicates whether or not this instance equals an Object
        Overrides:
        equals in class java.lang.Object
        Parameters:
        o - an Object
        Returns:
        true if and only if this instance is equal to o

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object
        Returns:
        a simple String representation of this Control
Skip navigation links

DMelt 3.0 © DataMelt by jWork.ORG

You see the box below because you did not login.