Interface PickResult<TFeature>

Pick result.

Provides information from Three.js raycasting augmented with Giro3D information.

May be extended, depending on what have been picked.

interface PickResult<TFeature> {
    batchId?: number;
    distance: number;
    distanceToRay?: number;
    entity: null | Entity3D<Entity3DEventMap, EntityUserData>;
    face?: null | Face;
    faceIndex?: number;
    features?: TFeature[];
    index?: number;
    instanceId?: number;
    normal?: Vector3;
    object: Object3D<Object3DEventMap>;
    point: Vector3;
    pointOnLine?: Vector3;
    uv?: Vector2;
    uv1?: Vector2;
}

Type Parameters

  • TFeature = unknown

Hierarchy (view full)

Properties

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

Properties

Optional batchId

batchId?: 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).

Optional index

index?: number

Optional instanceId

instanceId?: number

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

Optional normal

normal?: Vector3

object

object: Object3D<Object3DEventMap>

THREE.js object picked.

point

point: Vector3

Point picked.

Optional pointOnLine

pointOnLine?: Vector3

Optional uv

uv?: Vector2

Optional uv1

uv1?: Vector2

Settings

Member Visibility

On This Page

batchIddistancedistanceToRayentityfacefaceIndexfeaturesindexinstanceIdnormalobjectpointpointOnLineuvuv1