Class: PopmotionPlugin

Plugins.PopmotionPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ PopmotionPlugin

Properties

PluginType

▪ Static Readonly PluginType: "PopmotionPlugin"

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

toJSON

• toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

---

fromJSON

• fromJSON: any = undefined

Overrides

AViewerPlugin.fromJSON

---

dependencies

• dependencies: never[] = []

---

disableFrameFade

• disableFrameFade: boolean = true

Disable the frame fade plugin while animation is running

---

defaultDriver

• Readonly defaultDriver: Driver

---

animations

• Readonly animations: Record<string, AnimationResult> = {}

---

_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

---

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

---

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

---

animate

▸ animate<V>(options): AnimationResult

Type parameters

Name
V

Parameters

Name	Type
options	AnimationOptions<V>

Returns

AnimationResult

---

animateAsync

▸ animateAsync<V>(options): Promise<string>

Type parameters

Name
V

Parameters

Name	Type
options	AnimationOptions<V>

Returns

Promise<string>

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new PopmotionPlugin(enabled?)

Parameters

Name	Type	Default value
enabled	boolean	true

Overrides

AViewerPlugin.constructor