WebXRControllerPhysics | Babylon.js API documentation

Class WebXRControllerPhysics

Add physics impostor to your webxr controllers, including naive calculation of their linear and angular velocity

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRControllerPhysics

Index

Constructors

constructor

new WebXRControllerPhysics(
_xrSessionManager: WebXRSessionManager,
_options: IWebXRControllerPhysicsOptions,
): WebXRControllerPhysics
Construct a new Controller Physics Feature
Parameters
- _xrSessionManager: WebXRSessionManager
  the corresponding xr session manager
- _options: IWebXRControllerPhysicsOptions
  options to create this feature with
Returns WebXRControllerPhysics
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10313

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-physics-controller"

The module's name

`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

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

addController

addController(xrController: WebXRInputSource): void
Manually add a controller (if no xrInput was provided or physics engine was not enabled)
Parameters
- xrController: WebXRInputSource
  the controller to add
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10323

attach

attach(): boolean
attach this feature Will usually be called by the features manager

Returns boolean
true if successful.
Overrides WebXRAbstractFeature.attach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10330

detach

detach(): boolean
detach this feature. Will usually be called by the features manager

Returns boolean
true if successful.
Overrides WebXRAbstractFeature.detach
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10337

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

getHeadsetImpostor

getHeadsetImpostor(): undefined | PhysicsImpostor
Get the headset impostor, if enabled

Returns undefined | PhysicsImpostor
the impostor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10342

getImpostorForController

getImpostorForController(
controller: string | WebXRInputSource,
): Nullable<PhysicsImpostor>
Get the physics impostor of a specific controller. The impostor is not attached to a mesh because a mesh for each controller is not obligatory
Parameters
- controller: string | WebXRInputSource
  the controller or the controller id of which to get the impostor
Returns Nullable<PhysicsImpostor>
the impostor or null
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10349

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

setPhysicsProperties

setPhysicsProperties(
    newProperties: {
        friction?: number;
        impostorSize?: number | { depth: number; height: number; width: number };
        impostorType?: number;
        restitution?: number;
    },
): void
Update the physics properties provided in the constructor
Parameters
- newProperties: {
      friction?: number;
      impostorSize?: number | { depth: number; height: number; width: number };
      impostorType?: number;
      restitution?: number;
  }
  the new properties object
Returns void
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10358

Class WebXRControllerPhysics

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRControllerPhysics

Properties

OptionaldependsOn

disableAutoAttach

isDisposed

onFeatureAttachObservable

onFeatureDetachObservable

Static ReadonlyName

Static ReadonlyVersion

Accessors

attached

Returns boolean

xrNativeFeatureName

Returns string

Parameters

Returns void

Methods

addController

Parameters

Returns void

attach

Returns boolean

detach

Returns boolean

dispose

Returns void

getHeadsetImpostor

Returns undefined | PhysicsImpostor

getImpostorForController

Parameters

Returns Nullable<PhysicsImpostor>

isCompatible

Returns boolean

setPhysicsProperties

Parameters

Returns void

Settings

On This Page

`Optional`dependsOn

`Static` `Readonly`Name

`Static` `Readonly`Version