API
API|
@babylonjs/core|
IWebXRHitTestOptions

Interface IWebXRHitTestOptions

Options used for hit testing (version 2)

interface IWebXRHitTestOptions {
    disablePermanentHitTest?: boolean;
    enableTransientHitTest?: boolean;
    entityTypes?: XRHitTestTrackableType[];
    offsetRay?: Vector3;
    testOnPointerDownOnly?: boolean;
    transientHitTestProfile?: string;
    transientOffsetRay?: Vector3;
    useReferenceSpace?: boolean;
    worldParentNode?: TransformNode;
}

Hierarchy (View Summary)

Index
disablePermanentHitTest? enableTransientHitTest? entityTypes? offsetRay? testOnPointerDownOnly? transientHitTestProfile? transientOffsetRay? useReferenceSpace? worldParentNode?
disablePermanentHitTest?: boolean

Do not create a permanent hit test. Will usually be used when only transient inputs are needed.

enableTransientHitTest?: boolean

Enable transient (for example touch-based) hit test inspections

entityTypes?: XRHitTestTrackableType[]

Override the default entity type(s) of the hit-test result

offsetRay?: Vector3

Offset ray for the permanent hit test

testOnPointerDownOnly?: boolean

Only test when user interacted with the scene. Default - hit test every frame

transientHitTestProfile?: string

Override the default transient hit test profile (generic-touchscreen).

transientOffsetRay?: Vector3

Offset ray for the transient hit test

useReferenceSpace?: boolean

Instead of using viewer space for hit tests, use the reference space defined in the session manager

worldParentNode?: TransformNode

The node to use to transform the local results to world coordinates