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

OptionalbatchId

batchId?: number

distance

distance: number

Distance from the camera to the picked result.

OptionaldistanceToRay

distanceToRay?: number

entity

entity: null | Entity3D<Entity3DEventMap, EntityUserData>

Entity picked

Optionalface

face?: null | Face

Intersected face

OptionalfaceIndex

faceIndex?: number

Index of the intersected face

Optionalfeatures

features?: TFeature[]

Features picked (if pickFeatures enabled).

Optionalindex

index?: number

OptionalinstanceId

instanceId?: number

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

Optionalnormal

normal?: Vector3

object

object: Object3D<Object3DEventMap>

THREE.js object picked.

point

point: Vector3

Point picked.

OptionalpointOnLine

pointOnLine?: Vector3

Optionaluv

uv?: Vector2

Optionaluv1

uv1?: Vector2

Settings

Member Visibility

On This Page

Properties