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:49

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

`Readonly`animations

animations: Record<string, AnimationResult> = {}

autoIncrementTime

autoIncrementTime: boolean = true

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

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`timelineDriver

timelineDriver: Driver = ...

toJSON

toJSON: any = undefined

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = 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:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

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

`Protected`_storeKey

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

animate

animate<V>(
    options1: AnimationOptions<V> & { key?: string; target?: any },
    animateFunc?:
        | (<V = number>(__namedParameters: AnimationOptions<V>) => {})
        | (
            <V = number>(
                __namedParameters: KeyframeOptions<V> & Omit<
                    PlaybackOptions<V>,
                    "type" | "repeat" | "repeatType" | "repeatDelay" | "onRepeat",
                > & { canComplete?: boolean; delay?: number },
            ) => { stop: () => void }
        ),
): AnimationResult
Type Parameters
- V
Parameters
- options1: AnimationOptions<V> & { key?: string; target?: any }
- OptionalanimateFunc:
      | (<V = number>(__namedParameters: AnimationOptions<V>) => {})
      | (
          <V = number>(
              __namedParameters: KeyframeOptions<V> & Omit<
                  PlaybackOptions<V>,
                  "type" | "repeat" | "repeatType" | "repeatDelay" | "onRepeat",
              > & { canComplete?: boolean; delay?: number },
          ) => { stop: () => void }
      )
  - <V = number>(__namedParameters: AnimationOptions<V>) => {}
  - <V = number>(
        __namedParameters: KeyframeOptions<V> & Omit<
            PlaybackOptions<V>,
            "type" | "repeat" | "repeatType" | "repeatDelay" | "onRepeat",
        > & { canComplete?: boolean; delay?: number },
    ) => { stop: () => void }
    <V = number>(
        __namedParameters: KeyframeOptions<V> & Omit<
            PlaybackOptions<V>,
            "type" | "repeat" | "repeatType" | "repeatDelay" | "onRepeat",
        > & { canComplete?: boolean; delay?: number },
    ): { stop: () => void }
    Simplified version of popmption animate that supports seeking around the animation. Used in AnimationObject.ts
    
    Type Parameters
    V = number
    Parameters
    __namedParameters: KeyframeOptions<V> & Omit<
        PlaybackOptions<V>,
        "type" | "repeat" | "repeatType" | "repeatDelay" | "onRepeat",
    > & { canComplete?: boolean; delay?: number }
    Returns { stop: () => void }
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:193

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:323

animateCamera

animateCamera(
    camera: ICamera,
    view: ICameraView,
    spherical?: boolean,
    options?: Partial<AnimationOptions<any>> & { normalizeDuration?: boolean | undefined; },
):
    | AnimationResult
    | {
        _stop: () => void;
        anims: AnimationResult[];
        id: string;
        options: AnimationOptions<any>;
        promise: any;
        stop: () => void;
        stopped: false;
    }
Animate camera to a target view.
Parameters
- camera: ICamera
- view: ICameraView
- spherical: boolean = true
  use spherical interpolation (default true)
- Optionaloptions: Partial<AnimationOptions<any>> & { normalizeDuration?: boolean | undefined; }
  animation options. normalizeDuration scales duration based on travel distance and skips animation if camera is already at target. Default false when duration is provided, true otherwise.
Returns
    | AnimationResult
    | {
        _stop: () => void;
        anims: AnimationResult[];
        id: string;
        options: AnimationOptions<any>;
        promise: any;
        stop: () => void;
        stopped: false;
    }
- Defined in src/plugins/animation/PopmotionPlugin.ts:384

animateCameraAsync

animateCameraAsync(
    camera: ICamera,
    view: ICameraView,
    spherical?: boolean,
    options?: Partial<AnimationOptions<any>> & { normalizeDuration?: boolean | undefined; },
    animations?: AnimationResult[],
): Promise<any>
Parameters
- camera: ICamera
- view: ICameraView
- spherical: boolean = true
- Optionaloptions: Partial<AnimationOptions<any>> & { normalizeDuration?: boolean | undefined; }
- Optionalanimations: AnimationResult[]
Returns Promise<any>
- Defined in src/plugins/animation/PopmotionPlugin.ts:416

animateNumber

animateNumber(
    options: Omit<
        PlaybackOptions<number> & KeyframeOptions<number>,
        "to" | "from" | "onUpdate",
    > & {
        from?: number;
        onUpdate?: (value: number, delta: number) => void;
        to?: number;
    },
): AnimationResult
Similar to animate, but specifically for numbers, defaults from 0 to 1. Also calls onUpdate with the delta value.
Parameters
- options: Omit<
      PlaybackOptions<number> & KeyframeOptions<number>,
      "to" | "from" | "onUpdate",
  > & {
      from?: number;
      onUpdate?: (value: number, delta: number) => void;
      to?: number;
  }
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:335

animateObject

animateObject<V>(
    o: IAnimationObject<V>,
    delay?: number,
    canComplete?: boolean,
    driver?: Driver,
    delay2?: number,
): AnimationResult
Type Parameters
- V
Parameters
- o: IAnimationObject<V>
- Optionaldelay: number
- canComplete: boolean = true
- Optionaldriver: Driver
- Optionaldelay2: number
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:451

animateSet

animateSet(
    anims: IAnimSet,
    parallel?: boolean,
    delay1?: number,
    canComplete?: boolean,
    driver?: Driver,
): AnimationResult
Parameters
- anims: IAnimSet
- parallel: boolean = false
- delay1: number = 0
- canComplete: boolean = true
- Optionaldriver: Driver
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:504

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
Deprecated
- use animate instead
- Defined in src/plugins/animation/PopmotionPlugin.ts:372

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:360

createAnimationResult

createAnimationResult(
    options?: AnimationOptions<any>,
): {
    _stop: () => void;
    anims: AnimationResult[];
    id: string;
    options: AnimationOptions<any>;
    promise: any;
    stop: () => void;
    stopped: false;
}
Parameters
- options: AnimationOptions<any> = {}
Returns {
    _stop: () => void;
    anims: AnimationResult[];
    id: string;
    options: AnimationOptions<any>;
    promise: any;
    stop: () => void;
    stopped: false;
}
- Defined in src/plugins/animation/PopmotionPlugin.ts:424

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

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

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

`Optional`setDirty

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

stopAnimationResult

stopAnimationResult(uuid: string): void
Parameters
- uuid: string
Returns void
- Defined in src/plugins/animation/PopmotionPlugin.ts:440

timeout

timeout(ms: number, options?: AnimationOptions<number>): AnimationResult
Parameters
- ms: number
- Optionaloptions: AnimationOptions<number>
Returns AnimationResult
- Defined in src/plugins/animation/PopmotionPlugin.ts:353

Class PopmotionPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns PopmotionPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

Readonlyanimations

autoIncrementTime

constructor

ReadonlydefaultDriver

dependencies

disableFrameFade

enabled

fromJSON

isViewerPluginSync

ReadonlytimelineDriver

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

Type Parameters

Parameters

Returns { stop: () => void }

Returns AnimationResult

animateAsync

Type Parameters

Parameters

Returns Promise<string>

animateCamera

Parameters

Returns | AnimationResult | { _stop: () => void; anims: AnimationResult[]; id: string; options: AnimationOptions<any>; promise: any; stop: () => void; stopped: false; }

animateCameraAsync

Parameters

Returns Promise<any>

animateNumber

Parameters

Returns AnimationResult

animateObject

Type Parameters

Parameters

Returns AnimationResult

animateSet

Parameters

Returns AnimationResult

animateTarget

Type Parameters

Parameters

Returns AnimationResult

Deprecated

animateTargetAsync

Type Parameters

Parameters

Returns Promise<string>

createAnimationResult

Parameters

Returns { _stop: () => void; anims: AnimationResult[]; id: string; options: AnimationOptions<any>; promise: any; stop: () => void; stopped: false;}

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`animations

`Readonly`defaultDriver

`Readonly`timelineDriver

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

Returns
| AnimationResult
| {
_stop: () => void;
anims: AnimationResult[];
id: string;
options: AnimationOptions<any>;
promise: any;
stop: () => void;
stopped: false;
}

Returns {
_stop: () => void;
anims: AnimationResult[];
id: string;
options: AnimationOptions<any>;
promise: any;
stop: () => void;
stopped: false;
}

`Optional`setDirty