CameraKeyboardWalkOperator

class Communicator.Operator.CameraKeyboardWalkOperator()

Modules

Bim

Methods

addKeyMapping()

addMapping()

clearKeyMappings()

clearMapping()

disableBimMode()

enableBimMode()

getBimDoorConfig()

getBimFloorConfig()

getBimModeEnabled()

getBimWallConfig()

getElevationSpeed()

getKeyMapping()

getMajorAxis()

getMouseLookEnabled()

getMouseLookSpeed()

getRotationSpeed()

getTilt()

getViewAngle()

getWalkActive()

getWalkSpeed()

getZoomSpeed()

isBimModeEnabled()

resetDefaultWalkSpeeds()

rotateLeft()

rotateRight()

setBimDoorConfig()

setBimFloorConfig()

setBimWallConfig()

setElevationSpeed()

setMapping()

setMouseLookEnabled()

setMouseLookSpeed()

setRotationSpeed()

setTilt()

setViewAngle()

setWalkSpeed()

setZoomSpeed()

tiltDown()

tiltUp()

toggleBimMode()

walkBackward()

walkBackwardWithCollision()

walkDown()

walkForward()

walkForwardWithCollision()

walkLeft()

walkLeftWithCollision()

walkRight()

walkRightWithCollision()

walkUp()


Methods

addKeyMapping

Communicator.Operator.CameraKeyboardWalkOperator.addKeyMapping(key, walkDirection)

Adds a key mapping for a walk direction.

Arguments
  • key (Communicator.KeyCode()) –

  • walkDirection (Communicator.WalkDirection()) –

Return type

void

addMapping

Communicator.Operator.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
  • button (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void

clearKeyMappings

Communicator.Operator.CameraKeyboardWalkOperator.clearKeyMappings()

Clears all key mappings.

Return type

void

clearMapping

Communicator.Operator.CameraKeyboardWalkOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type

void

disableBimMode

Communicator.Operator.CameraKeyboardWalkOperator.disableBimMode()

Disables BIM mode, which includes collision detection

Return type

Promise[void]

enableBimMode

Communicator.Operator.CameraKeyboardWalkOperator.enableBimMode()

Enables BIM mode, which includes collision detection

Return type

Promise[void]

getBimDoorConfig

Communicator.Operator.CameraKeyboardWalkOperator.getBimDoorConfig()

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

Return type

DoorConfig

getBimFloorConfig

Communicator.Operator.CameraKeyboardWalkOperator.getBimFloorConfig()

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

Return type

FloorConfig

getBimModeEnabled

Communicator.Operator.CameraKeyboardWalkOperator.getBimModeEnabled()

Returns true if BIM mode is currently active

Return type

boolean

getBimWallConfig

Communicator.Operator.CameraKeyboardWalkOperator.getBimWallConfig()

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

Return type

WallConfig

getElevationSpeed

Communicator.Operator.CameraKeyboardWalkOperator.getElevationSpeed()

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

Return type

number

getKeyMapping

Communicator.Operator.CameraKeyboardWalkOperator.getKeyMapping()

Gets the walk direction key mapping.

Return type

Map[Communicator.KeyCode, Communicator.WalkDirection]

getMajorAxis

Communicator.Operator.CameraKeyboardWalkOperator.getMajorAxis()

Get major axis

Return type

Communicator.Axis

getMouseLookEnabled

Communicator.Operator.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

Communicator.Operator.CameraKeyboardWalkOperator.getMouseLookSpeed()

Gets the mouse look speed.

Return type

number

getRotationSpeed

Communicator.Operator.CameraKeyboardWalkOperator.getRotationSpeed()

Gets the rotation speed for tilt and rotate.

Return type

number

getTilt

Communicator.Operator.CameraKeyboardWalkOperator.getTilt()

Gets the tilt value.

Return type

number

getViewAngle

Communicator.Operator.CameraKeyboardWalkOperator.getViewAngle()

Gets the view angle.

Return type

number

getWalkActive

Communicator.Operator.CameraKeyboardWalkOperator.getWalkActive()

Returns true if walking is currently active

Return type

boolean

getWalkSpeed

Communicator.Operator.CameraKeyboardWalkOperator.getWalkSpeed()

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

Return type

number

getZoomSpeed

Communicator.Operator.CameraKeyboardWalkOperator.getZoomSpeed()

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

Return type

number

isBimModeEnabled

Communicator.Operator.CameraKeyboardWalkOperator.isBimModeEnabled()
Return type

boolean

resetDefaultWalkSpeeds

Communicator.Operator.CameraKeyboardWalkOperator.resetDefaultWalkSpeeds()
Return type

Promise[void]

rotateLeft

Communicator.Operator.CameraKeyboardWalkOperator.rotateLeft(degrees)
Arguments
  • degrees (number()) –

Return type

void

rotateRight

Communicator.Operator.CameraKeyboardWalkOperator.rotateRight(degrees)
Arguments
  • degrees (number()) –

Return type

void

setBimDoorConfig

Communicator.Operator.CameraKeyboardWalkOperator.setBimDoorConfig(doorConfig)

Sets the door distance config used by BIM mode.

Arguments
  • doorConfig (DoorConfig()) –

Return type

void

setBimFloorConfig

Communicator.Operator.CameraKeyboardWalkOperator.setBimFloorConfig(floorConfig)

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

Arguments
  • floorConfig (FloorConfig()) –

Return type

void

setBimWallConfig

Communicator.Operator.CameraKeyboardWalkOperator.setBimWallConfig(wallConfig)

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

Arguments
  • wallConfig (WallConfig()) –

Return type

void

setElevationSpeed

Communicator.Operator.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

Communicator.Operator.CameraKeyboardWalkOperator.setMapping(button, modifier)

Sets the button and key modifier mapping for the operator.

Arguments
  • button (Communicator.Button()) –

  • modifier (Communicator.KeyModifiers()) –

Return type

void

setMouseLookEnabled

Communicator.Operator.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

Communicator.Operator.CameraKeyboardWalkOperator.setMouseLookSpeed(mouseLookSpeed)

Sets the speed for mouse look.

Arguments
  • mouseLookSpeed (number()) –

Return type

void

setRotationSpeed

Communicator.Operator.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

Communicator.Operator.CameraKeyboardWalkOperator.setTilt(tilt)

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

Arguments
  • tilt (number()) –

Return type

void

setViewAngle

Communicator.Operator.CameraKeyboardWalkOperator.setViewAngle(degrees)

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

Arguments
  • degrees (number()) –

Return type

void

setWalkSpeed

Communicator.Operator.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

Communicator.Operator.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

Communicator.Operator.CameraKeyboardWalkOperator.tiltDown(degrees)
Arguments
  • degrees (number()) –

Return type

void

tiltUp

Communicator.Operator.CameraKeyboardWalkOperator.tiltUp(degrees)
Arguments
  • degrees (number()) –

Return type

void

toggleBimMode

Communicator.Operator.CameraKeyboardWalkOperator.toggleBimMode()

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

Return type

Promise[void]

walkBackward

Communicator.Operator.CameraKeyboardWalkOperator.walkBackward(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

void

walkBackwardWithCollision

Communicator.Operator.CameraKeyboardWalkOperator.walkBackwardWithCollision(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

Promise[void]

walkDown

Communicator.Operator.CameraKeyboardWalkOperator.walkDown(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

void

walkForward

Communicator.Operator.CameraKeyboardWalkOperator.walkForward(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

void

walkForwardWithCollision

Communicator.Operator.CameraKeyboardWalkOperator.walkForwardWithCollision(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

Promise[void]

walkLeft

Communicator.Operator.CameraKeyboardWalkOperator.walkLeft(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

void

walkLeftWithCollision

Communicator.Operator.CameraKeyboardWalkOperator.walkLeftWithCollision(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

Promise[void]

walkRight

Communicator.Operator.CameraKeyboardWalkOperator.walkRight(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

void

walkRightWithCollision

Communicator.Operator.CameraKeyboardWalkOperator.walkRightWithCollision(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

Promise[void]

walkUp

Communicator.Operator.CameraKeyboardWalkOperator.walkUp(walkDistance)
Arguments
  • walkDistance (number()) –

Return type

void