Skip to main content

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


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:18

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22


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

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:42


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:47


fromJSON

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

Parameters

NameType
dataany
meta?any

Returns

null | PickingPlugin | Promise<null | PickingPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:54


setDirty

setDirty(): void

Returns

void

Defined in

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


getSelectedObject

getSelectedObject<T>(): undefined | T

Type parameters

NameType
Textends IModel<any> | Object3D<Event> = IModel<any> & Object3D<Event>

Returns

undefined | T

Defined in

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


setSelectedObject

setSelectedObject(object, focusCamera?): void

Parameters

NameTypeDefault value
objectundefined | Object3D<Event>undefined
focusCamerabooleanfalse

Returns

void

Defined in

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


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

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


focusObject

focusObject(selected?): Promise<void>

Parameters

NameType
selected?Object3D<Event>

Returns

Promise<void>

Defined in

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


enableWidget

enableWidget(enable): void

Parameters

NameType
enableboolean

Returns

void

Defined in

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


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
type"serialize" | "deserialize" | "selectedObjectChanged" | "hoverObjectChanged" | "hitObject"
listener(event: IEvent<"serialize" | "deserialize" | "selectedObjectChanged" | "hoverObjectChanged" | "hitObject">) => void

Returns

void

Inherited from

AViewerPlugin.addEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:48


hasEventListener

hasEventListener(type, listener): boolean

Checks if listener is added to an event type.

Parameters

NameType
type"serialize" | "deserialize" | "selectedObjectChanged" | "hoverObjectChanged" | "hitObject"
listener(event: IEvent<"serialize" | "deserialize" | "selectedObjectChanged" | "hoverObjectChanged" | "hitObject">) => void

Returns

boolean

Inherited from

AViewerPlugin.hasEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:56


removeEventListener

removeEventListener(type, listener): void

Removes a listener from an event type.

Parameters

NameType
type"serialize" | "deserialize" | "selectedObjectChanged" | "hoverObjectChanged" | "hitObject"
listener(event: IEvent<"serialize" | "deserialize" | "selectedObjectChanged" | "hoverObjectChanged" | "hitObject">) => void

Returns

void

Inherited from

AViewerPlugin.removeEventListener

Defined in

webgi/src/helpers/EventDispatcher.ts:63


dispatchEvent

dispatchEvent(event): void

Fire an event type.

Parameters

NameType
eventIEvent<"serialize" | "deserialize" | "selectedObjectChanged" | "hoverObjectChanged" | "hitObject">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74

Constructors

constructor

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

Parameters

NameTypeDefault value
selectionundefined | Class<SelectionWidget>BoxSelectionWidget
controlsbooleanfalse
pickUibooleantrue
autoFocusbooleanfalse

Overrides

AViewerPlugin.constructor

Defined in

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