WebXRControllerMovement | Babylon.js API documentation

Class WebXRControllerMovement

This is a movement feature to be used with WebXR-enabled motion controllers. When enabled and attached, the feature will allow a user to move around and rotate in the scene using the input of the attached controllers.

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRControllerMovement

Constructors

constructor

new WebXRControllerMovement(
_xrSessionManager: WebXRSessionManager,
options: IWebXRControllerMovementOptions,
): WebXRControllerMovement
constructs a new movement controller system
Parameters
- _xrSessionManager: WebXRSessionManager
  an instance of WebXRSessionManager
- options: IWebXRControllerMovementOptions
  configuration object for this feature
Returns WebXRControllerMovement
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10583

Properties

`Optional`dependsOn

dependsOn?: string[]

The dependencies of this feature, if any

disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposed

isDisposed: boolean

Is this feature disposed?

onFeatureAttachObservable

onFeatureAttachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is attached

onFeatureDetachObservable

onFeatureDetachObservable: Observable<IWebXRFeature>

Observers registered here will be executed when the feature is detached

`Static` `Readonly`Name

Name: "xr-controller-movement"

The module's name

`Static` `Readonly`REGISTRATIONS

REGISTRATIONS: {
[key: string]: WebXRControllerMovementRegistrationConfiguration[];
}

Standard controller configurations.

`Static` `Readonly`Version

Version: 1

The (Babylon) version of this module. This is an integer representing the implementation version. This number does not correspond to the webxr specs version

Accessors

attached

get attached(): boolean
Is this feature attached

Returns boolean
Inherited from WebXRAbstractFeature.attached
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10866

movementDirection

get movementDirection(): Quaternion
Current movement direction. Will be null before XR Frames have been processed.

Returns Quaternion
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10514

movementEnabled

get movementEnabled(): boolean
Is movement enabled

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10518
set movementEnabled(enabled: boolean): void
Sets whether movement is enabled or not
Parameters
- enabled: boolean
  is movement enabled
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10523

movementOrientationFollowsViewerPose

get movementOrientationFollowsViewerPose(): boolean
If movement follows viewer pose

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10527
set movementOrientationFollowsViewerPose(followsPose: boolean): void
Sets whether movement follows viewer pose
Parameters
- followsPose: boolean
  is movement should follow viewer pose
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10532

movementSpeed

get movementSpeed(): number
Gets movement speed

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10536
set movementSpeed(movementSpeed: number): void
Sets movement speed
Parameters
- movementSpeed: number
  movement speed
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10541

movementThreshold

get movementThreshold(): number
Gets minimum threshold the controller's thumbstick/touchpad must pass before being recognized for movement (avoids jitter/unintentional movement)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10545
set movementThreshold(movementThreshold: number): void
Sets minimum threshold the controller's thumbstick/touchpad must pass before being recognized for movement (avoids jitter/unintentional movement)
Parameters
- movementThreshold: number
  new threshold
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10550

rotationEnabled

get rotationEnabled(): boolean
Is rotation enabled

Returns boolean
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10554
set rotationEnabled(enabled: boolean): void
Sets whether rotation is enabled or not
Parameters
- enabled: boolean
  is rotation enabled
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10559

rotationSpeed

get rotationSpeed(): number
Gets rotation speed factor

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10563
set rotationSpeed(rotationSpeed: number): void
Sets rotation speed factor (1.0 is default)
Parameters
- rotationSpeed: number
  new rotation speed factor
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10568

rotationThreshold

get rotationThreshold(): number
Gets minimum threshold the controller's thumbstick/touchpad must pass before being recognized for rotation (avoids jitter/unintentional rotation)

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10572
set rotationThreshold(threshold: number): void
Sets minimum threshold the controller's thumbstick/touchpad must pass before being recognized for rotation (avoids jitter/unintentional rotation)
Parameters
- threshold: number
  new threshold
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10577

xrNativeFeatureName

get xrNativeFeatureName(): string
The name of the native xr feature name (like anchor, hit-test, or hand-tracking)

Returns string
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10844
set xrNativeFeatureName(name: string): void
The name of the native xr feature name, if applicable (like anchor, hit-test, or hand-tracking)
Parameters
- name: string
Returns void
Inherited from WebXRAbstractFeature.xrNativeFeatureName
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10845

Methods

attach

attach(): boolean
attach this feature

Returns boolean
true if successful, false is failed or already attached
Overrides WebXRAbstractFeature.attach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10584

detach

detach(): boolean
detach this feature.

Returns boolean
true if successful, false if failed or already detached
Overrides WebXRAbstractFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10585

dispose

dispose(): void
Dispose this feature and all of the resources attached

Returns void
Inherited from WebXRAbstractFeature.dispose
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10883

isCompatible

isCompatible(): boolean
This function will be executed during before enabling the feature and can be used to not-allow enabling it. Note that at this point the session has NOT started, so this is purely checking if the browser supports it

Returns boolean
whether or not the feature is compatible in this environment
Inherited from WebXRAbstractFeature.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10890

Class WebXRControllerMovement

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRControllerMovement

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

Static ReadonlyName

Static ReadonlyREGISTRATIONS

Static ReadonlyVersion

Accessors

attached

Returns boolean

movementDirection

Returns Quaternion

movementEnabled

Returns boolean

Parameters

Returns void

movementOrientationFollowsViewerPose

Returns boolean

Parameters

Returns void

movementSpeed

Returns number

Parameters

Returns void

movementThreshold

Returns number

Parameters

Returns void

rotationEnabled

Returns boolean

Parameters

Returns void

rotationSpeed

Returns number

Parameters

Returns void

rotationThreshold

Returns number

Parameters

Returns void

xrNativeFeatureName

Returns string

Parameters

Returns void

Methods

attach

Returns boolean

detach

Returns boolean

dispose

Returns void

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Static` `Readonly`Name

`Static` `Readonly`REGISTRATIONS

`Static` `Readonly`Version