CameraWalkOperator

class wv.Operators.Camera.CameraWalkOperator()

Index

Methods

• 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

Methods

wv.Operators.Camera.CameraWalkOperator.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

wv.Operators.Camera.CameraWalkOperator.clearMapping()

inherited

clearMapping(): void

Clears any button and key modifier mappings for the operator.

Returns: void

wv.Operators.Camera.CameraWalkOperator.disableBimMode()

inherited

disableBimMode(): Promise

Disables BIM mode, which includes collision detection

Returns: Promise

wv.Operators.Camera.CameraWalkOperator.enableBimMode()

inherited

enableBimMode(): Promise

Enables BIM mode, which includes collision detection

Returns: Promise

wv.Operators.Camera.CameraWalkOperator.getBimDoorConfig()

inherited

getBimDoorConfig(): DoorConfig

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

Returns: DoorConfig

wv.Operators.Camera.CameraWalkOperator.getBimFloorConfig()

inherited

getBimFloorConfig(): FloorConfig

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

Returns: FloorConfig

wv.Operators.Camera.CameraWalkOperator.getBimModeEnabled()

inherited

getBimModeEnabled(): boolean

Returns true if BIM mode is currently active

Returns: boolean

wv.Operators.Camera.CameraWalkOperator.getBimWallConfig()

inherited

getBimWallConfig(): WallConfig

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

Returns: WallConfig

wv.Operators.Camera.CameraWalkOperator.getElevationSpeed()

inherited

getElevationSpeed(): number

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

Returns: number

wv.Operators.Camera.CameraWalkOperator.getMajorAxis()

inherited

getMajorAxis(): Axis

Get major axis

Returns: Axis

wv.Operators.Camera.CameraWalkOperator.getRotationSpeed()

inherited

getRotationSpeed(): number

Gets the rotation speed for tilt and rotate.

Returns: number

wv.Operators.Camera.CameraWalkOperator.getTilt()

inherited

getTilt(): number

Gets the tilt value.

Returns: number

wv.Operators.Camera.CameraWalkOperator.getViewAngle()

inherited

getViewAngle(): number

Gets the view angle.

Returns: number

wv.Operators.Camera.CameraWalkOperator.getWalkActive()

inherited

getWalkActive(): boolean

Returns true if walking is currently active

Returns: boolean

wv.Operators.Camera.CameraWalkOperator.getWalkSpeed()

inherited

getWalkSpeed(): number

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

Returns: number

wv.Operators.Camera.CameraWalkOperator.getZoomSpeed()

inherited

getZoomSpeed(): number

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

Returns: number

wv.Operators.Camera.CameraWalkOperator.isBimModeEnabled()

inherited

isBimModeEnabled(): boolean

Returns: boolean

wv.Operators.Camera.CameraWalkOperator.resetDefaultWalkSpeeds()

inherited

resetDefaultWalkSpeeds(): Promise

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

Returns: Promise

wv.Operators.Camera.CameraWalkOperator.rotateLeft()

inherited

rotateLeft(degrees: number): void

Parameters

degrees: number

Returns: void

wv.Operators.Camera.CameraWalkOperator.rotateRight()

inherited

rotateRight(degrees: number): void

Parameters

degrees: number

Returns: void

wv.Operators.Camera.CameraWalkOperator.setBimDoorConfig()

inherited

setBimDoorConfig(doorConfig: DoorConfig): void

Sets the door distance config used by BIM mode.

Parameters

doorConfig: DoorConfig

Returns: void

wv.Operators.Camera.CameraWalkOperator.setBimFloorConfig()

inherited

setBimFloorConfig(floorConfig: FloorConfig): void

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

Parameters

floorConfig: FloorConfig

Returns: void

wv.Operators.Camera.CameraWalkOperator.setBimWallConfig()

inherited

setBimWallConfig(wallConfig: WallConfig): void

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

Parameters

wallConfig: WallConfig

Returns: void

wv.Operators.Camera.CameraWalkOperator.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

wv.Operators.Camera.CameraWalkOperator.setMapping(