.. role:: clio-inherited
   :class: clio-flag clio-flag-inherited


#######################
CameraTurntableOperator
#######################

.. js:class:: wv.Operators.Camera.CameraTurntableOperator

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.addMapping`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.clearMapping`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.getCameraRotationMomentumEnabled`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.getMomentum`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.getMomentumLossPerSecond`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.isAnimating`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.isCurrentlyAnimating`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.setCameraRotationMomentumEnabled`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.setMapping`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.setMomentumLossPerSecond`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.setRotationAxis`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.stopAnimation`
   * :js:meth:`~wv.Operators.Camera.CameraTurntableOperator.supportsAnimation`
   
   



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

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


.. js:method:: wv.Operators.Camera.CameraTurntableOperator.addMapping

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | addMapping(**button**\ : :js:data:`Button <wv.Button>`\ , **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>`\ ?): *void*
      
      Adds a button and key modifier mapping for the operator. If no mapping is provided, all combinations are considered valid. All mappings require a mouse button, but a key modifier is optional.
      
      **Parameters**
      
      
         **button**\ : :js:data:`Button <wv.Button>`
      
         **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>` = KeyModifiers.None
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.clearMapping

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | clearMapping(): *void*
      
      Clears any button and key modifier mappings for the operator.
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.getCameraRotationMomentumEnabled

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getCameraRotationMomentumEnabled(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.getMomentum

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getMomentum(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.getMomentumLossPerSecond

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | getMomentumLossPerSecond(): *number*
      
      **Returns**\ : *number*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.isAnimating

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | isAnimating(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.isCurrentlyAnimating

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | isCurrentlyAnimating(): *boolean*
      
      **Returns**\ : *boolean*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.setCameraRotationMomentumEnabled

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setCameraRotationMomentumEnabled(**val**\ : *boolean*\ ): *void*
      
      **Parameters**
      
      
         **val**\ : *boolean*
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.setMapping

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setMapping(**button**\ : :js:data:`Button <wv.Button>`\ , **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>`\ ?): *void*
      
      Sets the button and key modifier mapping for the operator.
      
      **Parameters**
      
      
         **button**\ : :js:data:`Button <wv.Button>`
      
         **modifier**\ : :js:data:`KeyModifiers <wv.KeyModifiers>` = KeyModifiers.None
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.setMomentumLossPerSecond

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | setMomentumLossPerSecond(**amountLost**\ : *number*\ ): *void*
      
      Sets proportion of momentum lost per second if camera rotation momentum is enabled. At 0 no momentum is lost and the camera will orbit indefinitely. Above 1 the camera will stop orbiting within a second of release. Only values greater than or equal to 0 are accepted.
      
      **Parameters**
      
      
         **amountLost**\ : *number*
      
      
            Proportion of momentum lost per second
      
      
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.setRotationAxis

      .. rst-class:: sig-pretty-signature
      
         | setRotationAxis(**axis**\ : (:js:class:`Point3 <wv.Point3>` | :js:data:`Axis <wv.Axis>`\ )): *boolean*
      
      Sets the rotation axis.
      
      **Parameters**
      
      
         **axis**\ : (:js:class:`Point3 <wv.Point3>` \| :js:data:`Axis <wv.Axis>`\ )
      
      
            [[Axis]] or [[Point3]] used to set the rotation axis.
      
      
      
      **Returns**\ : *boolean*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.stopAnimation

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | stopAnimation(): *void*
      
      **Returns**\ : *void*
      



.. js:method:: wv.Operators.Camera.CameraTurntableOperator.supportsAnimation

      .. rst-class:: clio-flags
      
         :clio-inherited:`inherited`
      
      .. rst-class:: sig-pretty-signature
      
         | supportsAnimation(): *boolean*
      
      **Returns**\ : *boolean*
      




