Class PickingPlugin

Base Class for Sync Viewer Plugins

Hierarchy

AViewerPluginSync<"selectedObjectChanged" | "hoverObjectChanged" | "hitObject">
- PickingPlugin

Constructors

constructor

new PickingPlugin(selection?, pickUi?, autoFocus?): PickingPlugin
Parameters
- selection: undefined | Class<SelectionWidget> = BoxSelectionWidget
- pickUi: boolean = true
- autoFocus: boolean = false
Returns PickingPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/interaction/PickingPlugin.ts:35

Properties

`Protected` _dirty

_dirty: boolean = false

`Private` _enableWidget

_enableWidget: boolean = true

`Private` _pickUi

_pickUi: boolean

`Private` `Optional` _picker

_picker?: ObjectPicker

`Private` _uiConfigChildren

_uiConfigChildren: UiObjectConfig<any, string, any>[] = ...

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Private` `Optional` _widget

_widget?: SelectionWidget

autoFocus

autoFocus: boolean = false

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

`Static` `Readonly` PluginType

PluginType: "Picking" = 'Picking'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:81
set dirty(value): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:85

hoverEnabled

get hoverEnabled(): boolean
Returns boolean
- Defined in src/plugins/interaction/PickingPlugin.ts:20
set hoverEnabled(v): void
Parameters
- v: boolean
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:23

picker

get picker(): undefined | ObjectPicker
Returns undefined | ObjectPicker
- Defined in src/plugins/interaction/PickingPlugin.ts:12

widget

get widget(): undefined | SelectionWidget
Returns undefined | SelectionWidget
- Defined in src/plugins/interaction/PickingPlugin.ts:240

Methods

`Private` _mainCameraChange

_mainCameraChange(): void
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:135

`Private` _onObjectHit

_onObjectHit(e): void
Parameters
- e: any
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:185

`Private` _onObjectSelectEvent

_onObjectSelectEvent(e): void
Parameters
- e: IObject3DEvent<IObject3DEventTypes>
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:149

`Private` _onSceneUpdate

_onSceneUpdate(e): void
Parameters
- e: ISceneEvent<ISceneEventTypes>
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:139

`Private` _selectedObjectChanged

_selectedObjectChanged(e): void
Parameters
- e: any
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:155

`Protected` _storeKey

_storeKey(prefix?): string
Parameters
- Optional prefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:47

dispose

dispose(): void
Returns void
Overrides AViewerPluginSync.dispose
- Defined in src/plugins/interaction/PickingPlugin.ts:130

enableWidget

enableWidget(enable): void
Parameters
- enable: boolean
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:198

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:52

focusObject

focusObject(selected?): Promise<void>
Parameters
- Optional selected: Object3D<Event, string>
Returns Promise<void>
- Defined in src/plugins/interaction/PickingPlugin.ts:194

fromJSON

fromJSON(data, meta?): null | PickingPlugin | Promise<null | PickingPlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | PickingPlugin | Promise<null | PickingPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:39

getSelectedObject

getSelectedObject<T>(): undefined | T
Type Parameters
- T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
Returns undefined | T
- Defined in src/plugins/interaction/PickingPlugin.ts:45

importState

importState(state): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:55

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/interaction/PickingPlugin.ts:60

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/interaction/PickingPlugin.ts:113

setDirty

setDirty(): void
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:32

setSelectedObject

setSelectedObject(object, focusCamera?): void
Parameters
- object: undefined | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
- focusCamera: boolean = false
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:50

toJSON

toJSON(meta?): ISerializedConfig
Parameters
- Optional meta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:31

Generated using TypeDoc