Class: SwitchNodePlugin

Plugins.SwitchNodePlugin

Hierarchy

• SwitchNodeBasePlugin

  ↳ SwitchNodePlugin

Properties

PluginType

▪ Static Readonly PluginType: "SwitchNodePlugin"

Defined in

webgi/src/plugins/SwitchNodePlugin.ts:8

---

enabled

• enabled: boolean = true

Inherited from

SwitchNodeBasePlugin.enabled

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:12

---

autoSnapIcons

• autoSnapIcons: boolean = false

If true, the plugin will automatically take snapshots of the icons in _refreshUi and put them in the object.userdata.__icon Otherwise, call snapIcons manually

Inherited from

SwitchNodeBasePlugin.autoSnapIcons

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:90

---

dependencies

• dependencies: typeof AssetManagerPlugin[]

Inherited from

SwitchNodeBasePlugin.dependencies

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:133

---

variations

• variations: ObjectSwitchNode[] = []

Inherited from

SwitchNodeBasePlugin.variations

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:136

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

Inherited from

SwitchNodeBasePlugin.uiConfig

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:150

---

_dirty

• Protected _dirty: boolean = false

Inherited from

SwitchNodeBasePlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

SwitchNodeBasePlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

SwitchNodeBasePlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

SwitchNodeBasePlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

---

viewer

• get viewer(): undefined | TViewer

Returns

undefined | TViewer

Inherited from

SwitchNodeBasePlugin.viewer

Defined in

webgi/src/core/AViewerPlugin.ts:29

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

SwitchNodeBasePlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:40

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

SwitchNodeBasePlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:49

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | SwitchNodePlugin | Promise<null | SwitchNodePlugin>

Inherited from

SwitchNodeBasePlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:56

---

exportState

▸ exportState(): any

Returns

any

Inherited from

SwitchNodeBasePlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:68

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

SwitchNodeBasePlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:71

---

storeState

▸ storeState(prefix?, storage?, data?): void

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

SwitchNodeBasePlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:78

---

loadState

▸ loadState(prefix?, storage?): Promise<void>

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

SwitchNodeBasePlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:88

---

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

SwitchNodeBasePlugin.onAdded

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:23

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

SwitchNodeBasePlugin.onRemove

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:38

---

refreshUi

▸ refreshUi(): void

Returns

void

Inherited from

SwitchNodeBasePlugin.refreshUi

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:81

---

snapIcons

▸ snapIcons(): void

Snapshots icons and puts in the userdata.__icon

Returns

void

Inherited from

SwitchNodeBasePlugin.snapIcons

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:106

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

SwitchNodeBasePlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:64

---

_selectedSwitchNode

▸ Protected _selectedSwitchNode(): undefined | Object3D<Event, string>

Returns

undefined | Object3D<Event, string>

Inherited from

SwitchNodeBasePlugin._selectedSwitchNode

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:138

---

_refreshUi

▸ Protected _refreshUi(): boolean

Returns

boolean

Overrides

SwitchNodeBasePlugin._refreshUi

Defined in

webgi/src/plugins/SwitchNodePlugin.ts:10

Constructors

constructor

• new SwitchNodePlugin()

Inherited from

SwitchNodeBasePlugin.constructor

Defined in

webgi/src/plugins/SwitchNodeBasePlugin.ts:16