.. role:: clio-readonly
   :class: clio-flag clio-flag-readonly


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

.. js:class:: Operators.Camera.CameraWalkModeOperator

   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~Operators.Camera.CameraWalkModeOperator.viewer`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~Operators.Camera.CameraWalkModeOperator.keyboardWalkOperator`
   * :js:func:`~Operators.Camera.CameraWalkModeOperator.walkOperator`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :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`
   
   




Properties
==========

.. js:data:: Operators.Camera.CameraWalkModeOperator.viewer

   .. rst-class:: clio-flags
   
      :clio-readonly:`readonly`
   
   .. rst-class:: sig-pretty-signature
   
      | viewer: :js:class:`~IWebViewer`
   





Accessors
=========

.. js:method:: Operators.Camera.CameraWalkModeOperator.keyboardWalkOperator

   .. rst-class:: sig-pretty-signature
   
      | *get* keyboardWalkOperator(): :js:class:`CameraKeyboardWalkOperator <Operators.Camera.CameraKeyboardWalkOperator>`
   
   **Returns**\ : :js:class:`CameraKeyboardWalkOperator <Operators.Camera.CameraKeyboardWalkOperator>`
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.walkOperator

   .. rst-class:: sig-pretty-signature
   
      | *get* walkOperator(): :js:class:`CameraWalkOperator <Operators.Camera.CameraWalkOperator>`
   
   **Returns**\ : :js:class:`CameraWalkOperator <Operators.Camera.CameraWalkOperator>`
   





Methods
=======

.. js:method:: Operators.Camera.CameraWalkModeOperator.getWalkMode

   .. rst-class:: sig-pretty-signature
   
      | getWalkMode(): :js:data:`~WalkMode`
   
   Gets the walk mode.
   
   **Returns**\ : :js:data:`~WalkMode`
   
      Keyboard or Mouse
   
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.resetDefaultWalkSpeeds

   .. rst-class:: sig-pretty-signature
   
      | resetDefaultWalkSpeeds(): *Promise*
   
   Resets speeds to defaults on both mouse and keyboard walk
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setBimDoorConfig

   .. rst-class:: sig-pretty-signature
   
      | setBimDoorConfig(**doorConfig**\ : :js:class:`DoorConfig <Bim.DoorConfig>`\ ): *void*
   
   Sets BIM door config on both mouse and keyboard walk
   
   **Parameters**
   
      **doorConfig**\ : :js:class:`DoorConfig <Bim.DoorConfig>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setBimFloorConfig

   .. rst-class:: sig-pretty-signature
   
      | setBimFloorConfig(**floorConfig**\ : :js:class:`FloorConfig <Bim.FloorConfig>`\ ): *void*
   
   Sets BIM floor config on both mouse and keyboard walk
   
   **Parameters**
   
      **floorConfig**\ : :js:class:`FloorConfig <Bim.FloorConfig>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setBimModeEnabled

   .. rst-class:: sig-pretty-signature
   
      | setBimModeEnabled(**enabled**\ : *boolean*\ ): *Promise*
   
   Sets BIM mode enables/disabled on both mouse and keyboard walk
   
   **Parameters**
   
      **enabled**\ : *boolean*
   
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setBimWallConfig

   .. rst-class:: sig-pretty-signature
   
      | setBimWallConfig(**wallConfig**\ : :js:class:`WallConfig <Bim.WallConfig>`\ ): *void*
   
   Sets BIM wall config on both mouse and keyboard walk
   
   **Parameters**
   
      **wallConfig**\ : :js:class:`WallConfig <Bim.WallConfig>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setElevationSpeed

   .. rst-class:: sig-pretty-signature
   
      | setElevationSpeed(**speed**\ : *number*\ ): *void*
   
   Sets elevation speed for both mouse and keyboard walk
   
   **Parameters**
   
      **speed**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setRotationSpeed

   .. rst-class:: sig-pretty-signature
   
      | setRotationSpeed(**speed**\ : *number*\ ): *void*
   
   Sets rotation speed for both mouse and keyboard walk
   
   **Parameters**
   
      **speed**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setViewAngle

   .. rst-class:: sig-pretty-signature
   
      | setViewAngle(**angle**\ : *number*\ ): *void*
   
   Sets view angle (FOV) for both mouse and keyboard walk operators
   
   **Parameters**
   
      **angle**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setWalkMode

   .. rst-class:: sig-pretty-signature
   
      | setWalkMode(**walkMode**\ : :js:data:`~WalkMode`\ ): *Promise*
   
   Sets the walk mode to Mouse or Keyboard.
   
   **Parameters**
   
      **walkMode**\ : :js:data:`~WalkMode`
   
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setWalkSpeed

   .. rst-class:: sig-pretty-signature
   
      | setWalkSpeed(**speed**\ : *number*\ ): *void*
   
   Sets walk speed for both mouse and keyboard walk
   
   **Parameters**
   
      **speed**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkModeOperator.setZoomSpeed

   .. rst-class:: sig-pretty-signature
   
      | setZoomSpeed(**speed**\ : *number*\ ): *void*
   
   Sets zoom speed on both mouse and keyboard walk
   
   **Parameters**
   
      **speed**\ : *number*
   
   
   **Returns**\ : *void*
   





