API

Interface PickingInfo

Result of a GPU pick operation.

interface PickingInfo {
    bu: number;
    bv: number;
    distance: number;
    faceId: number;
    hit: boolean;
    pickedFaceNormal: [number, number, number] | null;
    pickedFaceNormalWorld: [number, number, number] | null;
    pickedMesh: Mesh | GaussianSplattingMesh | null;
    pickedNormal: [number, number, number] | null;
    pickedNormalWorld: [number, number, number] | null;
    pickedPoint: [number, number, number] | null;
    ray: Ray | null;
    subMeshId: number;
    thinInstanceIndex: number;
}
Index
bu: number
bv: number
distance: number
faceId: number

Exact winning GPU primitive index within pickedMesh's indexed draw.

hit: boolean
pickedFaceNormal: [number, number, number] | null
pickedFaceNormalWorld: [number, number, number] | null
pickedMesh: Mesh | GaussianSplattingMesh | null

The picked mesh. May be a regular Lite Mesh or a GaussianSplattingMesh (when GS picking via the gs-picking-pipeline ports the BJS GaussianSplattingGpuPickingMaterialPlugin).

pickedNormal: [number, number, number] | null
pickedNormalWorld: [number, number, number] | null
pickedPoint: [number, number, number] | null
ray: Ray | null
subMeshId: number
thinInstanceIndex: number