Class PickingPlugin

Base Class for Sync Viewer Plugins

Hierarchy (view full)

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

Properties

`Protected` _dirty

_dirty: boolean = false

`Private` `Optional` _hoverWidget

_hoverWidget?: SelectionWidget

`Private` _pickUi

_pickUi: boolean

`Private` `Optional` _picker

_picker?: ObjectPicker

`Private` _uiConfigChildren

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

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

`Private` `Optional` _widget

_widget?: SelectionWidget

autoFocus

autoFocus: boolean

autoFocusHover

autoFocusHover: boolean = false

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

uiConfig

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

widgetEnabled

widgetEnabled: boolean = true

Note: this is for runtime use only, not serialized

`Static` `Readonly` OldPluginType

OldPluginType: "PickingPlugin" = 'PickingPlugin'

`Static` `Readonly` PluginType

PluginType: "Picking" = 'Picking'

Accessors

dirty

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

hoverEnabled

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

picker

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

widget

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

Methods

`Private` _hoverObjectChanged

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

`Private` _mainCameraChange

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

`Private` _onObjectHit

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

`Private` _selectedObjectChanged

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

`Protected` _storeKey

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

`Protected` _widgetEnabledChange

_widgetEnabledChange(): void
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:45

disable

disable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

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

enable

enable(key): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

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

focusObject

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

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

getSelectedObject

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

importState

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

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:80

onAdded

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

onRemove

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

setDirty

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

setSelectedObject

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

toJSON

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

Class PickingPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

selection: undefined | Class<SelectionWidget> = BoxSelectionWidget

pickUi: boolean = true

autoFocus: boolean = false

Returns PickingPlugin

Properties

Protected _dirty

Private Optional _hoverWidget

Private _pickUi

Private Optional _picker

Private _uiConfigChildren

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

Private Optional _widget

autoFocus

autoFocusHover

constructor

enabled

uiConfig

widgetEnabled

Static Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

hoverEnabled

Returns boolean

Parameters

v: boolean

Returns void

picker

Returns undefined | ObjectPicker

widget

Returns undefined | SelectionWidget

Methods

Private _hoverObjectChanged

Parameters

e: any

Returns void

Private _mainCameraChange

Returns void

Private _onObjectHit

Parameters

e: any

Returns void

Private _onObjectSelectEvent

Parameters

e: IObject3DEvent<IObject3DEventTypes>

Returns void

Private _onSceneUpdate

Parameters

e: ISceneEvent<ISceneEventTypes>

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Private _selectedObjectChanged

Parameters

e: any

Returns void

Protected _storeKey

Parameters

Optional prefix: string

`Protected` _dirty

`Private` `Optional` _hoverWidget

`Private` _pickUi

`Private` `Optional` _picker

`Private` _uiConfigChildren

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Private` `Optional` _widget

`Static` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Private` _hoverObjectChanged

`Private` _mainCameraChange

`Private` _onObjectHit

`Private` _onObjectSelectEvent

`Private` _onSceneUpdate

`Protected` _onViewerEvent

`Private` _selectedObjectChanged

`Protected` _storeKey

`Optional` prefix: string

`Protected` _widgetEnabledChange

`Optional` selected: Object3D<Event, string>

`Optional` meta: SerializationMetaType

`Optional` meta: SerializationMetaType