Interface PointsPickResult<TFeature>

Pick result on PointCloud-like objects

interface PointsPickResult<TFeature> {
    batchId?: number;
    coord: {
        x: number;
        y: number;
        z: number;
    };
    distance: number;
    distanceToRay?: number;
    entity: null | Entity3D<Entity3DEventMap, EntityUserData>;
    face?: null | Face;
    faceIndex?: number;
    features?: TFeature[];
    index: number;
    instanceId?: number;
    isPointsPickResult: true;
    normal?: Vector3;
    object: Points<BufferGeometry<NormalBufferAttributes>, Material | Material[]>;
    point: Vector3;
    pointOnLine?: Vector3;
    uv?: Vector2;
    uv1?: Vector2;
}

Type Parameters

  • TFeature = unknown

Hierarchy (view full)

Properties

batchId? coord distance distanceToRay? entity face? faceIndex? features? index instanceId? isPointsPickResult normal? object point pointOnLine? uv? uv1?

Properties

Optional batchId

batchId?: number

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.

Optional distanceToRay

distanceToRay?: number

entity

entity: null | Entity3D<Entity3DEventMap, EntityUserData>

Entity picked

Optional face

face?: null | Face

Intersected face

Optional faceIndex

faceIndex?: number

Index of the intersected face

Optional features

features?: TFeature[]

Features picked (if pickFeatures enabled).

index

index: number

Index of the point in the Points object

Optional instanceId

instanceId?: number

The index number of the instance where the ray intersects the InstancedMesh

isPointsPickResult

isPointsPickResult: true

Optional normal

normal?: Vector3

object

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

Point cloud picked

point

point: Vector3

Point picked.

Optional pointOnLine

pointOnLine?: Vector3

Optional uv

uv?: Vector2

Optional uv1

uv1?: Vector2

Settings

Member Visibility

On This Page

batchIdcoorddistancedistanceToRayentityfacefaceIndexfeaturesindexinstanceIdisPointsPickResultnormalobjectpointpointOnLineuvuv1