# CameraWalkOperator

class `Operators.Camera.``CameraWalkOperator`()

  ## Index

  Methods

  - `addMapping`
  - `clearMapping`
  - `disableBimMode`
  - `enableBimMode`
  - `getBimDoorConfig`
  - `getBimFloorConfig`
  - `getBimModeEnabled`
  - `getBimWallConfig`
  - `getElevationSpeed`
  - `getMajorAxis`
  - `getRotationSpeed`
  - `getTilt`
  - `getViewAngle`
  - `getWalkActive`
  - `getWalkSpeed`
  - `getZoomSpeed`
  - `isBimModeEnabled`
  - `resetDefaultWalkSpeeds`
  - `rotateLeft`
  - `rotateRight`
  - `setBimDoorConfig`
  - `setBimFloorConfig`
  - `setBimWallConfig`
  - `setElevationSpeed`
  - `setMapping`
  - `setRotationSpeed`
  - `setTilt`
  - `setViewAngle`
  - `setWalkSpeed`
  - `setZoomSpeed`
  - `tiltDown`
  - `tiltUp`
  - `toggleBimMode`
  - `walkBackward`
  - `walkBackwardWithCollision`
  - `walkDown`
  - `walkForward`
  - `walkForwardWithCollision`
  - `walkLeft`
  - `walkLeftWithCollision`
  - `walkRight`
  - `walkRightWithCollision`
  - `walkUp`

## Methods

`Operators.Camera.CameraWalkOperator.``addMapping`()

  inherited

  addMapping(button: `Button`, modifier: `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: `Button`

  > modifier: `KeyModifiers` = KeyModifiers.None

  Returns: void

`Operators.Camera.CameraWalkOperator.``clearMapping`()

  inherited

  clearMapping(): void

  Clears any button and key modifier mappings for the operator.

  Returns: void

`Operators.Camera.CameraWalkOperator.``disableBimMode`()

  inherited

  disableBimMode(): Promise

  Disables BIM mode, which includes collision detection

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``enableBimMode`()

  inherited

  enableBimMode(): Promise

  Enables BIM mode, which includes collision detection

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``getBimDoorConfig`()

  inherited

  getBimDoorConfig(): `DoorConfig`

  Gets the door distance config used by BIM mode. See also: [[enableBimMode]].

  Returns: `DoorConfig`

`Operators.Camera.CameraWalkOperator.``getBimFloorConfig`()

  inherited

  getBimFloorConfig(): `FloorConfig`

  Gets the floor distance config used by BIM mode. See also: [[enableBimMode]].

  Returns: `FloorConfig`

`Operators.Camera.CameraWalkOperator.``getBimModeEnabled`()

  inherited

  getBimModeEnabled(): boolean

  Returns true if BIM mode is currently active

  Returns: boolean

`Operators.Camera.CameraWalkOperator.``getBimWallConfig`()

  inherited

  getBimWallConfig(): `WallConfig`

  Gets the wall distance config used by BIM mode. See also: [[enableBimMode]].

  Returns: `WallConfig`

`Operators.Camera.CameraWalkOperator.``getElevationSpeed`()

  inherited

  getElevationSpeed(): number

  Gets the elevation speed for moving the camera up and down.

  Returns: number

`Operators.Camera.CameraWalkOperator.``getMajorAxis`()

  inherited

  getMajorAxis(): `Axis`

  Get major axis

  Returns: `Axis`

`Operators.Camera.CameraWalkOperator.``getRotationSpeed`()

  inherited

  getRotationSpeed(): number

  Gets the rotation speed for tilt and rotate.

  Returns: number

`Operators.Camera.CameraWalkOperator.``getTilt`()

  inherited

  getTilt(): number

  Gets the tilt value.

  Returns: number

`Operators.Camera.CameraWalkOperator.``getViewAngle`()

  inherited

  getViewAngle(): number

  Gets the view angle.

  Returns: number

`Operators.Camera.CameraWalkOperator.``getWalkActive`()

  inherited

  getWalkActive(): boolean

  Returns true if walking is currently active

  Returns: boolean

`Operators.Camera.CameraWalkOperator.``getWalkSpeed`()

  inherited

  getWalkSpeed(): number

  Gets the walkSpeed for walking forward, backwards, left, and right.

  Returns: number

`Operators.Camera.CameraWalkOperator.``getZoomSpeed`()

  inherited

  getZoomSpeed(): number

  Gets the speed used when walking with the mouse scroll wheel.

  Returns: number

`Operators.Camera.CameraWalkOperator.``isBimModeEnabled`()

  inherited

  isBimModeEnabled(): boolean

  Returns: boolean

`Operators.Camera.CameraWalkOperator.``resetDefaultWalkSpeeds`()

  inherited

  resetDefaultWalkSpeeds(): Promise

  Sets the walk, rotate, and mouse look speeds to the default values.

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``rotateLeft`()

  inherited

  rotateLeft(degrees: number): void

  Parameters

  > degrees: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``rotateRight`()

  inherited

  rotateRight(degrees: number): void

  Parameters

  > degrees: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``setBimDoorConfig`()

  inherited

  setBimDoorConfig(doorConfig: `DoorConfig`): void

  Sets the door distance config used by BIM mode.

  Parameters

  > doorConfig: `DoorConfig`

  Returns: void

`Operators.Camera.CameraWalkOperator.``setBimFloorConfig`()

  inherited

  setBimFloorConfig(floorConfig: `FloorConfig`): void

  Sets the floor distance config used by BIM mode. See also: [[enableBimMode]].

  Parameters

  > floorConfig: `FloorConfig`

  Returns: void

`Operators.Camera.CameraWalkOperator.``setBimWallConfig`()

  inherited

  setBimWallConfig(wallConfig: `WallConfig`): void

  Sets the wall distance config used by BIM mode. See also: [[enableBimMode]].

  Parameters

  > wallConfig: `WallConfig`

  Returns: void

`Operators.Camera.CameraWalkOperator.``setElevationSpeed`()

  inherited

  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

`Operators.Camera.CameraWalkOperator.``setMapping`()

  inherited

  setMapping(button: `Button`, modifier: `KeyModifiers`?): void

  Sets the button and key modifier mapping for the operator.

  Parameters

  > button: `Button`

  > modifier: `KeyModifiers` = KeyModifiers.None

  Returns: void

`Operators.Camera.CameraWalkOperator.``setRotationSpeed`()

  inherited

  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

`Operators.Camera.CameraWalkOperator.``setTilt`()

  inherited

  setTilt(tilt: number): void

  Sets the tilt value. Values must be between -45 and 45 degrees.

  Parameters

  > tilt: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``setViewAngle`()

  inherited

  setViewAngle(degrees: number): void

  Sets the view angle. Values must be between 30 and 150 degrees.

  Parameters

  > degrees: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``setWalkSpeed`()

  inherited

  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

`Operators.Camera.CameraWalkOperator.``setZoomSpeed`()

  inherited

  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

`Operators.Camera.CameraWalkOperator.``tiltDown`()

  inherited

  tiltDown(degrees: number): void

  Parameters

  > degrees: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``tiltUp`()

  inherited

  tiltUp(degrees: number): void

  Parameters

  > degrees: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``toggleBimMode`()

  inherited

  toggleBimMode(): Promise

  Toggles BIM mode, deactivating it if it’s activated and activating it if it’s deactivated

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``walkBackward`()

  inherited

  walkBackward(walkDistance: number): void

  Parameters

  > walkDistance: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``walkBackwardWithCollision`()

  inherited

  walkBackwardWithCollision(walkDistance: number): Promise

  Parameters

  > walkDistance: number

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``walkDown`()

  inherited

  walkDown(walkDistance: number): void

  Parameters

  > walkDistance: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``walkForward`()

  inherited

  walkForward(walkDistance: number): void

  Parameters

  > walkDistance: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``walkForwardWithCollision`()

  inherited

  walkForwardWithCollision(walkDistance: number): Promise

  Parameters

  > walkDistance: number

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``walkLeft`()

  inherited

  walkLeft(walkDistance: number): void

  Parameters

  > walkDistance: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``walkLeftWithCollision`()

  inherited

  walkLeftWithCollision(walkDistance: number): Promise

  Parameters

  > walkDistance: number

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``walkRight`()

  inherited

  walkRight(walkDistance: number): void

  Parameters

  > walkDistance: number

  Returns: void

`Operators.Camera.CameraWalkOperator.``walkRightWithCollision`()

  inherited

  walkRightWithCollision(walkDistance: number): Promise

  Parameters

  > walkDistance: number

  Returns: Promise

`Operators.Camera.CameraWalkOperator.``walkUp`()

  inherited

  walkUp(walkDistance: number): void

  Parameters

  > walkDistance: number

  Returns: void

Conversation saved
HOOPSY BETA

### Hello! I'm HOOPSY

Your Docs generative AI assistant. Ask me anything about HOOPS Visualize Web or choose a sample question below to start a conversation:

What is HOOPS Visualize Web?
What are the latest release notes for HOOPS Visualize Web?
How do I start evaluating HOOPS Visualize Web?
How do I write my first sample application?
How can I get assistance?

HOOPSY may store conversations according to OpenAI's policy. Responses may not always be accurate.

HOOPSY is thinking...