import {PickResult} from '@xeokit/xeokit-sdk/src/viewer/scene/webgl/PickResult.js'

public class | source

PickResult

Pick result returned by Scene#pick.

Member Summary

Public Members
public get	bary: Number[] Barycentric coordinate within picked triangle.
public get	canvasPos: Number[] Canvas pick coordinates.
public get	direction: Number[] World-space 3D ray direction when raypicked.
public	entity: Entity \| * Picked entity.
public get	indices: Int32Array Picked triangle's vertex indices.
public get	localPos: Number[] Picked Local-space point.
public get	origin: Number[] World-space 3D ray origin when raypicked.
public	pickSurfacePrecision: Boolean True when the picked surface position is full precision.
public	primIndex: number Index of primitive that was picked.
public	primitive: String Type of primitive that was picked - usually "triangle".
public get	snapped: boolean: * True if snapped to edge or vertex.
public get	snappedCanvasPos: Number[] Canvas cursor coordinates, snapped when snap picking, otherwise same as PickResult#pointerPos.
public	snappedToEdge: boolean True when snapped to nearest edge.
public	snappedToVertex: boolean True when snapped to nearest vertex.
public	touchInput: boolean True when picked from touch input, else false when from mouse input.
public get	uv: Number[] UV coordinates at picked position on surface.
public get	viewPos: Number[] Picked View-space point.
public get	worldNormal: Number[] Normal vector at picked position on surface.
public get	worldPos: Number[] Picked World-space point.

Public Members

public get bary: Number[] source

Barycentric coordinate within picked triangle.

Properties:

Name	Type	Attribute	Description
bary	*

public get canvasPos: Number[] source

Canvas pick coordinates.

Properties:

Name	Type	Attribute	Description
canvasPos	*

public get direction: Number[] source

World-space 3D ray direction when raypicked.

Properties:

Name	Type	Attribute	Description
direction	*

public entity: Entity | * source

Picked entity. Null when no entity was picked.

Properties:

Name	Type	Attribute	Description
entity	*

public get indices: Int32Array source

Picked triangle's vertex indices.

Properties:

Name	Type	Attribute	Description
indices	*

public get localPos: Number[] source

Picked Local-space point.

Properties:

Name	Type	Attribute	Description
localPos	*

public get origin: Number[] source

World-space 3D ray origin when raypicked.

Properties:

Name	Type	Attribute	Description
origin	*

public pickSurfacePrecision: Boolean source

True when the picked surface position is full precision. When false, the picked surface position should be regarded as approximate. Full-precision surface picking is performed with the Scene#pick method's pickSurfacePrecision option.

Properties:

Name	Type	Attribute	Description
pickSurfacePrecision	*

public primIndex: number source

Index of primitive that was picked. -1 when no entity was picked.

Properties:

Name	Type	Attribute	Description
primIndex	*

public primitive: String source

Type of primitive that was picked - usually "triangle". Null when no primitive was picked.

Properties:

Name	Type	Attribute	Description
primitive	*

public get snapped: boolean: * source

True if snapped to edge or vertex.

Return:

boolean

public get snappedCanvasPos: Number[] source

Canvas cursor coordinates, snapped when snap picking, otherwise same as PickResult#pointerPos.

Properties:

Name	Type	Attribute	Description
snappedCanvasPos	*

public snappedToEdge: boolean source

True when snapped to nearest edge.

public snappedToVertex: boolean source

True when snapped to nearest vertex.

public touchInput: boolean source

True when picked from touch input, else false when from mouse input.

public get uv: Number[] source

UV coordinates at picked position on surface.

Properties:

Name	Type	Attribute	Description
uv	*

public get viewPos: Number[] source

Picked View-space point.

Properties:

Name	Type	Attribute	Description
viewPos	*

public get worldNormal: Number[] source

Normal vector at picked position on surface.

Properties:

Name	Type	Attribute	Description
worldNormal	*

public get worldPos: Number[] source

Picked World-space point.

Properties:

Name	Type	Attribute	Description
worldPos	*