CameraKeyboardWalkOperator

class Operators.Camera.CameraKeyboardWalkOperator()

Index

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

Operators.Camera.CameraKeyboardWalkOperator.addKeyMapping()

addKeyMapping(key: KeyCode, walkDirection: WalkDirection): void

Adds a key mapping for a walk direction.

Parameters

key: KeyCode

walkDirection: WalkDirection

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.addMapping()

inherited

addMapping(button: Button, modifier: KeyModifiers?): void

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.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.clearKeyMappings()

clearKeyMappings(): void

Clears all key mappings.

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.disableBimMode()

inherited

disableBimMode(): Promise

Disables BIM mode, which includes collision detection

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.enableBimMode()

inherited

enableBimMode(): Promise

Enables BIM mode, which includes collision detection

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.getBimDoorConfig()

inherited

getBimDoorConfig(): DoorConfig

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

Returns: DoorConfig

Operators.Camera.CameraKeyboardWalkOperator.getBimFloorConfig()

inherited

getBimFloorConfig(): FloorConfig

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

Returns: FloorConfig

Operators.Camera.CameraKeyboardWalkOperator.getBimModeEnabled()

inherited

getBimModeEnabled(): boolean

Returns true if BIM mode is currently active

Returns: boolean

Operators.Camera.CameraKeyboardWalkOperator.getBimWallConfig()

inherited

getBimWallConfig(): WallConfig

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

Returns: WallConfig

Operators.Camera.CameraKeyboardWalkOperator.getElevationSpeed()

inherited

getElevationSpeed(): number

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

Returns: number

Operators.Camera.CameraKeyboardWalkOperator.getKeyMapping()

getKeyMapping(): Map

Gets the walk direction key mapping.

Returns: Map

Operators.Camera.CameraKeyboardWalkOperator.getMajorAxis()

inherited

getMajorAxis(): Axis

Get major axis

Returns: Axis

Operators.Camera.CameraKeyboardWalkOperator.getMouseLookEnabled()

getMouseLookEnabled(): boolean

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

Returns: boolean

Operators.Camera.CameraKeyboardWalkOperator.getMouseLookSpeed()

getMouseLookSpeed(): number

Gets the mouse look speed.

Returns: number

Operators.Camera.CameraKeyboardWalkOperator.getRotationSpeed()

inherited

getRotationSpeed(): number

Gets the rotation speed for tilt and rotate.

Returns: number

Operators.Camera.CameraKeyboardWalkOperator.getTilt()

inherited

getTilt(): number

Gets the tilt value.

Returns: number

Operators.Camera.CameraKeyboardWalkOperator.getViewAngle()

inherited

getViewAngle(): number

Gets the view angle.

Returns: number

Operators.Camera.CameraKeyboardWalkOperator.getWalkActive()

inherited

getWalkActive(): boolean

Returns true if walking is currently active

Returns: boolean

Operators.Camera.CameraKeyboardWalkOperator.getWalkSpeed()

inherited

getWalkSpeed(): number

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

Returns: number

Operators.Camera.CameraKeyboardWalkOperator.getZoomSpeed()

inherited

getZoomSpeed(): number

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

Returns: number

Operators.Camera.CameraKeyboardWalkOperator.isBimModeEnabled()

inherited

isBimModeEnabled(): boolean

Returns: boolean

Operators.Camera.CameraKeyboardWalkOperator.resetDefaultWalkSpeeds()

resetDefaultWalkSpeeds(): Promise

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

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.rotateLeft()

inherited

rotateLeft(degrees: number): void

Parameters

degrees: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.rotateRight()

inherited

rotateRight(degrees: number): void

Parameters

degrees: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setBimDoorConfig()

inherited

setBimDoorConfig(doorConfig: DoorConfig): void

Sets the door distance config used by BIM mode.

Parameters

doorConfig: DoorConfig

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setBimFloorConfig()

inherited

setBimFloorConfig(floorConfig: FloorConfig): void

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

Parameters

floorConfig: FloorConfig

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setBimWallConfig()

inherited

setBimWallConfig(wallConfig: WallConfig): void

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

Parameters

wallConfig: WallConfig

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setElevationSpeed()

inherited

setElevationSpeed(elevationSpeed: number): void

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

Parameters

elevationSpeed: number

The camera will move by elevationSpeed per second.

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setMapping()

inherited

setMapping(button: Button, modifier: KeyModifiers?): void

Sets the button and key modifier mapping for the operator.

Parameters

button: Button

modifier: KeyModifiers = KeyModifiers.None

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setMouseLookEnabled()

setMouseLookEnabled(mouseLookEnabled: boolean): void

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

Parameters

mouseLookEnabled: boolean

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setMouseLookSpeed()

setMouseLookSpeed(mouseLookSpeed: number): void

Sets the speed for mouse look.

Parameters

mouseLookSpeed: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setRotationSpeed()

inherited

setRotationSpeed(rotationSpeed: number): void

Sets the rotation speed for tilt and rotate.

Parameters

rotationSpeed: number

The camera will rotate by rotationSpeed degrees per second.

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setTilt()

inherited

setTilt(tilt: number): void

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

Parameters

tilt: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setViewAngle()

inherited

setViewAngle(degrees: number): void

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

Parameters

degrees: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setWalkSpeed()

inherited

setWalkSpeed(walkSpeed: number): void

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

Parameters

walkSpeed: number

The camera will move by walkSpeed per second.

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.setZoomSpeed()

inherited

setZoomSpeed(zoomSpeed: number): void

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

Parameters

zoomSpeed: number

distance for walking with the mouse scroll wheel.

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.tiltDown()

inherited

tiltDown(degrees: number): void

Parameters

degrees: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.tiltUp()

inherited

tiltUp(degrees: number): void

Parameters

degrees: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.toggleBimMode()

inherited

toggleBimMode(): Promise

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

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.walkBackward()

inherited

walkBackward(walkDistance: number): void

Parameters

walkDistance: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.walkBackwardWithCollision()

inherited

walkBackwardWithCollision(walkDistance: number): Promise

Parameters

walkDistance: number

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.walkDown()

inherited

walkDown(walkDistance: number): void

Parameters

walkDistance: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.walkForward()

inherited

walkForward(walkDistance: number): void

Parameters

walkDistance: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.walkForwardWithCollision()

inherited

walkForwardWithCollision(walkDistance: number): Promise

Parameters

walkDistance: number

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.walkLeft()

inherited

walkLeft(walkDistance: number): void

Parameters

walkDistance: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.walkLeftWithCollision()

inherited

walkLeftWithCollision(walkDistance: number): Promise

Parameters

walkDistance: number

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.walkRight()

inherited

walkRight(walkDistance: number): void

Parameters

walkDistance: number

Returns: void

Operators.Camera.CameraKeyboardWalkOperator.walkRightWithCollision()

inherited

walkRightWithCollision(walkDistance: number): Promise

Parameters

walkDistance: number

Returns: Promise

Operators.Camera.CameraKeyboardWalkOperator.walkUp()

inherited

walkUp(walkDistance: number): void

Parameters

walkDistance: number

Returns: void