Package nl.tudelft.simulation.dsol.simulators

Interface AnimatorInterface

All Known Implementing Classes:
DevDessAnimator, DevsAnimator, DevsRealTimeAnimator, DevsRealTimeAnimator.TimeDouble, DevsRealTimeAnimator.TimeDoubleUnit, DevsRealTimeAnimator.TimeFloat, DevsRealTimeAnimator.TimeFloatUnit, DevsRealTimeAnimator.TimeLong
public interface AnimatorInterface
The AnimatorInterface defines the methods for a DEVSDESS simulator with wallclock delay between the consecutive time steps.

Copyright (c) 2002-2024 Delft University of Technology, Jaffalaan 5, 2628 BX Delft, the Netherlands. All rights reserved. See for project information https://simulation.tudelft.nl. The DSOL project is distributed under a three-clause BSD-style license, which can be found at https://https://simulation.tudelft.nl/dsol/docs/latest/license.html.

Author:
Peter Jacobs , Alexander Verbraeck

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    AnimatorInterface.AnimationThread
    The separate thread that takes care of the animation.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final org.djutils.event.EventType
    ANIMATION_DELAY_CHANGED_EVENT
    ANIMATION_DELAY_CHANGED_EVENT is fired when the time step is set.
    static final long
    DEFAULT_ANIMATION_DELAY
    DEFAULT_ANIMATION_DELAY of 100 milliseconds used in the animator.
    static final org.djutils.event.EventType
    UPDATE_ANIMATION_EVENT
    UPDATE_ANIMATION_EVENT is fired to wake up animatable components.

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getAnimationDelay()
    returns the animation delay in milliseconds between each consecutive animation update.
    void
    setAnimationDelay(long milliseconds)
    sets the animationDelay using wallclock time in milliseconds.
    void
    updateAnimation()
    updateAnimation takes care of firing the UPDATE_ANIMATION_EVENT.

  • Field Details

    • DEFAULT_ANIMATION_DELAY

      static final long DEFAULT_ANIMATION_DELAY
      DEFAULT_ANIMATION_DELAY of 100 milliseconds used in the animator.
      See Also:

    • UPDATE_ANIMATION_EVENT

      static final org.djutils.event.EventType UPDATE_ANIMATION_EVENT
      UPDATE_ANIMATION_EVENT is fired to wake up animatable components.

    • ANIMATION_DELAY_CHANGED_EVENT

      static final org.djutils.event.EventType ANIMATION_DELAY_CHANGED_EVENT
      ANIMATION_DELAY_CHANGED_EVENT is fired when the time step is set.

  • Method Details

    • getAnimationDelay

      long getAnimationDelay() throws RemoteException
      returns the animation delay in milliseconds between each consecutive animation update.
      Returns:
      long; the animation delay in milliseconds of wallclock time
      Throws:
      RemoteException - on network failure

    • setAnimationDelay

      void setAnimationDelay(long milliseconds) throws RemoteException
      sets the animationDelay using wallclock time in milliseconds.
      Parameters:
      milliseconds - long; the animation delay in milliseconds
      Throws:
      RemoteException - on network failure

    • updateAnimation

      void updateAnimation()
      updateAnimation takes care of firing the UPDATE_ANIMATION_EVENT.