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

.. js:class:: Animation.Animation

   Structure encapsulating a specific animation
   
   
   Index
   =====
   
   .. rubric:: Constructors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Animation.Animation.constructor`
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~Animation.Animation.cameraChannels`
   * :js:data:`~Animation.Animation.name`
   * :js:data:`~Animation.Animation.nodeChannels`
   * :js:data:`~Animation.Animation.pivotPoints`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Animation.Animation.createCameraChannel`
   * :js:meth:`~Animation.Animation.createNodeChannel`
   * :js:meth:`~Animation.Animation.deleteChannel`
   
   




Constructors
============

.. js:method:: Animation.Animation.constructor

   .. rst-class:: sig-pretty-signature
   
      | Animation(**name**\ : *string*\ ): :js:class:`Animation <Animation.Animation>`
   
   Creates a new, empty Animation
   
   **Parameters**
   
      **name**\ : *string*
   
         friendly name for the animation
   
   
   
   **Returns**\ : :js:class:`Animation <Animation.Animation>`
   





Properties
==========

.. js:data:: Animation.Animation.cameraChannels

   .. rst-class:: sig-pretty-signature
   
      | cameraChannels: :js:class:`CameraChannel <Animation.CameraChannel>`\ []
   



.. js:data:: Animation.Animation.name

   .. rst-class:: sig-pretty-signature
   
      | name: *string*
   
   friendly name for the animation
   



.. js:data:: Animation.Animation.nodeChannels

   .. rst-class:: sig-pretty-signature
   
      | nodeChannels: :js:class:`NodeChannel <Animation.NodeChannel>`\ []
   



.. js:data:: Animation.Animation.pivotPoints

   .. rst-class:: sig-pretty-signature
   
      | pivotPoints: *Map*
   





Methods
=======

.. js:method:: Animation.Animation.createCameraChannel

   .. rst-class:: sig-pretty-signature
   
      | createCameraChannel(**name**\ : *string*\ , **property**\ : :js:data:`CameraProperty <Animation.CameraProperty>`\ , **sampler**\ : :js:class:`Sampler <Animation.Sampler>`\ ): :js:class:`CameraChannel <Animation.CameraChannel>`
   
   Creates a new camera animation channel.
   
   **Parameters**
   
      **name**\ : *string*
   
         friendly name for the channel.
   
   
      **property**\ : :js:data:`CameraProperty <Animation.CameraProperty>`
   
         the property that will be animated by this channel.
   
   
      **sampler**\ : :js:class:`Sampler <Animation.Sampler>`
   
         sampler describing the buffer and interpolation type used.
   
   
   
   **Returns**\ : :js:class:`CameraChannel <Animation.CameraChannel>`
   



.. js:method:: Animation.Animation.createNodeChannel

   .. rst-class:: sig-pretty-signature
   
      | createNodeChannel(**name**\ : *string*\ , **target**\ : *number*\ , **property**\ : :js:data:`NodeProperty <Animation.NodeProperty>`\ , **sampler**\ : :js:class:`Sampler <Animation.Sampler>`\ ): :js:class:`NodeChannel <Animation.NodeChannel>`
   
   Creates a new node animation channel.
   
   **Parameters**
   
      **name**\ : *string*
   
         friendly name for the channel.
   
   
      **target**\ : *number*
   
         id of node that will receive interpolated values.
   
   
      **property**\ : :js:data:`NodeProperty <Animation.NodeProperty>`
   
         the node property that will be animated.
   
   
      **sampler**\ : :js:class:`Sampler <Animation.Sampler>`
   
         sampler describing the buffer and interpolation type.
   
   
   
   **Returns**\ : :js:class:`NodeChannel <Animation.NodeChannel>`
   



.. js:method:: Animation.Animation.deleteChannel

   .. rst-class:: sig-pretty-signature
   
      | deleteChannel(**channel**\ : (:js:class:`NodeChannel <Animation.NodeChannel>` \| :js:class:`CameraChannel <Animation.CameraChannel>`\ )): *void*
   
   Removes a channel from this animation.
   
   Call [[Player.reload]] on any players that are referencing this animation.
   
   **Parameters**
   
      **channel**\ : (:js:class:`NodeChannel <Animation.NodeChannel>` \| :js:class:`CameraChannel <Animation.CameraChannel>`\ )
   
   
   **Returns**\ : *void*
   





