Class TransformAnimationPlugin

Transform Animation Plugin

Helper plugin to save, load and animate between different transforms(position, rotation, scale) on objects. Also adds a UI to add and animate transforms on objects. Requires the PopmotionPlugin to animate.

Hierarchy (View Summary)

AViewerPluginSync<"">
- TransformAnimationPlugin

Index

Constructors

constructor

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

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,
> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof PopmotionPlugin[] = ...

enabled

enabled: boolean = true

toJSON

toJSON: any = undefined

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "TransformAnimationPlugin" = 'TransformAnimationPlugin'

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

addTransform

addTransform(
    o: IObject3D,
    name?: string,
): {
    name: string;
    position: Vector3;
    quaternion: Quaternion;
    scale: Vector3;
}
Parameters
- o: IObject3D
- Optionalname: string
Returns { name: string; position: Vector3; quaternion: Quaternion; scale: Vector3 }
- Defined in src/plugins/animation/TransformAnimationPlugin.ts:117

animateTransform

animateTransform(
    o: IObject3D,
    tr: string | number | TSavedTransform,
    duration?: number,
): undefined | AnimationResult
Parameters
- o: IObject3D
- tr: string | number | TSavedTransform
- duration: number = 2000
Returns undefined | AnimationResult
- Defined in src/plugins/animation/TransformAnimationPlugin.ts:151

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

fromJSON

fromJSON(
    data: ISerializedConfig,
    meta?: SerializationMetaType,
):
    | null
    | TransformAnimationPlugin
    | Promise<null | TransformAnimationPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | TransformAnimationPlugin | Promise<null | TransformAnimationPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:41

getSavedTransform

getSavedTransform(
tr: string | number | TSavedTransform,
o: IObject3D,
): undefined | TSavedTransform
Parameters
- tr: string | number | TSavedTransform
- o: IObject3D
Returns undefined | TSavedTransform
- Defined in src/plugins/animation/TransformAnimationPlugin.ts:143

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/TransformAnimationPlugin.ts:35

onRemove

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

`Optional`setDirty

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

setTransform

setTransform(o: IObject3D, tr: string | number | TSavedTransform): void
Parameters
- o: IObject3D
- tr: string | number | TSavedTransform
Returns void
- Defined in src/plugins/animation/TransformAnimationPlugin.ts:133

Class TransformAnimationPlugin

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TransformAnimationPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

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

addTransform

Parameters

Returns { name: string; position: Vector3; quaternion: Quaternion; scale: Vector3 }

animateTransform

Parameters

Returns undefined | AnimationResult

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | TransformAnimationPlugin | Promise<null | TransformAnimationPlugin>

getSavedTransform

Parameters

Returns undefined | TSavedTransform

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

setTransform

Parameters

Returns void

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty