The VS Code of video editing, built for agents.
TypeScript
Refactor world trait access to utilize Root entity
konstantin-paulus35b9185c65c9
diff --git a/apps/web/src/components/sidebar-right/inspector/background.tsx b/apps/web/src/components/sidebar-right/inspector/background.tsxindex 84b45818..65549df9 100644--- a/apps/web/src/components/sidebar-right/inspector/background.tsx+++ b/apps/web/src/components/sidebar-right/inspector/background.tsx@@ -16,21 +16,20 @@ import { ColorOpacityRow } from "@/components/ui/color-opacity-row";import { Button } from "@/components/ui/button";import { Tooltip, TooltipContent, TooltipTrigger } from "@/components/ui/tooltip";import { createSignal } from "solid-js";-import { Background, DEFAULT_BACKGROUND, getDocument } from "@diffusionstudio/runtime";+import { Background, DEFAULT_BACKGROUND, Root } from "@diffusionstudio/runtime";import { useTrait, useWorld } from "@diffusionstudio/koota-solid";export function BackgroundSettings() {const world = useWorld();const [isPickerOpen, setIsPickerOpen] = createSignal(false);- const document = getDocument(world);- const background = useTrait(document, Background);+ const background = useTrait(world.get(Root)!, Background);const color = () => background()?.value ?? DEFAULT_BACKGROUND;let anchorRef: HTMLDivElement | undefined;- const assignColor = (value: number) => document.set(Background, { value });+ const assignColor = (value: number) => world.get(Root)!.set(Background, { value });return (<PanelSection title="Background" ref={anchorRef}>diff --git a/apps/web/src/engine/hooks/use-camera.ts b/apps/web/src/engine/hooks/use-camera.tsindex 9999a5cb..aeac7a66 100644--- a/apps/web/src/engine/hooks/use-camera.ts+++ b/apps/web/src/engine/hooks/use-camera.ts@@ -2,12 +2,13 @@* License, v. 2.0. If a copy of the MPL was not distributed with this* file, You can obtain one at http://mozilla.org/MPL/2.0/. */-import { Camera, getDocument, type Camera2D } from '@diffusionstudio/runtime';+import { Camera, Root, type Camera2D } from '@diffusionstudio/runtime';import { useTrait, useWorld } from '@diffusionstudio/koota-solid';import type { Accessor } from 'solid-js';/** Reactive read of the document's Camera trait. Write via getDocument(world).set(Camera, ...). */export function useCamera(): Accessor<Camera2D | undefined> {- return useTrait(getDocument(useWorld()), Camera);+ const world = useWorld();+ return useTrait(world.get(Root)!, Camera);}diff --git a/apps/web/src/pages/editor.tsx b/apps/web/src/pages/editor.tsxindex c355947d..98a07089 100644--- a/apps/web/src/pages/editor.tsx+++ b/apps/web/src/pages/editor.tsx@@ -86,7 +86,7 @@ export function EditorPage() {<div class="col-span-full bg-border-strong relative"><Show when={!timelineMinimized()}><div- class="absolute left-0 right-0 -top-px h-[3px] z-10 cursor-ns-resize group"+ class="absolute left-0 right-0 -top-px h-0.75 z-10 cursor-ns-resize group"onPointerDown={handleResizeStart}><divdiff --git a/packages/reconciler/src/document.ts b/packages/reconciler/src/document.tsindex 5ed84394..9bd489df 100644--- a/packages/reconciler/src/document.ts+++ b/packages/reconciler/src/document.ts@@ -20,7 +20,6 @@ import {Color,Geometry,GeometryType,- getDocument,getParentEntity,ItemIndex,parseColor,@@ -28,6 +27,7 @@ import {resizeEntity,getEntityChildren,DocumentRoot,+ Root,} from '@diffusionstudio/runtime';import type { Entity, World } from 'koota';@@ -59,7 +59,7 @@ export class RuntimeDocument implements ProjectDocument<SceneNode> {public constructor(world: World) {this.world = world;- this.stage = { entity: getDocument(world) };+ this.stage = { entity: world.get(Root)! };}public createElement(tag: string): SceneNode {diff --git a/packages/runtime/src/actions/entities.ts b/packages/runtime/src/actions/entities.tsindex fafaa04c..34032daf 100644--- a/packages/runtime/src/actions/entities.ts+++ b/packages/runtime/src/actions/entities.ts@@ -6,8 +6,7 @@// app records undo entries by observing koota add/remove/change events.import { DEFAULT_DURATION_FRAMES } from '../constants';-import { ChildOf, Computed, Cache } from '../traits';-import { getDocument } from '../queries/hierarchy';+import { ChildOf, Computed, Cache, Root } from '../traits';import type { Entity, World } from 'koota';@@ -28,7 +27,7 @@ export function createEntity(world: World): Entity {duration: DEFAULT_DURATION_FRAMES,}),Cache,- ChildOf(getDocument(world)),+ ChildOf(world.get(Root)!),);}diff --git a/packages/runtime/src/actions/hierarchy.ts b/packages/runtime/src/actions/hierarchy.tsindex b007fad0..4e395b98 100644--- a/packages/runtime/src/actions/hierarchy.ts+++ b/packages/runtime/src/actions/hierarchy.ts@@ -10,10 +10,8 @@import { Or } from 'koota';-import {- ChildOf, Geometry, Group, AdjustmentLayer, ItemIndex, Selected,-} from '../traits';-import { getDocument, getEntityTree, getParentNode } from '../queries/hierarchy';+import { ChildOf, Geometry, Group, AdjustmentLayer, ItemIndex, Selected, Root } from '../traits';+import { getEntityTree, getParentNode } from '../queries/hierarchy';import { assert } from '../utils/assert';import { sortByItemIndex } from '../utils/sort';@@ -33,7 +31,7 @@ export function removeChild(world: World, entity: Entity, parent: Entity): voidassert(getParentNode(entity) === parent, 'Entity is not a child of the specified parent');// Back to top-level: re-target to the document (never drop ChildOf).- entity.add(ChildOf(getDocument(world)));+ entity.add(ChildOf(world.get(Root)!));}/**diff --git a/packages/runtime/src/queries/hierarchy.ts b/packages/runtime/src/queries/hierarchy.tsindex d0e7ed78..ab4d92f4 100644--- a/packages/runtime/src/queries/hierarchy.ts+++ b/packages/runtime/src/queries/hierarchy.ts@@ -2,19 +2,12 @@* License, v. 2.0. If a copy of the MPL was not distributed with this* file, You can obtain one at http://mozilla.org/MPL/2.0/. */-import { ChildOf, Computed, Name, Playback, PlaybackRate, DocumentRoot } from '../traits';+import { ChildOf, Computed, Name, Playback, PlaybackRate } from '../traits';import { isDocument, isScene } from './predicates';import { sortByItemIndex } from '../utils';import type { Entity, World, QueryParameter } from 'koota';-/** The world's document root (see DocumentRoot). */-export function getDocument(world: World): Entity {- const document = world.queryFirst(DocumentRoot);- if (document === undefined) throw new Error('World has no document root');- return document;-}-export function getParentEntity(entity: Entity | null | undefined): Entity | null {if (!entity) return null;return entity.targetFor(ChildOf) ?? null;diff --git a/packages/runtime/src/systems/playback.ts b/packages/runtime/src/systems/playback.tsindex bd93b196..6b38129f 100644--- a/packages/runtime/src/systems/playback.ts+++ b/packages/runtime/src/systems/playback.ts@@ -18,8 +18,9 @@ import {AudioPlayback, Computed,AudioDecoderHandle, AudioBusHandle, HtmlHostHandle,Mode, FrameRate, Time, AudioEngine, FramePromises, Mounts,+ Root,} from '../traits';-import { getDocument, getParentNode } from '../queries/hierarchy';+import { getParentNode } from '../queries/hierarchy';import { clamp } from '../math/common';import { getTransitionWindow } from '../utils/transition';import {@@ -411,8 +412,7 @@ export function playbackSystem(world: World): void {advancePlayhead(world, entity);}- const document = getDocument(world);- for (const entity of world.query(Or(Geometry, Group, AdjustmentLayer), ChildOf(document))) {+ for (const entity of world.query(Or(Geometry, Group, AdjustmentLayer), ChildOf(world.get(Root)!))) {updateVisibility(world, entity, entity);forwardDecoders(world, entity, entity);}diff --git a/packages/runtime/src/systems/render.ts b/packages/runtime/src/systems/render.tsindex 2d15b77b..3c1b2ef4 100644--- a/packages/runtime/src/systems/render.ts+++ b/packages/runtime/src/systems/render.ts@@ -24,8 +24,9 @@ import {HtmlHostHandle, SurfaceHostHandle,Mode, Time, FrameRate, Camera, Background, RenderSurface, Assets,HitRegions,+ Root,} from '../traits';-import { getDocument, getParentNode } from '../queries/hierarchy';+import { getParentNode } from '../queries/hierarchy';import { colorToHex } from '../utils/color';import { renderText } from '../utils/text';import { getTransitionWindow } from '../utils/transition';@@ -427,7 +428,7 @@ function renderShadows(world: World, entity: Entity): void {// ctx.shadowBlur/OffsetX/OffsetY are in device-pixel space and are not// affected by the current transform, so scale them up to match the// content transform (camera * resolution).- const camera = getDocument(world).get(Camera);+ const camera = world.get(Root)!.get(Camera);const resolution = world.get(RenderSurface)?.resolution ?? 1;const shadowScale = (camera?.a ?? 1) * resolution;@@ -845,7 +846,7 @@ export function renderSystem(world: World): void {// renders just the scene onto a transparent canvas (the scene paints its// own fill if it has one).if (world.get(Mode)?.value === 'realtime') {- ctx.fillStyle = colorToHex(getDocument(world).get(Background)?.value ?? 0);+ ctx.fillStyle = colorToHex(world.get(Root)!.get(Background)?.value ?? 0);ctx.fillRect(0, 0, cw, ch);world.get(HitRegions)?.list.push({target: { kind: 'hud', id: 'canvas', quad: getCanvasQuad(cw, ch) },@@ -853,7 +854,7 @@ export function renderSystem(world: World): void {}// Apply camera transform: DPR * Camera- const camera = getDocument(world).get(Camera)!+ const camera = world.get(Root)!.get(Camera)!const resolution = surface.resolution;ctx.setTransform(camera.a * resolution,@@ -865,7 +866,7 @@ export function renderSystem(world: World): void {);// Render top-level nodes.- const document = getDocument(world);+ const document = world.get(Root)!;for (const entity of world.query(Or(Geometry, Group), ChildOf(document), Not(Culled))) {renderNode(world, entity);}diff --git a/packages/runtime/src/systems/transform.ts b/packages/runtime/src/systems/transform.tsindex d26a909a..15bc627b 100644--- a/packages/runtime/src/systems/transform.ts+++ b/packages/runtime/src/systems/transform.ts@@ -9,8 +9,9 @@ import {ChildOf, Geometry, Group, Hidden, Sequential, AdjustmentLayer,Culled, Flip, Anchor, Computed, Cache, LocalTransform, WorldTransform,WorldBounds, Camera, RenderSurface,+ Root,} from '../traits';-import { getDocument, getParentNode } from '../queries/hierarchy';+import { getParentNode } from '../queries/hierarchy';import {multiply2D,@@ -92,7 +93,7 @@ export function computeWorldTransform(world: World, entity: Entity, parentEntitye: worldStore.e[pid], f: worldStore.f[pid],};} else {- const camera = getDocument(world).get(Camera)!;+ const camera = world.get(Root)!.get(Camera)!;const res = world.get(RenderSurface)?.resolution ?? 1;parent = {a: camera.a * res, b: camera.b * res,@@ -317,7 +318,7 @@ export function transformSystem(world: World): void {}};- for (const entity of world.query(Or(Geometry, Group), ChildOf(getDocument(world)))) {+ for (const entity of world.query(Or(Geometry, Group), ChildOf(world.get(Root)!))) {walk(entity, null);}diff --git a/packages/runtime/src/traits/world.ts b/packages/runtime/src/traits/world.tsindex d9a1186e..21230eb1 100644--- a/packages/runtime/src/traits/world.ts+++ b/packages/runtime/src/traits/world.ts@@ -25,6 +25,9 @@ export const Project = trait({ id: '' });// getDocument(world).export const DocumentRoot = trait();+// World-level pointer to the root entity+export const Root = trait(() => null as Entity | null);+/*** 2D affine camera transform in CSS pixel space (before DPR scaling), on the* document root. The render system multiplies this by RenderSurface.resolutiondiff --git a/packages/runtime/src/utils/text.ts b/packages/runtime/src/utils/text.tsindex f26b02d5..cdea2256 100644--- a/packages/runtime/src/utils/text.ts+++ b/packages/runtime/src/utils/text.ts@@ -12,9 +12,8 @@ import {import {Size, Hidden, Paint, Color, Blur, Offset, Appearance, StrokeStyle,Chars, TextStyle, TextRange, TextCache, Cache, Computed, Camera,- RenderSurface,+ RenderSurface, Root,} from '../traits';-import { getDocument } from '../queries/hierarchy';import { clamp } from '../math/common';import { colorToHex } from './color';import { createLinearGradient, createRadialGradient } from '../systems/gradients';@@ -299,7 +298,7 @@ function renderTokens(ctx: Ctx, world: World, entity: Entity): void {// ctx.shadowBlur/OffsetX/OffsetY are in device-pixel space and are not// affected by the current transform, so scale them up to match the// content transform (camera * resolution).- const camera = getDocument(world).get(Camera);+ const camera = world.get(Root)!.get(Camera);const resolution = world.get(RenderSurface)?.resolution ?? 1;const shadowScale = (camera?.a ?? 1) * resolution;diff --git a/packages/runtime/src/world/create-world.ts b/packages/runtime/src/world/create-world.tsindex ec4960cc..5bf0df71 100644--- a/packages/runtime/src/world/create-world.ts+++ b/packages/runtime/src/world/create-world.ts@@ -7,6 +7,7 @@ import { createWorld } from 'koota';import { observeWorld } from './observers';import {DocumentRoot,+ Root,Project,Mode,ActiveScene,@@ -47,10 +48,11 @@ export function createRuntimeWorld(projectId: string) {Mounts,FramePromises,HitRegions,+ Root,);// The document root all rendered entities hang off (see DocumentRoot);- world.spawn(DocumentRoot, Camera, Background);+ world.set(Root, world.spawn(DocumentRoot, Camera, Background));// Cache upkeep, Computed mirrors, and time-range reactions.observeWorld(world);