Documentation / @giro3d/piero / index / Picker

Interface: Picker

Defined in: packages/piero/src/services/picking.ts:46

Methods

filterPick()

protected filterPick(instance, result): boolean

Defined in: packages/piero/src/services/picking.ts:259

Parameters

instance

Instance

result

PickResult

Returns

boolean

---

getAttributesFromAnnotation()

protected getAttributesFromAnnotation(pickResult, attributesGroups): void

Defined in: packages/piero/src/services/picking.ts:291

Parameters

pickResult

ShapePickResult

attributesGroups

AttributesGroups

Returns

void

---

getAttributesFromEntity()

protected getAttributesFromEntity(entity, attributesGroups): void

Defined in: packages/piero/src/services/picking.ts:350

Parameters

entity

Entity

attributesGroups

AttributesGroups

Returns

void

---

getAttributesFromMeasure()

protected getAttributesFromMeasure(pickResult, attributesGroups): void

Defined in: packages/piero/src/services/picking.ts:361

Parameters

pickResult

PickResult

attributesGroups

AttributesGroups

Returns

void

---

getAttributesFromObject3D()

protected getAttributesFromObject3D(object, attributes): void

Defined in: packages/piero/src/services/picking.ts:393

Parameters

object

Object3D

attributes

Attribute[]

Returns

void

---

getAttributesFromOLFeature()

protected getAttributesFromOLFeature(feature, attributesGroups): void

Defined in: packages/piero/src/services/picking.ts:407

Parameters

feature

Feature

attributesGroups

AttributesGroups

Returns

void

---

getAttributesFromPickedObject3D()

protected getAttributesFromPickedObject3D(pickResult, attributesGroups): void

Defined in: packages/piero/src/services/picking.ts:427

Parameters

pickResult

PickResult

attributesGroups

AttributesGroups

Returns

void

---

getAttributesFromPointCloud()

protected getAttributesFromPointCloud(pickResult, attributesGroups): void

Defined in: packages/piero/src/services/picking.ts:439

Parameters

pickResult

PointsPickResult

attributesGroups

AttributesGroups

Returns

void

---

getAttributesFromUserData()

protected getAttributesFromUserData(userData, attributes): void

Defined in: packages/piero/src/services/picking.ts:446

Parameters

userData

object

attributes

Attribute[]

Returns

void

---

getDatasetAttributes()

protected getDatasetAttributes(object, datasetAttributes): void

Defined in: packages/piero/src/services/picking.ts:482

Parameters

object

Object3D

datasetAttributes

Attribute[]

Returns

void

---

getFeatureFromPickedObject()

getFeatureFromPickedObject(pickedObject): Feature | null

Defined in: packages/piero/src/services/picking.ts:49

Parameters

pickedObject

PickResult

Returns

Feature | null

---

getFirstFeatureAt()

getFirstFeatureAt(instance, e, radius?, filterOnObjects?): PickResult<unknown>[] | null

Defined in: packages/piero/src/services/picking.ts:123

Parameters

instance

Instance

e

Vector2 | MouseEvent

radius?

number = 1

filterOnObjects?

(obj) => boolean

Returns

PickResult<unknown>[] | null

---

getGeometryAttributes()

getGeometryAttributes(object, attributes): void

Defined in: packages/piero/src/services/picking.ts:142

Parameters

object

Object3D

attributes

Attribute[]

Returns

void

---

getMapAt()

getMapAt(instance, e, radius?): PickResult<unknown> | null

Defined in: packages/piero/src/services/picking.ts:173

Gets the point on map or grid where the user clicked.

Parameters

instance

Instance

e

Vector2 | MouseEvent

Mouse event

radius?

number = 1

Radius - the smaller, the faster and more precise (but may return nothing)

Returns

PickResult<unknown> | null

Result or null if nothing found

---

getMouseCoordinate()

getMouseCoordinate(instance, mouse): Vector3 | null

Defined in: packages/piero/src/services/picking.ts:187

Parameters

instance

Instance

mouse

Vector2

Returns

Vector3 | null

---

getNameFromOLFeature()

protected getNameFromOLFeature(feature): string

Defined in: packages/piero/src/services/picking.ts:494

Parameters

feature

Feature

Returns

string

---

getObjectsAt()

getObjectsAt(instance, e, radius?, filterOnObjects?): PickResult<unknown>[] | null

Defined in: packages/piero/src/services/picking.ts:209

Gets the closest dataset object from where the user clicked. Does NOT pick on the base map!

Parameters

instance

Instance

e

Vector2 | MouseEvent

Mouse event

radius?

number = 1

Radius - the smaller, the faster and more precise (but may return nothing)

filterOnObjects?

(obj) => boolean

Returns

PickResult<unknown>[] | null

Result or null if notthing found

---

hasFeature()

hasFeature(instance, mouse): boolean

Defined in: packages/piero/src/services/picking.ts:232

Parameters

instance

Instance

mouse

Vector2

Returns

boolean

---

pick()

pick(instance, event): { feature: Feature | null; pickResult: PickResult; point: Vector3; } | null

Defined in: packages/piero/src/services/picking.ts:245

Parameters

instance

Instance

event

Vector2 | MouseEvent

Returns

{ feature: Feature | null; pickResult: PickResult; point: Vector3; } | null