WalkOperatorService

class wvc.WalkOperatorService()

Index

Constructors

• constructor

Properties

• DefaultConfiguration
• serviceName

Accessors

• keyboardWalkOperator
• mouseWalkOperator
• walkModeOperator

Methods

• getElevationSpeed
• getFieldOfView
• getMouseLookSpeed
• getRotationSpeed
• getWalkMode
• getWalkSpeed
• isCollisionDetectionEnabled
• isMouseLookEnabled
• reset
• resetConfiguration
• setCollisionDetectionEnabled
• setElevationSpeed
• setFieldOfView
• setMouseLookEnabled
• setMouseLookSpeed
• setRotationSpeed
• setWalkMode
• setWalkSpeed

Constructors

wvc.WalkOperatorService.constructor()

WalkOperatorService(options: { keyboardWalkOperator: CameraKeyboardWalkOperator, mouseWalkOperator: CameraWalkOperator, walkModeOperator: CameraWalkModeOperator }): WalkOperatorService

Parameters

options: { keyboardWalkOperator: CameraKeyboardWalkOperator, mouseWalkOperator: CameraWalkOperator, walkModeOperator: CameraWalkModeOperator }

Returns: WalkOperatorService

Properties

wvc.WalkOperatorService.DefaultConfiguration

static readonly

DefaultConfiguration: { collisionDetectionEnabled: boolean, mouseLookEnabled: boolean, walkMode: (“Mouse” | “Keyboard”) }

wvc.WalkOperatorService.serviceName

readonly

serviceName: “WalkOperatorService”

Accessors

wvc.WalkOperatorService.keyboardWalkOperator()

get keyboardWalkOperator(): (undefined | CameraKeyboardWalkOperator)

Returns: (undefined | CameraKeyboardWalkOperator)

set keyboardWalkOperator(value: (undefined | CameraKeyboardWalkOperator)): void

Parameters

value: (undefined | CameraKeyboardWalkOperator)

Returns: void

wvc.WalkOperatorService.mouseWalkOperator()

get mouseWalkOperator(): (undefined | CameraWalkOperator)

Returns: (undefined | CameraWalkOperator)

set mouseWalkOperator(value: (undefined | CameraWalkOperator)): void

Parameters

value: (undefined | CameraWalkOperator)

Returns: void

wvc.WalkOperatorService.walkModeOperator()

get walkModeOperator(): (undefined | CameraWalkModeOperator)

Returns: (undefined | CameraWalkModeOperator)

set walkModeOperator(value: (undefined | CameraWalkModeOperator)): void

Parameters

value: (undefined | CameraWalkModeOperator)

Returns: void

Methods

wvc.WalkOperatorService.getElevationSpeed()

getElevationSpeed(): number

Returns: number

wvc.WalkOperatorService.getFieldOfView()

getFieldOfView(): number

Returns: number

wvc.WalkOperatorService.getMouseLookSpeed()

getMouseLookSpeed(): number

Returns: number

wvc.WalkOperatorService.getRotationSpeed()

getRotationSpeed(): number

Returns: number

wvc.WalkOperatorService.getWalkMode()

getWalkMode(): (“Mouse” | “Keyboard”)

Returns: (“Mouse” | “Keyboard”)

wvc.WalkOperatorService.getWalkSpeed()

getWalkSpeed(): number

Returns: number

wvc.WalkOperatorService.isCollisionDetectionEnabled()

isCollisionDetectionEnabled(): boolean

Returns: boolean

wvc.WalkOperatorService.isMouseLookEnabled()

isMouseLookEnabled(): boolean

Returns: boolean

wvc.WalkOperatorService.reset()

reset(): void

Returns: void

wvc.WalkOperatorService.resetConfiguration()

resetConfiguration(obj: object): Promise

Parameters

obj: object

Returns: Promise

wvc.WalkOperatorService.setCollisionDetectionEnabled()

setCollisionDetectionEnabled(enabled: boolean): Promise

Parameters

enabled: boolean

Returns: Promise

wvc.WalkOperatorService.setElevationSpeed()

setElevationSpeed(value: number): void

Parameters

value: number

Returns: void

wvc.WalkOperatorService.setFieldOfView()

setFieldOfView(value: number): void

Parameters

value: number

Returns: void

wvc.WalkOperatorService.setMouseLookEnabled()

setMouseLookEnabled(enabled: boolean): void

Parameters

enabled: boolean

Returns: void

wvc.WalkOperatorService.setMouseLookSpeed()

setMouseLookSpeed(speed: number): void

Parameters

speed: number

Returns: void

wvc.WalkOperatorService.setRotationSpeed()

setRotationSpeed(value: number): void

Parameters

value: number

Returns: void

wvc.WalkOperatorService.setWalkMode()

setWalkMode(mode: (“Mouse” | “Keyboard”)): Promise

Parameters

mode: (“Mouse” | “Keyboard”)

Returns: Promise

wvc.WalkOperatorService.setWalkSpeed()

setWalkSpeed(value: number): void

Parameters

value: number

Returns: void