ldr 0.11.1 → 0.13.0

package/README.md

@@ -86,7 +86,8 @@ Light the scene (or set `scene.environment`) as you would for any `MeshStandardM
 | `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. |
 | `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 }` entries. |
+| `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). |
+| `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. |
@@ -209,7 +210,8 @@ Reproduce: `cd bench && bun run setup && bun run perf` (regression gate) or `bun
 
 ## Limitations
 
-- **Transparency:** transparent colours render opaque.
+- **Finishes:** `!COLOUR` CHROME / PEARLESCENT / RUBBER / METAL / MATTE_METALLIC map to MeshStandard/Physical PBR (same numbers as three.js `LDrawLoader`). MATERIAL GLITTER / SPECKLE use a procedural grain approximation; FABRIC uses sheen. ALPHA sets opacity; LUMINANCE drives emissive.
+- **Transparency:** transparent colours (`ALPHA < 255`) render with opacity and `depthWrite: false` (one material bucket per finish × opacity class).
 - **Opt-in pack features:** conditional lines need packs built with `cond`. Printed parts show their images only from `textures` packs (the embedded PNGs dominate the pack size); default packs draw the FALLBACK geometry.
 - **ROTSTEP** is reported (`stepViews`, `instance.view`), not applied; `planStepViews` takes a `fixed(step)` override if you want to honour it.
 - **Packs are static:** they hold only the parts they were built for. A model that uses parts missing from the pack lists them in `stats.missing`.

package/dist/cli.js

@@ -1,18 +1,18 @@
 #!/usr/bin/env node
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/cli.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/cli.ts
 import fs4 from "node:fs";
 import zlib from "node:zlib";
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/node/build-pack.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/node/build-pack.ts
 import fs3 from "node:fs";
 import path3 from "node:path";
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/node/resolver.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/node/resolver.ts
 import fs from "node:fs";
 import path from "node:path";
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/spec.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/spec.ts
 var norm = (s) => s.trim().toLowerCase().replace(/\\/g, "/").replace(/\/+/g, "/");
 function parseColor(tok) {
   if (/^0x/i.test(tok))
@@ -705,7 +705,7 @@ function fileStepViews(f) {
   return out;
 }
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/model.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/model.ts
 var CALLOUT_END = 999999;
 var stepKey = (steps) => steps.map((x) => String(x).padStart(6, "0")).join(".") + "~";
 function flatten(doc, opts = {}) {
@@ -854,17 +854,208 @@ function sequenceSteps(insts) {
   });
   return { count: uniq.length, stepOf, views };
 }
+var FINISH_WORDS = new Set(["CHROME", "PEARLESCENT", "RUBBER", "MATTE_METALLIC", "METAL", "MATERIAL"]);
+function parseHexColor(tok) {
+  if (!tok)
+    return null;
+  if (tok.startsWith("#") && /^#[0-9A-Fa-f]{6}$/.test(tok))
+    return tok.toUpperCase();
+  if (/^0x[0-9A-Fa-f]{6}$/i.test(tok))
+    return ("#" + tok.slice(2)).toUpperCase();
+  return null;
+}
+function parseGrain(tokens, i) {
+  const grain = { value: "#FFFFFF", fraction: 0.5 };
+  while (i < tokens.length) {
+    const t = tokens[i].toUpperCase();
+    const n = tokens[i + 1];
+    if (t === "VALUE") {
+      const h = parseHexColor(n);
+      if (h)
+        grain.value = h;
+      i += 2;
+    } else if (t === "ALPHA") {
+      grain.alpha = +n;
+      i += 2;
+    } else if (t === "LUMINANCE") {
+      grain.luminance = +n;
+      i += 2;
+    } else if (t === "FRACTION") {
+      grain.fraction = +n;
+      i += 2;
+    } else if (t === "VFRACTION") {
+      grain.vfraction = +n;
+      i += 2;
+    } else if (t === "SIZE") {
+      grain.size = +n;
+      i += 2;
+    } else if (t === "MINSIZE") {
+      grain.minsize = +n;
+      i += 2;
+    } else if (t === "MAXSIZE") {
+      grain.maxsize = +n;
+      i += 2;
+    } else
+      break;
+  }
+  return { grain, next: i };
+}
+function parseColourLine(line) {
+  const idx = line.indexOf("!COLOUR");
+  if (idx < 0)
+    return null;
+  const tokens = line.slice(idx + "!COLOUR".length).trim().split(/\s+/).filter(Boolean);
+  if (tokens.length < 2)
+    return null;
+  const name = tokens[0];
+  let code = -1, 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;
+      i += 2;
+    } else if (t === "VALUE") {
+      const h = parseHexColor(n);
+      if (h)
+        hex = h;
+      i += 2;
+    } else if (t === "EDGE") {
+      const h = parseHexColor(n);
+      edge = h ?? n;
+      i += 2;
+    } else if (t === "ALPHA") {
+      alpha = +n;
+      i += 2;
+    } else if (t === "LUMINANCE") {
+      luminance = +n;
+      i += 2;
+    } else if (t === "CHROME") {
+      finish = { type: "chrome" };
+      i += 1;
+    } else if (t === "PEARLESCENT") {
+      finish = { type: "pearlescent" };
+      i += 1;
+    } else if (t === "RUBBER") {
+      finish = { type: "rubber" };
+      i += 1;
+    } else if (t === "MATTE_METALLIC") {
+      finish = { type: "matte_metallic" };
+      i += 1;
+    } else if (t === "METAL") {
+      finish = { type: "metal" };
+      i += 1;
+    } else if (t === "MATERIAL") {
+      const kind = (tokens[i + 1] || "").toUpperCase();
+      if (kind === "GLITTER") {
+        const { grain, next } = parseGrain(tokens, i + 2);
+        finish = { type: "glitter", material: grain };
+        i = next;
+      } else if (kind === "SPECKLE") {
+        const { grain, next } = parseGrain(tokens, i + 2);
+        finish = { type: "speckle", material: grain };
+        i = next;
+      } else if (kind === "FABRIC") {
+        const sub = (tokens[i + 2] || "").toUpperCase();
+        const fab = ["VELVET", "CANVAS", "STRING", "FUR"].includes(sub) ? sub.toLowerCase() : undefined;
+        finish = { type: "fabric", kind: fab };
+        i += fab ? 3 : 2;
+      } else {
+        i = tokens.length;
+      }
+    } else if (FINISH_WORDS.has(t)) {
+      i += 1;
+    } else
+      i += 1;
+  }
+  if (code < 0 || !hex)
+    return null;
+  return { code, name, hex, edge, alpha: Number.isFinite(alpha) ? alpha : 255, luminance: Number.isFinite(luminance) ? luminance : 0, finish };
+}
+function colourSurface(c) {
+  const opacity = Math.max(0, Math.min(1, (c.alpha ?? 255) / 255));
+  const transparent = opacity < 1;
+  const emissive = Math.max(0, Math.min(1, (c.luminance ?? 0) / 255));
+  const base = {
+    opacity,
+    transparent,
+    depthWrite: !transparent,
+    emissive,
+    clearcoat: 0,
+    clearcoatRoughness: 0,
+    sheen: 0,
+    sheenRoughness: 0
+  };
+  const fin = c.finish?.type ?? "default";
+  switch (fin) {
+    case "chrome":
+      return { ...base, metalness: 1, roughness: 0, finish: "chrome" };
+    case "pearlescent":
+      return { ...base, metalness: 0.25, roughness: 0.3, clearcoat: 0.5, clearcoatRoughness: 0.25, sheen: 0.4, sheenRoughness: 0.35, finish: "pearlescent" };
+    case "rubber":
+      return { ...base, metalness: 0, roughness: 0.9, finish: "rubber" };
+    case "matte_metallic":
+      return { ...base, metalness: 0.4, roughness: 0.8, finish: "matte_metallic" };
+    case "metal":
+      return { ...base, metalness: 0.85, roughness: 0.2, finish: "metal" };
+    case "glitter": {
+      const m = c.finish.material;
+      const size = m.size ?? (m.minsize != null && m.maxsize != null ? (m.minsize + m.maxsize) / 2 : 1);
+      return {
+        ...base,
+        metalness: 0.35,
+        roughness: 0.25,
+        clearcoat: 1,
+        clearcoatRoughness: 0.08,
+        particleHex: m.value,
+        particleFraction: m.fraction,
+        particleSize: size,
+        finish: "glitter"
+      };
+    }
+    case "speckle": {
+      const m = c.finish.material;
+      const size = m.size ?? (m.minsize != null && m.maxsize != null ? (m.minsize + m.maxsize) / 2 : 1);
+      return {
+        ...base,
+        metalness: 0.2,
+        roughness: 0.55,
+        particleHex: m.value,
+        particleFraction: m.fraction,
+        particleSize: size,
+        finish: "speckle"
+      };
+    }
+    case "fabric":
+      return { ...base, metalness: 0, roughness: 0.85, sheen: 0.65, sheenRoughness: 0.75, finish: "fabric" };
+    default:
+      return { ...base, metalness: 0, roughness: 0.45, finish: "default" };
+  }
+}
+function colourMaterialKey(c) {
+  const s = colourSurface(c);
+  const opac = !s.transparent ? "op" : s.opacity >= 0.75 ? "a200" : s.opacity >= 0.4 ? "a128" : `a${Math.round(s.opacity * 255)}`;
+  const lum = s.emissive > 0 ? `L${Math.round(s.emissive * 16)}` : "";
+  let k = `${s.finish}:${opac}${lum}`;
+  if (s.particleHex)
+    k += `:${s.particleHex}:${(s.particleFraction ?? 0).toFixed(2)}`;
+  return k;
+}
 function parseLDConfig(text) {
   const out = new Map;
   for (const l of text.split(/\r?\n/)) {
-    const m = /!COLOUR\s+(\S+)\s+CODE\s+(\d+)\s+VALUE\s+(#[0-9A-Fa-f]{6})\s+EDGE\s+(\S+)(?:.*?ALPHA\s+(\d+))?/.exec(l);
-    if (m)
-      out.set(+m[2], { code: +m[2], name: m[1], hex: m[3].toUpperCase(), edge: m[4], alpha: m[5] ? +m[5] : 255 });
+    if (!l.includes("!COLOUR"))
+      continue;
+    const c = parseColourLine(l);
+    if (c)
+      out.set(c.code, c);
   }
   return out;
 }
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/node/resolver.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/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();
@@ -1134,11 +1325,11 @@ function collectDeps(lib, refs) {
   return out;
 }
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/node/compile.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/node/compile.ts
 import fs2 from "node:fs";
 import path2 from "node:path";
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/node/lod.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/node/lod.ts
 import { MeshoptSimplifier, MeshoptEncoder } from "meshoptimizer";
 await Promise.all([MeshoptSimplifier.ready, MeshoptEncoder.ready]);
 function reorderMesh(P, N, C, I) {
@@ -1330,7 +1521,7 @@ function lodChain(P, C, I) {
   return out;
 }
 
-// ../../../../../../../tmp/ldr-build-ClpPxU/src/node/compile.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/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/)) {
@@ -1913,7 +2104,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-ClpPxU/src/node/build-pack.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/node/build-pack.ts
 function buildPack(o) {
   const lib = new Library(o.ldrawRoot);
   const refs = new Map;
@@ -1965,8 +2156,13 @@ function buildPack(o) {
   let extra;
   if (o.colors !== false) {
     const cfg = path3.join(o.ldrawRoot, "LDConfig.ldr");
-    if (fs3.existsSync(cfg))
-      extra = { colors: Object.fromEntries([...parseLDConfig(fs3.readFileSync(cfg, "latin1"))].map(([k, v]) => [k, v.hex])) };
+    if (fs3.existsSync(cfg)) {
+      const table = [...parseLDConfig(fs3.readFileSync(cfg, "latin1"))];
+      extra = {
+        colors: Object.fromEntries(table.map(([k, v]) => [k, v.hex])),
+        colorTable: Object.fromEntries(table.map(([k, v]) => [k, { name: v.name, hex: v.hex, edge: v.edge, alpha: v.alpha, luminance: v.luminance, finish: v.finish }]))
+      };
+    }
   }
   const texture = (n) => {
     const k = norm2(n), b = data.get(k) ?? data.get(k.replace(/^textures\//, "")) ?? data.get("textures/" + k);
@@ -1976,7 +2172,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-ClpPxU/src/cli.ts
+// ../../../../../../../tmp/ldr-build-TjmzYL/src/cli.ts
 var HELP = `ldr pack — build a parts pack for the ldr three.js renderer
 
 Usage:

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 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 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, CALLOUT_END } from "./model.js";
+export { flatten, parseModel, sequenceSteps, stepKey, parseLDConfig, parseColourLine, colourSurface, colourMaterialKey, 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 } from "./model.js";
-export { loadPack, decodePack, buildLdrScene, makeMaterial, createInstancedEdges, computeCulling, cullCore, forEachStud, conditionalLines, createInstancedConditionalEdges, conditionalLineVisible, warmPackGeometry } from "./render.js";
+export type { PartInstance, FlattenOptions, LDrawColor, LDrawFinish, LDrawFinishType, LDrawMaterialGrain, ColourSurface } from "./model.js";
+export { loadPack, decodePack, buildLdrScene, makeMaterial, makeFinishMaterial, createInstancedEdges, computeCulling, cullCore, forEachStud, conditionalLines, createInstancedConditionalEdges, conditionalLineVisible, warmPackGeometry } from "./render.js";
 export { precomputeCull, sceneInstances } from "./cull.js";
 export type { Pack, LdrParams, Inst, CullResult } from "./render.js";
 export { createLdrObject } from "./scene.js";