.. role:: ts-api-decorator

######################
CameraWalkModeOperator
######################

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

.. container:: ts-api-section

   .. js:class:: CameraWalkModeOperator



.. container:: api-index-section

   .. rubric:: Methods

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

   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.getWalkMode`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.resetDefaultWalkSpeeds`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setBimDoorConfig`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setBimFloorConfig`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setBimModeEnabled`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setBimWallConfig`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setElevationSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setRotationSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setViewAngle`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setWalkMode`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setWalkSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkModeOperator.setZoomSpeed`





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

Methods
=======

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

getWalkMode
-----------

.. js:method:: CameraWalkModeOperator.getWalkMode()



   Gets the walk mode.

   :returns: Keyboard or Mouse


   :rtype: WalkMode

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

resetDefaultWalkSpeeds
----------------------

.. js:method:: CameraWalkModeOperator.resetDefaultWalkSpeeds()



   Resets speeds to defaults on both mouse and keyboard walk


   :rtype: Promise <void>

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

setBimDoorConfig
----------------

.. js:method:: CameraWalkModeOperator.setBimDoorConfig( doorConfig)

   :param doorConfig: None
   :type doorConfig: DoorConfig


   Sets BIM door config on both mouse and keyboard walk


   :rtype: void

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

setBimFloorConfig
-----------------

.. js:method:: CameraWalkModeOperator.setBimFloorConfig( floorConfig)

   :param floorConfig: None
   :type floorConfig: FloorConfig


   Sets BIM floor config on both mouse and keyboard walk


   :rtype: void

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

setBimModeEnabled
-----------------

.. js:method:: CameraWalkModeOperator.setBimModeEnabled( enabled)

   :param enabled: None
   :type enabled: boolean


   Sets BIM mode enables/disabled on both mouse and keyboard walk


   :rtype: Promise <void>

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

setBimWallConfig
----------------

.. js:method:: CameraWalkModeOperator.setBimWallConfig( wallConfig)

   :param wallConfig: None
   :type wallConfig: WallConfig


   Sets BIM wall config on both mouse and keyboard walk


   :rtype: void

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

setElevationSpeed
-----------------

.. js:method:: CameraWalkModeOperator.setElevationSpeed( speed)

   :param speed: None
   :type speed: number


   Sets elevation speed for both mouse and keyboard walk


   :rtype: void

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

setRotationSpeed
----------------

.. js:method:: CameraWalkModeOperator.setRotationSpeed( speed)

   :param speed: None
   :type speed: number


   Sets rotation speed for both mouse and keyboard walk


   :rtype: void

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

setViewAngle
------------

.. js:method:: CameraWalkModeOperator.setViewAngle( angle)

   :param angle: None
   :type angle: number


   Sets view angle (FOV) for both mouse and keyboard walk operators


   :rtype: void

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

setWalkMode
-----------

.. js:method:: CameraWalkModeOperator.setWalkMode( walkMode)

   :param walkMode: None
   :type walkMode: WalkMode


   Sets the walk mode to Mouse or Keyboard.


   :rtype: Promise <void>

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

setWalkSpeed
------------

.. js:method:: CameraWalkModeOperator.setWalkSpeed( speed)

   :param speed: None
   :type speed: number


   Sets walk speed for both mouse and keyboard walk


   :rtype: void

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

setZoomSpeed
------------

.. js:method:: CameraWalkModeOperator.setZoomSpeed( speed)

   :param speed: None
   :type speed: number


   Sets zoom speed on both mouse and keyboard walk


   :rtype: void

