EnvironmentAnimationOptions

What an EnvironmentAnimationRuntime is built from.

@internote/canvas-sdkInterface
On this page
import { EnvironmentAnimationOptions } from '@internote/canvas-sdk';

#Fields

ctxRequired
Handed through to the hooks and handlers. The host passes the environment's context.
Ctx
detached
A runtime that only reads: it neither listens to the steps nor dispatches hooks and verbs. What EnvironmentAnimationRuntime.at builds.
boolean
interpolations
How keyframed values blend between keyframes. The built-in registry when absent.
InterpolationRegistry
nodeRequired
The compiled environment node this runtime animates.
CompiledNode
onStep
Called after every step change, with the step entered.
(step: number, ctx: Ctx) => void
parameters
A token whose identity changes when any of the scene's parameters moves, and a reader of their numbers, called only when a value is not already cached. A bool attribute written as a condition over a slider's letter (hidden: t > 3, D57) is decided against them, so every surface reads a boolean where it reads the attribute.
() => { numbers: () => Record<string, number>; token: unknown }
stepsRequired
The scene's step controller, shared by every environment in the scene.
StepController
verbs
The environment's verb handlers, keyed by vocabulary identifier.
Record<string, VerbHandler<Ctx>>

Declared in packages/canvas-sdk/src/animation/EnvironmentAnimationRuntime.ts:83.

Last updated