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

.. js:class:: wv.Animation.Animation

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



.. rst-class:: kind-group kind-constructors

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


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

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



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

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


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

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



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

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



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

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



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

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



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

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


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

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



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

      .. rst-class:: sig-pretty-signature
      
         | createNodeChannel(**name**\ : *string*\ , **target**\ : *number*\ , **property**\ : :js:data:`NodeProperty <wv.Animation.NodeProperty>`\ , **sampler**\ : :js:class:`Sampler <wv.Animation.Sampler>`\ ): :js:class:`NodeChannel <wv.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 <wv.Animation.NodeProperty>`
      
      
            the node property that will be animated.
      
      
         **sampler**\ : :js:class:`Sampler <wv.Animation.Sampler>`
      
      
            sampler describing the buffer and interpolation type.
      
      
      
      **Returns**\ : :js:class:`NodeChannel <wv.Animation.NodeChannel>`
      



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

      .. rst-class:: sig-pretty-signature
      
         | deleteChannel(**channel**\ : (:js:class:`NodeChannel <wv.Animation.NodeChannel>` | :js:class:`CameraChannel <wv.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 <wv.Animation.NodeChannel>` \| :js:class:`CameraChannel <wv.Animation.CameraChannel>`\ )
      
      
      **Returns**\ : *void*
      




