CameraKeyboardWalkOperator
-
class
Operators.Camera.CameraKeyboardWalkOperator()
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
-
CameraKeyboardWalkOperator.addKeyMapping(key, walkDirection) Arguments: - key (
KeyCode()) – None - walkDirection (
WalkDirection()) – None
Adds a key mapping for a walk direction.
Return type: void - key (
addMapping
-
CameraKeyboardWalkOperator.addMapping(button, modifier) Arguments: - button (
Button()) – None - modifier (
KeyModifiers()) – None
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.
Return type: void - button (
clearKeyMappings
-
CameraKeyboardWalkOperator.clearKeyMappings() Clears all key mappings.
Return type: void
clearMapping
-
CameraKeyboardWalkOperator.clearMapping() Clears any button and key modifier mappings for the operator.
Return type: void
disableBimMode
-
CameraKeyboardWalkOperator.disableBimMode() Disables BIM mode, which includes collision detection
Return type: Promise <void>
enableBimMode
-
CameraKeyboardWalkOperator.enableBimMode() Enables BIM mode, which includes collision detection
Return type: Promise <void>
getBimDoorConfig
-
CameraKeyboardWalkOperator.getBimDoorConfig() Gets the door distance config used by BIM mode. See also: [[enableBimMode]].
Return type: DoorConfig
getBimFloorConfig
-
CameraKeyboardWalkOperator.getBimFloorConfig() Gets the floor distance config used by BIM mode. See also: [[enableBimMode]].
Return type: FloorConfig
getBimModeEnabled
-
CameraKeyboardWalkOperator.getBimModeEnabled() Returns true if BIM mode is currently active
Return type: boolean
getBimWallConfig
-
CameraKeyboardWalkOperator.getBimWallConfig() Gets the wall distance config used by BIM mode. See also: [[enableBimMode]].
Return type: WallConfig
getElevationSpeed
-
CameraKeyboardWalkOperator.getElevationSpeed() Gets the elevation speed for moving the camera up and down.
Return type: number
getKeyMapping
-
CameraKeyboardWalkOperator.getKeyMapping() Gets the walk direction key mapping.
Return type: Map <KeyCode, WalkDirection>
getMouseLookEnabled
-
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
-
CameraKeyboardWalkOperator.getMouseLookSpeed() Gets the mouse look speed.
Return type: number
getRotationSpeed
-
CameraKeyboardWalkOperator.getRotationSpeed() Gets the rotation speed for tilt and rotate.
Return type: number
getWalkActive
-
CameraKeyboardWalkOperator.getWalkActive() Returns true if walking is currently active
Return type: boolean
getWalkSpeed
-
CameraKeyboardWalkOperator.getWalkSpeed() Gets the walkSpeed for walking forward, backwards, left, and right.
Return type: number
getZoomSpeed
-
CameraKeyboardWalkOperator.getZoomSpeed() Gets the speed used when walking with the mouse scroll wheel.
Return type: number
resetDefaultWalkSpeeds
-
CameraKeyboardWalkOperator.resetDefaultWalkSpeeds() Sets the walk, rotate, and mouse look speeds to the default values.
Return type: Promise <void>
rotateLeft
-
CameraKeyboardWalkOperator.rotateLeft(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
rotateRight
-
CameraKeyboardWalkOperator.rotateRight(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
setBimDoorConfig
-
CameraKeyboardWalkOperator.setBimDoorConfig(doorConfig) Arguments: - doorConfig (
DoorConfig()) – None
Sets the door distance config used by BIM mode.
Return type: void - doorConfig (
setBimFloorConfig
-
CameraKeyboardWalkOperator.setBimFloorConfig(floorConfig) Arguments: - floorConfig (
FloorConfig()) – None
Sets the floor distance config used by BIM mode. See also: [[enableBimMode]].
Return type: void - floorConfig (
setBimWallConfig
-
CameraKeyboardWalkOperator.setBimWallConfig(wallConfig) Arguments: - wallConfig (
WallConfig()) – None
Sets the wall distance config used by BIM mode. See also: [[enableBimMode]].
Return type: void - wallConfig (
setElevationSpeed
-
CameraKeyboardWalkOperator.setElevationSpeed(elevationSpeed) Arguments: - elevationSpeed (
number()) – The camera will move by elevationSpeed per second.
Sets the elevation speed for moving the camera up and down.
Return type: void - elevationSpeed (
setMapping
-
CameraKeyboardWalkOperator.setMapping(button, modifier) Arguments: - button (
Button()) – None - modifier (
KeyModifiers()) – None
Sets the button and key modifier mapping for the operator.
Return type: void - button (
setMouseLookEnabled
-
CameraKeyboardWalkOperator.setMouseLookEnabled(mouseLookEnabled) Arguments: - mouseLookEnabled (
boolean()) – None
Sets whether the mouse look is enabled. If enabled, mouse move events will not continue down the operator stack.
Return type: void - mouseLookEnabled (
setMouseLookSpeed
-
CameraKeyboardWalkOperator.setMouseLookSpeed(mouseLookSpeed) Arguments: - mouseLookSpeed (
number()) – None
Sets the speed for mouse look.
Return type: void - mouseLookSpeed (
setRotationSpeed
-
CameraKeyboardWalkOperator.setRotationSpeed(rotationSpeed) Arguments: - rotationSpeed (
number()) – The camera will rotate by rotationSpeed degrees per second.
Sets the rotation speed for tilt and rotate.
Return type: void - rotationSpeed (
setTilt
-
CameraKeyboardWalkOperator.setTilt(tilt) Arguments: - tilt (
number()) – None
Sets the tilt value. Values must be between -45 and 45 degrees.
Return type: void - tilt (
setViewAngle
-
CameraKeyboardWalkOperator.setViewAngle(degrees) Arguments: - degrees (
number()) – None
Sets the view angle. Values must be between 30 and 150 degrees.
Return type: void - degrees (
setWalkSpeed
-
CameraKeyboardWalkOperator.setWalkSpeed(walkSpeed) Arguments: - walkSpeed (
number()) – The camera will move by walkSpeed per second.
Sets the walkSpeed for walking forward, backwards, left, and right.
Return type: void - walkSpeed (
setZoomSpeed
-
CameraKeyboardWalkOperator.setZoomSpeed(zoomSpeed) Arguments: - zoomSpeed (
number()) – distance for walking with the mouse scroll wheel.
Sets the speed to walk when using the mouse scroll wheel.
Return type: void - zoomSpeed (
tiltDown
-
CameraKeyboardWalkOperator.tiltDown(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
tiltUp
-
CameraKeyboardWalkOperator.tiltUp(degrees) Arguments: - degrees (
number()) – None
Return type: void
- degrees (
toggleBimMode
-
CameraKeyboardWalkOperator.toggleBimMode() Toggles BIM mode, deactivating it if it’s activated and activating it if it’s deactivated
Return type: Promise <void>
walkBackward
-
CameraKeyboardWalkOperator.walkBackward(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: void
- walkDistance (
walkBackwardWithCollision
-
CameraKeyboardWalkOperator.walkBackwardWithCollision(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: Promise <void>
- walkDistance (
walkDown
-
CameraKeyboardWalkOperator.walkDown(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: void
- walkDistance (
walkForward
-
CameraKeyboardWalkOperator.walkForward(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: void
- walkDistance (
walkForwardWithCollision
-
CameraKeyboardWalkOperator.walkForwardWithCollision(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: Promise <void>
- walkDistance (
walkLeft
-
CameraKeyboardWalkOperator.walkLeft(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: void
- walkDistance (
walkLeftWithCollision
-
CameraKeyboardWalkOperator.walkLeftWithCollision(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: Promise <void>
- walkDistance (
walkRight
-
CameraKeyboardWalkOperator.walkRight(walkDistance) Arguments: - walkDistance (
number()) – None
Return type: void
- walkDistance (