Interface PointsPickResult<TFeature>

Pick result on PointCloud-like objects

interface PointsPickResult<TFeature> {
    coord: {
        x: number;
        y: number;
        z: number;
    };
    distance: number;
    entity: Entity3D<Entity3DEventMap, EntityUserData>;
    features?: TFeature[];
    index: number;
    isPointsPickResult: true;
    object: Points<BufferGeometry<NormalBufferAttributes>, Material | Material[]>;
    point: Vector3;
}

Type Parameters

  • TFeature = unknown

Hierarchy (view full)

Properties

coord distance entity features? index isPointsPickResult object point

Properties

coord

coord: {
    x: number;
    y: number;
    z: number;
}

Coordinates of the point picked.

Type declaration

  • x: number
  • y: number
  • z: number

distance

distance: number

Distance from the camera to the picked result.

entity

entity: Entity3D<Entity3DEventMap, EntityUserData>

Entity picked

Optional features

features?: TFeature[]

Features picked (if pickFeatures enabled).

index

index: number

Index of the point in the Points object

isPointsPickResult

isPointsPickResult: true

object

object: Points<BufferGeometry<NormalBufferAttributes>, Material | Material[]>

Point cloud picked

point

point: Vector3

Point picked.

Settings

Member Visibility

On This Page

coorddistanceentityfeaturesindexisPointsPickResultobjectpoint