ldr 0.24.2 → 0.26.0

package/README.md

@@ -83,16 +83,17 @@ Light the scene (or set `scene.environment`) as you would for any `MeshStandardM
 | export | description |
 |---|---|
 | `parse(text, name?, { geometryText? }) → Doc` | Parses LDraw text into files and commands. MPD-aware: `0 FILE`/`0 NOFILE` and `0 !DATA` blocks. |
-| `flatten(doc, options?) → PartInstance[]` | Expands submodels into placed parts. Each instance has `part`, `color`, a 12-number matrix `m`, `step`, nested `steps`, `path` and the ROTSTEP `view` of its step. |
+| `flatten(doc, options?) → PartInstance[]` | Expands submodels into placed parts. Each instance has `part`, `color`, a 12-number matrix `m`, `step`, nested `steps`, `path` and the ROTSTEP `view` of its step. `colour` (an `LDrawColor`) is set when a `0 !COLOUR` line in the model itself defines the instance's colour. |
 | `parseModel(text, name?, options?)` | `parse` followed by `flatten`. |
 | `sequenceSteps(instances) → { count, stepOf, views }` | Gives each instance a global build-step index, sequencing nested submodel steps. `views` holds the ROTSTEP view per global step. |
 | `parseLDConfig(text) → Map<code, LDrawColor>` | Reads a `!COLOUR` table into `{ code, name, hex, edge, alpha, luminance, finish }` (CHROME / PEARLESCENT / RUBBER / METAL / MATTE_METALLIC / MATERIAL GLITTER|SPECKLE|FABRIC). |
+| `blendedColourHex(code)` | RGB of a blended (old dithered) code 256-511, for codes LDConfig doesn't define. |
 | `parseColourLine`, `colourSurface`, `colourMaterialKey`, `makeFinishMaterial` | Spec finish → PBR surface (metalness/roughness/clearcoat/sheen; glitter/speckle use cheap procedural grain). |
 | `fileKind(doc, name)` | Decides whether an MPD file is a part or a model: by its header type, otherwise by whether it has its own geometry. |
 | `looseSteps` / `looseFile` / `looseSource` / `loosePartName` | A model's own type 2–5 geometry, per step, as synthetic parts named `<file>#<step>`. |
 | `rotStepMatrix` / `stepViewMatrix` / `fileStepViews` | ROTSTEP views, following MLCad: `REL`, `ADD`, `ABS`, `END`. A ROTSTEP ends its step. |
 | `parseTexMap` / `texmapUV` / `texmapTriangleUV` / `transformTexMap` / `resolveTexture` / `texWrapper` | `!TEXMAP` support (`PLANAR`, `CYLINDRICAL`, `SPHERICAL`). UV conventions follow LDView: v = 0 is the image's top row. |
-| `parseColor`, `isDirectColor`, `colorToken`, `mul`, `invert`, `IDENTITY`, `norm`, `smoothNormals`, `hash32` | Low-level helpers. |
+| `parseColor`, `isDirectColor`, `namedColorCode`, `isNamedColor`, `colorToken`, `mul`, `invert`, `IDENTITY`, `norm`, `smoothNormals`, `hash32` | Low-level helpers. |
 
 `FlattenOptions`:
 
@@ -209,6 +210,9 @@ Reproduce: `cd bench && bun run setup && bun run perf` (regression gate) or `bun
 - `0 STEP`, nested submodel step sequencing, `0 ROTSTEP` (`REL`/`ADD`/`ABS`/`END`), and `0 BUFEXCHG`.
 - `!TEXMAP` `START`/`NEXT`/`FALLBACK`/`END`, with `PLANAR`, `CYLINDRICAL` and `SPHERICAL` projections (orientation matches LDView), `GLOSSMAP` (alpha = gloss amount, same UVs), and model-level `!TEXMAP` around part references.
 - Colours: LDConfig `!COLOUR`, edge colours, main/edge colour inheritance (16/24), and direct colours (`0x2RRGGBB`).
+- `!COLOUR` lines in a model follow the spec's scope rule. A definition applies from its line to the end of its file and to the files that file references, and it never leaks back to the parent. It sets the instance colour and finish. Colours hard-coded inside parts (printed parts, MPD-embedded parts) always come from LDConfig, because parts are precompiled.
+- Named colour codes: a `!COLOUR` CODE may be an identifier instead of a number (`0 !COLOUR My_Red CODE MyRed VALUE #FF0000 EDGE #333333`, then `1 myred ...`), which the spec allows outside strict LDraw compatibility. Identifiers are case-insensitive and follow the same scope rule. `parseColor` turns one into a stable negative code (`namedColorCode`, `isNamedColor`), and `colorToken` turns it back into the identifier. A named code with no definition in scope draws the fallback colour.
+- Blended colour codes 256-511 that LDConfig doesn't define (used by old models, e.g. 382 in Datsville) render as the spec's average of two ldraw.exe colours instead of the fallback grey.
 - Case-insensitive, backslash-normalized file lookup; `~Moved to` alias parts.
 
 ## Limitations

package/dist/cli.js

@@ -1,20 +1,38 @@
 #!/usr/bin/env node
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/cli.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/cli.ts
 import fs4 from "node:fs";
 import zlib from "node:zlib";
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/node/build-pack.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/node/build-pack.ts
 import fs3 from "node:fs";
 import path3 from "node:path";
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/node/resolver.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/node/resolver.ts
 import fs from "node:fs";
 import path from "node:path";
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/spec.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/spec.ts
 var norm = (s) => s.trim().toLowerCase().replace(/\\/g, "/").replace(/\/+/g, "/");
+var COLOUR_ID_RE = /^[A-Za-z][A-Za-z0-9_]*$/;
+var namedCodes = new Map;
+function namedColorCode(id) {
+  const s = id.toLowerCase();
+  let h = 2166136261;
+  for (let i = 0;i < s.length; i++) {
+    h ^= s.charCodeAt(i);
+    h = Math.imul(h, 16777619);
+  }
+  const c = -1 - (h >>> 0 & 1073741823);
+  if (!namedCodes.has(c))
+    namedCodes.set(c, s);
+  return c;
+}
+var isNamedColor = (c) => c < 0 && Number.isInteger(c);
 function parseColor(tok) {
+  const c0 = tok.charCodeAt(0) | 32;
+  if (c0 >= 97 && c0 <= 122 && COLOUR_ID_RE.test(tok))
+    return namedColorCode(tok);
   if (/^0x/i.test(tok))
     return parseInt(tok, 16);
   return +tok;
@@ -590,7 +608,7 @@ function looseSteps(f) {
   looseMemo.set(f, r);
   return r;
 }
-var colorToken = (c) => c > 16777215 ? "0x" + c.toString(16).toUpperCase() : String(c);
+var colorToken = (c) => c > 16777215 ? "0x" + c.toString(16).toUpperCase() : c < 0 ? namedCodes.get(c) ?? String(c) : String(c);
 var lineOf = (c) => c.t === 0 ? "0 " + c.text : c.t === 1 ? `1 ${colorToken(c.color)} ${c.m.join(" ")} ${c.file}` : c.src ? c.src : `${c.t} ${colorToken(c.color)} ${c.p.join(" ")}`;
 var loosePartName = (file, step) => `${norm(file)}#${step}`;
 function looseFile(f, step) {
@@ -705,7 +723,7 @@ function fileStepViews(f) {
   return out;
 }
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/model.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/model.ts
 var CALLOUT_END = 999999;
 var stepKey = (steps) => steps.map((x) => String(x).padStart(6, "0")).join(".") + "~";
 function flatten(doc, opts = {}) {
@@ -724,17 +742,18 @@ function flatten(doc, opts = {}) {
     }
     return fn;
   };
-  const walk = (d, fname, m, color, path, stepPath, depth, texIn, fixed = null, subPath = [], subMats = []) => {
+  const walk = (d, fname, m, color, path, stepPath, depth, texIn, fixed = null, subPath = [], subMats = [], colour = undefined, scope0 = null) => {
     const f = d.files.get(fname);
     if (!f || depth > maxDepth)
       return;
+    let scope = scope0;
     let s = 0;
     const subId = depth > 0 ? ++subs : 0;
     const sp0 = co && subId ? [...subPath, subId] : subPath;
     const sm0 = co && subId ? [...subMats, m] : subMats;
     const groups = co && !fixed ? new Map : null;
     let ordStep = -1, ord = 0;
-    const sub = (sd, file, mm, col, sp, lt) => {
+    const sub = (sd, file, mm, col, sp, lt, cd) => {
       if (ordStep !== s) {
         ordStep = s;
         ord = 0;
@@ -742,19 +761,21 @@ function flatten(doc, opts = {}) {
       const g = groups?.get(s + "|" + file);
       if (g) {
         g.n++;
-        return walk(sd, sd === d ? file : sd.main, mm, col, path + "/" + file, [...sp, CALLOUT_END], depth + 1, lt, [...sp, CALLOUT_END], sp0, sm0);
+        return walk(sd, sd === d ? file : sd.main, mm, col, path + "/" + file, [...sp, CALLOUT_END], depth + 1, lt, [...sp, CALLOUT_END], sp0, sm0, cd, scope);
       }
       const spo = [...sp, ord++], from = out.length;
-      walk(sd, sd === d ? file : sd.main, mm, col, path + "/" + file, spo, depth + 1, lt, fixed, sp0, sm0);
+      walk(sd, sd === d ? file : sd.main, mm, col, path + "/" + file, spo, depth + 1, lt, fixed, sp0, sm0, cd, scope);
       groups?.set(s + "|" + file, { n: 1, from, to: out.length });
     };
     const views = fileStepViews(f);
     const ls = loose ? looseSteps(f) : [];
     let li = 0;
-    const emit = (part, col, mm, sp, k, embedded, tex) => {
+    const emit = (part, col, mm, sp, k, embedded, tex, cd) => {
       if (fixed)
         sp = fixed;
       const i = { part, color: col, m: mm, step: sp[0], steps: sp, localStep: k, path };
+      if (cd)
+        i.colour = cd;
       if (subId) {
         i.sub = subId;
         if (co) {
@@ -778,7 +799,7 @@ function flatten(doc, opts = {}) {
     const flushLoose = (upTo) => {
       while (li < ls.length && ls[li] <= upTo) {
         const k = ls[li++];
-        emit(loosePartName(f.name, k), color, m, [...stepPath, k], k, false, null).source = lazy(f, k);
+        emit(loosePartName(f.name, k), color, m, [...stepPath, k], k, false, null, colour).source = lazy(f, k);
       }
     };
     for (const c0 of f.cmds) {
@@ -792,6 +813,12 @@ function flatten(doc, opts = {}) {
         continue;
       }
       if (c.t === 0) {
+        if (c.meta === "!COLOUR") {
+          const def = parseColourLine(c.text);
+          if (def && def.code !== 16 && def.code !== 24)
+            (scope = new Map(scope ?? [])).set(def.code, def);
+          continue;
+        }
         if (tx && c.geom?.t === 1)
           c = c.geom;
         else
@@ -801,24 +828,24 @@ function flatten(doc, opts = {}) {
         continue;
       if (tx && c.fallback)
         continue;
-      const col = c.color === 16 ? color : c.color, mm = mul(m, c.m), sp = [...stepPath, s];
+      const col = c.color === 16 ? color : c.color, cd = c.color === 16 ? colour : scope?.get(c.color), mm = mul(m, c.m), sp = [...stepPath, s];
       const tex = tx ? c.tex ?? texIn : null;
       const local = tex ? invert(c.m) : null;
       const lt = tex && local ? transformTexMap(tex, local) : null;
       if (d.files.has(c.file)) {
         if (fileKind(d, c.file) === "model") {
-          sub(d, c.file, mm, col, sp, lt);
+          sub(d, c.file, mm, col, sp, lt, cd);
           continue;
         }
-        emit(c.file, col, mm, sp, s, true, lt);
+        emit(c.file, col, mm, sp, s, true, lt, cd);
         continue;
       }
       const ext = opts.resolveModel?.(c.file);
       if (ext) {
-        sub(ext, c.file, mm, col, sp, lt);
+        sub(ext, c.file, mm, col, sp, lt, cd);
         continue;
       }
-      emit(c.file, col, mm, sp, s, false, lt);
+      emit(c.file, col, mm, sp, s, false, lt, cd);
     }
     flushLoose(Infinity);
     if (groups) {
@@ -908,14 +935,14 @@ function parseColourLine(line) {
   if (tokens.length < 2)
     return null;
   const name = tokens[0];
-  let code = -1, hex = "#FF00FF", edge = "#333333", alpha = 255, luminance = 0;
+  let code = NaN, hex = "#FF00FF", edge = "#333333", alpha = 255, luminance = 0;
   let finish = { type: "default" };
   let i = 1;
   while (i < tokens.length) {
     const t = tokens[i].toUpperCase();
     const n = tokens[i + 1];
     if (t === "CODE") {
-      code = +n;
+      code = n !== undefined && COLOUR_ID_RE.test(n) ? namedColorCode(n) : n !== undefined && /^\d+$/.test(n) ? +n : NaN;
       i += 2;
     } else if (t === "VALUE") {
       const h = parseHexColor(n);
@@ -970,7 +997,7 @@ function parseColourLine(line) {
     } else
       i += 1;
   }
-  if (code < 0 || !hex)
+  if (Number.isNaN(code) || !hex)
     return null;
   return { code, name, hex, edge, alpha: Number.isFinite(alpha) ? alpha : 255, luminance: Number.isFinite(luminance) ? luminance : 0, finish };
 }
@@ -1054,8 +1081,32 @@ function parseLDConfig(text) {
   }
   return out;
 }
+var LDRAW_EXE_16 = [
+  [51, 51, 51],
+  [0, 51, 178],
+  [0, 127, 51],
+  [0, 181, 166],
+  [204, 0, 0],
+  [255, 51, 153],
+  [102, 51, 0],
+  [153, 153, 153],
+  [102, 102, 88],
+  [0, 128, 255],
+  [51, 255, 102],
+  [171, 253, 249],
+  [255, 0, 0],
+  [255, 176, 204],
+  [255, 229, 0],
+  [255, 255, 255]
+];
+function blendedColourHex(code) {
+  if (!Number.isInteger(code) || code < 256 || code > 511)
+    return null;
+  const a = LDRAW_EXE_16[code - 256 >> 4], b = LDRAW_EXE_16[code - 256 & 15];
+  return "#" + [0, 1, 2].map((k) => (a[k] + b[k] >> 1).toString(16).padStart(2, "0")).join("").toUpperCase();
+}
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/node/resolver.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/node/resolver.ts
 var TOP_STUD_RE = /^(stud|studa|stud2|stud2a|stud6|stud6a|stud10|stud15|stud2s|stud2s2|stud-logo\d*|stud2-logo\d*)\.dat$/i;
 var UNDER_STUD_RE = /^(stud3|stud3a|stud4.*|stud12|stud16.*|stud18a)\.dat$/i;
 var norm2 = (ref) => ref.trim().replace(/\\/g, "/").toLowerCase();
@@ -1325,11 +1376,11 @@ function collectDeps(lib, refs) {
   return out;
 }
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/node/compile.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/node/compile.ts
 import fs2 from "node:fs";
 import path2 from "node:path";
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/node/lod.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/node/lod.ts
 import { MeshoptSimplifier, MeshoptEncoder } from "meshoptimizer";
 await Promise.all([MeshoptSimplifier.ready, MeshoptEncoder.ready]);
 function reorderMesh(P, N, C, I) {
@@ -1521,7 +1572,7 @@ function lodChain(P, C, I) {
   return out;
 }
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/node/compile.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/node/compile.ts
 function loadColors(root) {
   const map = new Map;
   for (const l of fs2.readFileSync(path2.join(root, "LDConfig.ldr"), "latin1").split(/\r?\n/)) {
@@ -1533,6 +1584,13 @@ function loadColors(root) {
   }
   return map;
 }
+var blendedRgb = (code) => {
+  const h = blendedColourHex(+code);
+  if (!h)
+    return null;
+  const v = parseInt(h.slice(1), 16);
+  return [(v >> 16) / 255, (v >> 8 & 255) / 255, (v & 255) / 255];
+};
 var det3 = (m) => m[3] * (m[7] * m[11] - m[8] * m[10]) - m[4] * (m[6] * m[11] - m[8] * m[9]) + m[5] * (m[6] * m[10] - m[7] * m[9]);
 
 class Compiler {
@@ -1570,7 +1628,7 @@ class Compiler {
     if (this.cache.has(ck))
       return this.cache.get(ck);
     const out = { body: { pos: [], col: [] }, under: { pos: [], col: [] }, edges: [], condLines: 0, cond: this.opts.cond ? [] : undefined, condUnder: this.opts.cond ? [] : undefined, studs: [], bbox: [Infinity, Infinity, Infinity, -Infinity, -Infinity, -Infinity], fullBottom: false };
-    const colorOf = (code) => code === "16" ? [1, 1, 1, 0] : [...this.colors.get(code) || (code.startsWith("0x2") ? [parseInt(code.slice(3, 5), 16) / 255, parseInt(code.slice(5, 7), 16) / 255, parseInt(code.slice(7, 9), 16) / 255] : [1, 0, 1]), 1];
+    const colorOf = (code) => code === "16" ? [1, 1, 1, 0] : [...this.colors.get(code) || (code.startsWith("0x2") ? [parseInt(code.slice(3, 5), 16) / 255, parseInt(code.slice(5, 7), 16) / 255, parseInt(code.slice(7, 9), 16) / 255] : blendedRgb(code) ?? [1, 0, 1]), 1];
     const walk = (fk, M, color, invert, target, depth) => {
       if (depth > 40)
         return;
@@ -2151,7 +2209,7 @@ function encodePack(parts, studKinds, weld, extra, options = {}) {
   return Buffer.concat([head, ...chunks.map((c) => new Uint8Array(c.buffer, c.byteOffset, c.byteLength))]);
 }
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/node/build-pack.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/node/build-pack.ts
 function buildPack(o) {
   const lib = new Library(o.ldrawRoot);
   const refs = new Map;
@@ -2219,7 +2277,7 @@ function buildPack(o) {
   return { data: encodePack(parts, kinds, comp.opts.weld, extra, { texture, lod: o.lod !== false, reorder: !!o.reorder }), parts: parts.size, studKinds: kinds.size, missing: [...missing], ...warnings.length ? { warnings } : {} };
 }
 
-// ../../../../../../../tmp/ldr-build-JiiKTe/src/cli.ts
+// ../../../../../../../tmp/ldr-build-tYthc8/src/cli.ts
 var HELP = `ldr pack — build a parts pack for the ldr three.js renderer
 
 Usage:

package/dist/cull.d.ts

@@ -1,4 +1,4 @@
-import type { PartInstance } from './model.js';
+import type { PartInstance, LDrawColor } from './model.js';
 export type Inst = {
     part: string;
     color: string;
@@ -63,6 +63,7 @@ export declare function sceneInstances(instances: PartInstance[], H: any, useTex
     }[];
     stepOf: number[];
     nSteps: number;
+    localColours: Map<string, LDrawColor>;
 };
 /** Culling for `createLdrObject(instances, pack, { textures })`, computable off the main thread and passed back as `precomputedCull`. */
 export declare function precomputeCull(instances: PartInstance[], H: any, useTex?: boolean): CullResult;

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-export { parse, parseColor, isDirectColor, mul, I as IDENTITY, norm, smoothNormals, parseTexMap, texmapUV, texmapTriangleUV, transformTexMap, resolveTexture, fileKind, looseSteps, looseSource, looseFile, loosePartName, texWrapper, invert, hash32, colorToken, rotStepMatrix, stepViewMatrix, fileStepViews } from "./spec.js";
+export { parse, parseColor, isDirectColor, namedColorCode, isNamedColor, mul, I as IDENTITY, norm, smoothNormals, parseTexMap, texmapUV, texmapTriangleUV, transformTexMap, resolveTexture, fileKind, looseSteps, looseSource, looseFile, loosePartName, texWrapper, invert, hash32, colorToken, rotStepMatrix, stepViewMatrix, fileStepViews } from "./spec.js";
 export type { M as Matrix12, Doc, LFile, Cmd, RotStep, BufExchg, TexMap, TexMapCmd, TexMapMethod, TexAnno, DataBlock, PartMesh, FileKind, StepView } from "./spec.js";
-export { flatten, parseModel, sequenceSteps, stepKey, parseLDConfig, parseColourLine, colourSurface, colourMaterialKey, CALLOUT_END } from "./model.js";
+export { flatten, parseModel, sequenceSteps, stepKey, parseLDConfig, parseColourLine, colourSurface, colourMaterialKey, blendedColourHex, CALLOUT_END } from "./model.js";
 export { planStepViews, isolateMask, viewDir, instanceBoxes, MIN_VIS, REORIENT } from "./instructions.js";
 export type { StepCameraView, StepCameraOptions, Vec3 } from "./instructions.js";
 export type { PartInstance, FlattenOptions, LDrawColor, LDrawFinish, LDrawFinishType, LDrawMaterialGrain, ColourSurface } from "./model.js";