@motionscript/charts 0.1.0-alpha.0 → 0.1.0-alpha.10

package/src/line-chart/chart-line.ts

@@ -1,21 +1,19 @@
 import {
-  type AssetScope,
   Graphics2D,
-  Node2D,
-  command,
-  easeOut,
+  Types,
+  component2d,
   strokeOps,
-  property,
-  type Command,
-  type CommandArgs,
-  type EasingFunction,
-  type Node2DProps,
-  type RenderContext2D,
+  type NodeOf,
+  // Named so this component's emitted type reaches `Node2D` through the sdk, not core.
+  type Node2D as _Node2D,
   type Stroke,
   type StrokeResolved,
   type Vector2,
-} from "@motionscript/core"
+} from "@motionscript/sdk"
 
+import { fresh } from "../kit/entries"
+import { frameEase } from "../kit/motion"
+import { loadPaints } from "../kit/paints"
 import { SPOTLIGHT_DIM } from "../kit/shared"
 import {
   EMPTY_REGION_BOX,
@@ -23,40 +21,42 @@ import {
   hasRegion,
   type RegionBox,
 } from "./shared"
-import { declarePaints } from "@motionscript/core/component"
 
-export interface ChartLineProps extends Node2DProps {
-  /**
-   * The series polyline, already mapped into this node's local pixel space
-   * (origin at centre, y-up) by the parent {@link LineChart}. Ordered along x.
-   */
-  points: Vector2[]
-  /** Line colour + weight (+ optional dash/cap/join) — the per-series stroke. */
-  stroke: Stroke
-  /**
-   * Reveal of the line in `[0, 1]`: 0 hides it, 1 traces it fully from its left
-   * end to its right.
-   *
-   * Defaults to **1**, unlike the standalone chart this was ported from: in the
-   * studio a node's resting state is what the paused editor canvas paints, so a
-   * chart that only appeared once a command had run would edit blind. {@link
-   * enter} drives it from 0 regardless of where it rests, so the animation is
-   * unchanged.
-   */
-  progress: number
-  /**
-   * Whether this line is drawn at all. `false` hides it outright — the switch
-   * the chart flips alongside its legend's per-series toggle.
-   */
-  enabled: boolean
-  /**
-   * A slice of the plot to spotlight, in this node's own pixel space. When set
-   * to a real box, the stretches of the line *outside* it drop to
-   * {@link ChartLineProps.dimOpacity} while the stretches inside stay full.
-   */
-  spotlight: RegionBox
-  /** Opacity the out-of-region stretches fade to. */
-  dimOpacity: number
+/**
+ * The prefix of `pts` revealed at fraction `p ∈ [0, 1]`, measuring the reveal
+ * by *cumulative arc length* so the line traces at a steady pace regardless of
+ * uneven point spacing. Returns the whole-point prefix plus one interpolated
+ * point partway along the active segment.
+ */
+function tracePoints(pts: Vector2[], p: number): Vector2[] {
+  if (p >= 1 || pts.length < 2) return pts
+  if (p <= 0) return []
+
+  const segLen: number[] = []
+  let total = 0
+  for (let i = 1; i < pts.length; i++) {
+    const d = Math.hypot(pts[i].x - pts[i - 1].x, pts[i].y - pts[i - 1].y)
+    segLen.push(d)
+    total += d
+  }
+  if (total === 0) return pts
+
+  let target = total * p
+  const out: Vector2[] = [pts[0]]
+  for (let i = 0; i < segLen.length; i++) {
+    if (target >= segLen[i]) {
+      out.push(pts[i + 1])
+      target -= segLen[i]
+    } else {
+      const t = segLen[i] === 0 ? 0 : target / segLen[i]
+      out.push({
+        x: pts[i].x + (pts[i + 1].x - pts[i].x) * t,
+        y: pts[i].y + (pts[i + 1].y - pts[i].y) * t,
+      })
+      break
+    }
+  }
+  return out
 }
 
 /**
@@ -64,41 +64,69 @@ export interface ChartLineProps extends Node2DProps {
  * through pre-mapped pixel `points`, drawn as one {@link Graphics2D} command list.
  * Sized and positioned by the parent, which shares the plot's coordinate frame.
  *
- * Two signals drive it: {@link ChartLineProps.progress} traces the line in
- * (animated by {@link enter}) and `enabled` shows or hides it wholesale.
+ * Two signals drive it: `progress` traces the line in
+ * (animated by `enter`) and `enabled` shows or hides it wholesale.
  */
-export class ChartLine extends Node2D<ChartLineProps> {
-  @property({ default: () => [] as Vector2[] }) declare points: Vector2[]
-  @property({ default: [], mapper: strokeOps.resolve, tween: strokeOps.lerp })
-  declare stroke: Stroke
-  @property({ default: 1 }) declare progress: number
-  @property({ default: true }) declare enabled: boolean
-  @property({ default: () => EMPTY_REGION_BOX }) declare spotlight: RegionBox
-  @property({ default: SPOTLIGHT_DIM }) declare dimOpacity: number
-
-  /**
-   * This node extends `Node2D` rather than `ShapeNode`, so nothing declares the
-   * paint props it carries — see {@link declarePaints}.
-   */
-  override declareAssets(assets: AssetScope): void {
-    super.declareAssets(assets)
-    declarePaints(this, assets)
-  }
-
-  protected renderSelf(ctx: RenderContext2D): void {
-    if (!this.enabled) return
-    const pts = this.points
+export const ChartLine = component2d({
+  key: "chartLine",
+  state: {
+    /** The series polyline, already mapped into this node's local pixel space (origin at centre, y-up) by the parent {@link LineChart}. Ordered along x. */
+    points: fresh<Vector2[]>(() => []),
+    /** Line colour + weight (+ optional dash/cap/join) — the per-series stroke. */
+    stroke: Types.custom<Stroke, StrokeResolved[]>([], { resolve: strokeOps.resolve, lerp: strokeOps.lerp }),
+    /**
+     * Reveal of the line in `[0, 1]`: 0 hides it, 1 traces it fully from its left
+     * end to its right. Defaults to 1, so the paused editor canvas paints the line;
+     * `enter` drives it from 0 regardless of where it rests.
+     */
+    progress: 1,
+    /** Whether this line is drawn at all: the switch the chart flips alongside its legend's per-series toggle. */
+    enabled: true,
+    /** A slice of the plot to spotlight, in this node's own pixel space: outside it the line drops to `dimOpacity`. */
+    spotlight: fresh<RegionBox>(() => EMPTY_REGION_BOX),
+    /** Opacity the out-of-region stretches fade to. */
+    dimOpacity: SPOTLIGHT_DIM,
+  },
+  load: (loader, state) => loadPaints(loader, { strokes: [state.stroke] }),
+  commands: {
+    /**
+     * Trace the line from `from` to `to` over the command — by default in from
+     * its left end to its right. `showSeries` and `hideSeries` are the same
+     * motion in opposite directions, so both are this with their ends stated.
+     *
+     * `enabled` rides along in the same value rather than being set before or
+     * after the command: a line is drawable for every `t` the trace covers and
+     * undrawn outside it, which is what makes arriving at a time backwards show
+     * what arriving forwards does.
+     */
+    enter: {
+      args: { from: Types.number(0, { min: 0, max: 1 }), to: Types.number(1, { min: 0, max: 1 }) },
+      run: (timeline) => {
+        const { from, to } = timeline.args
+        const ease = frameEase(timeline)
+        return timeline.animate((t) => {
+          const progress = from + (to - from) * ease(t)
+          // Hidden only once it has fully retraced, so the last frame of a hide is
+          // the empty plot rather than a line that vanished a frame early.
+          return { progress, enabled: progress > 0 }
+        })
+      },
+    },
+  },
+  render: (ctx, state) => {
+    if (!state.enabled) return
+    const pts = state.points
     if (pts.length < 2) return
 
-    const p = Math.max(0, Math.min(1, this.progress))
+    const p = Math.max(0, Math.min(1, state.progress))
     if (p <= 0) return
 
-    const drawn = this.tracePoints(pts, p)
+    const drawn = tracePoints(pts, p)
     if (drawn.length < 2) return
-    const stroke = this.stroke as StrokeResolved[]
+    const stroke = state.stroke
     const radius = (stroke[0]?.weight ?? 0) * 2 // round the joins
 
-    const box = this.spotlight
+    const box = state.spotlight
     if (!hasRegion(box)) {
       ctx.draw(new Graphics2D().line({ points: drawn, radius }).stroke(stroke))
       return
@@ -113,7 +141,7 @@ export class ChartLine extends Node2D<ChartLineProps> {
       new Graphics2D()
         .line({ points: drawn, radius })
         .stroke(stroke)
-        .opacity(Math.max(0, Math.min(1, this.dimOpacity)))
+        .opacity(Math.max(0, Math.min(1, state.dimOpacity)))
     )
 
     // One `draw` per run: shapes chained before a `stroke()` are combined into a
@@ -122,87 +150,7 @@ export class ChartLine extends Node2D<ChartLineProps> {
     for (const run of clipPolylineToBox(drawn, box)) {
       ctx.draw(new Graphics2D().line({ points: run, radius }).stroke(stroke))
     }
-  }
-
-  /**
-   * The prefix of `pts` revealed at fraction `p ∈ [0, 1]`, measuring the reveal
-   * by *cumulative arc length* so the line traces at a steady pace regardless of
-   * uneven point spacing. Returns the whole-point prefix plus one interpolated
-   * point partway along the active segment.
-   */
-  private tracePoints(pts: Vector2[], p: number): Vector2[] {
-    if (p >= 1 || pts.length < 2) return pts
-    if (p <= 0) return []
-
-    const segLen: number[] = []
-    let total = 0
-    for (let i = 1; i < pts.length; i++) {
-      const d = Math.hypot(pts[i].x - pts[i - 1].x, pts[i].y - pts[i - 1].y)
-      segLen.push(d)
-      total += d
-    }
-    if (total === 0) return pts
-
-    let target = total * p
-    const out: Vector2[] = [pts[0]]
-    for (let i = 0; i < segLen.length; i++) {
-      if (target >= segLen[i]) {
-        out.push(pts[i + 1])
-        target -= segLen[i]
-      } else {
-        const t = segLen[i] === 0 ? 0 : target / segLen[i]
-        out.push({
-          x: pts[i].x + (pts[i + 1].x - pts[i].x) * t,
-          y: pts[i].y + (pts[i + 1].y - pts[i].y) * t,
-        })
-        break
-      }
-    }
-    return out
-  }
+  },
+})
 
-  /**
-   * Trace the line in from its left end to its right over `duration` seconds.
-   * Drives `progress` `0 → 1`.
-   *
-   * A `Command` rather than a generator, so the trace can be *evaluated* at a
-   * time instead of run to one — which is what lets a scene containing this
-   * chart be scrubbed in constant time. It no longer needs to prime `progress`
-   * to 0 first: the value at `t` is a function of `t`, so a repeat call re-traces
-   * by definition rather than by having reset something.
-   */
-  @command()
-  enter(args: CommandArgs<Record<string, never>> & { duration: number }): Command<ChartLineProps> {
-    return this.enterFrom(0, args.duration, args.easing ?? easeOut())
-  }
-
-  /**
-   * The trace, with both ends stated: `progress` runs `from` → `to`.
-   *
-   * What {@link LineChart.showSeries} and `hideSeries` are both made of — they
-   * are the same motion in opposite directions, and expressing them as one thing
-   * with endpoints is what stops the pair drifting apart.
-   *
-   * `enabled` rides along in the same value rather than being set before or after
-   * the command. A line is drawable for every `t` the trace covers and undrawn
-   * outside it, which is what makes arriving at a time backwards show what
-   * arriving forwards does — a flag flipped by a side effect would not.
-   */
-  enterFrom(
-    from: number,
-    duration: number,
-    easing: EasingFunction = easeOut(),
-    to = 1
-  ): Command<ChartLineProps> {
-    return this.command<ChartLineProps>(
-      (t) => {
-        const progress = from + (to - from) * t
-        // Hidden only once it has fully retraced, so the last frame of a hide is
-        // the empty plot rather than a line that vanished a frame early.
-        return { progress, enabled: progress > 0 }
-      },
-      duration,
-      easing
-    )
-  }
-}
+export type ChartLine = NodeOf<typeof ChartLine>

package/src/line-chart/chart-region.ts

@@ -1,50 +1,32 @@
 import {
-  type AssetScope,
   Graphics2D,
-  Node2D,
+  Types,
+  component2d,
   fillOps,
   strokeOps,
-  property,
   type Fill,
   type FillResolved,
-  type Node2DProps,
-  type RenderContext2D,
+  type NodeOf,
+  // Named so this component's emitted type reaches `Node2D` through the sdk, not core.
+  type Node2D as _Node2D,
   type Stroke,
   type StrokeResolved,
-} from "@motionscript/core"
+} from "@motionscript/sdk"
 
+import { fresh } from "../kit/entries"
+import { loadPaints } from "../kit/paints"
 import {
   DEFAULT_CHART_THEME,
   EMPTY_REGION_BOX,
   hasRegion,
   type RegionBox,
 } from "./shared"
-import { declarePaints } from "@motionscript/core/component"
-
-export interface ChartRegionProps extends Node2DProps {
-  /**
-   * The highlighted slice, already resolved into this node's local pixel space
-   * (origin at centre, y-up) by the parent {@link LineChart}. A degenerate box
-   * draws nothing.
-   */
-  box: RegionBox
-  /** Dashed rule marking each *bounded* edge of the box. */
-  stroke: Stroke
-  /** Wash filling the box, under the series lines. */
-  fill: Fill
-  /**
-   * Reveal of the annotation in `[0, 1]`: 0 hides it, 1 draws it fully. Driven
-   * by the chart's own `regionReveal`, so the rules and the series' dimming move
-   * as one.
-   */
-  reveal: number
-}
 
 /**
  * The **region call-out** of a {@link LineChart}: a washed rectangle over the
  * plot with a dashed rule down each edge the author actually bounded. Sized and
- * positioned entirely from the pre-mapped {@link ChartRegionProps.box} rather
- * than its own `layoutBounds` — the box already carries the plot geometry.
+ * positioned entirely from the pre-mapped `box` rather
+ * than its own box — the region already carries the plot geometry.
  *
  * It draws only the *marking*; fading the series outside the region is
  * {@link ChartLine}'s job (it clips its own polyline against the same box), so
@@ -54,36 +36,24 @@ export interface ChartRegionProps extends Node2DProps {
  * plot height, so its top and bottom edges are the plot's own border, not a data
  * bound — drawing dashes there would assert a limit the author didn't set.
  */
-export class ChartRegion extends Node2D<ChartRegionProps> {
-  @property({ default: () => EMPTY_REGION_BOX }) declare box: RegionBox
-  @property({
-    default: DEFAULT_CHART_THEME.region.stroke,
-    mapper: strokeOps.resolve,
-    tween: strokeOps.lerp,
-  })
-  declare stroke: Stroke
-  @property({
-    default: DEFAULT_CHART_THEME.region.fill,
-    mapper: fillOps.resolve,
-    tween: fillOps.lerp,
-  })
-  declare fill: Fill
-  @property({ default: 0 }) declare reveal: number
-
-  /**
-   * This node extends `Node2D` rather than `ShapeNode`, so nothing declares the
-   * paint props it carries — see {@link declarePaints}.
-   */
-  override declareAssets(assets: AssetScope): void {
-    super.declareAssets(assets)
-    declarePaints(this, assets)
-  }
-
-  protected renderSelf(ctx: RenderContext2D): void {
-    const box = this.box
+export const ChartRegion = component2d({
+  key: "chartRegion",
+  state: {
+    /** The highlighted slice, already resolved into this node's local pixel space (origin at centre, y-up) by the parent {@link LineChart}. A degenerate box draws nothing. */
+    box: fresh<RegionBox>(() => EMPTY_REGION_BOX),
+    /** Dashed rule marking each *bounded* edge of the box. */
+    stroke: Types.custom<Stroke, StrokeResolved[]>(DEFAULT_CHART_THEME.region.stroke, { resolve: strokeOps.resolve, lerp: strokeOps.lerp }),
+    /** Wash filling the box, under the series lines. */
+    fill: Types.custom<Fill, FillResolved[]>(DEFAULT_CHART_THEME.region.fill, { resolve: fillOps.resolve, lerp: fillOps.lerp }),
+    /** Reveal of the annotation in `[0, 1]`, driven by the chart's own `regionReveal` so the rules and the series' dimming move as one. */
+    reveal: 0,
+  },
+  load: (loader, state) => loadPaints(loader, { fills: [state.fill], strokes: [state.stroke] }),
+  render: (ctx, state) => {
+    const box = state.box
     if (!hasRegion(box)) return
 
-    const r = Math.max(0, Math.min(1, this.reveal))
+    const r = Math.max(0, Math.min(1, state.reveal))
     if (r <= 0) return
 
     const width = box.right - box.left
@@ -92,44 +62,29 @@ export class ChartRegion extends Node2D<ChartRegionProps> {
     const cy = (box.bottom + box.top) / 2
 
     // Wash first, so the rules sit over their own tint.
-    const layers = this.fill as FillResolved[]
-    if (layers.length > 0) {
-      ctx.draw(
-        new Graphics2D()
-          .rect({ x: cx, y: cy, width, height })
-          .fill(this.fill)
-          .opacity(r)
-      )
+    if (state.fill.length > 0) {
+      ctx.draw(new Graphics2D().rect({ x: cx, y: cy, width, height }).fill(state.fill).opacity(r))
     }
 
     // One rule per bounded edge, growing from the region's centre outward as
     // `reveal` climbs — the same "trace it in" beat as the series lines.
-    const stroke = this.stroke as StrokeResolved[]
-    if (stroke.length === 0) return
+    if (state.stroke.length === 0) return
 
     // One `draw` per rule rather than four line ops under a single paint:
     // shapes chained before a `stroke()` are combined into one surface, and
     // stroking a union of disjoint open paths doesn't paint.
     const rule = (points: { x: number; y: number }[]) =>
-      ctx.draw(new Graphics2D().line({ points }).stroke(this.stroke).opacity(r))
+      ctx.draw(new Graphics2D().line({ points }).stroke(state.stroke).opacity(r))
 
     if (box.xBounded) {
       const half = (height / 2) * r
-      for (const x of [box.left, box.right]) {
-        rule([
-          { x, y: cy - half },
-          { x, y: cy + half },
-        ])
-      }
+      for (const x of [box.left, box.right]) rule([{ x, y: cy - half }, { x, y: cy + half }])
     }
     if (box.yBounded) {
       const half = (width / 2) * r
-      for (const y of [box.bottom, box.top]) {
-        rule([
-          { x: cx - half, y },
-          { x: cx + half, y },
-        ])
-      }
+      for (const y of [box.bottom, box.top]) rule([{ x: cx - half, y }, { x: cx + half, y }])
     }
-  }
-}
+  },
+})
+
+export type ChartRegion = NodeOf<typeof ChartRegion>