lazy-widgets/dist/drivers/RayPointerDriver.d.ts

Typescript retained mode GUI for the HTML canvas API

import { PointerDriver } from './PointerDriver.js';
import { Root } from '../core/Root.js';
import type { RayPointerSource } from './RayPointerSource.js';
import type { PointerHint } from './PointerHint.js';
/**
 * A {@link PointerDriver} which gets pointer events from raycasts in a 3D
 * engine's world. This is an abstract class and must be implemented.
 *
 * @category Driver
 */
export declare abstract class RayPointerDriver extends PointerDriver {
    /** The sources which this is assigned to */
    protected readonly sources: Set<RayPointerSource>;
    /**
     * Cast a ray in the world and get which root was intersected and where.
     *
     * @param origin - The world position where the ray is starting
     * @param direction - A normalised vector representing the ray's direction. Not a euler rotation nor a quaternion
     * @returns Returns a 3-tuple containing, in this order, the intersected root or null if none intersected, the normalised x axis of the intersection and the normalised y axis of the intersection. If no root was intersected, use bogus values for x and y
     */
    abstract castRay(origin: [number, number, number], direction: [number, number, number]): [Root | null, number, number];
    /**
     * Receive a ray from a {@link RayPointerSource}.
     *
     * @param pointer - The source's pointer ID, given when setting the source's sink
     * @param pressing - Is the pointer pressed? If null, then the last pressing state will be used. A bitmask where each set bit represents a different button being pressed
     * @param origin - The world position where the ray is starting
     * @param direction - A normalised vector representing the ray's direction. Not a euler rotation nor a quaternion
     * @param shift - Is shift being pressed?
     * @param ctrl - Is control being pressed?
     * @param alt - Is alt being pressed?
     */
    handlePointerRay(pointer: number, pressing: number | null, origin: [number, number, number], direction: [number, number, number], shift: boolean, ctrl: boolean, alt: boolean): void;
    /** Add a source. Assigns itself to the given source. */
    addSource(source: RayPointerSource): void;
    protected setPointerHint(pointer: number, hint: PointerHint): boolean;
}