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


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

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

   
   Index
   =====
   
   .. rubric:: Properties
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:data:`~wv.Operators.Camera.CameraWalkModeOperator.viewer`
   
   .. rubric:: Accessors
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:func:`~wv.Operators.Camera.CameraWalkModeOperator.keyboardWalkOperator`
   * :js:func:`~wv.Operators.Camera.CameraWalkModeOperator.walkOperator`
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.getWalkMode`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.resetDefaultWalkSpeeds`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setBimDoorConfig`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setBimFloorConfig`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setBimModeEnabled`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setBimWallConfig`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setElevationSpeed`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setRotationSpeed`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setViewAngle`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setWalkMode`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setWalkSpeed`
   * :js:meth:`~wv.Operators.Camera.CameraWalkModeOperator.setZoomSpeed`
   
   



.. rst-class:: kind-group kind-properties

.. rubric:: Properties
   :class: kind-group-title


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

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



.. rst-class:: kind-group kind-accessors

.. rubric:: Accessors
   :class: kind-group-title


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

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



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

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



.. rst-class:: kind-group kind-methods

.. rubric:: Methods
   :class: kind-group-title


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

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



.. js:method:: wv.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:: wv.Operators.Camera.CameraWalkModeOperator.setBimDoorConfig

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



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

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



.. js:method:: wv.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:: wv.Operators.Camera.CameraWalkModeOperator.setBimWallConfig

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



.. js:method:: wv.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:: wv.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:: wv.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:: wv.Operators.Camera.CameraWalkModeOperator.setWalkMode

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



.. js:method:: wv.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:: wv.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*
      




