WebXRControllerPointerSelection | Babylon.js API documentation

Class WebXRControllerPointerSelection

A module that will enable pointer selection for motion controllers of XR Input Sources

Hierarchy (View Summary)

WebXRAbstractFeature
- WebXRControllerPointerSelection

Constructors

constructor

new WebXRControllerPointerSelection(
_xrSessionManager: WebXRSessionManager,
_options: IWebXRControllerPointerSelectionOptions,
): WebXRControllerPointerSelection
constructs a new background remover module
Parameters
- _xrSessionManager: WebXRSessionManager
  the session manager for this module
- _options: IWebXRControllerPointerSelectionOptions
  read-only options to be used in this module
Returns WebXRControllerPointerSelection
Overrides WebXRAbstractFeature.constructor
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10173

Properties

`Optional`dependsOn

dependsOn?: string[]

The dependencies of this feature, if any

disableAutoAttach

disableAutoAttach: boolean

Should auto-attach be disabled?

disablePointerLighting

disablePointerLighting: boolean

Disable lighting on the laser pointer (so it will always be visible)

disableSelectionMeshLighting

disableSelectionMeshLighting: boolean

Disable lighting on the selection mesh (so it will always be visible)

displayLaserPointer

displayLaserPointer: boolean

Should the laser pointer be displayed

displaySelectionMesh

displaySelectionMesh: boolean

Should the selection mesh be displayed (The ring at the end of the laser pointer)

isDisposed

isDisposed: boolean

Is this feature disposed?

laserPointerDefaultColor

laserPointerDefaultColor: Color3

Default color of the laser pointer

laserPointerPickedColor

laserPointerPickedColor: Color3

This color will be set to the laser pointer when selection is triggered

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

raySelectionPredicate

raySelectionPredicate: (mesh: AbstractMesh) => boolean

Optional filter to be used for ray selection. This predicate shares behavior with scene.pointerMovePredicate which takes priority if it is also assigned.

selectionMeshDefaultColor

selectionMeshDefaultColor: Color3

default color of the selection ring

selectionMeshPickedColor

selectionMeshPickedColor: Color3

This color will be applied to the selection ring when selection is triggered

`Static` `Readonly`Name

Name: "xr-controller-pointer-selection"

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

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

Methods

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

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

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

getMeshUnderPointer

getMeshUnderPointer(controllerId: string): Nullable<AbstractMesh>
Will get the mesh under a specific pointer. scene.meshUnderPointer will only return one mesh - either left or right.
Parameters
- controllerId: string
  the controllerId to check
Returns Nullable<AbstractMesh>
The mesh under pointer or null if no mesh is under the pointer
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10194

getXRControllerByPointerId

getXRControllerByPointerId(id: number): Nullable<WebXRInputSource>
Get the xr controller that correlates to the pointer id in the pointer event
Parameters
- id: number
  the pointer id to search for
Returns Nullable<WebXRInputSource>
the controller that correlates to this id or null if not found
- Defined in .temp/typedoc/docdirectory/doc.d.ts:10201

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

Class WebXRControllerPointerSelection

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebXRControllerPointerSelection

Properties

OptionaldependsOn

disableAutoAttach

disablePointerLighting

disableSelectionMeshLighting

displayLaserPointer

displaySelectionMesh

isDisposed

laserPointerDefaultColor

laserPointerPickedColor

onFeatureAttachObservable

onFeatureDetachObservable

raySelectionPredicate

selectionMeshDefaultColor

selectionMeshPickedColor

Static ReadonlyName

Static ReadonlyVersion

Accessors

attached

Returns boolean

xrNativeFeatureName

Returns string

Parameters

Returns void

Methods

attach

Returns boolean

detach

Returns boolean

dispose

Returns void

getMeshUnderPointer

Parameters

Returns Nullable<AbstractMesh>

getXRControllerByPointerId

Parameters

Returns Nullable<WebXRInputSource>

isCompatible

Returns boolean

Settings

On This Page

`Optional`dependsOn

`Static` `Readonly`Name

`Static` `Readonly`Version