SDK JS
    Preparing search index...

    Interface PositionPickable

    Structural interface of a layer that can resolve a screen point to a 3D position (the mesh layers' pickPosition). Pass any mix of SDK 3D layers through this.

    interface PositionPickable {
        pickPosition(
            x: number,
            y: number,
            snapRadiusPx?: number,
        ): PickedPosition | null;
    }
    Index

    Methods

    pickPosition

    Methods

    • Resolve a canvas point to the 3D position of the frontmost surface.

      Parameters

      • x: number

        Canvas X in CSS pixels, top-left origin.

      • y: number

        Canvas Y in CSS pixels, top-left origin.

      • OptionalsnapRadiusPx: number

        Optional snap radius in CSS pixels (nearest hit within it wins).

      Returns PickedPosition | null

      The picked position, or null on a miss.

    Settings

    Member Visibility

    On This Page

    Methods