Interface Animator<R, T, I>

Type Parameters

  • R = any

  • T = any

  • I extends any[] = [T]

Hierarchy

Properties

coherentTime inlet inletVersion interpolator name owner state timing value version

Accessors

affinity binds coherent derived descriptorType fastenerType inheritName inherits inletKeys inletState inletValue mounted parent parentType transition tweening updateFlags valueType

Methods

attachFastener attachInlets bindInlet decohere decohereFastener definedValue deriveValue detachInlets didBindInlet didInterrupt didMount didSetAffinity didSetInherits didSetState didSetValue didStartTweening didStopTweening didTransition didUnbindInlet didUnmount equalValues fromLike get getFastener getInletState getInletStateOr getInletValue getInletValueOr getOutletState getOutletValue getParentFastener getState getStateOr getTransition? getValue getValueOr hasAffinity incrementVersion init initValue onBindInlet onMount onSetAffinity onSetInherits onSetState onSetValue onStartTweening onStopTweening onUnbindInlet onUnmount recohere requireRecohere requireUpdate resolveInlets set setAffinity setCoherent setCoherentTime setInherits setInterpolatedValue setIntrinsic setState setValue toString transformState transformValue unbindInlet willBindInlet willMount willSetAffinity willSetInherits willSetState willSetValue willStartTweening willStopTweening willTransition willUnbindInlet willUnmount

Properties

Readonly coherentTime

coherentTime: number

Readonly inlet

inlet: Fastener<any, any, any> | readonly Fastener<any, any, any>[]

Readonly inletVersion

inletVersion: number | readonly number[]

Readonly interpolator

interpolator: Interpolator<T>

Readonly name

name: PropertyKey

Readonly owner

owner: R

Readonly state

state: T

Readonly timing

timing: Timing

Readonly value

value: T

Readonly version

version: number

Accessors

affinity

  • get affinity(): Affinity

  • Returns Affinity

binds

  • get binds(): boolean

  • Returns boolean

coherent

  • get coherent(): boolean

  • Returns boolean

derived

  • get derived(): boolean

  • Returns boolean

descriptorType

  • get descriptorType(): Proto<AnimatorDescriptor<R, T>>

  • Returns Proto<AnimatorDescriptor<R, T>>

fastenerType

  • get fastenerType(): Proto<Property<any, any, any>>

  • Returns Proto<Property<any, any, any>>

inheritName

  • get inheritName(): PropertyKey

  • Returns PropertyKey

inherits

  • get inherits(): boolean

  • Returns boolean

inletKeys

  • get inletKeys(): readonly PropertyKey[]
  • Protected

    Returns readonly PropertyKey[]

inletState

  • get inletState(): I[0]

  • Returns I[0]

inletValue

  • get inletValue(): I[0]

  • Returns I[0]

mounted

  • get mounted(): boolean

  • Returns boolean

parent

  • get parent(): Property<any, I[0], any>

  • Returns Property<any, I[0], any>

parentType

  • get parentType(): Proto<any>

  • Returns Proto<any>

transition

  • get transition(): boolean | Timing

  • Returns boolean | Timing

tweening

  • get tweening(): boolean

  • Returns true if this animator is actively transitioning to a new state.

    Returns boolean

updateFlags

  • get updateFlags(): number

  • Returns number

valueType

  • get valueType(): unknown

  • Returns unknown

Methods

attachFastener

  • Parameters

    Returns void

Protected attachInlets

  • Protected

    Returns void

bindInlet

  • Type Parameters

    • K extends string | number | symbol

    • IK

    Parameters

    Returns void

  • Type Parameters

    • I0 extends any

    Parameters

    Returns void

decohere

  • Parameters

    • Optional inlet: Fastener<any, any, any>

    Returns void

decohereFastener

  • Parameters

    Returns void

definedValue

  • Parameters

    • value: T

    Returns boolean

deriveValue

  • Parameters

    • Rest ...inletValues: I

    Returns T

Protected detachInlets

  • Protected

    Returns void

Protected didBindInlet

  • Protected

    Parameters

    Returns void

Protected didInterrupt

  • Protected

    Parameters

    • value: T

    Returns void

Protected didMount

  • Protected

    Returns void

Protected didSetAffinity

  • Protected

    Parameters

    Returns void

Protected didSetInherits

  • Protected

    Parameters

    • inherits: boolean
    • inheritName: PropertyKey

    Returns void

Protected didSetState

  • Protected

    Parameters

    • newState: T
    • oldState: T

    Returns void

Protected didSetValue

  • Protected

    Parameters

    • newValue: T
    • oldValue: T

    Returns void

Protected didStartTweening

  • Protected

    Returns void

Protected didStopTweening

  • Protected

    Returns void

Protected didTransition

  • Protected

    Parameters

    • newValue: T

    Returns void

Protected didUnbindInlet

  • Protected

    Parameters

    Returns void

Protected didUnmount

  • Protected

    Returns void

equalValues

  • Parameters

    • newValue: T
    • oldValue: T

    Returns boolean

fromLike

  • Parameters

    • value: T | LikeType<T>

    Returns T

get

  • Returns T

getFastener

  • Type Parameters

    Parameters

    • fastenerName: PropertyKey
    • Optional fastenerType: Proto<F>
    • Optional contextType: Proto<any>

    Returns F

getInletState

  • Returns NonNullable<I[0]>

getInletStateOr

  • Type Parameters

    • E

    Parameters

    • elseState: E

    Returns NonNullable<I[0]> | E

getInletValue

  • Returns NonNullable<I[0]>

getInletValueOr

  • Type Parameters

    • E

    Parameters

    • elseValue: E

    Returns NonNullable<I[0]> | E

getOutletState

  • Parameters

    Returns T

getOutletValue

  • Parameters

    Returns T

getParentFastener

  • Type Parameters

    Parameters

    • fastenerName: string
    • Optional fastenerType: Proto<F>
    • Optional contextType: Proto<any>

    Returns F

getState

  • Returns NonNullable<T>

getStateOr

  • Type Parameters

    • E

    Parameters

    • elseState: E

    Returns NonNullable<T> | E

Optional getTransition

  • Parameters

    Returns Timing

getValue

  • Returns NonNullable<T>

getValueOr

  • Type Parameters

    • E

    Parameters

    • elseValue: E

    Returns NonNullable<T> | E

hasAffinity

  • Parameters

    Returns boolean

Protected incrementVersion

  • Protected

    Returns void

Protected init

  • Protected

    Returns void

initValue

  • Returns T

Protected onBindInlet

  • Protected

    Parameters

    Returns void

Protected onMount

  • Protected

    Returns void

Protected onSetAffinity

  • Protected

    Parameters

    Returns void

Protected onSetInherits

  • Protected

    Parameters

    • inherits: boolean
    • inheritName: PropertyKey

    Returns void

Protected onSetState

  • Protected

    Parameters

    • newState: T
    • oldState: T

    Returns void

Protected onSetValue

  • Protected

    Parameters

    • newValue: T
    • oldValue: T

    Returns void

Protected onStartTweening

  • Protected

    Returns void

Protected onStopTweening

  • Protected

    Returns void

Protected onUnbindInlet

  • Protected

    Parameters

    Returns void

Protected onUnmount

  • Protected

    Returns void

recohere

  • Parameters

    • t: number

    Returns void

requireRecohere

  • Returns void

requireUpdate

  • Parameters

    • updateFlags: number

    Returns void

resolveInlets

  • Returns readonly Fastener<any, any, any>[]

set

  • Parameters

    • newValue: T | Fastener<any, I[0], any> | LikeType<T>
    • Optional timing: boolean | TimingLike

    Returns R

setAffinity

  • Parameters

    Returns void

Protected setCoherent

  • Protected

    Parameters

    • coherent: boolean

    Returns void

Protected setCoherentTime

  • Protected

    Parameters

    • coherentTime: number

    Returns void

setInherits

  • Parameters

    • inherits: boolean | PropertyKey

    Returns void

setInterpolatedValue

  • Parameters

    • newValue: T
    • Optional newState: T

    Returns void

setIntrinsic

  • Parameters

    • newValue: T | Fastener<any, I[0], any> | LikeType<T>
    • Optional timing: boolean | TimingLike

    Returns R

setState

  • Parameters

    • newState: T | LikeType<T>
    • timingOrAffinity: boolean | Affinity | TimingLike

    Returns void

  • Parameters

    • newState: T | LikeType<T>
    • Optional timing: boolean | TimingLike
    • Optional affinity: Affinity

    Returns void

setValue

  • Parameters

    • newValue: T | LikeType<T>
    • Optional affinity: Affinity

    Returns void

toString

  • Returns string

transformState

  • Parameters

    • state: T

    Returns T

transformValue

  • Parameters

    • value: T

    Returns T

unbindInlet

  • Parameters

    • Optional inlet: Fastener<any, any, any>

    Returns void

Protected willBindInlet

  • Protected

    Parameters

    Returns void

Protected willMount

  • Protected

    Returns void

Protected willSetAffinity

  • Protected

    Parameters

    Returns void

Protected willSetInherits

  • Protected

    Parameters

    • inherits: boolean
    • inheritName: PropertyKey

    Returns void

Protected willSetState

  • Protected

    Parameters

    • newState: T
    • oldState: T

    Returns void

Protected willSetValue

  • Protected

    Parameters

    • newValue: T
    • oldValue: T

    Returns void

Protected willStartTweening

  • Protected

    Returns void

Protected willStopTweening

  • Protected

    Returns void

Protected willTransition

  • Protected

    Parameters

    • oldValue: T

    Returns void

Protected willUnbindInlet

  • Protected

    Parameters

    Returns void

Protected willUnmount

  • Protected

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc