Class PopmotionPlugin

Popmotion plugin

Provides animation capabilities to the viewer using the popmotion library: https://popmotion.io/

Overrides the driver in popmotion to sync with the viewer and provide ways to keep track and stop animations.

Hierarchy (View Summary)

AViewerPluginSync<"">
- PopmotionPlugin

Constructors

constructor

new PopmotionPlugin(enabled?: boolean): PopmotionPlugin
Parameters
- enabled: boolean = true
Returns PopmotionPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/animation/PopmotionPlugin.ts:38

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

`Readonly`animations

animations: Record<string, AnimationResult> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

`Readonly`defaultDriver

defaultDriver: Driver = ...

dependencies

dependencies: never[] = []

disableFrameFade

disableFrameFade: boolean = true

Disable the frame fade plugin while animation is running

enabled

enabled: boolean = true

fromJSON

fromJSON: any = undefined

toJSON

toJSON: any = undefined

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "PopmotionPlugin" = 'PopmotionPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:49

animate

animate<V>(
options1: AnimationOptions<V> & { key?: string; target?: any },
): AnimationResult
Type Parameters
- V
Parameters
- options1: AnimationOptions<V> & { key?: string; target?: any }
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:132

animateAsync

animateAsync<V>(
options: AnimationOptions<V> & { key?: string; target?: any },
animations?: AnimationResult[],
): Promise<string>
Type Parameters
- V
Parameters
- options: AnimationOptions<V> & { key?: string; target?: any }
- Optionalanimations: AnimationResult[]
Returns Promise<string>
- Defined in src/plugins/animation/PopmotionPlugin.ts:225

animateCamera

animateCamera(
    camera: ICamera,
    view: ICameraView,
    spherical?: boolean,
    options?: Partial<AnimationOptions<any>>,
): AnimationResult
Parameters
- camera: ICamera
- view: ICameraView
- spherical: boolean = true
- Optionaloptions: Partial<AnimationOptions<any>>
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:237

animateCameraAsync

animateCameraAsync(
    camera: ICamera,
    view: ICameraView,
    spherical?: boolean,
    options?: Partial<AnimationOptions<any>>,
    animations?: AnimationResult[],
): Promise<string>
Parameters
- camera: ICamera
- view: ICameraView
- spherical: boolean = true
- Optionaloptions: Partial<AnimationOptions<any>>
- Optionalanimations: AnimationResult[]
Returns Promise<string>
- Defined in src/plugins/animation/PopmotionPlugin.ts:247

animateTarget

animateTarget<T>(
    target: T,
    key: keyof T,
    options: AnimationOptions<T[keyof T]>,
): AnimationResult
Type Parameters
- T
Parameters
- target: T
- key: keyof T
- options: AnimationOptions<T[keyof T]>
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:128

animateTargetAsync

animateTargetAsync<T>(
    target: T,
    key: keyof T,
    options: AnimationOptions<T[keyof T]>,
    animations?: AnimationResult[],
): Promise<string>
Type Parameters
- T
Parameters
- target: T
- key: keyof T
- options: AnimationOptions<T[keyof T]>
- Optionalanimations: AnimationResult[]
Returns Promise<string>
- Defined in src/plugins/animation/PopmotionPlugin.ts:231

disable

disable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:29

enable

enable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:54

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:57

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:80

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/animation/PopmotionPlugin.ts:116

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/animation/PopmotionPlugin.ts:121

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

Class PopmotionPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PopmotionPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

Readonlyanimations

constructor

ReadonlydefaultDriver

dependencies

disableFrameFade

enabled

fromJSON

toJSON

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

animate

Type Parameters

Parameters

Returns AnimationResult

animateAsync

Type Parameters

Parameters

Returns Promise<string>

animateCamera

Parameters

Returns AnimationResult

animateCameraAsync

Parameters

Returns Promise<string>

animateTarget

Type Parameters

Parameters

Returns AnimationResult

animateTargetAsync

Type Parameters

Parameters

Returns Promise<string>

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`animations

`Readonly`defaultDriver

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty