Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Animator<T>

Type parameters

  • T

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Type parameters

    • T

    Returns Animator<T>

Properties

Readonly animatorFlags

animatorFlags: number

Readonly interpolator

interpolator: null | Interpolator<T>

Readonly ownLook

ownLook: null | Look<T, never>

Readonly ownState

ownState: T

Readonly ownValue

ownValue: T

Readonly precedence

precedence: number

Readonly timing

timing: null | Timing

Static Readonly AnimatingFlag

AnimatingFlag: number

Static AnimatorFlagsShift

AnimatorFlagsShift: number

Static Readonly ConstrainedFlag

ConstrainedFlag: number

Static Readonly ConstrainingFlag

ConstrainingFlag: number

Static Readonly DivergedFlag

DivergedFlag: number

Static Readonly InheritedFlag

InheritedFlag: number

Static Readonly InterruptFlag

InterruptFlag: number

Static Readonly MountedFlag

MountedFlag: number

Static Readonly OverrideFlag

OverrideFlag: number

Static Readonly UpdatedFlag

UpdatedFlag: number

Accessors

look

  • get look(): null | Look<T, never>

  • Returns null | Look<T, never>

state

  • get state(): T

  • Returns T

updatedValue

  • get updatedValue(): undefined | T

  • Returns undefined | T

value

  • get value(): T

  • Returns T

Methods

didSetLook

  • didSetLook(newLook: null | Look<T, never>, oldLook: null | Look<T, never>, timing: boolean | Timing): void

  • Parameters

    • newLook: null | Look<T, never>
    • oldLook: null | Look<T, never>
    • timing: boolean | Timing

    Returns void

didSetPrecedence

  • didSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

Protected didSetState

  • didSetState(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

didSetValue

  • didSetValue(newValue: T, oldValue: T): void

  • Parameters

    • newValue: T
    • oldValue: T

    Returns void

didStartAnimating

  • didStartAnimating(): void

  • Returns void

didStopAnimating

  • didStopAnimating(): void

  • Returns void

getState

  • getState(): NonNullable<T>

  • Returns NonNullable<T>

getStateOr

  • getStateOr<E>(elseState: E): NonNullable<T> | E

  • Type parameters

    • E

    Parameters

    • elseState: E

    Returns NonNullable<T> | E

getValue

  • getValue(): NonNullable<T>

  • Returns NonNullable<T>

getValueOr

  • getValueOr<E>(elseValue: E): NonNullable<T> | E

  • Type parameters

    • E

    Parameters

    • elseValue: E

    Returns NonNullable<T> | E

isAnimating

  • isAnimating(): boolean

  • Returns boolean

isDefined

  • isDefined(value: T): boolean

  • Parameters

    • value: T

    Returns boolean

isUpdated

  • isUpdated(): boolean

  • Returns boolean

onAnimate

  • onAnimate(t: number): void

  • Parameters

    • t: number

    Returns void

onBegin

  • onBegin(value: T): void

  • Parameters

    • value: T

    Returns void

onEnd

  • onEnd(value: T): void

  • Parameters

    • value: T

    Returns void

onInterrupt

  • onInterrupt(value: T): void

  • Parameters

    • value: T

    Returns void

onSetLook

  • onSetLook(newLook: null | Look<T, never>, oldLook: null | Look<T, never>, timing: boolean | Timing): void

  • Parameters

    • newLook: null | Look<T, never>
    • oldLook: null | Look<T, never>
    • timing: boolean | Timing

    Returns void

onSetPrecedence

  • onSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

Protected onSetState

  • onSetState(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

onSetValue

  • onSetValue(newValue: T, oldValue: T): void

  • Parameters

    • newValue: T
    • oldValue: T

    Returns void

onStartAnimating

  • onStartAnimating(): void

  • Returns void

onStopAnimating

  • onStopAnimating(): void

  • Returns void

setAnimatedState

  • setAnimatedState(newState: T, oldState: T, timing: Timing): void

  • Parameters

    • newState: T
    • oldState: T
    • timing: Timing

    Returns void

setAnimatorFlags

  • setAnimatorFlags(animatorFlags: number): void

  • Parameters

    • animatorFlags: number

    Returns void

setImmediateState

  • setImmediateState(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

setIntermediateValue

  • setIntermediateValue(newValue: T, newState?: T): void

  • Parameters

    • newValue: T
    • Optional newState: T

    Returns void

setLook

  • setLook(newLook: null | Look<T, never>, precedenceOrTiming: undefined | number | boolean | AnyTiming): void
  • setLook(newLook: null | Look<T, never>, timing?: boolean | AnyTiming, precedence?: number): void

  • Parameters

    • newLook: null | Look<T, never>
    • precedenceOrTiming: undefined | number | boolean | AnyTiming

    Returns void

  • Parameters

    • newLook: null | Look<T, never>
    • Optional timing: boolean | AnyTiming
    • Optional precedence: number

    Returns void

setOwnLook

  • setOwnLook(newLook: null | Look<T, never>, timing?: boolean | AnyTiming): void

  • Parameters

    • newLook: null | Look<T, never>
    • Optional timing: boolean | AnyTiming

    Returns void

setOwnState

  • setOwnState(newState: T, timing?: boolean | AnyTiming): void

  • Parameters

    • newState: T
    • Optional timing: boolean | AnyTiming

    Returns void

setPrecedence

  • setPrecedence(newPrecedence: number): void

  • Parameters

    • newPrecedence: number

    Returns void

setState

  • setState(newState: T, precedenceOrTiming: undefined | number | boolean | AnyTiming): void
  • setState(newState: T, timing?: boolean | AnyTiming, precedence?: number): void

  • Parameters

    • newState: T
    • precedenceOrTiming: undefined | number | boolean | AnyTiming

    Returns void

  • Parameters

    • newState: T
    • Optional timing: boolean | AnyTiming
    • Optional precedence: number

    Returns void

setValue

  • setValue(newValue: T, oldValue?: T): void

  • Parameters

    • newValue: T
    • Optional oldValue: T

    Returns void

Protected startAnimating

  • startAnimating(): void

  • Returns void

Protected stopAnimating

  • stopAnimating(): void

  • Returns void

takeUpdatedValue

  • takeUpdatedValue(): undefined | T

  • Returns undefined | T

takeValue

  • takeValue(): T

  • Returns T

takesPrecedence

  • takesPrecedence(precedence: number): boolean

  • Parameters

    • precedence: number

    Returns boolean

willSetLook

  • willSetLook(newLook: null | Look<T, never>, oldLook: null | Look<T, never>, timing: boolean | Timing): void

  • Parameters

    • newLook: null | Look<T, never>
    • oldLook: null | Look<T, never>
    • timing: boolean | Timing

    Returns void

willSetPrecedence

  • willSetPrecedence(newPrecedence: number, oldPrecedence: number): void

  • Parameters

    • newPrecedence: number
    • oldPrecedence: number

    Returns void

Protected willSetState

  • willSetState(newState: T, oldState: T): void

  • Parameters

    • newState: T
    • oldState: T

    Returns void

willSetValue

  • willSetValue(newValue: T, oldValue: T): void

  • Parameters

    • newValue: T
    • oldValue: T

    Returns void

willStartAnimating

  • willStartAnimating(): void

  • Returns void

willStopAnimating

  • willStopAnimating(): void

  • Returns void

Generated using TypeDoc