@revideo/2d / decorators / FiltersSignalContext

Class: FiltersSignalContext<TOwner>

Defined in: 2d/src/lib/decorators/filtersSignal.ts:29

Extends

SignalContext<Filter[], Filter[], TOwner>

Type Parameters

TOwner

TOwner

Constructors

Constructor

new FiltersSignalContext<TOwner>(initial, owner): FiltersSignalContext<TOwner>

Defined in: 2d/src/lib/decorators/filtersSignal.ts:34

Parameters

initial

Filter[]

owner

TOwner

Returns

FiltersSignalContext<TOwner>

Overrides

SignalContext< Filter[], Filter[], TOwner >.constructor

Properties

current

protected current: SignalValue<Filter[]> | undefined

Defined in: core/lib/signals/SignalContext.d.ts:27

Inherited from

SignalContext.current

dependencies

protected dependencies: Set<Subscribable<void, EventHandler<void>>>

Defined in: core/lib/signals/DependencyContext.d.ts:20

Inherited from

SignalContext.dependencies

event

protected event: FlagDispatcher

Defined in: core/lib/signals/DependencyContext.d.ts:21

Inherited from

SignalContext.event

extensions

protected extensions: SignalExtensions<Filter[], Filter[]>

Defined in: core/lib/signals/SignalContext.d.ts:26

Inherited from

SignalContext.extensions

invokable

protected readonly invokable: any

Defined in: core/lib/signals/DependencyContext.d.ts:19

Inherited from

SignalContext.invokable

last

protected last: Filter[] | undefined

Defined in: core/lib/signals/SignalContext.d.ts:28

Inherited from

SignalContext.last

markDirty

protected markDirty: () => void

Defined in: core/lib/signals/DependencyContext.d.ts:22

Returns

void

Inherited from

SignalContext.markDirty

owner

protected owner: TOwner

Defined in: core/lib/signals/DependencyContext.d.ts:11

Inherited from

SignalContext.owner

parser

protected parser: (value) => Filter[]

Defined in: core/lib/signals/SignalContext.d.ts:25

Parameters

value

Filter[]

Returns

Filter[]

Inherited from

SignalContext.parser

tweening

protected tweening: boolean

Defined in: core/lib/signals/SignalContext.d.ts:29

Inherited from

SignalContext.tweening

collectionSet

protected static collectionSet: Set<DependencyContext<any>>

Defined in: core/lib/signals/DependencyContext.d.ts:12

Inherited from

SignalContext.collectionSet

collectionStack

protected static collectionStack: DependencyContext<any>[]

Defined in: core/lib/signals/DependencyContext.d.ts:13

Inherited from

SignalContext.collectionStack

promises

protected static promises: PromiseHandle<any>[]

Defined in: core/lib/signals/DependencyContext.d.ts:14

Inherited from

SignalContext.promises

Methods

clearDependencies()

protected clearDependencies(): void

Defined in: core/lib/signals/DependencyContext.d.ts:27

Returns

void

Inherited from

SignalContext.clearDependencies

collect()

protected collect(): void

Defined in: core/lib/signals/DependencyContext.d.ts:28

Returns

void

Inherited from

SignalContext.collect

createQueue()

protected createQueue(defaultTimingFunction, defaultInterpolationFunction): SignalGenerator<Filter[], Filter[]>

Defined in: core/lib/signals/SignalContext.d.ts:38

Parameters

defaultTimingFunction

TimingFunction

defaultInterpolationFunction

InterpolationFunction<Filter[]>

Returns

SignalGenerator<Filter[], Filter[]>

Inherited from

SignalContext.createQueue

dispose()

dispose(): void

Defined in: core/lib/signals/SignalContext.d.ts:41

Returns

void

Inherited from

SignalContext.dispose

finishCollecting()

protected finishCollecting(): void

Defined in: core/lib/signals/DependencyContext.d.ts:26

Returns

void

Inherited from

SignalContext.finishCollecting

get()

get(): Filter[]

Defined in: core/lib/signals/SignalContext.d.ts:35

Returns

Filter[]

Inherited from

SignalContext.get

getInitial()

getInitial(): SignalValue<Filter[]> | undefined

Defined in: core/lib/signals/SignalContext.d.ts:90

Get the initial value of this signal.

Returns

SignalValue<Filter[]> | undefined

Inherited from

SignalContext.getInitial

getter()

getter(): Filter[]

Defined in: core/lib/signals/SignalContext.d.ts:36

Returns

Filter[]

Inherited from

SignalContext.getter

invoke()

protected invoke(value?, duration?, timingFunction?, interpolationFunction?): Filter[] | TOwner | SignalGenerator<Filter[], Filter[]>

Defined in: core/lib/signals/SignalContext.d.ts:37

Parameters

value?

typeof DEFAULT | SignalValue<Filter[]>

duration?

number

timingFunction?

TimingFunction

interpolationFunction?

InterpolationFunction<Filter[], any[]>

Returns

Filter[] | TOwner | SignalGenerator<Filter[], Filter[]>

Inherited from

SignalContext.invoke

isInitial()

isInitial(): boolean

Defined in: core/lib/signals/SignalContext.d.ts:86

Check if the signal is currently using its initial value.

Returns

boolean

Example


 
const signal = createSignal(0);
signal.isInitial(); // true
 
signal(5);
signal.isInitial(); // false
 
signal(DEFAULT);
signal.isInitial(); // true

Inherited from

SignalContext.isInitial

isTweening()

isTweening(): boolean

Defined in: core/lib/signals/SignalContext.d.ts:118

Is the signal undergoing a tween?

Returns

boolean

Inherited from

SignalContext.isTweening

parse()

parse(value): Filter[]

Defined in: core/lib/signals/SignalContext.d.ts:32

Parameters

value

Filter[]

Returns

Filter[]

Inherited from

SignalContext.parse

raw()

raw(): SignalValue<Filter[]> | undefined

Defined in: core/lib/signals/SignalContext.d.ts:114

Get the raw value of this signal.

Returns

SignalValue<Filter[]> | undefined

Remarks

If the signal was provided with a factory function, the function itself will be returned, without invoking it.

This method can be used to create copies of signals.

Example


const a = createSignal(2);
const b = createSignal(() => a);
// b() == 2
 
const bClone = createSignal(b.raw());
// bClone() == 2
 
a(4);
// b() == 4
// bClone() == 4

Inherited from

SignalContext.raw

reset()

reset(): TOwner

Defined in: core/lib/signals/SignalContext.d.ts:54

Reset the signal to its initial value (if one has been set).

Returns

TOwner

Example


const signal = createSignal(7);
 
signal.reset();
// same as:
signal(7);

Inherited from

SignalContext.reset

save()

save(): TOwner

Defined in: core/lib/signals/SignalContext.d.ts:69

Compute the current value of the signal and immediately set it.

Returns

TOwner

Remarks

This method can be used to stop the signal from updating while keeping its current value.

Example


signal.save();
// same as:
signal(signal());

Inherited from

SignalContext.save

set()

set(value): TOwner

Defined in: core/lib/signals/SignalContext.d.ts:33

Parameters

value

typeof DEFAULT | SignalValue<Filter[]>

Returns

TOwner

Inherited from

SignalContext.set

setter()

setter(value): TOwner

Defined in: core/lib/signals/SignalContext.d.ts:34

Parameters

value

typeof DEFAULT | SignalValue<Filter[]>

Returns

TOwner

Inherited from

SignalContext.setter

startCollecting()

protected startCollecting(): void

Defined in: core/lib/signals/DependencyContext.d.ts:25

Returns

void

Inherited from

SignalContext.startCollecting

toPromise()

toPromise(): Promise<FiltersSignalContext<TOwner>>

Defined in: core/lib/signals/DependencyContext.d.ts:30

Returns

Promise<FiltersSignalContext<TOwner>>

Inherited from

SignalContext.toPromise

toSignal()

toSignal(): Signal<Filter[], Filter[], TOwner>

Defined in: core/lib/signals/SignalContext.d.ts:31

Returns

Signal<Filter[], Filter[], TOwner>

Inherited from

SignalContext.toSignal

tween()

protected tween(value, duration, timingFunction, interpolationFunction): ThreadGenerator

Defined in: core/lib/signals/SignalContext.d.ts:39

Parameters

value

typeof DEFAULT | SignalValue<Filter[]>

duration

number

timingFunction

TimingFunction

interpolationFunction

InterpolationFunction<Filter[]>

Returns

ThreadGenerator

Inherited from

SignalContext.tween

tweener()

tweener(value, duration, timingFunction): ThreadGenerator

Defined in: 2d/src/lib/decorators/filtersSignal.ts:72

Parameters

value

SignalValue<Filter[]>

duration

number

timingFunction

TimingFunction

Returns

ThreadGenerator

Overrides

SignalContext.tweener

collectPromise()

Call Signature

static collectPromise<T>(promise): PromiseHandle<T | null>

Defined in: core/lib/signals/DependencyContext.d.ts:15

Type Parameters

T

T

Parameters

promise

Promise<T>

Returns

PromiseHandle<T | null>

Inherited from

SignalContext.collectPromise

Call Signature

static collectPromise<T>(promise, initialValue): PromiseHandle<T>

Defined in: core/lib/signals/DependencyContext.d.ts:16

Type Parameters

T

T

Parameters

promise

Promise<T>

initialValue

T

Returns

PromiseHandle<T>

Inherited from

SignalContext.collectPromise

consumePromises()

static consumePromises(): Promise<PromiseHandle<any>[]>

Defined in: core/lib/signals/DependencyContext.d.ts:18

Returns

Promise<PromiseHandle<any>[]>

Inherited from

SignalContext.consumePromises

hasPromises()

static hasPromises(): boolean

Defined in: core/lib/signals/DependencyContext.d.ts:17

Returns

boolean

Inherited from

SignalContext.hasPromises