WebXRWalkingLocomotion | Babylon.js API documentation

Class WebXRWalkingLocomotion

A module that will enable VR locomotion by detecting when the user walks in place.

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRWalkingLocomotion

Index

Constructors

constructor

new WebXRWalkingLocomotion(
sessionManager: WebXRSessionManager,
options: IWebXRWalkingLocomotionOptions,
): WebXRWalkingLocomotion
Construct a new Walking Locomotion feature.
Parameters
- sessionManager: WebXRSessionManager
  manager for the current XR session
- options: IWebXRWalkingLocomotionOptions
  creation options, prominently including the vector target for locomotion
Returns WebXRWalkingLocomotion
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7693

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

Accessors

attached

get attached(): boolean
Is this feature attached

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

locomotionTarget

get locomotionTarget(): TransformNode | WebXRCamera
The target to be articulated by walking locomotion. When the walking locomotion feature detects walking in place, this element's X and Z coordinates will be modified to reflect locomotion. This target should be either the XR space's origin (i.e., the parent node of the WebXRCamera) or the WebXRCamera itself. Note that the WebXRCamera path will modify the position of the WebXRCamera directly and is thus discouraged.

Returns TransformNode | WebXRCamera
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7678
set locomotionTarget(locomotionTarget: TransformNode | WebXRCamera): void
The target to be articulated by walking locomotion. When the walking locomotion feature detects walking in place, this element's X and Z coordinates will be modified to reflect locomotion. This target should be either the XR space's origin (i.e., the parent node of the WebXRCamera) or the WebXRCamera itself. Note that the WebXRCamera path will modify the position of the WebXRCamera directly and is thus discouraged.
Parameters
- locomotionTarget: TransformNode | WebXRCamera
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7687

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:10859
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:10860

`Static`Name

get Name(): string
The module's name.

Returns string
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7655

`Static`Version

get Version(): number
The (Babylon) version of this module. This is an integer representing the implementation version. This number has no external basis.

Returns number
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7661

Methods

attach

attach(): boolean
Attaches the feature. Typically called automatically by the features manager.

Returns boolean
true if attach succeeded, false otherwise
Overrides WebXRAbstractFeature.attach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7705

detach

detach(): boolean
Detaches the feature. Typically called automatically by the features manager.

Returns boolean
true if detach succeeded, false otherwise
Overrides WebXRAbstractFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7711

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:10898

isCompatible

isCompatible(): boolean
Checks whether this feature is compatible with the current WebXR session. Walking locomotion is only compatible with "immersive-vr" sessions.

Returns boolean
true if compatible, false otherwise
Overrides WebXRAbstractFeature.isCompatible
- Defined in .temp/typedoc/docdirectory/doc.d.ts:7699

Class WebXRWalkingLocomotion

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRWalkingLocomotion

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

Accessors

attached

Returns boolean

locomotionTarget

Returns TransformNode | WebXRCamera

Parameters

Returns void

xrNativeFeatureName

Returns string

Parameters

Returns void

StaticName

Returns string

StaticVersion

Returns number

Methods

attach

Returns boolean

detach

Returns boolean

dispose

Returns void

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Static`Name

`Static`Version