Interface SceneRaycastResult

Outcome of a SceneRaycaster.pick call.

Always includes the world-space ray that was tested (useful for downstream visualisation or follow-up queries). Hit fields are populated iff hit === true.

interface SceneRaycastResult {
    hit: boolean;
    meshId: string;
    objectId: string;
    rayDir: Vec3Float;
    rayOrigin: Vec3Float;
    tHit: number;
    triangleIndex: number;
    worldPos: Vec3Float;
}

Properties

hit meshId objectId rayDir rayOrigin tHit triangleIndex worldPos

Properties

hit

hit: boolean

True when the ray hit a triangle that satisfied the pick filters.

meshId

meshId: string

Mesh ID of the hit triangle. null on a miss.

objectId

objectId: string

Object ID of the hit. null on a miss.

rayDir

rayDir: Vec3Float

World-space ray direction used for the test (unnormalised).

rayOrigin

rayOrigin: Vec3Float

World-space ray origin used for the test.

tHit

tHit: number

Parametric distance along the ray, in dir-multiples. null on a miss.

triangleIndex

triangleIndex: number

Index of the hit triangle (offset into geometry indices ÷ 3); -1 on a miss.

worldPos

worldPos: Vec3Float

World-space hit position. null on a miss.

Settings

Member Visibility

On This Page

Properties