Reference Source
public class | source

PickResult

Pick result returned by Scene#pick.

Member Summary

Public Members
public get

Barycentric coordinate within picked triangle.

public get

Canvas coordinates when picking with a 2D pointer.

public get

World-space 3D ray direction when raypicked.

public

entity: Entity | *

Picked entity.

public get

Picked triangle's vertex indices. Only defined when an entity and triangle was picked.

public get

Picked Local-space point on surface.

public get

World-space 3D ray origin when raypicked.

public

True when the picked surface position is full precision.

public

Index of primitive that was picked.

public

Type of primitive that was picked - usually "triangle".

public

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

Picked View-space point on surface.

public get

Normal vector at picked position on surface.

public get

Picked World-space point on surface.

Public Members

public get bary: Number[] source

Barycentric coordinate within picked triangle. Only defined when an entity and a point on its surface was picked.

Properties:

NameTypeAttributeDescription
bary *

public get canvasPos: Number[] source

Canvas coordinates when picking with a 2D pointer.

Properties:

NameTypeAttributeDescription
canvasPos *

public get direction: Number[] source

World-space 3D ray direction when raypicked.

Properties:

NameTypeAttributeDescription
direction *

public entity: Entity | * source

Picked entity. Null when no entity was picked.

Properties:

NameTypeAttributeDescription
entity *

public get indices: Int32Array source

Picked triangle's vertex indices. Only defined when an entity and triangle was picked.

Properties:

NameTypeAttributeDescription
indices *

public get localPos: Number[] source

Picked Local-space point on surface. Only defined when an entity and a point on its surface was picked.

Properties:

NameTypeAttributeDescription
localPos *

public get origin: Number[] source

World-space 3D ray origin when raypicked.

Properties:

NameTypeAttributeDescription
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:

NameTypeAttributeDescription
pickSurfacePrecision *

public primIndex: number source

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

Properties:

NameTypeAttributeDescription
primIndex *

public primitive: String source

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

Properties:

NameTypeAttributeDescription
primitive *

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. Only defined when an entity and a point on its surface was picked.

Properties:

NameTypeAttributeDescription
uv *

public get viewPos: Number[] source

Picked View-space point on surface. Only defined when an entity and a point on its surface was picked.

Properties:

NameTypeAttributeDescription
viewPos *

public get worldNormal: Number[] source

Normal vector at picked position on surface. Only defined when an entity and a point on its surface was picked.

Properties:

NameTypeAttributeDescription
worldNormal *

public get worldPos: Number[] source

Picked World-space point on surface. Only defined when an entity and a point on its surface was picked.

Properties:

NameTypeAttributeDescription
worldPos *