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


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

.. js:class:: Operators.Camera.CameraNavigationOperator

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :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
=======

.. js:method:: Operators.Camera.CameraNavigationOperator.addMapping

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | addMapping(**button**\ : :js:data:`~Button`\ , **modifier**\ : :js:data:`~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`
   
      **modifier**\ : :js:data:`~KeyModifiers` = KeyModifiers.None
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraNavigationOperator.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:: Operators.Camera.CameraNavigationOperator.getBimNavigationEnabled

   .. rst-class:: sig-pretty-signature
   
      | getBimNavigationEnabled(): *boolean*
   
   Returns true if BIM navigation is enabled.
   
   **Returns**\ : *boolean*
   



.. js:method:: Operators.Camera.CameraNavigationOperator.setBimNavigationEnabled

   .. rst-class:: sig-pretty-signature
   
      | setBimNavigationEnabled(**bimNavigation**\ : *boolean*\ ): *void*
   
   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
   
   **Parameters**
   
      **bimNavigation**\ : *boolean*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraNavigationOperator.setMapping

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





