Class AnimationSprite

Describes and controls and animation by yielding mutators according to the stored AnimationStructure and AnimationSequences Applied to a Node directly via script or ComponentAnimation.

Authors

Lukas Scheuerle, HFU, 2019 | Jirka Dell'Oro-Friedl, HFU, 2021-2023 | Jonas Plotzky, HFU, 2025

Hierarchy (View Summary)

FudgeCore.Animation
- AnimationSprite

Constructors

constructor

new AnimationSprite(_name?: string): AnimationSprite
Parameters
- _name: string = "AnimationSprite"
Returns AnimationSprite
Overrides Animation.constructor
- Defined in Source/Core/Animation/AnimationSprite.ts:15

Properties

animationStructure

animationStructure: AnimationStructure

events

events: AnimationEventTrigger = {}

idResource

idResource: string = undefined

labels

labels: AnimationLabel = {}

name

name: string

totalTime

totalTime: number = 0

`Static` `Readonly`iSubclass

iSubclass: number = ...

`Static` `Readonly`subclasses

subclasses: typeof FudgeCore.Animation[] = []

Accessors

fps

get fps(): number
Returns number
Inherited from Animation.fps
- Defined in Source/Core/Animation/Animation.ts:167
set fps(_fps: number): void
Parameters
- _fps: number
Returns void
Inherited from Animation.fps
- Defined in Source/Core/Animation/Animation.ts:171

getLabels

get getLabels(): Enumerator
Returns Enumerator
Inherited from Animation.getLabels
- Defined in Source/Core/Animation/Animation.ts:161

isSerializableResource

get isSerializableResource(): true
Returns true
Inherited from Animation.isSerializableResource
- Defined in Source/Core/Animation/Animation.ts:157

texture

get texture(): Texture
Returns Texture
- Defined in Source/Core/Animation/AnimationSprite.ts:23
set texture(_texture: Texture): void
Sets the texture to be used as the spritesheet
Parameters
- _texture: Texture
Returns void
- Defined in Source/Core/Animation/AnimationSprite.ts:29

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 Animation.type
- Defined in Source/Core/Serialization/Mutable.ts:193

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 Animation.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 Animation.animate
- Defined in Source/Core/Serialization/Mutable.ts:329

calculateDirection

calculateDirection(_time: number, _playmode: ANIMATION_PLAYMODE): number
Calculates and returns the direction the animation should currently be playing in.
Parameters
- _time: number
  the time at which to calculate the direction
- _playmode: ANIMATION_PLAYMODE
Returns number
1 if forward, 0 if stop, -1 if backwards
Inherited from Animation.calculateDirection
- Defined in Source/Core/Animation/Animation.ts:271

calculateTotalTime

calculateTotalTime(): void
(Re-)Calculate the total time of the Animation. Calculation-heavy, use only if actually needed.

Returns void
Inherited from Animation.calculateTotalTime
- Defined in Source/Core/Animation/Animation.ts:240

clearCache

clearCache(): void
Clear this animations cache.

Returns void
Inherited from Animation.clearCache
- Defined in Source/Core/Animation/Animation.ts:180

convertToAnimation

convertToAnimation(): FudgeCore.Animation
Converts the AnimationSprite into an Animation

Returns FudgeCore.Animation
- Defined in Source/Core/Animation/AnimationSprite.ts:156

create

create(
    _texture: Texture,
    _frames: number,
    _wrapAfter: number,
    _start: Vector2,
    _size: Vector2,
    _next: Vector2,
    _wrap: Vector2,
    _framesPerSecond: number,
): void
Creates this animation sprite from the given arguments
Parameters
- _texture: Texture
- _frames: number
- _wrapAfter: number
- _start: Vector2
- _size: Vector2
- _next: Vector2
- _wrap: Vector2
- _framesPerSecond: number
Returns void
- Defined in Source/Core/Animation/AnimationSprite.ts:37

deserialize

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

dispatchEvent

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

getEventsToFire

getEventsToFire(
    _min: number,
    _max: number,
    _quantization: ANIMATION_QUANTIZATION,
    _direction: number,
): string[]
Returns a list of the names of the events the ComponentAnimation needs to fire between _min and _max input values.
Parameters
- _min: number
- _max: number
- _quantization: ANIMATION_QUANTIZATION
- _direction: number
  The direction the animation is supposed to run in. >0 == forward, 0 == stop, <0 == backwards
Returns string[]
a list of strings with the names of the custom events to fire.
Inherited from Animation.getEventsToFire
- Defined in Source/Core/Animation/Animation.ts:197

getMetaAttributeTypes

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

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

getMetadata

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

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

getModalTime

getModalTime(
    _time: number,
    _playmode: ANIMATION_PLAYMODE,
    _timeStop?: number,
): number
Returns the time to use for animation sampling when applying a playmode
Parameters
- _time: number
- _playmode: ANIMATION_PLAYMODE
- _timeStop: number = _time
Returns number
Inherited from Animation.getModalTime
- Defined in Source/Core/Animation/Animation.ts:250

getMutator

getMutator(_extendable?: boolean): 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.
Parameters
- _extendable: boolean = false
Returns Mutator
Inherited from Animation.getMutator
- Defined in Source/Core/Serialization/Mutable.ts:202

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 Animation.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 Animation.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 Animation.getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:245

getPositions

getPositions(): Vector2[]
Returns the positions of the spritesheet

Returns Vector2[]
- Defined in Source/Core/Animation/AnimationSprite.ts:99

getScale

getScale(): Vector2
Returns the scale of the spritesheet

Returns Vector2
- Defined in Source/Core/Animation/AnimationSprite.ts:89

getState

getState(
    _time: number,
    _direction: number,
    _quantization: ANIMATION_QUANTIZATION,
    _mutatorOut?: Mutator,
): Mutator
Generates and returns a Mutator with the information to apply to the Node to animate in the state the animation is in at the given time, direction and quantization
Parameters
- _time: number
- _direction: number
- _quantization: ANIMATION_QUANTIZATION
- _mutatorOut: Mutator = {}
Returns Mutator
Inherited from Animation.getState
- Defined in Source/Core/Animation/Animation.ts:188

mutate

mutate(
    _mutator: Mutator,
    _selection?: string[],
    _dispatchMutate?: boolean,
): 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 Promise<void>
Overrides Animation.mutate
- Defined in Source/Core/Animation/AnimationSprite.ts:119

removeEvent

removeEvent(_name: string): void
Removes the event with the given name from the list of events.
Parameters
- _name: string
  name of the event to remove.
Returns void
Inherited from Animation.removeEvent
- Defined in Source/Core/Animation/Animation.ts:232

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 Animation.removeEventListener
- Defined in Source/Core/Event/Event.ts:98

serialize

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

Returns Serialization
Overrides Animation.serialize
- Defined in Source/Core/Animation/AnimationSprite.ts:124

setEvent

setEvent(_name: string, _time: number): void
Adds an Event to the List of events.
Parameters
- _name: string
  The name of the event (needs to be unique per Animation).
- _time: number
  The timestamp of the event (in milliseconds).
Returns void
Inherited from Animation.setEvent
- Defined in Source/Core/Animation/Animation.ts:223

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 Animation.updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:304

`Static`blendAdditive

blendAdditive(_base: Mutator, _add: Mutator, _weight: number): Mutator
Add the given additive mutator to the given base mutator. The values of the additive mutator will be multiplied by the given weight.
Parameters
- _base: Mutator
- _add: Mutator
- _weight: number
Returns Mutator
Inherited from Animation.blendAdditive
- Defined in Source/Core/Animation/Animation.ts:115

`Static`blendOverride

blendOverride(
    _base: Mutator,
    _override: Mutator,
    _weight: number,
    _intersect?: boolean,
): Mutator
Override the given base mutator with the given override mutator using linear interpolation between the values with the given weight. Set the intersect flag to only include properties in the result that exist in both of the given mutators.
Parameters
- _base: Mutator
- _override: Mutator
- _weight: number
- _intersect: boolean = false
Returns Mutator
Inherited from Animation.blendOverride
- Defined in Source/Core/Animation/Animation.ts:108

`Static`blendRecursive

blendRecursive(
    _base: Mutator,
    _blend: Mutator,
    _weightBase: number,
    _weightBlend: number,
    _intersect?: boolean,
): Mutator
Blend the two given mutators together, using the given weights to determine the influence of each. The resulting mutator will contain all properties of the base mutator, with the properties of the blend mutator blended in. Blend mutator properties that don't exist in the base mutator will be added to the result mutator. Set the intersect flag to only include properties in the result that exist in both of the given mutators.
Parameters
- _base: Mutator
- _blend: Mutator
- _weightBase: number
- _weightBlend: number
- _intersect: boolean = false
Returns Mutator
Inherited from Animation.blendRecursive
- Defined in Source/Core/Animation/Animation.ts:125

`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 Animation.getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:178

Class AnimationSprite

Authors

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AnimationSprite

Properties

animationStructure

events

idResource

labels

name

totalTime

Static ReadonlyiSubclass

Static Readonlysubclasses

Accessors

fps

Returns number

Parameters

Returns void

getLabels

Returns Enumerator

isSerializableResource

Returns true

texture

Returns Texture

Parameters

Returns void

type

Returns string

Methods

addEventListener

Parameters

Returns void

animate

Parameters

Returns void

calculateDirection

Parameters

Returns number

calculateTotalTime

Returns void

clearCache

Returns void

convertToAnimation

Returns FudgeCore.Animation

create

Parameters

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getEventsToFire

Parameters

Returns string[]

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getModalTime

Parameters

Returns number

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

`Static` `Readonly`iSubclass

`Static` `Readonly`subclasses

`Static`blendAdditive

`Static`blendOverride

`Static`blendRecursive

`Static`getMutatorFromPath