Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AttributeAnimator<O, T, U>

Type parameters

  • O = unknown

  • T = unknown

  • U = never

Hierarchy

Callable

  • AttributeAnimator(): T
  • AttributeAnimator(newState: T | U, timingOrAffinity: undefined | null | number | boolean | AnyTiming): O
  • AttributeAnimator(newState: T | U, timing?: null | boolean | AnyTiming, affinity?: number): O
  • AttributeAnimator(): T
  • AttributeAnimator(state: T | U, affinity?: number): O

  • Returns T

  • Parameters

    • newState: T | U
    • timingOrAffinity: undefined | null | number | boolean | AnyTiming

    Returns O

  • Parameters

    • newState: T | U
    • Optional timing: null | boolean | AnyTiming
    • Optional affinity: number

    Returns O

  • Returns T

  • Parameters

    • state: T | U
    • Optional affinity: number

    Returns O

Index

Properties

Accessors

Methods

Properties

Readonly flags

flags: number

Readonly interpolator

interpolator: null | Interpolator<T>

Readonly look

look: null | Look<T, never>

Readonly ownValue

ownValue: T

Readonly owner

owner: O

Readonly state

state: T

Readonly subFasteners

subFasteners: null | readonly Property<unknown, T, T>[]

Readonly superFastener

superFastener: null | Property<unknown, T, T>

Readonly timing

timing: null | Timing

Accessors

affinity

  • get affinity(): number

  • Returns number

attributeName

  • get attributeName(): string

  • Returns string

attributeValue

  • get attributeValue(): undefined | T

  • Returns undefined | T

coherent

  • get coherent(): boolean

  • Returns boolean

familyType

  • Returns null | Class<Property<any, any, any>>

inherited

  • get inherited(): boolean

  • Returns boolean

inherits

  • get inherits(): boolean

  • Returns boolean

lazy

  • get lazy(): boolean

  • Returns boolean

mounted

  • get mounted(): boolean

  • Returns boolean

name

  • get name(): string

  • Returns string

static

  • get static(): string | boolean

  • Returns string | boolean

superLook

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

  • Returns null | Look<T, never>

superName

  • get superName(): undefined | string

  • Returns undefined | string

superState

  • get superState(): undefined | T

  • Returns undefined | T

superValue

  • get superValue(): undefined | T

  • Returns undefined | T

tweening

  • get tweening(): boolean

  • Returns boolean

updateFlags

  • get updateFlags(): undefined | number

  • Returns undefined | number

value

  • get value(): T
  • set value(value: T): void

  • Returns T

  • Parameters

    • value: T

    Returns void

Methods

applyLook

  • applyLook(look: Look<T, never>, timing: boolean | Timing): void

  • Parameters

    Returns void

applyTheme

  • Parameters

    Returns void

attachSubFastener

  • attachSubFastener(subFastener: Property<unknown, T, T>): void

  • Parameters

    Returns void

bindSuperFastener

  • bindSuperFastener(): void

  • Returns void

decohere

  • decohere(): void

  • Returns void

decohereSubFastener

  • decohereSubFastener(subFastener: Property<unknown, T, T>): void

  • Parameters

    Returns void

decohereSubFasteners

  • decohereSubFasteners(): void

  • Returns void

detachSubFastener

  • detachSubFastener(subFastener: Property<unknown, T, T>): void

  • Parameters

    Returns void

didBindSuperFastener

  • didBindSuperFastener(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

didInherit

  • didInherit(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

didInterrupt

  • didInterrupt(value: T): void

  • Parameters

    • value: T

    Returns void

didMount

  • didMount(): void

  • Returns void

didSetAffinity

  • didSetAffinity(newAffinity: number, oldAffinity: number): void

  • Parameters

    • newAffinity: number
    • oldAffinity: number

    Returns void

didSetInherits

  • didSetInherits(inherits: boolean, superName: undefined | string): void

  • Parameters

    • inherits: boolean
    • superName: undefined | string

    Returns void

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

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

didStartTweening

  • didStartTweening(): void

  • Returns void

didStopTweening

  • didStopTweening(): void

  • Returns void

didTransition

  • didTransition(newValue: T): void

  • Parameters

    • newValue: T

    Returns void

didUnbindSuperFastener

  • didUnbindSuperFastener(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

didUninherit

  • didUninherit(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

didUnmount

  • didUnmount(): void

  • Returns void

equalState

  • equalState(newState: T, oldState: undefined | T): boolean

  • Parameters

    • newState: T
    • oldState: undefined | T

    Returns boolean

fromAny

  • fromAny(value: T | U): T

  • Parameters

    • value: T | U

    Returns T

getLook

  • getLook(): Look<T, never>

  • Returns Look<T, never>

getLookOr

  • getLookOr<E>(elseLook: E): Look<T, never> | E

  • Type parameters

    • E

    Parameters

    • elseLook: E

    Returns Look<T, never> | E

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

getSuperFastener

  • getSuperFastener(): null | Property<unknown, T, T>

  • Returns null | Property<unknown, T, T>

getSuperLook

  • getSuperLook(): Look<T, never>

  • Returns Look<T, never>

getSuperLookOr

  • getSuperLookOr<E>(elseLook: E): Look<T, never> | E

  • Type parameters

    • E

    Parameters

    • elseLook: E

    Returns Look<T, never> | E

getSuperState

  • getSuperState(): NonNullable<T>

  • Returns NonNullable<T>

getSuperStateOr

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

  • Type parameters

    • E

    Parameters

    • elseState: E

    Returns NonNullable<T> | E

getSuperValue

  • getSuperValue(): NonNullable<T>

  • Returns NonNullable<T>

getSuperValueOr

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

  • Type parameters

    • E

    Parameters

    • elseValue: 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

hasAffinity

  • hasAffinity(affinity: number): boolean

  • Parameters

    • affinity: number

    Returns boolean

init

  • init(): void

  • Returns void

initAffinity

  • initAffinity(affinity: number): void

  • Parameters

    • affinity: number

    Returns void

initInherits

  • initInherits(inherits: string | boolean): void

  • Parameters

    • inherits: string | boolean

    Returns void

isDefined

  • isDefined(value: T): boolean

  • Parameters

    • value: T

    Returns boolean

minAffinity

  • minAffinity(affinity: undefined | number): boolean

  • Parameters

    • affinity: undefined | number

    Returns boolean

mount

  • mount(): void

  • Returns void

onBindSuperFastener

  • onBindSuperFastener(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

onInherit

  • onInherit(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

onMount

  • onMount(): void

  • Returns void

onSetAffinity

  • onSetAffinity(newAffinity: number, oldAffinity: number): void

  • Parameters

    • newAffinity: number
    • oldAffinity: number

    Returns void

onSetInherits

  • onSetInherits(inherits: boolean, superName: undefined | string): void

  • Parameters

    • inherits: boolean
    • superName: undefined | string

    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

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

onStartTweening

  • onStartTweening(): void

  • Returns void

onStopTweening

  • onStopTweening(): void

  • Returns void

onUnbindSuperFastener

  • onUnbindSuperFastener(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

onUninherit

  • onUninherit(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

onUnmount

  • onUnmount(): void

  • Returns void

parse

  • parse(value: string): T

  • Parameters

    • value: string

    Returns T

recohere

  • recohere(t: number): void

  • Parameters

    • t: number

    Returns void

setAffinity

  • setAffinity(affinity: number): void

  • Parameters

    • affinity: number

    Returns void

setCoherent

  • setCoherent(coherent: boolean): void

  • Parameters

    • coherent: boolean

    Returns void

setFlags

  • setFlags(flags: number): void

  • Parameters

    • flags: number

    Returns void

setInherited

  • setInherited(inherited: boolean, superFastener: Property<unknown, T, T>): void

  • Parameters

    • inherited: boolean
    • superFastener: Property<unknown, T, T>

    Returns void

setInherits

  • setInherits(inherits: string | boolean): void

  • Parameters

    • inherits: string | boolean

    Returns void

setInterpolatedValue

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

  • Parameters

    • newValue: T
    • Optional newState: T

    Returns void

setLook

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

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

setState

  • setState(newState: T | U, timingOrAffinity: undefined | null | number | boolean | AnyTiming): void
  • setState(newState: T | U, timing?: null | boolean | AnyTiming, affinity?: number): void

  • Parameters

    • newState: T | U
    • timingOrAffinity: undefined | null | number | boolean | AnyTiming

    Returns void

  • Parameters

    • newState: T | U
    • Optional timing: null | boolean | AnyTiming
    • Optional affinity: number

    Returns void

setValue

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

  • Parameters

    • newValue: T
    • Optional oldValue: T

    Returns void

startTweening

  • startTweening(): void

  • Returns void

stopTweening

  • stopTweening(): void

  • Returns void

toString

  • toString(): string

  • Returns string

tween

  • tween(t: number): void

  • Parameters

    • t: number

    Returns void

tweenInherited

  • tweenInherited(t: number): void

  • Parameters

    • t: number

    Returns void

unbindSuperFastener

  • unbindSuperFastener(): void

  • Returns void

unmount

  • unmount(): void

  • Returns void

willBindSuperFastener

  • willBindSuperFastener(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

willInherit

  • willInherit(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

willMount

  • willMount(): void

  • Returns void

willSetAffinity

  • willSetAffinity(newAffinity: number, oldAffinity: number): void

  • Parameters

    • newAffinity: number
    • oldAffinity: number

    Returns void

willSetInherits

  • willSetInherits(inherits: boolean, superName: undefined | string): void

  • Parameters

    • inherits: boolean
    • superName: undefined | string

    Returns void

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

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

willStartTweening

  • willStartTweening(): void

  • Returns void

willStopTweening

  • willStopTweening(): void

  • Returns void

willTransition

  • willTransition(oldValue: T): void

  • Parameters

    • oldValue: T

    Returns void

willUnbindSuperFastener

  • willUnbindSuperFastener(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

willUninherit

  • willUninherit(superFastener: Property<unknown, T, T>): void

  • Parameters

    • superFastener: Property<unknown, T, T>

    Returns void

willUnmount

  • willUnmount(): void

  • Returns void

Generated using TypeDoc