Class PickingPlugin

Base Class for Sync Viewer Plugins

Hierarchy (View Summary)

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

Constructors

constructor

new PickingPlugin(
    selection?: undefined | Class<SelectionWidget>,
    pickUi?: boolean,
    autoFocus?: boolean,
): 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:59

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

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

autoFocus

autoFocus: boolean

autoFocusHover

autoFocusHover: boolean = false

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enabled

enabled: boolean = true

uiConfig

uiConfig: UiObjectConfig = ...

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: boolean): 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:25
set hoverEnabled(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in src/plugins/interaction/PickingPlugin.ts:28

picker

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

widget

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

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: 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:46

disable

disable(key: any): 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:172

enable

enable(key: any): 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?: Object3D): Promise<void>
Parameters
- Optionalselected: Object3D
Returns Promise<void>
- Defined in src/plugins/interaction/PickingPlugin.ts:268

fromJSON

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

getSelectedObject

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

importState

importState(state: any): 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

setSelectedObject

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

toJSON

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

Class PickingPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PickingPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

autoFocus

autoFocusHover

constructor

enabled

uiConfig

widgetEnabled

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

hoverEnabled

Returns boolean

Parameters

Returns void

picker

Returns undefined | ObjectPicker

widget

Returns undefined | SelectionWidget

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

Protected_widgetEnabledChange

Returns void

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

focusObject

Parameters

Returns Promise<void>

fromJSON

Parameters

Returns null | PickingPlugin | Promise<null | PickingPlugin>

getSelectedObject

Type Parameters

Returns undefined | T

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

setDirty

Returns void

setSelectedObject

Parameters

Returns void

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Protected`_widgetEnabledChange