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

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<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "removePlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof PopmotionPlugin[] = ...

enabled

enabled: boolean = true

toJSON

toJSON: any = undefined

`Optional` uiConfig

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

Methods

`Private` _addSceneObject

_addSceneObject(e): void
Parameters
- e: any
Returns void
- Defined in src/plugins/animation/TransformAnimationPlugin.ts:43

`Protected` _onViewerEvent

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

`Protected` _storeKey

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

addTransform

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

animateTransform

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

disable

disable(key): 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): 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, meta?): null | TransformAnimationPlugin | Promise<null | TransformAnimationPlugin>
Parameters
- data: ISerializedConfig
- Optional meta: SerializationMetaType
Returns null | TransformAnimationPlugin | Promise<null | TransformAnimationPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:41

getSavedTransform

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

importState

importState(state): 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): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/animation/TransformAnimationPlugin.ts:35

onRemove

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

`Optional` setDirty

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

setTransform

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

Class TransformAnimationPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns TransformAnimationPlugin

Properties

Protected _dirty

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

constructor

dependencies

enabled

toJSON

Optional uiConfig

Static Optional Readonly OldPluginType

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

Methods

Private _addSceneObject

Parameters

e: any

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _storeKey

Parameters

Optional prefix: string

Returns string

addTransform

Parameters

o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Optional name: string

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

name: string

position: Vector3

quaternion: Quaternion

scale: Vector3

animateTransform

Parameters

o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

tr: string | number | TSavedTransform

duration: number = 2000

Returns undefined | AnimationResult

disable

Parameters

key: any

Returns void

dispose

Returns void

enable

Parameters

key: any

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

data: ISerializedConfig

Optional meta: SerializationMetaType

Returns null | TransformAnimationPlugin | Promise<null | TransformAnimationPlugin>

getSavedTransform

Parameters

tr: string | number | TSavedTransform

o: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

`Protected` _dirty

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` uiConfig

`Static` `Optional` `Readonly` OldPluginType

`Static` `Readonly` PluginType

`Private` _addSceneObject

`Protected` _onViewerEvent

`Protected` _storeKey

`Optional` prefix: string

`Optional` name: string

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

`Optional` meta: SerializationMetaType

`Optional` setDirty

`Rest` ...args: any[]