Interface ShapePickResult

The picking result for shapes.

interface ShapePickResult {
    barycoord?: null | Vector3;
    batchId?: number;
    distance: number;
    distanceToRay?: number;
    entity: entities.Shape<EntityUserData>;
    face?: null | Face;
    faceIndex?: null | number;
    features?: unknown[];
    index?: number;
    instanceId?: number;
    isShapePickResult: true;
    normal?: Vector3;
    object: Object3D<Object3DEventMap>;
    pickedLabel?: boolean;
    pickedSegment?: number;
    pickedSurface?: boolean;
    pickedVertexIndex?: number;
    point: Vector3;
    pointOnLine?: Vector3;
    uv?: Vector2;
    uv1?: Vector2;
}

Hierarchy (view full)

Properties

barycoord? batchId? distance distanceToRay? entity face? faceIndex? features? index? instanceId? isShapePickResult normal? object pickedLabel? pickedSegment? pickedSurface? pickedVertexIndex? point pointOnLine? uv? uv1?

Properties

Optionalbarycoord

barycoord?: null | Vector3

OptionalbatchId

batchId?: number

distance

distance: number

Distance from the camera to the picked result.

OptionaldistanceToRay

distanceToRay?: number

entity

entity: entities.Shape<EntityUserData>

Entity picked

Optionalface

face?: null | Face

Intersected face

OptionalfaceIndex

faceIndex?: null | number

Index of the intersected face

Optionalfeatures

features?: unknown[]

Features picked (if pickFeatures enabled).

Optionalindex

index?: number

OptionalinstanceId

instanceId?: number

The index number of the instance where the ray intersects the THREE.InstancedMesh | InstancedMesh

isShapePickResult

isShapePickResult

Optionalnormal

normal?: Vector3

object

object: Object3D<Object3DEventMap>

THREE.js object picked.

OptionalpickedLabel

pickedLabel?: boolean

true if a label was picked, false otherwise.

OptionalpickedSegment

pickedSegment?: number

The index of the first point that makes the picked segment, otherwise null.

OptionalpickedSurface

pickedSurface?: boolean

true if the surface was picked, false otherwise.

OptionalpickedVertexIndex

pickedVertexIndex?: number

The index of the picked vertex, otherwise null.

point

point: Vector3

Point picked.

OptionalpointOnLine

pointOnLine?: Vector3

Optionaluv

uv?: Vector2

Optionaluv1

uv1?: Vector2

Settings

Member Visibility

On This Page

Properties