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 = unknown> {
    distance: number;
    entity: Entity3D<Entity3DEventMap, EntityUserData> | null;
    features?: TFeature[];
    object: Object3D;
    point: Vector3;
}

Type Parameters

TFeature = unknown

Hierarchy (View Summary)

Intersection
- PickResult

Index

Properties

distance entity features? object point

Properties

distance

distance: number

Distance from the camera to the picked result.

entity

entity: Entity3D<Entity3DEventMap, EntityUserData> | null

Entity picked

`Optional`features

features?: TFeature[]

Features picked (if pickFeatures enabled).

object

object: Object3D

THREE.js object picked.

point

point: Vector3

Point picked.