Class: ModelStagePlugin

Plugins.ModelStagePlugin

Hierarchy

• AViewerPlugin<"">

  ↳ ModelStagePlugin

Properties

PluginType

▪ Static PluginType: string = 'ModelStagePlugin'

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

model

• model: string | File = ''

Use setModel to change this

---

dependencies

• dependencies: typeof AssetManagerPlugin[]

---

modelRef

• modelRef: undefined | Object3DModel

---

groundBelowModel

• groundBelowModel: boolean = false

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Constructors

constructor

• new ModelStagePlugin()

Inherited from

AViewerPlugin.constructor

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

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

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

---

promptLoadModel

▸ promptLoadModel(): Promise<void>

Returns

Promise<void>

---

promptLoadModelUrl

▸ promptLoadModelUrl(): Promise<void>

Returns

Promise<void>

---

setModel

▸ setModel(mf): Promise<undefined | string | File>

Parameters

Name	Type
mf	null | string | File

Returns

Promise<undefined | string | File>

---

refreshTransform

▸ refreshTransform(): 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

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | ModelStagePlugin | Promise<null | ModelStagePlugin>

Overrides

AViewerPlugin.fromJSON

---

loadSampleModel

▸ loadSampleModel(): void

Returns

void

---

togglePlaceholders

▸ togglePlaceholders(): void

Returns

void

---

importStageViewerConfig

▸ importStageViewerConfig(): void

Returns

void

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

---

_sceneUpdate

▸ Protected _sceneUpdate(e): void

Parameters

Name	Type
e	any

Returns

void