CameraKeyboardWalkOperator

class Operators.Camera.CameraKeyboardWalkOperator()

Methods

Methods

addKeyMapping

CameraKeyboardWalkOperator.addKeyMapping(key, walkDirection)
Arguments:
  • key (KeyCode()) – None
  • walkDirection (WalkDirection()) – None

Adds a key mapping for a walk direction.

Return type:void

addMapping

CameraKeyboardWalkOperator.addMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

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.

Return type:void

clearKeyMappings

CameraKeyboardWalkOperator.clearKeyMappings()

Clears all key mappings.

Return type:void

clearMapping

CameraKeyboardWalkOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type:void

disableBimMode

CameraKeyboardWalkOperator.disableBimMode()

Disables BIM mode, which includes collision detection

Return type:Promise <void>

enableBimMode

CameraKeyboardWalkOperator.enableBimMode()

Enables BIM mode, which includes collision detection

Return type:Promise <void>

getBimDoorConfig

CameraKeyboardWalkOperator.getBimDoorConfig()

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

Return type:DoorConfig

getBimFloorConfig

CameraKeyboardWalkOperator.getBimFloorConfig()

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

Return type:FloorConfig

getBimModeEnabled

CameraKeyboardWalkOperator.getBimModeEnabled()

Returns true if BIM mode is currently active

Return type:boolean

getBimWallConfig

CameraKeyboardWalkOperator.getBimWallConfig()

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

Return type:WallConfig

getElevationSpeed

CameraKeyboardWalkOperator.getElevationSpeed()

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

Return type:number

getKeyMapping

CameraKeyboardWalkOperator.getKeyMapping()

Gets the walk direction key mapping.

Return type:Map <KeyCode, WalkDirection>

getMajorAxis

CameraKeyboardWalkOperator.getMajorAxis()

Get major axis

Return type:Axis

getMouseLookEnabled

CameraKeyboardWalkOperator.getMouseLookEnabled()

Gets whether the mouse look is enabled. If enabled, mouse move events will not continue down the operator stack.

Return type:boolean

getMouseLookSpeed

CameraKeyboardWalkOperator.getMouseLookSpeed()

Gets the mouse look speed.

Return type:number

getRotationSpeed

CameraKeyboardWalkOperator.getRotationSpeed()

Gets the rotation speed for tilt and rotate.

Return type:number

getTilt

CameraKeyboardWalkOperator.getTilt()

Gets the tilt value.

Return type:number

getViewAngle

CameraKeyboardWalkOperator.getViewAngle()

Gets the view angle.

Return type:number

getWalkActive

CameraKeyboardWalkOperator.getWalkActive()

Returns true if walking is currently active

Return type:boolean

getWalkSpeed

CameraKeyboardWalkOperator.getWalkSpeed()

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

Return type:number

getZoomSpeed

CameraKeyboardWalkOperator.getZoomSpeed()

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

Return type:number

isBimModeEnabled

CameraKeyboardWalkOperator.isBimModeEnabled()
Return type:boolean

resetDefaultWalkSpeeds

CameraKeyboardWalkOperator.resetDefaultWalkSpeeds()

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

Return type:Promise <void>

rotateLeft

CameraKeyboardWalkOperator.rotateLeft(degrees)
Arguments:
  • degrees (number()) – None
Return type:

void

rotateRight

CameraKeyboardWalkOperator.rotateRight(degrees)
Arguments:
  • degrees (number()) – None
Return type:

void

setBimDoorConfig

CameraKeyboardWalkOperator.setBimDoorConfig(doorConfig)
Arguments:
  • doorConfig (DoorConfig()) – None

Sets the door distance config used by BIM mode.

Return type:void

setBimFloorConfig

CameraKeyboardWalkOperator.setBimFloorConfig(floorConfig)
Arguments:
  • floorConfig (FloorConfig()) – None

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

Return type:void

setBimWallConfig

CameraKeyboardWalkOperator.setBimWallConfig(wallConfig)
Arguments:
  • wallConfig (WallConfig()) – None

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

Return type:void

setElevationSpeed

CameraKeyboardWalkOperator.setElevationSpeed(elevationSpeed)
Arguments:
  • elevationSpeed (number()) – The camera will move by elevationSpeed per second.

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

Return type:void

setMapping

CameraKeyboardWalkOperator.setMapping(button, modifier)
Arguments:
  • button (Button()) – None
  • modifier (KeyModifiers()) – None

Sets the button and key modifier mapping for the operator.

Return type:void

setMouseLookEnabled

CameraKeyboardWalkOperator.setMouseLookEnabled(mouseLookEnabled)
Arguments:
  • mouseLookEnabled (boolean()) – None

Sets whether the mouse look is enabled. If enabled, mouse move events will not continue down the operator stack.

Return type:void

setMouseLookSpeed

CameraKeyboardWalkOperator.setMouseLookSpeed(mouseLookSpeed)
Arguments:
  • mouseLookSpeed (number()) – None

Sets the speed for mouse look.

Return type:void

setRotationSpeed

CameraKeyboardWalkOperator.setRotationSpeed(rotationSpeed)
Arguments:
  • rotationSpeed (number()) – The camera will rotate by rotationSpeed degrees per second.

Sets the rotation speed for tilt and rotate.

Return type:void

setTilt

CameraKeyboardWalkOperator.setTilt(tilt)
Arguments:
  • tilt (number()) – None

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

Return type:void

setViewAngle

CameraKeyboardWalkOperator.setViewAngle(degrees)
Arguments:
  • degrees (number()) – None

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

Return type:void

setWalkSpeed

CameraKeyboardWalkOperator.setWalkSpeed(walkSpeed)
Arguments:
  • walkSpeed (number()) – The camera will move by walkSpeed per second.

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

Return type:void

setZoomSpeed

CameraKeyboardWalkOperator.setZoomSpeed(zoomSpeed)
Arguments:
  • zoomSpeed (number()) – distance for walking with the mouse scroll wheel.

Sets the speed to walk when using the mouse scroll wheel.

Return type:void

tiltDown

CameraKeyboardWalkOperator.tiltDown(degrees)
Arguments:
  • degrees (number()) – None
Return type:

void

tiltUp

CameraKeyboardWalkOperator.tiltUp(degrees)
Arguments:
  • degrees (number()) – None
Return type:

void

toggleBimMode

CameraKeyboardWalkOperator.toggleBimMode()

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

Return type:Promise <void>

walkBackward

CameraKeyboardWalkOperator.walkBackward(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

void

walkBackwardWithCollision

CameraKeyboardWalkOperator.walkBackwardWithCollision(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

Promise <void>

walkDown

CameraKeyboardWalkOperator.walkDown(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

void

walkForward

CameraKeyboardWalkOperator.walkForward(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

void

walkForwardWithCollision

CameraKeyboardWalkOperator.walkForwardWithCollision(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

Promise <void>

walkLeft

CameraKeyboardWalkOperator.walkLeft(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

void

walkLeftWithCollision

CameraKeyboardWalkOperator.walkLeftWithCollision(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

Promise <void>

walkRight

CameraKeyboardWalkOperator.walkRight(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

void

walkRightWithCollision

CameraKeyboardWalkOperator.walkRightWithCollision(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

Promise <void>

walkUp

CameraKeyboardWalkOperator.walkUp(walkDistance)
Arguments:
  • walkDistance (number()) – None
Return type:

void