Skip to content

@ue-too/animate / Animator

Interface: Animator

Defined in: composite-animation.ts:29

Core interface for all animators in the animation system.

Remarks

The Animator interface defines the contract for both individual animations (Animation) and composite animations (CompositeAnimation). All animators support:

  • Lifecycle control (start, stop, pause, resume)
  • Duration management with delays and drag time
  • Looping with optional max loop count
  • Parent-child relationships for composition
  • Event callbacks for start and end

Properties

delay

delay: number

Defined in: composite-animation.ts:32


drag

drag: number

Defined in: composite-animation.ts:33


duration

duration: number

Defined in: composite-animation.ts:31


loops

loops: boolean

Defined in: composite-animation.ts:30


maxLoopCount

maxLoopCount: number | undefined

Defined in: composite-animation.ts:50


playing

playing: boolean

Defined in: composite-animation.ts:51

Methods

animate()

animate(deltaTime): void

Defined in: composite-animation.ts:39

Parameters

deltaTime

number

Returns

void


clearOnEnd()

clearOnEnd(): void

Defined in: composite-animation.ts:49

Returns

void


clearOnStart()

clearOnStart(): void

Defined in: composite-animation.ts:48

Returns

void


detachParent()

detachParent(): void

Defined in: composite-animation.ts:44

Returns

void


nonCascadingDuration()

nonCascadingDuration(newDuration): void

Defined in: composite-animation.ts:34

Parameters

newDuration

number

Returns

void


onEnd()

onEnd(callback): UnSubscribe

Defined in: composite-animation.ts:46

Parameters

callback

Function

Returns

UnSubscribe


onStart()

onStart(callback): UnSubscribe

Defined in: composite-animation.ts:47

Parameters

callback

Function

Returns

UnSubscribe


pause()

pause(): void

Defined in: composite-animation.ts:37

Returns

void


resetAnimationState()

resetAnimationState(): void

Defined in: composite-animation.ts:41

Returns

void


resume()

resume(): void

Defined in: composite-animation.ts:38

Returns

void


setParent()

setParent(parent): void

Defined in: composite-animation.ts:43

Parameters

parent

AnimatorContainer

Returns

void


setUp()

setUp(): void

Defined in: composite-animation.ts:40

Returns

void


start()

start(): void

Defined in: composite-animation.ts:35

Returns

void


stop()

stop(): void

Defined in: composite-animation.ts:36

Returns

void


tearDown()

tearDown(): void

Defined in: composite-animation.ts:42

Returns

void


toggleReverse()

toggleReverse(reverse): void

Defined in: composite-animation.ts:45

Parameters

reverse

boolean

Returns

void