@volter/editor-threejs 0.5.57

package/LICENSE-APACHE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Volter AI, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,12 @@
+Copyright 2026 Volter AI, Inc.
+
+Modules under src/viewport and src/capture were imported from the
+AGPL-3.0-only @vgai/threejs package; LICENSE contains that license.
+
+Modules under src/adapter, src/animation, src/ecs and src/render, together
+with src/asset-loaders.ts, src/asset-parse-error.ts and src/loader.ts, were
+imported from the Apache-2.0 @vgai/threejs-runtime package. They retain that
+license; LICENSE-APACHE contains its text.
+
+Source revisions and original file hashes are recorded in the repository's
+provenance/blender-integration.json and provenance/editor-host.json.

package/README.md

@@ -0,0 +1,16 @@
+# Three.js editor utilities
+
+Shared bounds, layers, clipping, renderer ownership, preview environment and
+detached scene capture used by Volter Editor's modeling integration.
+
+This package does not yet own the interactive viewport. The current Three-aware
+editor core retains that implementation; full extraction remains deferred.
+No game-runtime, DOM authoring, physics or gameplay packages are dependencies.
+
+Structural object marks retain their existing keys and behavior. Their readers
+are included here because bounds and editor-layer filtering need them; importing
+these small modules must not pull in a gameplay runtime.
+
+Run `npm run typecheck -w @volter/editor-threejs` through the active World.
+See NOTICE for the per-file license distinction. This package remains private
+while the editor migration and complete distribution review are unfinished.

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@volter/editor-threejs",
+  "author": "Volter AI, Inc.",
+  "version": "0.5.57",
+  "publishConfig": {
+    "access": "public"
+  },
+  "type": "module",
+  "license": "AGPL-3.0-only AND Apache-2.0",
+  "description": "Shared Three.js bounds, rendering and capture utilities used by Volter Editor.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/volter-ai/editor.git",
+    "directory": "packages/editor-threejs"
+  },
+  "files": [
+    "src",
+    "LICENSE",
+    "NOTICE",
+    "LICENSE-APACHE"
+  ],
+  "exports": {
+    "./package.json": "./package.json",
+    "./*": {
+      "types": "./src/*.ts",
+      "default": "./src/*"
+    },
+    "./asset-parse-error": "./src/asset-parse-error.ts",
+    "./loader": "./src/loader.ts"
+  },
+  "peerDependencies": {
+    "three": "^0.180.0"
+  },
+  "scripts": {
+    "typecheck": "tsc -p tsconfig.json"
+  },
+  "dependencies": {
+    "@volter/editor-project": "0.5.57",
+    "@sparkjsdev/spark": "^2.1.0",
+    "three.quarks": "^0.16.0",
+    "zod": "^4.3.6"
+  }
+}

package/src/adapter/constraint.ts

@@ -0,0 +1,78 @@
+/**
+ * Format-neutral live mark for source-owned spatial constraints.
+ *
+ * The project capability that performs a solve attaches one or more marks to
+ * the Object3D that owns the constrained pose. The editor reads the marks to
+ * render an ordinary constraint stack and transient viewport handles. This is
+ * observation, not authored data: the owning TS/TSX and its ordinary target /
+ * pole Object3Ds remain the only source of truth.
+ */
+import type * as THREE from 'three';
+import { deleteUserData, getUserData, setUserData } from '../ecs/user-data';
+
+export type ConstraintStatus = 'ready' | 'disabled' | 'unresolved' | 'error';
+
+export interface ConstraintConfig {
+  /** Stable only within this mounted owner. */
+  readonly id: string;
+  readonly type: 'two-bone-ik' | 'ccd-ik' | 'aim' | 'rotation' | (string & {});
+  readonly label: string;
+  readonly enabled: boolean;
+  readonly weight: number;
+  /** Evaluation order among constraints attached to this owner. */
+  readonly order: number;
+}
+
+export interface ConstraintError {
+  readonly value: number;
+  readonly unit: 'metres' | 'degrees';
+}
+
+export interface ConstraintSnapshot {
+  readonly status: ConstraintStatus;
+  readonly message?: string;
+  /** Root → effector, using the real bones from the live skeleton. */
+  readonly chain: readonly THREE.Object3D[];
+  /** The ordinary object whose transform the constraint affects. */
+  readonly constrained: THREE.Object3D | null;
+  readonly target: THREE.Object3D | null;
+  readonly pole: THREE.Object3D | null;
+  /** Residual after the latest solve, in the constraint's native unit. */
+  readonly error: ConstraintError | null;
+}
+
+export interface ConstraintMark {
+  readonly config: ConstraintConfig;
+  getSnapshot(): ConstraintSnapshot;
+}
+
+export function constraintsOf(
+  object: THREE.Object3D | null | undefined,
+): readonly ConstraintMark[] {
+  const candidate = getUserData(object, 'constraints');
+  if (!Array.isArray(candidate)) return [];
+  return candidate.filter(
+    (entry): entry is ConstraintMark =>
+      Boolean(entry) &&
+      typeof entry === 'object' &&
+      typeof (entry as Partial<ConstraintMark>).getSnapshot === 'function' &&
+      Boolean((entry as Partial<ConstraintMark>).config),
+  );
+}
+
+/** Add or replace one constraint mark without disturbing sibling constraints. */
+export function setConstraintMark(object: THREE.Object3D, mark: ConstraintMark): void {
+  const next = constraintsOf(object).filter((entry) => entry.config.id !== mark.config.id);
+  setUserData(object, 'constraints', [...next, mark]);
+}
+
+/** Remove one mark, or the whole live projection when no id is supplied. */
+export function clearConstraintMark(object: THREE.Object3D, id?: string): void {
+  if (id === undefined) {
+    deleteUserData(object, 'constraints');
+    return;
+  }
+  const next = constraintsOf(object).filter((entry) => entry.config.id !== id);
+  if (next.length === 0) deleteUserData(object, 'constraints');
+  else setUserData(object, 'constraints', next);
+}

package/src/adapter/hierarchy-marks.ts

@@ -0,0 +1,156 @@
+/**
+ * The hierarchy-presentation convention: how a game tells the editor which
+ * parts of its LIVE scene graph are one component instance, and which parts are
+ * implementation rather than content.
+ *
+ * ## Why marks and not a second tree
+ *
+ * The live tree IS the display surface. A hierarchy derived from source would
+ * be a mirror layer — a second model of the world that drifts from the one on
+ * screen — so the boundaries a reader needs have to live ON the nodes. That is
+ * what these marks are, and it is the whole mechanism: a component WRAPS its
+ * functionality and MARKS its root; the editor supports the convention
+ * generically and never learns which library, importer or lane produced the
+ * node.
+ *
+ * ## STRUCTURE IS THE TREE'S JOB. MARKS ONLY CLASSIFY.
+ *
+ * There is deliberately no mark that says "show this row somewhere else". A
+ * group owns its children by CONTAINING them; a prefab owns its parts by
+ * CONTAINING them. If an object reads as belonging under something it is not
+ * parented to, the tree is wrong and the tree is what to fix — because the
+ * panel is not the only reader. `getWorldPosition`, raycasting, disposal,
+ * `traverse`, every physics or gameplay walk and every person reading the
+ * source all follow real parenthood, and a presentation-only "logical parent"
+ * would be true for exactly one of them.
+ *
+ * The usual reason a world gets this wrong is that three's parent chain is a
+ * TRANSFORM chain: `matrixWorld` is unconditionally `parent × local`, so an
+ * object that must not inherit its owner's pose — a physics-driven body writing
+ * a world transform every step, a world-space trail or decal, a follow camera
+ * that must escape its target's rotation — gets mounted at the scene root, and
+ * ownership is lost as a side effect. **That trade is not necessary.** Set
+ * `object.matrixWorldAutoUpdate = false` (three r144+) and the parent's
+ * propagation skips it: the object stays parented where it belongs and its
+ * `matrixWorld` becomes yours to write. Keep it parented, own the matrix, and
+ * the hierarchy needs no help.
+ *
+ * These two marks then have exactly one job left, which is CLASSIFICATION:
+ * which of the objects that really are here is the game, and which is the
+ * machinery underneath it.
+ *
+ * ## What the hierarchy is FOR
+ *
+ * It shows YOUR GAME: the structure you authored, plus the objects your game
+ * makes while it runs. Nothing else. Three consequences, and every rule below
+ * follows from them:
+ *
+ *  - **A spawned object is content.** A bullet you fired, a wave of enemies, a
+ *    prop pulled out of a pool and parented into the level — these are rows.
+ *    They exist, you can select them, and they are usually the exact things you
+ *    opened the panel to look at. An object your game frees stops being a row,
+ *    because it stopped existing.
+ *  - **An implementation artifact is not.** The bones behind a rig, the batched
+ *    renderer behind a particle system, the instanced-mesh pools behind a tile
+ *    field, the `target` object three needs in order to aim a directional
+ *    light: machinery a library or a helper builds so one thing you DID author
+ *    can work. It belongs UNDER that thing, folded, not beside it.
+ *  - **"Not in the source file" is the wrong test for either.** Half of a
+ *    running world is not in the source file — that is what running means.
+ *    Folding spawned gameplay because a document does not name it is the same
+ *    defect as listing bones, in the more damaging direction: the rows it loses
+ *    are the ones you were looking for.
+ *
+ * ## The two marks
+ *
+ * - {@link markComponentRoot} — "this subtree is one instance of `<name>`."
+ *   The editor renders it as ONE row, closed, expandable on demand. Put it on
+ *   the EARLIEST point the node exists: the constructor that makes it, or the
+ *   ref callback that receives it. A component whose root is a plain `<mesh>`
+ *   marks that mesh.
+ * - {@link markBuiltInternal} — "this is IMPLEMENTATION, not content." It is
+ *   **subtree-scoped**: marking the root of a built subtree marks everything
+ *   under it, so a 60-bone rig costs one call and folding is transitive. The
+ *   editor hides these rows and offers them behind the same "Reveal Internals"
+ *   action a source-backed instance's internals already use — revealed rows
+ *   are read-only, because there is no authored source for a rename or a
+ *   reparent to write to.
+ *
+ * An instance therefore reads as the parent of everything meaningful beneath
+ * it: content nested inside an implementation node is listed under the instance
+ * rather than lost with it (the editor's `hierarchy-component-marks.ts` calls
+ * that promotion), so marking a rig does not hide the mesh skinned to it.
+ *
+ * ## Mark it where the subtree is ATTACHED, by whoever attaches it
+ *
+ * A mark belongs at the attach seam: the code that puts an implementation
+ * subtree into the world marks it in the same breath, because that code is the
+ * only thing that knows the subtree is implementation. Not a later sweep of the
+ * tree — "everything present at time T that the source did not name" is the
+ * wrong predicate twice over. It arrives too early for anything attached
+ * asynchronously (a model clone landing after its bytes resolve, a node gated
+ * on an audio decode) and too late in principle for anything attached
+ * afterwards (every spawn) — and were it re-run to catch those, it would
+ * classify each spawned object as implementation, which is the second bullet
+ * above inverted. Attach-seam marking has neither failure: it fires once, at
+ * the moment the answer is known, and an unmarked node is content by default.
+ *
+ * The subtree scope is what keeps this cheap — one call per attached root, not
+ * one per node, so a rig or a pool costs one line at the one place that builds
+ * it.
+ *
+ * ## What is NOT built-internal
+ *
+ * A node your game means as content — even one a class rather than JSX
+ * constructs — is content. `vgaiBuiltInternal` is not "the editor cannot write
+ * this"; that question is `TransformProvider.editability`'s, answered per
+ * channel with a sentence. This mark answers "is this implementation", and
+ * getting it wrong hides real content.
+ *
+ * Both keys live in the structural mark registry (`../ecs/object-marks.ts`),
+ * which the full typed `userData` registry includes, so
+ * their literal strings are spelled exactly once; this module is the only
+ * reader/writer, which is why the helpers below exist at all rather than
+ * `setUserData` calls scattered through emitters and prefabs.
+ */
+
+import type * as THREE from 'three';
+import { getObjectMark, setObjectMark } from '../ecs/object-marks';
+
+/**
+ * Declare `node` the root of one component instance, displayed under `name`.
+ *
+ * `name` is the COMPONENT's name (`'Coin'`, `'HeroBox'`), not the instance's —
+ * the instance is already named by `node.name`, and the editor prints both.
+ */
+export function markComponentRoot(node: THREE.Object3D, name: string): void {
+  setObjectMark(node, 'vgaiComponentRoot', name);
+}
+
+/** The component name `node` is the root of, or `undefined` for an ordinary node. */
+export function componentRootName(node: THREE.Object3D | null | undefined): string | undefined {
+  const name = getObjectMark(node, 'vgaiComponentRoot');
+  return typeof name === 'string' && name ? name : undefined;
+}
+
+/** Whether `node` is a marked component-instance root. */
+export function isComponentRoot(node: THREE.Object3D | null | undefined): boolean {
+  return componentRootName(node) !== undefined;
+}
+
+/**
+ * Declare `node` (and everything under it) IMPLEMENTATION of whatever node it
+ * sits under, rather than content of its own. Call it on the ROOT of the built
+ * subtree only, at the seam that attaches it — see this module's header for why
+ * the seam and not a sweep.
+ */
+export function markBuiltInternal(node: THREE.Object3D): void {
+  setObjectMark(node, 'vgaiBuiltInternal', true);
+}
+
+/** Whether `node` itself carries the implementation mark. Ancestry is the
+ *  CALLER's walk — see this module's header for why the mark is subtree-scoped
+ *  but not restamped onto descendants. */
+export function isBuiltInternal(node: THREE.Object3D | null | undefined): boolean {
+  return getObjectMark(node, 'vgaiBuiltInternal') === true;
+}