API
Viewer API|
ViewerHotSpotQuery

Type Alias ViewerHotSpotQuery

ViewerHotSpotQuery:
    | { meshIndex: number; type: "surface" } & HotSpotQuery
    | {
        normal: [x: number, y: number, z: number];
        position: [x: number, y: number, z: number];
        type: "world";
    }

A hot spot query specifying either a surface point or a fixed world position.

Type Declaration

  • { meshIndex: number; type: "surface" } & HotSpotQuery
    • meshIndex: number

      The index of the mesh within the loaded model.

    • type: "surface"

      The type of the hot spot.

  • {
        normal: [x: number, y: number, z: number];
        position: [x: number, y: number, z: number];
        type: "world";
    }
    • normal: [x: number, y: number, z: number]

      The fixed world space normal of the hot spot.

    • position: [x: number, y: number, z: number]

      The fixed world space position of the hot spot.

    • type: "world"

      The type of the hot spot.