.. role:: ts-api-decorator

##########
Navigation
##########

.. js:module:: cee
   :noindex:

.. container:: ts-api-section

   .. js:class:: Navigation

      Class for controlling interactive navigation in a view

      You can specify the navigation scheme for the left mouse button, set the rotation point and 
      control the minimum walk target distance (for Walk navigation).

      You can access the navigation object with the ``View.navigation`` property.



.. container:: api-index-section

   .. rubric:: Constructors

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

   * :js:meth:`~cee.Navigation.constructor`



.. container:: api-index-section

   .. rubric:: Accessors

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

   * :js:attr:`~cee.Navigation.config`
   * :js:attr:`~cee.Navigation.minWalkTargetDistance`
   * :js:attr:`~cee.Navigation.mouseWheelZoomAndWalkBehavior`
   * :js:attr:`~cee.Navigation.rotationPoint`
   * :js:attr:`~cee.Navigation.rotationSensitivity`





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

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

.. container:: ts-api-section

   .. js:function:: Navigation.constructor()



      :rtype: Navigation



Accessors
=========

.. container:: ts-api-section

   .. js:function:: Navigation.config()



      The navigation configuration.

      Specify what should happen on mouse and touch input


      :rtype: NavigationConfig



.. container:: ts-api-section

   .. js:function:: Navigation.minWalkTargetDistance()



      The minimum walk target minTargetDistance

      For walk navigation, this is used to control how much the navigation should slow down when getting
      close to the rotation point. The walk speed is dynamic so you can interact with large models. 
      Depending on your model size, you might want to adjust this parameter.

      The default is undefined (automatic), which will be interpreted as 1/10 of the current view bounding box.


      :rtype: number

   .. js:function:: Navigation.minWalkTargetDistance( minTargetDistance)

      :param minTargetDistance: None
      :type minTargetDistance: number


      :rtype: void



.. container:: ts-api-section

   .. js:function:: Navigation.mouseWheelZoomAndWalkBehavior()



      Determine mouse wheel zoom and walk behavior

      This setting will only have effect if mouse wheel is configured to perform zoom or walk navigation.


      :rtype: MouseWheelZoomAndWalkBehavior

   .. js:function:: Navigation.mouseWheelZoomAndWalkBehavior( behavior)

      :param behavior: None
      :type behavior: MouseWheelZoomAndWalkBehavior


      :rtype: void



.. container:: ts-api-section

   .. js:function:: Navigation.rotationPoint()



      The current rotation point


      :rtype: Vec3Like

   .. js:function:: Navigation.rotationPoint( rotationPoint)

      :param rotationPoint: None
      :type rotationPoint: Vec3Like


      :rtype: void



.. container:: ts-api-section

   .. js:function:: Navigation.rotationSensitivity()



      Rotation sensitivity

      Sensitivity factor controlling how sensitive the mouse is when doing rotations.

      Default 1.0


      :rtype: number

   .. js:function:: Navigation.rotationSensitivity( sensitivity)

      :param sensitivity: None
      :type sensitivity: number


      :rtype: void



