GTKX

API Reference / @gtkx/animated / FrameValue

Abstract Class: FrameValue<T> ​

A kind of FluidValue that manages an AnimatedValue node.

Its underlying value can be accessed and even observed.

Extends ​

Extended by ​

Type Parameters ​

T ​

T = any

Constructors ​

Constructor ​

new FrameValue<T>(get?): FrameValue<T>

Parameters ​

get? ​

() => T

Returns ​

FrameValue<T>

Inherited from ​

FluidValue<T, FrameValue.Event<T>>.constructor

Properties ​

_priority ​

protected _priority: number

id ​

readonly id: number

key? ​

abstract optional key?: string

Accessors ​

idle ​

Get Signature ​

get abstract idle(): boolean

Returns ​

boolean

priority ​

Get Signature ​

get priority(): number

Returns ​

number

Set Signature ​

set priority(priority): void

Parameters ​
priority ​

number

Returns ​

void

Methods ​

_attach() ​

protected _attach(): void

Called when the first child is added.

Returns ​

void

_detach() ​

protected _detach(): void

Called when the last child is removed.

Returns ​

void

_onChange() ​

protected _onChange(value, idle?): void

Tell our children about our new value

Parameters ​

value ​

T

idle? ​

boolean

Returns ​

void

_onPriorityChange() ​

protected _onPriorityChange(priority): void

Tell our children about our new priority

Parameters ​

priority ​

number

Returns ​

void

advance() ​

abstract advance(dt): void

Internal

Parameters ​

dt ​

number

Returns ​

void

eventObserved() ​

abstract eventObserved(_event): void

Internal

Parameters ​

_event ​

Event

Returns ​

void

get() ​

get(): T

Get the current value

Returns ​

T

Overrides ​

FluidValue.get

interpolate() ​

interpolate<Out>(...args): Interpolation<T, Out>

Type Parameters ​

Out ​

Out

Parameters ​

args ​

...InterpolatorArgs<T, Out>

Returns ​

Interpolation<T, Out>

Deprecated ​

Use the to method instead.

observerAdded() ​

protected observerAdded(count): void

Called after an observer is added.

Parameters ​

count ​

number

Returns ​

void

Overrides ​

FluidValue.observerAdded

observerRemoved() ​

protected observerRemoved(count): void

Called after an observer is removed.

Parameters ​

count ​

number

Returns ​

void

Overrides ​

FluidValue.observerRemoved

to() ​

to<Out>(...args): Interpolation<T, Out>

Create a spring that maps our value to another value

Type Parameters ​

Out ​

Out

Parameters ​

args ​

...InterpolatorArgs<T, Out>

Returns ​

Interpolation<T, Out>

toJSON() ​

toJSON(): T

Returns ​

T