Class: Object3DWidgetsPlugin

UI-Plugins.Object3DWidgetsPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ Object3DWidgetsPlugin

Properties

PluginType

▪ Static Readonly PluginType: "WidgetsPlugin"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

helpers

• helpers: IObject3DHelper<Object3D<Object3DEventMap> & IWidget<any, IObject3DEventMap>>[]

---

toJSON

• toJSON: any = null

Overrides

AViewerPlugin.toJSON

---

widgets

• widgets: IWidget<any, IObject3DEventMap>[] = []

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

---

_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

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | Object3DWidgetsPlugin | Promise<null | Object3DWidgetsPlugin>

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

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

---

refresh

▸ refresh(): void

Returns

void

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new Object3DWidgetsPlugin(enabled?)

Parameters

Name	Type	Default value
enabled	boolean	true

Overrides

AViewerPlugin.constructor