.. role:: ts-api-decorator

########################
CameraNavigationOperator
########################

.. js:module:: Operators.Camera
   :noindex:

.. container:: ts-api-section

   .. js:class:: CameraNavigationOperator



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~Operators.Camera.CameraNavigationOperator.addMapping`
   * :js:meth:`~Operators.Camera.CameraNavigationOperator.clearMapping`
   * :js:meth:`~Operators.Camera.CameraNavigationOperator.getBimNavigationEnabled`
   * :js:meth:`~Operators.Camera.CameraNavigationOperator.setBimNavigationEnabled`
   * :js:meth:`~Operators.Camera.CameraNavigationOperator.setMapping`





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

Methods
=======

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

addMapping
----------

.. js:method:: CameraNavigationOperator.addMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   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.


   :rtype: void

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

clearMapping
------------

.. js:method:: CameraNavigationOperator.clearMapping()



   Clears any button and key modifier mappings for the operator.


   :rtype: void

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

getBimNavigationEnabled
-----------------------

.. js:method:: CameraNavigationOperator.getBimNavigationEnabled()



   Returns true if BIM navigation is enabled.


   :rtype: boolean

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

setBimNavigationEnabled
-----------------------

.. js:method:: CameraNavigationOperator.setBimNavigationEnabled( bimNavigation)

   :param bimNavigation: None
   :type bimNavigation: boolean


   When BIM navigation is enabled, the following controls for orbit, pan, and zoom are set:
   Left mouse button: orbit
   Middle mouse wheel: zoom
   Middle mouse button: pan
   Right mouse button: zoom


   :rtype: void

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

setMapping
----------

.. js:method:: CameraNavigationOperator.setMapping( button, modifier)

   :param button: None
   :type button: Button
   :param modifier: None
   :type modifier: KeyModifiers


   Sets the button and key modifier mapping for the operator.


   :rtype: void

