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


##################
CameraWalkOperator
##################

.. js:class:: Operators.Camera.CameraWalkOperator

   
   Index
   =====
   
   .. rubric:: Methods
   
   
   .. rst-class:: api-xref-list
   
   
   * :js:meth:`~Operators.Camera.CameraWalkOperator.addMapping`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.clearMapping`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.disableBimMode`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.enableBimMode`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getBimDoorConfig`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getBimFloorConfig`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getBimModeEnabled`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getBimWallConfig`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getElevationSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getMajorAxis`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getRotationSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getTilt`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getViewAngle`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getWalkActive`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getWalkSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.getZoomSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.isBimModeEnabled`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.resetDefaultWalkSpeeds`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.rotateLeft`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.rotateRight`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setBimDoorConfig`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setBimFloorConfig`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setBimWallConfig`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setElevationSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setMapping`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setRotationSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setTilt`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setViewAngle`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setWalkSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.setZoomSpeed`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.tiltDown`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.tiltUp`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.toggleBimMode`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkBackward`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkBackwardWithCollision`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkDown`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkForward`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkForwardWithCollision`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkLeft`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkLeftWithCollision`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkRight`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkRightWithCollision`
   * :js:meth:`~Operators.Camera.CameraWalkOperator.walkUp`
   
   




Methods
=======

.. js:method:: Operators.Camera.CameraWalkOperator.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.CameraWalkOperator.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.CameraWalkOperator.disableBimMode

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | disableBimMode(): *Promise*
   
   Disables BIM mode, which includes collision detection
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.enableBimMode

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | enableBimMode(): *Promise*
   
   Enables BIM mode, which includes collision detection
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getBimDoorConfig

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getBimDoorConfig(): :js:class:`DoorConfig <Bim.DoorConfig>`
   
   Gets the door distance config used by BIM mode. See also: [[enableBimMode]].
   
   **Returns**\ : :js:class:`DoorConfig <Bim.DoorConfig>`
   



.. js:method:: Operators.Camera.CameraWalkOperator.getBimFloorConfig

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getBimFloorConfig(): :js:class:`FloorConfig <Bim.FloorConfig>`
   
   Gets the floor distance config used by BIM mode. See also: [[enableBimMode]].
   
   **Returns**\ : :js:class:`FloorConfig <Bim.FloorConfig>`
   



.. js:method:: Operators.Camera.CameraWalkOperator.getBimModeEnabled

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getBimModeEnabled(): *boolean*
   
   Returns true if BIM mode is currently active
   
   **Returns**\ : *boolean*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getBimWallConfig

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getBimWallConfig(): :js:class:`WallConfig <Bim.WallConfig>`
   
   Gets the wall distance config used by BIM mode. See also: [[enableBimMode]].
   
   **Returns**\ : :js:class:`WallConfig <Bim.WallConfig>`
   



.. js:method:: Operators.Camera.CameraWalkOperator.getElevationSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getElevationSpeed(): *number*
   
   Gets the elevation speed for moving the camera up and down.
   
   **Returns**\ : *number*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getMajorAxis

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getMajorAxis(): :js:data:`~Axis`
   
   Get major axis
   
   **Returns**\ : :js:data:`~Axis`
   



.. js:method:: Operators.Camera.CameraWalkOperator.getRotationSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getRotationSpeed(): *number*
   
   Gets the rotation speed for tilt and rotate.
   
   **Returns**\ : *number*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getTilt

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getTilt(): *number*
   
   Gets the tilt value.
   
   **Returns**\ : *number*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getViewAngle

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getViewAngle(): *number*
   
   Gets the view angle.
   
   **Returns**\ : *number*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getWalkActive

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getWalkActive(): *boolean*
   
   Returns true if walking is currently active
   
   **Returns**\ : *boolean*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getWalkSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getWalkSpeed(): *number*
   
   Gets the walkSpeed for walking forward, backwards, left, and right.
   
   **Returns**\ : *number*
   



.. js:method:: Operators.Camera.CameraWalkOperator.getZoomSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | getZoomSpeed(): *number*
   
   Gets the speed used when walking with the mouse scroll wheel.
   
   **Returns**\ : *number*
   



.. js:method:: Operators.Camera.CameraWalkOperator.isBimModeEnabled

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | isBimModeEnabled(): *boolean*
   
   **Returns**\ : *boolean*
   



.. js:method:: Operators.Camera.CameraWalkOperator.resetDefaultWalkSpeeds

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | resetDefaultWalkSpeeds(): *Promise*
   
   Sets the walk, rotate, and mouse look speeds to the default values.
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.rotateLeft

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | rotateLeft(**degrees**\ : *number*\ ): *void*
   
   **Parameters**
   
      **degrees**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.rotateRight

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | rotateRight(**degrees**\ : *number*\ ): *void*
   
   **Parameters**
   
      **degrees**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setBimDoorConfig

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setBimDoorConfig(**doorConfig**\ : :js:class:`DoorConfig <Bim.DoorConfig>`\ ): *void*
   
   Sets the door distance config used by BIM mode.
   
   **Parameters**
   
      **doorConfig**\ : :js:class:`DoorConfig <Bim.DoorConfig>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setBimFloorConfig

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setBimFloorConfig(**floorConfig**\ : :js:class:`FloorConfig <Bim.FloorConfig>`\ ): *void*
   
   Sets the floor distance config used by BIM mode. See also: [[enableBimMode]].
   
   **Parameters**
   
      **floorConfig**\ : :js:class:`FloorConfig <Bim.FloorConfig>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setBimWallConfig

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setBimWallConfig(**wallConfig**\ : :js:class:`WallConfig <Bim.WallConfig>`\ ): *void*
   
   Sets the wall distance config used by BIM mode. See also: [[enableBimMode]].
   
   **Parameters**
   
      **wallConfig**\ : :js:class:`WallConfig <Bim.WallConfig>`
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setElevationSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setElevationSpeed(**elevationSpeed**\ : *number*\ ): *void*
   
   Sets the elevation speed for moving the camera up and down.
   
   **Parameters**
   
      **elevationSpeed**\ : *number*
   
         The camera will move by elevationSpeed per second.
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.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*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setRotationSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setRotationSpeed(**rotationSpeed**\ : *number*\ ): *void*
   
   Sets the rotation speed for tilt and rotate.
   
   **Parameters**
   
      **rotationSpeed**\ : *number*
   
         The camera will rotate by rotationSpeed degrees per second.
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setTilt

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setTilt(**tilt**\ : *number*\ ): *void*
   
   Sets the tilt value. Values must be between -45 and 45 degrees.
   
   **Parameters**
   
      **tilt**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setViewAngle

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setViewAngle(**degrees**\ : *number*\ ): *void*
   
   Sets the view angle. Values must be between 30 and 150 degrees.
   
   **Parameters**
   
      **degrees**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setWalkSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setWalkSpeed(**walkSpeed**\ : *number*\ ): *void*
   
   Sets the walkSpeed for walking forward, backwards, left, and right.
   
   **Parameters**
   
      **walkSpeed**\ : *number*
   
         The camera will move by walkSpeed per second.
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.setZoomSpeed

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | setZoomSpeed(**zoomSpeed**\ : *number*\ ): *void*
   
   Sets the speed to walk when using the mouse scroll wheel.
   
   **Parameters**
   
      **zoomSpeed**\ : *number*
   
         distance for walking with the mouse scroll wheel.
   
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.tiltDown

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | tiltDown(**degrees**\ : *number*\ ): *void*
   
   **Parameters**
   
      **degrees**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.tiltUp

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | tiltUp(**degrees**\ : *number*\ ): *void*
   
   **Parameters**
   
      **degrees**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.toggleBimMode

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | toggleBimMode(): *Promise*
   
   Toggles BIM mode, deactivating it if it's activated and activating it if it's deactivated
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkBackward

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkBackward(**walkDistance**\ : *number*\ ): *void*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkBackwardWithCollision

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkBackwardWithCollision(**walkDistance**\ : *number*\ ): *Promise*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkDown

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkDown(**walkDistance**\ : *number*\ ): *void*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkForward

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkForward(**walkDistance**\ : *number*\ ): *void*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkForwardWithCollision

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkForwardWithCollision(**walkDistance**\ : *number*\ ): *Promise*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkLeft

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkLeft(**walkDistance**\ : *number*\ ): *void*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkLeftWithCollision

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkLeftWithCollision(**walkDistance**\ : *number*\ ): *Promise*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkRight

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkRight(**walkDistance**\ : *number*\ ): *void*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *void*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkRightWithCollision

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkRightWithCollision(**walkDistance**\ : *number*\ ): *Promise*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *Promise*
   



.. js:method:: Operators.Camera.CameraWalkOperator.walkUp

   .. rst-class:: clio-flags
   
      :clio-inherited:`inherited`
   
   .. rst-class:: sig-pretty-signature
   
      | walkUp(**walkDistance**\ : *number*\ ): *void*
   
   **Parameters**
   
      **walkDistance**\ : *number*
   
   
   **Returns**\ : *void*
   





