Documentation - v20.0.0-dev
    Preparing search index...

    Interface SceneIntersection

    Where a ray hits an object of the scene (see ViewerRaycaster.raycast).

    interface SceneIntersection {
        distance: number;
        layer: number;
        object: SceneObject;
        part: number | null;
        point: Vector3;
        proxy: MeshProxy | null;
    }
    Index

    Properties

    distance: number

    From the ray origin to point, world frame.

    layer: number

    The layer the object is drawn in (the engine's MeshLayer): a layer is drawn over the lower ones, whatever their depth. CLIPPING_PLANE_LAYER for a clipping plane's quad.

    object: SceneObject

    The object hit.

    part: number | null

    The rank of the part of proxy hit; null without proxy.

    point: Vector3

    World frame.

    proxy: MeshProxy | null

    The engine object hit, for a mesh (e.g. one of a BimMesh's representations); null for a sprite, a clipping plane's quad or an object drawn outside the engine.