Interface MapPickResult<TFeature>

Pick result on tiles (e.g. map)

interface MapPickResult<TFeature> {
    batchId?: number;
    coord: Coordinates;
    distance: number;
    distanceToRay?: number;
    entity: entities.Map<EntityUserData>;
    face?: null | Face;
    faceIndex?: number;
    features?: TFeature[];
    index?: number;
    instanceId?: number;
    isMapPickResult: true;
    normal?: Vector3;
    object: TileMesh;
    point: Vector3;
    pointOnLine?: Vector3;
    uv?: Vector2;
    uv1?: Vector2;
}

Type Parameters

  • TFeature = unknown

Hierarchy (view full)

Properties

batchId?: number

Coordinates of the point picked.

distance: number

Distance from the camera to the picked result.

distanceToRay?: number

Entity picked

face?: null | Face

Intersected face

faceIndex?: number

Index of the intersected face

features?: TFeature[]

Features picked (if pickFeatures enabled).

index?: number
instanceId?: number

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

isMapPickResult
normal?: Vector3
object: TileMesh

Tile containing the picked result.

point: Vector3

Point picked.

pointOnLine?: Vector3
uv?: Vector2
uv1?: Vector2