CameraWalkOperator

class Communicator.Operator.CameraWalkOperator()

Modules

Bim

Methods

Methods

addMapping

Communicator.Operator.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 (Communicator.Button()) –
modifier (Communicator.KeyModifiers()) –

Return type

void

clearMapping

Communicator.Operator.CameraWalkOperator.clearMapping()

Clears any button and key modifier mappings for the operator.

Return type: void

disableBimMode

Communicator.Operator.CameraWalkOperator.disableBimMode()

Disables BIM mode, which includes collision detection

Return type: Promise[void]

enableBimMode

Communicator.Operator.CameraWalkOperator.enableBimMode()

Enables BIM mode, which includes collision detection

Return type: Promise[void]

getBimDoorConfig

Communicator.Operator.CameraWalkOperator.getBimDoorConfig()

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

Return type: DoorConfig

getBimFloorConfig

Communicator.Operator.CameraWalkOperator.getBimFloorConfig()

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

Return type: FloorConfig

getBimModeEnabled

Communicator.Operator.CameraWalkOperator.getBimModeEnabled()

Returns true if BIM mode is currently active

Return type: boolean

getBimWallConfig

Communicator.Operator.CameraWalkOperator.getBimWallConfig()

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

Return type: WallConfig

getElevationSpeed

Communicator.Operator.CameraWalkOperator.getElevationSpeed()

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

Return type: number

getMajorAxis

Communicator.Operator.CameraWalkOperator.getMajorAxis()

Get major axis

Return type: Communicator.Axis

getRotationSpeed

Communicator.Operator.CameraWalkOperator.getRotationSpeed()

Gets the rotation speed for tilt and rotate.

Return type: number

getTilt

Communicator.Operator.CameraWalkOperator.getTilt()

Gets the tilt value.

Return type: number

getViewAngle

Communicator.Operator.CameraWalkOperator.getViewAngle()

Gets the view angle.

Return type: number

getWalkActive

Communicator.Operator.CameraWalkOperator.getWalkActive()

Returns true if walking is currently active

Return type: boolean

getWalkSpeed

Communicator.Operator.CameraWalkOperator.getWalkSpeed()

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

Return type: number

getZoomSpeed

Communicator.Operator.CameraWalkOperator.getZoomSpeed()

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

Return type: number

isBimModeEnabled

Communicator.Operator.CameraWalkOperator.isBimModeEnabled()

Return type: boolean

resetDefaultWalkSpeeds

Communicator.Operator.CameraWalkOperator.resetDefaultWalkSpeeds()

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

Return type: Promise[void]

rotateLeft

Communicator.Operator.CameraWalkOperator.rotateLeft(degrees)

Arguments

degrees (number()) –

Return type

void

rotateRight

Communicator.Operator.CameraWalkOperator.rotateRight(degrees)

Arguments

degrees (number()) –

Return type

void

setBimDoorConfig

Communicator.Operator.CameraWalkOperator.setBimDoorConfig(doorConfig)

Sets the door distance config used by BIM mode.

Arguments

doorConfig (DoorConfig()) –

Return type

void

setBimFloorConfig

Communicator.Operator.CameraWalkOperator.setBimFloorConfig(floorConfig)

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

Arguments

floorConfig (FloorConfig()) –

Return type

void

setBimWallConfig

Communicator.Operator.CameraWalkOperator.setBimWallConfig(wallConfig)

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

Arguments

wallConfig (WallConfig()) –

Return type

void

setElevationSpeed

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

Communicator.Operator.CameraWalkOperator.setMapping(button, modifier)

Sets the button and key modifier mapping for the operator.

Arguments

button (Communicator.Button()) –
modifier (Communicator.KeyModifiers()) –

Return type

void

setRotationSpeed

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

Communicator.Operator.CameraWalkOperator.setTilt(tilt)

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

Arguments

tilt (number()) –

Return type

void

setViewAngle

Communicator.Operator.CameraWalkOperator.setViewAngle(degrees)

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

Arguments

degrees (number()) –

Return type

void

setWalkSpeed

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

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

Communicator.Operator.CameraWalkOperator.tiltDown(degrees)

Arguments

degrees (number()) –

Return type

void

tiltUp

Communicator.Operator.CameraWalkOperator.tiltUp(degrees)

Arguments

degrees (number()) –

Return type

void

toggleBimMode

Communicator.Operator.CameraWalkOperator.toggleBimMode()

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

Return type: Promise[void]

walkBackward

Communicator.Operator.CameraWalkOperator.walkBackward(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkBackwardWithCollision

Communicator.Operator.CameraWalkOperator.walkBackwardWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise[void]

walkDown

Communicator.Operator.CameraWalkOperator.walkDown(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkForward

Communicator.Operator.CameraWalkOperator.walkForward(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkForwardWithCollision

Communicator.Operator.CameraWalkOperator.walkForwardWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise[void]

walkLeft

Communicator.Operator.CameraWalkOperator.walkLeft(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkLeftWithCollision

Communicator.Operator.CameraWalkOperator.walkLeftWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise[void]

walkRight

Communicator.Operator.CameraWalkOperator.walkRight(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

walkRightWithCollision

Communicator.Operator.CameraWalkOperator.walkRightWithCollision(walkDistance)

Arguments

walkDistance (number()) –

Return type

Promise[void]

walkUp

Communicator.Operator.CameraWalkOperator.walkUp(walkDistance)

Arguments

walkDistance (number()) –

Return type

void

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