API (v2.0.0) - Giro3D
    Preparing search index...

    Interface ShapePickResult

    The picking result for shapes.

    interface ShapePickResult {
        distance: number;
        entity: Shape;
        features?: unknown[];
        isShapePickResult: true;
        object: Object3D;
        pickedLabel?: boolean;
        pickedSegment?: number;
        pickedSurface?: boolean;
        pickedVertexIndex?: number;
        point: Vector3;
    }

    Hierarchy (View Summary)

    Index

    Properties

    distance entity features? isShapePickResult object pickedLabel? pickedSegment? pickedSurface? pickedVertexIndex? point

    Properties

    distance: number

    Distance from the camera to the picked result.

    entity: Shape

    Entity picked

    features?: unknown[]

    Features picked (if pickFeatures enabled).

    isShapePickResult: true
    object: Object3D

    THREE.js object picked.

    pickedLabel?: boolean

    true if a label was picked, false otherwise.

    pickedSegment?: number

    The index of the first point that makes the picked segment, otherwise null.

    pickedSurface?: boolean

    true if the surface was picked, false otherwise.

    pickedVertexIndex?: number

    The index of the picked vertex, otherwise null.

    point: Vector3

    Point picked.

    Settings

    Member Visibility

    On This Page

    Properties