CameraKeyboardWalkOperator

class Communicator.Operator.CameraKeyboardWalkOperator()

Modules

Methods

Methods

addKeyMapping

CameraKeyboardWalkOperator.addKeyMapping(key, walkDirection)

Adds a key mapping for a walk direction.

Arguments
Return type

void

addMapping

CameraKeyboardWalkOperator.addMapping(button[, modifier])

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.

Arguments
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()
Return type

Promise <void>

rotateLeft

CameraKeyboardWalkOperator.rotateLeft(degrees)
Arguments

  • degrees (number()) –

Return type

void

rotateRight

CameraKeyboardWalkOperator.rotateRight(degrees)
Arguments

  • degrees (number()) –

Return type

void

setBimDoorConfig

CameraKeyboardWalkOperator.setBimDoorConfig(doorConfig)

Sets the door distance config used by BIM mode.

Arguments

  • doorConfig (DoorConfig()) –

Return type

void

setBimFloorConfig

CameraKeyboardWalkOperator.setBimFloorConfig(floorConfig)

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

Arguments

  • floorConfig (FloorConfig()) –

Return type

void

setBimWallConfig

CameraKeyboardWalkOperator.setBimWallConfig(wallConfig)

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

Arguments

  • wallConfig (WallConfig()) –

Return type

void

setElevationSpeed

CameraKeyboardWalkOperator.setElevationSpeed(elevationSpeed)

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

Arguments

  • elevationSpeed (number()) – The camera will move by elevationSpeed per second.

Return type

void

setMapping

CameraKeyboardWalkOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments
Return type

void

setMouseLookEnabled

CameraKeyboardWalkOperator.setMouseLookEnabled(mouseLookEnabled)

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

Arguments

  • mouseLookEnabled (boolean()) –

Return type

void

setMouseLookSpeed

CameraKeyboardWalkOperator.setMouseLookSpeed(mouseLookSpeed)

Sets the speed for mouse look.

Arguments

  • mouseLookSpeed (number()) –

Return type

void

setRotationSpeed

CameraKeyboardWalkOperator.setRotationSpeed(rotationSpeed)

Sets the rotation speed for tilt and rotate.

Arguments

  • rotationSpeed (number()) – The camera will rotate by rotationSpeed degrees per second.

Return type

void

setTilt

CameraKeyboardWalkOperator.setTilt(tilt)

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

Arguments

  • tilt (number()) –

Return type

void

setViewAngle

CameraKeyboardWalkOperator.setViewAngle(degrees)

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

Arguments

  • degrees (number()) –

Return type

void

setWalkSpeed

CameraKeyboardWalkOperator.setWalkSpeed(walkSpeed)

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

Arguments

  • walkSpeed (number()) – The camera will move by walkSpeed per second.

Return type

void

setZoomSpeed

CameraKeyboardWalkOperator.setZoomSpeed(zoomSpeed)

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

Arguments

  • zoomSpeed (number()) – distance for walking with the mouse scroll wheel.

Return type

void

tiltDown

CameraKeyboardWalkOperator.tiltDown(degrees)
Arguments

  • degrees (number()) –

Return type

void

tiltUp

CameraKeyboardWalkOperator.tiltUp(degrees)
Arguments

  • degrees (number()) –

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()) –

Return type

void

walkBackwardWithCollision

CameraKeyboardWalkOperator.walkBackwardWithCollision(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

Promise <void>

walkDown

CameraKeyboardWalkOperator.walkDown(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

void

walkForward

CameraKeyboardWalkOperator.walkForward(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

void

walkForwardWithCollision

CameraKeyboardWalkOperator.walkForwardWithCollision(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

Promise <void>

walkLeft

CameraKeyboardWalkOperator.walkLeft(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

void

walkLeftWithCollision

CameraKeyboardWalkOperator.walkLeftWithCollision(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

Promise <void>

walkRight

CameraKeyboardWalkOperator.walkRight(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

void

walkRightWithCollision

CameraKeyboardWalkOperator.walkRightWithCollision(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

Promise <void>

walkUp

CameraKeyboardWalkOperator.walkUp(walkDistance)
Arguments

  • walkDistance (number()) –

Return type

void