Skip to main content

Class: PopmotionPlugin

Plugins.PopmotionPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "PopmotionPlugin"

Defined in

webgi/src/plugins/PopmotionPlugin.ts:19


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/PopmotionPlugin.ts:20


toJSON

toJSON: any = undefined

Overrides

AViewerPlugin.toJSON

Defined in

webgi/src/plugins/PopmotionPlugin.ts:22


fromJSON

fromJSON: any = undefined

Overrides

AViewerPlugin.fromJSON

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

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:25


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

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

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:22

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:38


addEventListener

addEventListener(type, listener): void

Adds a listener to an event type.

Parameters

NameType
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

NameType
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

NameType
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

NameType
eventIEvent<"" | "serialize" | "deserialize">

Returns

void

Inherited from

AViewerPlugin.dispatchEvent

Defined in

webgi/src/helpers/EventDispatcher.ts:74


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/PopmotionPlugin.ts:102


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/PopmotionPlugin.ts:107


animate

animate<V>(options): AnimationResult

Type parameters

Name
V

Parameters

NameType
optionsAnimationOptions<V>

Returns

AnimationResult

Defined in

webgi/src/plugins/PopmotionPlugin.ts:114


animateAsync

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

Type parameters

Name
V

Parameters

NameType
optionsAnimationOptions<V>

Returns

Promise<string>

Defined in

webgi/src/plugins/PopmotionPlugin.ts:149

Constructors

constructor

new PopmotionPlugin(enabled?)

Parameters

NameTypeDefault value
enabledbooleantrue

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/PopmotionPlugin.ts:25