flow
import {...} from "@wangyaoshen/locus-core/lib/flow";
Utilities for controlling the flow and timing of an animation.
Interfaces
Functions
all
public all...tasks: ThreadGenerator[]: ThreadGenerator
Run all tasks concurrently and wait for all of them to finish.
Examples
Parameters
...tasks: ThreadGenerator[]A list of tasks to run.
any
public any...tasks: ThreadGenerator[]: ThreadGenerator
Run all tasks concurrently and wait for any of them to finish.
Examples
Parameters
...tasks: ThreadGenerator[]A list of tasks to run.
chain
public chain...tasks: CallbackThreadGenerator[]: ThreadGenerator
Run tasks one after another.
Examples
Parameters
...tasks: CallbackThreadGenerator[]A list of tasks to run.
delay
Run the given generator or callback after a specific amount of time.
Examples
Parameters
time: numberThe delay in seconds
task: CallbackThreadGeneratorThe task or callback to run after the delay.
every
Call the given callback every N seconds.
Examples
Parameters
interval: numberThe interval between subsequent calls.
callback: EveryCallbackThe callback to be called.
loop
public loopfactory: LoopCallback: ThreadGenerator
public loopiterations: numberfactory: LoopCallback: ThreadGenerator
Run the given generator in a loop.
Each iteration waits until the previous one is completed.
Because this loop never finishes it cannot be used in the main thread.
Instead, use yield or threading.spawn to run the loop concurrently.
Examples
Parameters
factory: LoopCallbackA function creating the generator to run. Because generators can't be reset, a new generator is created on each iteration.
loopFor
Run a generator in a loop for the given amount of time.
Generators are executed completely before the next iteration starts. An iteration is allowed to finish even when the time is up. This means that the actual duration of the loop may be longer than the given duration.
Examples
Parameters
seconds: numberThe duration in seconds.
factory: LoopCallbackA function creating the generator to run. Because generators can't be reset, a new generator is created on each iteration.
loopUntil
Run a generator in a loop until the given time event.
Generators are executed completely before the next iteration starts. An iteration is allowed to finish even when the time is up. This means that the actual duration of the loop may be longer than the given duration.
Examples
Parameters
event: stringThe event.
factory: LoopCallbackA function creating the generator to run. Because generators can't be reset, a new generator is created on each iteration.
noop
public noop(): ThreadGenerator
Do nothing.
run
public runrunner: () => ThreadGenerator: ThreadGenerator
Turn the given generator function into a task.
If you want to immediately run the generator in its own thread, you can use
threading.spawn instead. This function is useful when you want to
pass the created task to other flow functions.
Examples
Parameters
runner: () => ThreadGeneratorA generator function or a factory that creates the generator.
sequence
Start all tasks one after another with a constant delay between.
The function doesn't wait until the previous task in the sequence has finished. Once the delay has passed, the next task will start even if the previous is still running.
Examples
Parameters
delay: numberThe delay between each of the tasks.
...tasks: ThreadGenerator[]A list of tasks to be run in a sequence.
waitFor
Wait for the given amount of time.
Examples
Parameters
seconds: number = 0The relative time in seconds.
after?: ThreadGeneratorAn optional task to be run after the function completes.
waitUntil
Wait until the given time event.
Time events are displayed on the timeline and can be edited to adjust the delay. By default, an event happens immediately - without any delay.