Interface GLAnimatorControl

    • Method Detail

      • getThread

        Thread getThread()
        Returns:
        The animation thread if running, otherwise null.
        See Also:
        start(), stop()
      • start

        boolean start()
        Starts this animator, if not running.

        In most situations this method blocks until completion, except when called from the animation thread itself or in some cases from an implementation-internal thread like the AWT event queue thread.

        Note that an animator w/o added drawables will be paused automatically.

        If started, all counters (time, frames, ..) are reset to zero.

        Returns:
        true is started due to this call, otherwise false, ie started already or unable to start.
        See Also:
        stop(), isAnimating(), isPaused(), getThread()
      • stop

        boolean stop()
        Stops this animator.

        In most situations this method blocks until completion, except when called from the animation thread itself or in some cases from an implementation-internal thread like the AWT event queue thread.

        Returns:
        true is stopped due to this call, otherwise false, ie not started or unable to stop.
        See Also:
        start(), isAnimating(), getThread()
      • pause

        boolean pause()
        Pauses this animator.

        In most situations this method blocks until completion, except when called from the animation thread itself or in some cases from an implementation-internal thread like the AWT event queue thread.

        Returns:
        false if not started, already paused or failed to pause, otherwise true
        See Also:
        resume(), isAnimating()
      • resume

        boolean resume()
        Resumes animation if paused.

        In most situations this method blocks until completion, except when called from the animation thread itself or in some cases from an implementation-internal thread like the AWT event queue thread.

        If resumed, all counters (time, frames, ..) are reset to zero.

        Returns:
        false if not started, not paused or unable to resume, otherwise true
        See Also:
        pause(), isAnimating()
      • add

        void add​(GLAutoDrawable drawable)
        Adds a drawable to this animator's list of rendering drawables.

        This allows the animator thread to become animating, in case the first drawable is added and the animator is started.

        Parameters:
        drawable - the drawable to be added
        Throws:
        IllegalArgumentException - if drawable was already added to this animator
      • remove

        void remove​(GLAutoDrawable drawable)
        Removes a drawable from the animator's list of rendering drawables.

        This method should get called in case a drawable becomes invalid, and will not be recovered.

        This allows the animator thread to become not animating, in case the last drawable has been removed.

        Parameters:
        drawable - the drawable to be removed
        Throws:
        IllegalArgumentException - if drawable was not added to this animator