Interface IWebXRControllerPointerSelectionOptions
Hierarchy
- IWebXRControllerPointerSelectionOptions
Index
Properties
- custom
Utility Layer Scene - disable
Pointer UpOn Touch Out - disable
Scene Pointer Vector Update - disable
Switch OnClick - enable
Pointer Selection OnAll Controllers - force
Gaze Mode - gaze
Camera - gaze
Mode Pointer Moved Factor - max
Pointer Distance - override
Button Id - preferred
Handedness - rendering
Group Id - time
ToSelect - use
Utility Layer - xr
Input
Properties
Optional custom Utility Layer SceneSearch playground for customUtilityLayerScene
if provided, this scene will be used to render meshes.
disable Pointer UpOn Touch OutSearch playground for disablePointerUpOnTouchOut
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
disable Scene Pointer Vector UpdateSearch playground for disableScenePointerVectorUpdate
Should the scene pointerX and pointerY update be disabled This is required for fullscreen AR GUI, but might slow down other experiences. Disable in VR, if not needed. The first rig camera (left eye) will be used to calculate the projection
Optional disable Switch OnClickSearch playground for disableSwitchOnClick
Disable switching the pointer selection from one controller to the other. If the preferred hand is set it will be fixed on this hand, and if not it will be fixed on the first controller added to the scene
Optional enable Pointer Selection OnAll ControllersSearch playground for enablePointerSelectionOnAllControllers
Enable pointer selection on all controllers instead of switching between them
force Gaze ModeSearch playground for forceGazeMode
For gaze mode for tracked-pointer / controllers (time to select instead of button press)
Optional gaze CameraSearch playground for gazeCamera
Optional WebXR camera to be used for gaze selection
Optional gaze Mode Pointer Moved FactorSearch playground for gazeModePointerMovedFactor
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 max Pointer DistanceSearch playground for maxPointerDistance
The maximum distance of the pointer selection feature. Defaults to 100.
Optional override Button IdSearch playground for overrideButtonId
Different button type to use instead of the main component
Optional preferred HandednessSearch playground for preferredHandedness
The preferred hand to give the pointer selection to. This will be prioritized when the controller initialize. If switch is enabled, it will still allow the user to switch between the different controllers
Optional rendering Group IdSearch playground for renderingGroupId
use this rendering group id for the meshes (optional)
Optional time ToSelectSearch playground for timeToSelect
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 use Utility LayerSearch playground for useUtilityLayer
Should meshes created here be added to a utility layer or the main scene
xr InputSearch playground for xrInput
the xr input to use with this pointer selection
Options interface for the pointer selection module