CameraWalkOperator

class Communicator.Operator.CameraWalkOperator()

Modules

Bim

Methods

addMapping

CameraWalkOperator.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 (Button) –
modifier (KeyModifiers) – optional

Return type

void

clearMapping

CameraWalkOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

disableBimMode

CameraWalkOperator.disableBimMode()

Disables BIM mode, which includes collision detection

Return type: Promise <void>

enableBimMode

CameraWalkOperator.enableBimMode()

Enables BIM mode, which includes collision detection

Return type: Promise <void>

getBimDoorConfig

CameraWalkOperator.getBimDoorConfig()

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

Return type: DoorConfig

getBimFloorConfig

CameraWalkOperator.getBimFloorConfig()

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

Return type: FloorConfig

getBimModeEnabled

CameraWalkOperator.getBimModeEnabled()

Returns true if BIM mode is currently active

Return type: boolean

getBimWallConfig

CameraWalkOperator.getBimWallConfig()

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

Return type: WallConfig

getElevationSpeed

CameraWalkOperator.getElevationSpeed()

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

Return type: number

getMajorAxis

CameraWalkOperator.getMajorAxis()

Get major axis

Return type: Axis

getRotationSpeed

CameraWalkOperator.getRotationSpeed()

Gets the rotation speed for tilt and rotate.

Return type: number

getTilt

CameraWalkOperator.getTilt()

Gets the tilt value.

Return type: number

getViewAngle

CameraWalkOperator.getViewAngle()

Gets the view angle.

Return type: number

getWalkActive

CameraWalkOperator.getWalkActive()

Returns true if walking is currently active

Return type: boolean

getWalkSpeed

CameraWalkOperator.getWalkSpeed()

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

Return type: number

getZoomSpeed

CameraWalkOperator.getZoomSpeed()

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

Return type: number

isBimModeEnabled

CameraWalkOperator.isBimModeEnabled()

Return type: boolean

resetDefaultWalkSpeeds

CameraWalkOperator.resetDefaultWalkSpeeds()

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

Return type: Promise <void>

rotateLeft

CameraWalkOperator.rotateLeft(degrees)

Arguments

degrees (number()) –

Return type

void

rotateRight

CameraWalkOperator.rotateRight(degrees)

Arguments

degrees (number()) –

Return type

void

setBimDoorConfig

CameraWalkOperator.setBimDoorConfig(doorConfig)

Sets the door distance config used by BIM mode.

Arguments

doorConfig (DoorConfig()) –

Return type

void

setBimFloorConfig

CameraWalkOperator.setBimFloorConfig(floorConfig)

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

Arguments

floorConfig (FloorConfig()) –

Return type

void

setBimWallConfig

CameraWalkOperator.setBimWallConfig(wallConfig)

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

Arguments

wallConfig (WallConfig()) –

Return type

void

setElevationSpeed

CameraWalkOperator.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

CameraWalkOperator.setMapping(button[, modifier])

Sets the button and key modifier mapping for the operator.

Arguments

button (Button) –
modifier (KeyModifiers) – optional

Return type

void

setRotationSpeed

CameraWalkOperator.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

CameraWalkOperator.setTilt(tilt)

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

Arguments

tilt (number()) –

Return type

void

setViewAngle

CameraWalkOperator.setViewAngle(degrees)

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

Arguments

degrees (number()) –

Return type

void

setWalkSpeed

CameraWalkOperator.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

CameraWalkOperator.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

CameraWalkOperator.tiltDown(degrees)

Arguments

degrees (number()) –

Return type

void

tiltUp

CameraWalkOperator.tiltUp(degrees)

Arguments

degrees (number()) –

Return type

void

toggleBimMode

CameraWalkOperator.toggleBimMode()

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

Return type: Promise <void>

walkBackward

CameraWalkOperator.walkBackward(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkBackwardWithCollision

CameraWalkOperator.walkBackwardWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise <void>

walkDown

CameraWalkOperator.walkDown(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkForward

CameraWalkOperator.walkForward(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkForwardWithCollision

CameraWalkOperator.walkForwardWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise <void>

walkLeft

CameraWalkOperator.walkLeft(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkLeftWithCollision

CameraWalkOperator.walkLeftWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise <void>

walkRight

CameraWalkOperator.walkRight(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkRightWithCollision

CameraWalkOperator.walkRightWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise <void>

walkUp

CameraWalkOperator.walkUp(walkDistance)

Arguments

walkDistance (number()) –

Return type

void