Class: PopmotionPlugin
Plugins.PopmotionPlugin
Hierarchy
AViewerPlugin<"">↳
PopmotionPlugin
Properties
PluginType
▪ Static Readonly PluginType: "PopmotionPlugin"
Defined in
webgi/src/plugins/PopmotionPlugin.ts:19
enabled
• enabled: boolean = true
Overrides
Defined in
webgi/src/plugins/PopmotionPlugin.ts:20
toJSON
• toJSON: any = undefined
Overrides
Defined in
webgi/src/plugins/PopmotionPlugin.ts:22
fromJSON
• fromJSON: any = undefined
Overrides
Defined in
webgi/src/plugins/PopmotionPlugin.ts:23
dependencies
• dependencies: never[] = []
Defined in
webgi/src/plugins/PopmotionPlugin.ts:35
disableFrameFade
• disableFrameFade: boolean = true
Disable the frame fade plugin while animation is running
Defined in
webgi/src/plugins/PopmotionPlugin.ts:41
defaultDriver
• Readonly defaultDriver: Driver
Defined in
webgi/src/plugins/PopmotionPlugin.ts:95
animations
• Readonly animations: Record<string, AnimationResult> = {}
Defined in
webgi/src/plugins/PopmotionPlugin.ts:112
_dirty
• Protected _dirty: boolean = false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:25
_viewer
• Protected Optional _viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:29
Accessors
dirty
• get dirty(): boolean
Returns
boolean
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:18
• set dirty(value): void
Parameters
| Name | Type |
|---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:22
Methods
onDispose
▸ onDispose(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:38
addEventListener
▸ addEventListener(type, listener): void
Adds a listener to an event type.
Parameters
| Name | Type |
|---|---|
type | "" | "serialize" | "deserialize" |
listener | (event: IEvent<"" | "serialize" | "deserialize">) => void |
Returns
void
Inherited from
AViewerPlugin.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:48
hasEventListener
▸ hasEventListener(type, listener): boolean
Checks if listener is added to an event type.
Parameters
| Name | Type |
|---|---|
type | "" | "serialize" | "deserialize" |
listener | (event: IEvent<"" | "serialize" | "deserialize">) => void |
Returns
boolean
Inherited from
AViewerPlugin.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:56
removeEventListener
▸ removeEventListener(type, listener): void
Removes a listener from an event type.
Parameters
| Name | Type |
|---|---|
type | "" | "serialize" | "deserialize" |
listener | (event: IEvent<"" | "serialize" | "deserialize">) => void |
Returns
void
Inherited from
AViewerPlugin.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:63
dispatchEvent
▸ dispatchEvent(event): void
Fire an event type.
Parameters
| Name | Type |
|---|---|
event | IEvent<"" | "serialize" | "deserialize"> |
Returns
void
Inherited from
Defined in
webgi/src/helpers/EventDispatcher.ts:74
onAdded
▸ onAdded(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
Defined in
webgi/src/plugins/PopmotionPlugin.ts:102
onRemove
▸ onRemove(viewer): Promise<void>
Parameters
| Name | Type |
|---|---|
viewer | ViewerApp |
Returns
Promise<void>
Overrides
Defined in
webgi/src/plugins/PopmotionPlugin.ts:107
animate
▸ animate<V>(options): AnimationResult
Type parameters
| Name |
|---|
V |
Parameters
| Name | Type |
|---|---|
options | AnimationOptions<V> |
Returns
Defined in
webgi/src/plugins/PopmotionPlugin.ts:114
animateAsync
▸ animateAsync<V>(options): Promise<string>
Type parameters
| Name |
|---|
V |
Parameters
| Name | Type |
|---|---|
options | AnimationOptions<V> |
Returns
Promise<string>
Defined in
webgi/src/plugins/PopmotionPlugin.ts:149
Constructors
constructor
• new PopmotionPlugin(enabled?)
Parameters
| Name | Type | Default value |
|---|---|---|
enabled | boolean | true |