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

.. js:class:: cee.cug.Animation

   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~cee.cug.Animation.particleTraceAnimationStepCount`
   * :js:data:`~cee.cug.Animation.targetFrameRate`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :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`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


.. js:data:: cee.cug.Animation.particleTraceAnimationStepCount

      .. rst-class:: sig-pretty-signature
      
         | particleTraceAnimationStepCount: *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.
      



.. js:data:: cee.cug.Animation.targetFrameRate

      .. rst-class:: sig-pretty-signature
      
         | targetFrameRate: *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.
      



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


.. js:method:: cee.cug.Animation.runAnimation

      .. rst-class:: sig-pretty-signature
      
         | runAnimation(**run**\ : *boolean*\ ): *void*
      
      Starts or stops an animation
      
      **Parameters**
      
      
         **run**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.cug.Animation.runParticleTraceAnimation

      .. rst-class:: sig-pretty-signature
      
         | runParticleTraceAnimation(**run**\ : *boolean*\ ): *void*
      
      Starts or stops a particle trace animation.
      
      **Parameters**
      
      
         **run**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: cee.cug.Animation.setFirstFrame

      .. rst-class:: sig-pretty-signature
      
         | setFirstFrame(): *void*
      
      **Returns**\ : *void*
      



.. js:method:: cee.cug.Animation.setLastFrame

      .. rst-class:: sig-pretty-signature
      
         | setLastFrame(): *void*
      
      **Returns**\ : *void*
      



.. js:method:: cee.cug.Animation.setNextFrame

      .. rst-class:: sig-pretty-signature
      
         | setNextFrame(): *void*
      
      **Returns**\ : *void*
      



.. js:method:: cee.cug.Animation.setPreviousFrame

      .. rst-class:: sig-pretty-signature
      
         | setPreviousFrame(): *void*
      
      **Returns**\ : *void*
      




