Class WebXRControllerPhysics

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

Hierarchy

WebXRAbstractFeature
- WebXRControllerPhysics

Implements

IWebXRFeature

Index

Constructors

constructor

Properties

Accessors

attached

Methods

Constructors

constructor

new WebXRControllerPhysics(_xrSessionManager: WebXRSessionManager, _options: IWebXRControllerPhysicsOptions): WebXRControllerPhysics

Overrides WebXRAbstractFeature.constructor
- Defined in .temp/docdirectory/doc.d.ts:91375
Construct a new Controller Physics Feature

Parameters
- _xrSessionManager: WebXRSessionManager
  
  the corresponding xr session manager
- _options: IWebXRControllerPhysicsOptions
  
  options to create this feature with
Returns WebXRControllerPhysics

Properties

disableAutoAttachSearch playground for disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

isDisposedSearch playground for isDisposed

isDisposed: boolean

Is this feature disposed?

xrNativeFeatureNameSearch playground for xrNativeFeatureName

xrNativeFeatureName: string

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

Static Readonly NameSearch playground for Name

Name: "xr-physics-controller" = "xr-physics-controller"

The module's name

Static Readonly VersionSearch playground for Version

Version: 1 = 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

Inherited from WebXRAbstractFeature.attached
- Defined in .temp/docdirectory/doc.d.ts:90815
Is this feature attached

Returns boolean

Methods

addControllerSearch playground for addController

addController(xrController: WebXRInputSource): void

- Defined in .temp/docdirectory/doc.d.ts:91391
Manually add a controller (if no xrInput was provided or physics engine was not enabled)

Parameters
- xrController: WebXRInputSource
  
  the controller to add
Returns void

attachSearch playground for attach

attach(): boolean

Overrides WebXRAbstractFeature.attach
- Defined in .temp/docdirectory/doc.d.ts:91398
attach this feature Will usually be called by the features manager

Returns boolean

true if successful.

detachSearch playground for detach

detach(): boolean

Implementation of IWebXRFeature.detach

Overrides WebXRAbstractFeature.detach
- Defined in .temp/docdirectory/doc.d.ts:91405
detach this feature. Will usually be called by the features manager

Returns boolean

true if successful.

disposeSearch playground for dispose

dispose(): void

Implementation of IWebXRFeature.dispose

Inherited from WebXRAbstractFeature.dispose
- Defined in .temp/docdirectory/doc.d.ts:90832
Dispose this feature and all of the resources attached

Returns void

getHeadsetImpostorSearch playground for getHeadsetImpostor

getHeadsetImpostor(): PhysicsImpostor | undefined

- Defined in .temp/docdirectory/doc.d.ts:91410
Get the headset impostor, if enabled

Returns PhysicsImpostor | undefined

the impostor

getImpostorForControllerSearch playground for getImpostorForController

getImpostorForController(controller: WebXRInputSource | string): Nullable<PhysicsImpostor>

- Defined in .temp/docdirectory/doc.d.ts:91417
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: WebXRInputSource | string
  
  the controller or the controller id of which to get the impostor
Returns Nullable<PhysicsImpostor>

the impostor or null

isCompatibleSearch playground for isCompatible

isCompatible(): boolean

Implementation of IWebXRFeature.isCompatible

Inherited from WebXRAbstractFeature.isCompatible
- Defined in .temp/docdirectory/doc.d.ts:90839
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

setPhysicsPropertiesSearch playground for setPhysicsProperties

setPhysicsProperties(newProperties: { friction?: number; impostorSize?: number | { depth: number; height: number; width: number }; impostorType?: number; restitution?: number }): void

- Defined in .temp/docdirectory/doc.d.ts:91426
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
  - Optional friction?: number
  - Optional impostorSize?: number | { depth: number; height: number; width: number }
  - Optional impostorType?: number
  - Optional restitution?: number
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

_xrSessionManager: WebXRSessionManager

_options: IWebXRControllerPhysicsOptions

Returns WebXRControllerPhysics

Properties

disableAutoAttachSearch playground for disableAutoAttach

isDisposedSearch playground for isDisposed

xrNativeFeatureNameSearch playground for xrNativeFeatureName

Static Readonly NameSearch playground for Name

Static Readonly VersionSearch playground for Version

Accessors

attached

Returns boolean

Methods

addControllerSearch playground for addController

Parameters

xrController: WebXRInputSource

Returns void

attachSearch playground for attach

Returns boolean

detachSearch playground for detach

Returns boolean

disposeSearch playground for dispose

Returns void

getHeadsetImpostorSearch playground for getHeadsetImpostor

Returns PhysicsImpostor | undefined

getImpostorForControllerSearch playground for getImpostorForController

Parameters

controller: WebXRInputSource | string

Returns Nullable<PhysicsImpostor>

isCompatibleSearch playground for isCompatible

Returns boolean

setPhysicsPropertiesSearch playground for setPhysicsProperties

Parameters

newProperties: { friction?: number; impostorSize?: number | { depth: number; height: number; width: number }; impostorType?: number; restitution?: number }

Optional friction?: number

Optional impostorSize?: number | { depth: number; height: number; width: number }

Optional impostorType?: number

Optional restitution?: number

Returns void