Class AnimationKey<T>

Holds information about continous points in time their accompanying values as well as their slopes. Also holds a reference to the AnimationFunctions that come in and out of the sides. The AnimationFunctions are handled by the AnimationSequences. If the property constant is true, the value does not change and wil not be interpolated between this and the next key in a sequence

Authors

Lukas Scheuerle, HFU, 2019 | Jonas Plotzky, HFU, 2025

Type Parameters

T extends AnimationReturnType = AnimationReturnType

Hierarchy (View Summary)

Mutable
- AnimationKey

Implements

Serializable

Constructors

constructor

new AnimationKey<T extends AnimationReturnType = AnimationReturnType>(
    _time?: number,
    _value?: T,
    _interpolation?: ANIMATION_INTERPOLATION,
    _slopeIn?: T,
    _slopeOut?: T,
): AnimationKey<T>
Type Parameters
- T extends AnimationReturnType = AnimationReturnType
Parameters
- _time: number = 0
- Optional_value: T
- _interpolation: ANIMATION_INTERPOLATION = ANIMATION_INTERPOLATION.CUBIC
- Optional_slopeIn: T
- Optional_slopeOut: T
Returns AnimationKey<T>
Overrides Mutable.constructor
- Defined in Source/Core/Animation/AnimationKey.ts:25

Properties

functionOut

functionOut: AnimationFunction<T>

Don't modify this unless you know what you're doing.

Accessors

interpolation

get interpolation(): ANIMATION_INTERPOLATION
Returns ANIMATION_INTERPOLATION
- Defined in Source/Core/Animation/AnimationKey.ts:73
set interpolation(_interpolation: ANIMATION_INTERPOLATION): void
Parameters
- _interpolation: ANIMATION_INTERPOLATION
Returns void
- Defined in Source/Core/Animation/AnimationKey.ts:77

slopeIn

get slopeIn(): T
Returns T
- Defined in Source/Core/Animation/AnimationKey.ts:82
set slopeIn(_slope: T): void
Parameters
- _slope: T
Returns void
- Defined in Source/Core/Animation/AnimationKey.ts:86

slopeOut

get slopeOut(): T
Returns T
- Defined in Source/Core/Animation/AnimationKey.ts:90
set slopeOut(_slope: T): void
Parameters
- _slope: T
Returns void
- Defined in Source/Core/Animation/AnimationKey.ts:94

time

get time(): number
Returns number
- Defined in Source/Core/Animation/AnimationKey.ts:55
set time(_time: number): void
Parameters
- _time: number
Returns void
- Defined in Source/Core/Animation/AnimationKey.ts:59

type

get type(): string
Retrieves the type of this mutable subclass as the name of the runtime class

Returns string
The type of the mutable
Inherited from Mutable.type
- Defined in Source/Core/Serialization/Mutable.ts:193

value

get value(): T
Returns T
- Defined in Source/Core/Animation/AnimationKey.ts:64
set value(_value: T): void
Parameters
- _value: T
Returns void
- Defined in Source/Core/Animation/AnimationKey.ts:68

Methods

addEventListener

addEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.addEventListener
- Defined in Source/Core/Event/Event.ts:91

animate

animate(_mutator: AnimationMutator): void
Updates the property values of the instance according to the state of the animation mutator. Override to implement custom animation behavior.
Parameters
- _mutator: AnimationMutator
Returns void
Inherited from Mutable.animate
- Defined in Source/Core/Serialization/Mutable.ts:329

deserialize

deserialize(_serialization: Serialization): Promise<Serializable>
Recreates this instance of Serializable with the information from the given Serialization.
Parameters
- _serialization: Serialization
Returns Promise<Serializable>
Implementation of Serializable.deserialize
- Defined in Source/Core/Animation/AnimationKey.ts:110

dispatchEvent

dispatchEvent(_event: EventUnified): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from Mutable.dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from Mutable.getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:289

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from Mutable.getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:296

getMutator

getMutator(): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.

Returns Mutator
Overrides Mutable.getMutator
- Defined in Source/Core/Animation/AnimationKey.ts:120

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator: Mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from Mutable.getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:260

getMutatorForAnimation

getMutatorForAnimation(_extendable?: boolean): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from Mutable.getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:237

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?: boolean): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from Mutable.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:245

mutate

mutate(
    _mutator: Mutator,
    _selection?: string[],
    _dispatchMutate?: boolean,
): void | Promise<void>
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
- Optional_selection: string[]
- Optional_dispatchMutate: boolean
Returns void | Promise<void>
Inherited from Mutable.mutate
- Defined in Source/Core/Serialization/Mutable.ts:319

removeEventListener

removeEventListener(
    _type: string,
    _handler: EventListenerUnified,
    _options?: boolean | AddEventListenerOptions,
): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional_options: boolean | AddEventListenerOptions
Returns void
Inherited from Mutable.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

serialize

serialize(): Serialization
Returns a Serialization of this object.

Returns Serialization
Implementation of Serializable.serialize
- Defined in Source/Core/Animation/AnimationKey.ts:100

updateMutator

updateMutator(_mutator: Mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from Mutable.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:304

`Static`compare

compare<T extends AnimationReturnType, K extends AnimationKey<T>>(
_a: K,
_b: K,
): number
Static comparation function to use in an array sort function to sort the keys by their time.
Type Parameters
- T extends AnimationReturnType
- K extends AnimationKey<T>
Parameters
- _a: K
  the animation key to check
- _b: K
  the animation key to check against
Returns number

0 if a>b, 0 if a=b, <0 if a<b
- Defined in Source/Core/Animation/AnimationKey.ts:51

`Static`getMutatorFromPath

getMutatorFromPath(_mutator: Mutator, _path: string[]): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from Mutable.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:178

Class AnimationKey<T>

Authors

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns AnimationKey<T>

Properties

functionOut

Accessors

interpolation

Returns ANIMATION_INTERPOLATION

Parameters

Returns void

slopeIn

Returns T

Parameters

Returns void

slopeOut

Returns T

Parameters

Returns void

time

Returns number

Parameters

Returns void

type

Returns string

value

Returns T

Parameters

Returns void

Methods

addEventListener

Parameters

Returns void

animate

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getMutator

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

Returns MutatorForUserInterface

mutate

Parameters

Returns void | Promise<void>

removeEventListener

Parameters

Returns void

serialize

Returns Serialization

updateMutator

Parameters

Returns void

Staticcompare

`Static`compare

`Static`getMutatorFromPath