Options interface for the pointer selection module


  • IWebXRControllerPointerSelectionOptions



Optional customUtilityLayerScene

Find examples in Playground
customUtilityLayerScene: Scene

if provided, this scene will be used to render meshes.


Find examples in Playground
disablePointerUpOnTouchOut: boolean

Disable the pointer up event when the xr controller in screen and gaze mode is disposed (meaning - when the user removed the finger from the screen) If not disabled, the last picked point will be used to execute a pointer up event If disabled, pointer up event will be triggered right after the pointer down event. Used in screen and gaze target ray mode only


Find examples in Playground
forceGazeMode: boolean

For gaze mode for tracked-pointer / controllers (time to select instead of button press)

Optional gazeCamera

Find examples in Playground
gazeCamera: WebXRCamera

Optional WebXR camera to be used for gaze selection

Optional gazeModePointerMovedFactor

Find examples in Playground
gazeModePointerMovedFactor: number

Factor to be applied to the pointer-moved function in the gaze mode. How sensitive should the gaze mode be when checking if the pointer moved to start a new countdown to the pointer down event. Defaults to 1.

Optional overrideButtonId

Find examples in Playground
overrideButtonId: string

Different button type to use instead of the main component

Optional renderingGroupId

Find examples in Playground
renderingGroupId: number

use this rendering group id for the meshes (optional)

Optional timeToSelect

Find examples in Playground
timeToSelect: number

The amount of time in milliseconds it takes between pick found something to a pointer down event. Used in gaze modes. Tracked pointer uses the trigger, screen uses touch events 3000 means 3 seconds between pointing at something and selecting it

Optional useUtilityLayer

Find examples in Playground
useUtilityLayer: boolean

Should meshes created here be added to a utility layer or the main scene


Find examples in Playground
xrInput: WebXRInput

the xr input to use with this pointer selection

Generated using TypeDoc