WalkOperatorService

class wvc.WalkOperatorService()

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.addEventListener()

inherited

addEventListener(type: string, callback: (None | EventListenerOrEventListenerObject), options: (boolean | AddEventListenerOptions)): void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options’s capture.

When set to true, options’s capture prevents callback from being invoked when the event’s eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event’s eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event’s eventPhase attribute value is AT_TARGET.

When set to true, options’s passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options’s once indicates that the callback will only be invoked once after which the event listener will be removed.

If an AbortSignal is passed for options’s signal, then the event listener will be removed when signal is aborted.

The event listener is appended to target’s event listener list and is not appended if it has the same type, callback, and capture.

MDN Reference

Parameters

type: string

callback: (None | EventListenerOrEventListenerObject)

options: (boolean | AddEventListenerOptions)

Returns: void

wvc.WalkOperatorService.dispatchEvent()

inherited

dispatchEvent(event: Event): boolean

Dispatches a synthetic event event to target and returns true if either event’s cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

MDN Reference

Parameters

event: Event

Returns: boolean

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.removeEventListener()

inherited

removeEventListener(type: string, callback: (None | EventListenerOrEventListenerObject), options: (boolean | EventListenerOptions)): void

Removes the event listener in target’s event listener list with the same type, callback, and options.

MDN Reference

Parameters

type: string

callback: (None | EventListenerOrEventListenerObject)

options: (boolean | EventListenerOptions)

Returns: void

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