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 full)

AViewerPluginSync<"">
- PopmotionPlugin

Constructors

constructor

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

Properties

`Protected` _dirty

_dirty: boolean = false

`Private` _fadeDisabled

_fadeDisabled: boolean = false

`Private` _lastFrameTime

_lastFrameTime: number = 0

`Private` _updaters

_updaters: {
time: number;
u: ((timestamp) => void);
}[] = []

Type declaration

time: number
u: ((timestamp) => void)
- - (timestamp): void
  - Parameters
    - timestamp: number
    Returns void

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns 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<any, string, any> = undefined

`Static` `Readonly` PluginType

PluginType: "PopmotionPlugin" = 'PopmotionPlugin'

Accessors

dirty

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

Methods

`Protected` _onViewerEvent

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

`Private` _postFrame

_postFrame(): void
Returns void
- Defined in src/plugins/animation/PopmotionPlugin.ts:58

`Protected` _storeKey

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

animate

animate<V>(options1): 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, animations?): Promise<string>
Type Parameters
- V
Parameters
- options: AnimationOptions<V> & {
  key?: string;
  target?: any;
  }
- Optional animations: AnimationResult[]
Returns Promise<string>
- Defined in src/plugins/animation/PopmotionPlugin.ts:213

animateCamera

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

animateCameraAsync

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

animateTarget

animateTarget<T>(target, key, options): 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, key, options, animations?): Promise<string>
Type Parameters
- T
Parameters
- target: T
- key: keyof T
- options: AnimationOptions<T[keyof T]>
- Optional animations: AnimationResult[]
Returns Promise<string>
- Defined in src/plugins/animation/PopmotionPlugin.ts:219

disable

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

dispose

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

enable

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

exportState

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

`Optional` setDirty

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

Class PopmotionPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

enabled: boolean = true

Returns PopmotionPlugin

Properties

Protected _dirty

Private _fadeDisabled

Private _lastFrameTime

Private _updaters

Type declaration

time: number

u: ((timestamp) => void)

Parameters

timestamp: number

Returns void

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

Readonly animations

constructor

Readonly defaultDriver

dependencies

disableFrameFade

enabled

fromJSON

toJSON

Optional uiConfig

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Private _postFrame

Returns void

Protected _storeKey

Parameters

Optional prefix: string

Returns string

animate

Type Parameters

V

Parameters

options1: AnimationOptions<V> & { key?: string; target?: any; }

Returns AnimationResult

animateAsync

Type Parameters

V

Parameters

options: AnimationOptions<V> & { key?: string; target?: any; }

Optional animations: AnimationResult[]

Returns Promise<string>

animateCamera

Parameters

camera: ICamera<ICameraEvent, ICameraEventTypes>

view: ICameraView

spherical: boolean = true

Optional options: Partial<AnimationOptions<any>>

Returns AnimationResult

animateCameraAsync

Parameters

camera: ICamera<ICameraEvent, ICameraEventTypes>

view: ICameraView

`Protected` _dirty

`Private` _fadeDisabled

`Private` _lastFrameTime

`Private` _updaters

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Readonly` animations

`Readonly` defaultDriver

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _onViewerEvent

`Private` _postFrame

`Protected` _storeKey

`Optional` prefix: string

options1: AnimationOptions<V> & {
key?: string;
target?: any;
}

options: AnimationOptions<V> & {
key?: string;
target?: any;
}

`Optional` animations: AnimationResult[]

`Optional` options: Partial<AnimationOptions<any>>

`Optional` options: Partial<AnimationOptions<any>>

`Optional` animations: AnimationResult[]

`Optional` animations: AnimationResult[]

`Optional` setDirty

`Rest` ...args: any[]