.. role:: ts-api-decorator

#########
Animation
#########

.. js:module:: cee.cug
   :noindex:

.. container:: ts-api-section

   .. js:class:: Animation



.. container:: api-index-section

   .. rubric:: Properties

   .. rst-class:: api-index-list-item api-kind-property api-parent-kind-interface

   * :js:attr:`~cee.cug.Animation.particleTraceAnimationStepCount`
   * :js:attr:`~cee.cug.Animation.targetFrameRate`



.. container:: api-index-section

   .. rubric:: Methods

   .. rst-class:: api-index-list-item api-kind-method api-parent-kind-interface

   * :js:meth:`~cee.cug.Animation.runAnimation`
   * :js:meth:`~cee.cug.Animation.runParticleTraceAnimation`
   * :js:meth:`~cee.cug.Animation.setFirstFrame`
   * :js:meth:`~cee.cug.Animation.setLastFrame`
   * :js:meth:`~cee.cug.Animation.setNextFrame`
   * :js:meth:`~cee.cug.Animation.setPreviousFrame`





------------

Properties
==========

.. container:: ts-api-section

   .. js:attribute:: Animation.particleTraceAnimationStepCount

      :type: number

      The number of steps to use for the particle trace animation.

      The number of steps will be used to calculate the delta time for each step in the animation
      based on the total time of all active traces.



.. container:: ts-api-section

   .. js:attribute:: Animation.targetFrameRate

      :type: number

      The target animation speed in frames per second (fps).

      This will be the maximum animation speed, but the actual speed may be lower for large
      models or slow clients.



Methods
=======

.. rst-class:: ts-api-section

runAnimation
------------

.. js:method:: Animation.runAnimation( run)

   :param run: None
   :type run: boolean


   Starts or stops an animation


   :rtype: void

.. rst-class:: ts-api-section

runParticleTraceAnimation
-------------------------

.. js:method:: Animation.runParticleTraceAnimation( run)

   :param run: None
   :type run: boolean


   Starts or stops a particle trace animation.


   :rtype: void

.. rst-class:: ts-api-section

setFirstFrame
-------------

.. js:method:: Animation.setFirstFrame()



   :rtype: void

.. rst-class:: ts-api-section

setLastFrame
------------

.. js:method:: Animation.setLastFrame()



   :rtype: void

.. rst-class:: ts-api-section

setNextFrame
------------

.. js:method:: Animation.setNextFrame()



   :rtype: void

.. rst-class:: ts-api-section

setPreviousFrame
----------------

.. js:method:: Animation.setPreviousFrame()



   :rtype: void

