Class AnimationObjectPlugin

Animation Object Plugin

This plugin allows you to create and manage animation objects for properties in the viewer, plugins, objects, materials etc. Animation objects are serializable javascript objects that bind to a property, and can animate it over time across keyframes.

Animation Object plugin adds support for creating animations bound to viewer and plugins and serializing them along with this plugin. Also adds support for tracking and playback of animation objects in the userData of objects and materials.

All the tracked animations are played on load and synced with the viewer timeline if its active.

This plugin also adds trigger buttons for creating and editing animation objects, keyframes, for the ui config.

Hierarchy (View Summary)

AViewerPluginSync<AnimationObjectPluginEventMap>
- AnimationObjectPlugin

Constructors

constructor

new AnimationObjectPlugin(): AnimationObjectPlugin
Returns AnimationObjectPlugin
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:128

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: { postFrame: () => void } = ...

`Readonly`animation

animation: AnimationObject = ...

Main animation with target = viewer for global properties

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof PopmotionPlugin[] = ...

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Readonly`runtimeAnimation

runtimeAnimation: AnimationObject = ...

uiConfig

uiConfig: UiObjectConfig = ...

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "AnimationObjectPlugin" = 'AnimationObjectPlugin'

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

triggerButtonsShown

get triggerButtonsShown(): boolean
Returns boolean
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:110
set triggerButtonsShown(v: boolean): void
Parameters
- v: boolean
Returns void
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:113

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

addAnimation

addAnimation(
    access?: string,
    target?: any,
    anim?: AnimationObject<any>,
): AnimationObject<any>
Parameters
- Optionalaccess: string
- Optionaltarget: any
- Optionalanim: AnimationObject<any>
Returns AnimationObject<any>
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:186

cleanupUiConfigButton

cleanupUiConfigButton(config?: UiObjectConfig<any, string, any>): void
Parameters
- Optionalconfig: UiObjectConfig<any, string, any>
Returns void
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:418

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

fromJSON

fromJSON(data: any, meta?: any): null | AnimationObjectPlugin
Parameters
- data: any
- Optionalmeta: any
Returns null | AnimationObjectPlugin
Overrides AViewerPluginSync.fromJSON
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:511

getAllAnimations

getAllAnimations(): AnimationObject<any>[]
Returns AnimationObject<any>[]
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:44

getTimeline

getTimeline(): [AnimationObject<any>, AnimationResult][]
Returns [AnimationObject<any>, AnimationResult][]
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:182

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

removeAnimation

removeAnimation(anim: AnimationObject, target?: any): void
Parameters
- anim: AnimationObject
- Optionaltarget: any
Returns void
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:202

`Optional`setDirty

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

setupUiConfigButton

setupUiConfigButton(
    obj:
        | IMaterial<IMaterialEventMap>
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    config: UiObjectConfig,
    path?: string,
): void
Parameters
- obj:
      | IMaterial<IMaterialEventMap>
      | IObject3D<
          IObject3DEventMap,
          undefined
          | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
          undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
      >
- config: UiObjectConfig
- Optionalpath: string
Returns void
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:332

showTriggers

showTriggers(v?: boolean): void
Parameters
- v: boolean = true
Returns void
- Defined in src/plugins/animation/AnimationObjectPlugin.ts:124

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:39

Class AnimationObjectPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AnimationObjectPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

Readonlyanimation

constructor

dependencies

enabled

isViewerPluginSync

ReadonlyruntimeAnimation

uiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

triggerButtonsShown

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

addAnimation

Parameters

Returns AnimationObject<any>

cleanupUiConfigButton

Parameters

Returns void

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | AnimationObjectPlugin

getAllAnimations

Returns AnimationObject<any>[]

getTimeline

Returns [AnimationObject<any>, AnimationResult][]

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

rebuildTimeline

Returns void

removeAnimation

Parameters

Returns void

OptionalsetDirty

Parameters

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Readonly`animation

`Readonly`runtimeAnimation

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty