Class: PickingPlugin

Interaction.PickingPlugin

Hierarchy

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

  ↳ PickingPlugin

Properties

PluginType

▪ Static Readonly PluginType: "Picking"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

autoFocus

• autoFocus: boolean = false

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

---

widgetEnabled

• get widgetEnabled(): boolean

Returns

boolean

---

picker

• get picker(): undefined | ObjectPicker

Returns

undefined | ObjectPicker

---

uiConfig

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

Returns

UiObjectConfig<any, string>

---

widget

• get widget(): undefined | SelectionWidget

Returns

undefined | SelectionWidget

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

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

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

setDirty

▸ setDirty(): void

Returns

void

---

getSelectedObject

▸ getSelectedObject<T>(): undefined | T

Type parameters

Name	Type
T	extends Object3D<Object3DEventMap> | IModel<any, IObject3DEventMap> = IModel<any, IObject3DEventMap> & Object3D<Object3DEventMap>

Returns

undefined | T

---

setSelectedObject

▸ setSelectedObject(object, focusCamera?): void

Parameters

Name	Type	Default value
object	undefined | Object3D<Object3DEventMap>	undefined
focusCamera	boolean	false

Returns

void

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

focusObject

▸ focusObject(selected?): Promise<void>

Parameters

Name	Type
selected?	Object3D<Object3DEventMap>

Returns

Promise<void>

---

enableWidget

▸ enableWidget(enable): void

Parameters

Name	Type
enable	boolean

Returns

void

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

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