@threlte/xr/dist/hooks/useHitTest.svelte.d.ts

Tools to more easily create VR and AR experiences with Threlte

import { Matrix4 } from 'three';
export type HitTestCallback = (hitMatrix: Matrix4, hit: XRHitTestResult | undefined) => void;
export type UseHitTestOptions = {
    /**
     * The ray source when performing hit testing.
     *
     * @default 'viewer'
     */
    source?: 'viewer' | 'leftInput' | 'rightInput';
};
/**
 * Use this hook to perform a hit test per frame in an AR environment.
 *
 * ```ts
 * useHitTest((hitMatrix, hit) => {
 *   mesh.matrix.copy(hitMatrix)
 * }, {
 *   source: 'viewer' | 'leftInput' | 'rightInput' // Default 'viewer'
 * })
 * ```
 */
export declare const useHitTest: (hitTestCallback: HitTestCallback, options?: UseHitTestOptions) => void;