Class: PickingPlugin

Interaction.PickingPlugin

Hierarchy

• AViewerPlugin<"selectedObjectChanged" | "hoverObjectChanged" | "hitObject">

  ↳ PickingPlugin

Properties

PluginType

▪ Static Readonly PluginType: "Picking"

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:23

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:17

---

autoFocus

• autoFocus: boolean = false

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:31

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

picker

• get picker(): undefined | ObjectPicker

Returns

undefined | ObjectPicker

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:20

---

uiConfig

• get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:207

---

transformControls

• get transformControls(): undefined | TransformControls & IWidget<any>

Returns

undefined | TransformControls & IWidget<any>

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:221

---

widget

• get widget(): undefined | SelectionWidget

Returns

undefined | SelectionWidget

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:224

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45

---

fromJSON

▸ fromJSON(data, meta?): null | PickingPlugin | Promise<null | PickingPlugin>

Parameters

Name	Type
data	any
meta?	any

Returns

null | PickingPlugin | Promise<null | PickingPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84

---

setDirty

▸ setDirty(): void

Returns

void

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:33

---

getSelectedObject

▸ getSelectedObject<T>(): undefined | T

Type parameters

Name	Type
T	extends Object3D<Event, string> | IModel<any> = IModel<any> & Object3D<Event, string>

Returns

undefined | T

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:46

---

setSelectedObject

▸ setSelectedObject(object, focusCamera?): void

Parameters

Name	Type	Default value
object	undefined | Object3D<Event, string>	undefined
focusCamera	boolean	false

Returns

void

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:51

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:61

---

focusObject

▸ focusObject(selected?): Promise<void>

Parameters

Name	Type
selected?	Object3D<Event, string>

Returns

Promise<void>

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:170

---

enableWidget

▸ enableWidget(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:175

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60

Constructors

constructor

• new PickingPlugin(selection?, controls?, pickUi?, autoFocus?)

Parameters

Name	Type	Default value
selection	undefined | Class<SelectionWidget>	BoxSelectionWidget
controls	boolean	false
pickUi	boolean	true
autoFocus	boolean	false

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/extras/interaction/PickingPlugin.ts:36