poppygl 0.0.37 → 0.0.38

package/README.md

@@ -245,6 +245,28 @@ Pass `explosionLines` to any render entrypoint to draw polylines between assembl
 and displaced part positions. The caller moves the geometry and supplies the
 points in the same glTF scene frame and units (normally right-handed, +Y up).
 
+The selected glTF scene can embed the same setting in `extras.poppygl.explosionLines`:
+
+```json
+{
+  "scene": 0,
+  "scenes": [{
+    "nodes": [0],
+    "extras": {
+      "poppygl": {
+        "explosionLines": [{ "points": [[0, 0, 0], [0, 20, 0]], "dashed": true }]
+      }
+    }
+  }]
+}
+```
+
+`renderSceneFromGLTF`, the URL renderer, and the GLB renderer use these guides
+when `explosionLines` is omitted. An explicit list replaces the embedded guides;
+`null` or `[]` hides them. Points are already in glTF world coordinates and are
+not transformed by individual nodes. No guide meshes are required, and other
+glTF viewers may ignore this optional metadata.
+
 This lamp is adapted from [core's reference-surface lamp](https://github.com/tscircuit/core/blob/81bef4337570e3ac4d7dd6d30ab63481304e8147/tests/assembly/fixtures/reference-surface-lamp.tsx).
 Its base, hollow blue stem, and bulb stay in place while the hollow shade,
 mounting collar, and three spokes move together by **+60 mm on scene Y**. The

package/dist/index.d.ts

@@ -1,69 +1,5 @@
 import { mat4 } from 'gl-matrix';
 
-type RGBA = readonly [number, number, number, number];
-type MutableRGBA = [number, number, number, number];
-interface BitmapLike {
-    width: number;
-    height: number;
-    data: Uint8Array | Uint8ClampedArray;
-}
-type ImageFactory = (width: number, height: number) => BitmapLike;
-declare const createUint8Bitmap: ImageFactory;
-
-interface Material {
-    baseColorFactor: [number, number, number, number];
-    baseColorTexture: BitmapLike | null;
-    /** Repeat rather than clamp the base-color texture (used by section hatching). */
-    baseColorTextureWrap?: "repeat" | "clamp";
-    metallicFactor?: number;
-    roughnessFactor?: number;
-    emissiveFactor?: [number, number, number];
-    emissiveTexture?: BitmapLike | null;
-    emissiveStrength?: number;
-    alphaMode?: "OPAQUE" | "MASK" | "BLEND";
-    alphaCutoff?: number;
-}
-interface DrawCall {
-    /** Generated section cap; preserve its hatch material in outline style. */
-    outlineSectionCap?: boolean;
-    positions: Float32Array;
-    normals: Float32Array | null;
-    uvs: Float32Array | null;
-    indices: Uint32Array | null;
-    model: mat4;
-    material: Material;
-    colors?: Float32Array | null;
-    mode?: number;
-    showHiddenEdges?: boolean;
-    /** Source triangle third vertices for each extracted edge segment. */
-    edgeAdjacentVertices?: number[][];
-}
-interface GridOptions {
-    size?: number | readonly [number, number, number];
-    divisions?: number;
-    color?: readonly [number, number, number];
-    offset?: Partial<{
-        x: number;
-        y: number;
-        z: number;
-    }>;
-    infiniteGrid?: boolean;
-    cellSize?: number;
-    sectionSize?: number;
-    fadeDistance?: number;
-    fadeStrength?: number;
-    gridColor?: readonly [number, number, number];
-    sectionColor?: readonly [number, number, number];
-}
-interface GLTFResources {
-    buffers: Uint8Array[];
-    images: BitmapLike[];
-}
-interface GLTFScene {
-    drawCalls: DrawCall[];
-    gltf: any;
-}
-
 type SectionAxis = "x" | "y" | "z";
 /** Axis-aligned plane in world/glTF coordinates, in model scene units. */
 interface OutlineSection {
@@ -162,6 +98,72 @@ type RenderOptionsInput = Partial<RenderOptions>;
 declare const DEFAULT_RENDER_OPTIONS: RenderOptions;
 declare function getDefaultRenderOptions(): RenderOptions;
 
+type RGBA = readonly [number, number, number, number];
+type MutableRGBA = [number, number, number, number];
+interface BitmapLike {
+    width: number;
+    height: number;
+    data: Uint8Array | Uint8ClampedArray;
+}
+type ImageFactory = (width: number, height: number) => BitmapLike;
+declare const createUint8Bitmap: ImageFactory;
+
+interface Material {
+    baseColorFactor: [number, number, number, number];
+    baseColorTexture: BitmapLike | null;
+    /** Repeat rather than clamp the base-color texture (used by section hatching). */
+    baseColorTextureWrap?: "repeat" | "clamp";
+    metallicFactor?: number;
+    roughnessFactor?: number;
+    emissiveFactor?: [number, number, number];
+    emissiveTexture?: BitmapLike | null;
+    emissiveStrength?: number;
+    alphaMode?: "OPAQUE" | "MASK" | "BLEND";
+    alphaCutoff?: number;
+}
+interface DrawCall {
+    /** Generated section cap; preserve its hatch material in outline style. */
+    outlineSectionCap?: boolean;
+    positions: Float32Array;
+    normals: Float32Array | null;
+    uvs: Float32Array | null;
+    indices: Uint32Array | null;
+    model: mat4;
+    material: Material;
+    colors?: Float32Array | null;
+    mode?: number;
+    showHiddenEdges?: boolean;
+    /** Source triangle third vertices for each extracted edge segment. */
+    edgeAdjacentVertices?: number[][];
+}
+interface GridOptions {
+    size?: number | readonly [number, number, number];
+    divisions?: number;
+    color?: readonly [number, number, number];
+    offset?: Partial<{
+        x: number;
+        y: number;
+        z: number;
+    }>;
+    infiniteGrid?: boolean;
+    cellSize?: number;
+    sectionSize?: number;
+    fadeDistance?: number;
+    fadeStrength?: number;
+    gridColor?: readonly [number, number, number];
+    sectionColor?: readonly [number, number, number];
+}
+interface GLTFResources {
+    buffers: Uint8Array[];
+    images: BitmapLike[];
+}
+interface GLTFScene {
+    /** Selected scene extras.poppygl.explosionLines, in glTF world coordinates. */
+    explosionLines?: readonly ExplosionLine[];
+    drawCalls: DrawCall[];
+    gltf: any;
+}
+
 interface Camera {
     view: mat4;
     proj: mat4;
@@ -311,6 +313,9 @@ declare function renderGLTFToPNGFromURL(url: string, options?: RenderGLTFToPNGFr
 type RenderGLTFToPNGFromGLBOptions = RenderOptionsInput;
 declare function renderGLTFToPNGFromGLB(glb: ArrayBuffer | Uint8Array, options?: RenderGLTFToPNGFromGLBOptions): Promise<Uint8Array>;
 
+/** Render the selected glTF scene's guides in scene-world coordinates.
+ * Explicit options override extras; null or [] disables embedded guides.
+ */
 declare function renderSceneFromGLTF(scene: GLTFScene, options?: RenderOptionsInput, imageFactory?: ImageFactory): RenderResult;
 
 export { type BitmapLike, type Camera, type CameraRotation, type CameraUp, DEFAULT_LIGHT_DIR, DEFAULT_RENDER_OPTIONS, type DebugPoint, type DrawCall, type ExplosionLine, type FetchLike, type GLTFResources, type GLTFScene, type GridOptions, type ImageFactory, type LightSettings, type LineRenderOptions, type LoadGLTFWithResourcesFromURLOptions, type Material, type MutableRGBA, type OutlineSection, type RGBA, type RenderGLTFToPNGFromGLBOptions, type RenderGLTFToPNGFromURLOptions, type RenderOptions, type RenderOptionsInput, type RenderResult, SoftwareRenderer, bufferFromDataURI, buildCamera, computeSmoothNormals, computeWorldAABB, createEdgeDrawCall, createGrid, createInfiniteGrid, createOutlineSection, createSceneFromGLTF, createUint8Bitmap, decodeImageFromBuffer, drawInfiniteGrid, encodePNG, getDefaultRenderOptions, hexToRgb, isJPG, isPNG, loadGLTFWithResourcesFromURL, renderDrawCalls, renderGLTFToPNGFromGLB, renderGLTFToPNGFromURL, renderSceneFromGLTF, resolveRenderOptions };

package/dist/index.js

@@ -3492,7 +3492,11 @@ function createSceneFromGLTF(gltf, resources) {
   for (const rootIndex of scene.nodes || []) {
     traverse(rootIndex, identity);
   }
-  return { gltf, drawCalls };
+  return {
+    gltf,
+    drawCalls,
+    explosionLines: scene.extras?.poppygl?.explosionLines
+  };
 }
 
 // lib/gltf/resourceUtils.ts
@@ -3732,6 +3736,18 @@ async function encodePNG(image) {
   });
 }
 
+// lib/render/renderSceneFromGLTF.ts
+function renderSceneFromGLTF(scene, options = {}, imageFactory) {
+  return renderDrawCalls(
+    scene.drawCalls,
+    {
+      ...options,
+      explosionLines: options.explosionLines === void 0 ? scene.explosionLines : options.explosionLines
+    },
+    imageFactory
+  );
+}
+
 // lib/render/renderGLTFToPNGFromURL.ts
 async function renderGLTFToPNGFromURL(url, options = {}) {
   const { fetchImpl, ...renderOptions } = options;
@@ -3739,8 +3755,8 @@ async function renderGLTFToPNGFromURL(url, options = {}) {
     fetchImpl
   });
   const scene = createSceneFromGLTF(gltf, resources);
-  const { bitmap } = renderDrawCalls(
-    scene.drawCalls,
+  const { bitmap } = renderSceneFromGLTF(
+    scene,
     renderOptions,
     createUint8Bitmap
   );
@@ -3817,18 +3833,9 @@ async function renderGLTFToPNGFromGLB(glb, options = {}) {
     })
   );
   const scene = createSceneFromGLTF(gltf, { buffers, images });
-  const { bitmap } = renderDrawCalls(
-    scene.drawCalls,
-    options,
-    createUint8Bitmap
-  );
+  const { bitmap } = renderSceneFromGLTF(scene, options, createUint8Bitmap);
   return encodePNG(bitmap);
 }
-
-// lib/index.ts
-function renderSceneFromGLTF(scene, options, imageFactory) {
-  return renderDrawCalls(scene.drawCalls, options, imageFactory);
-}
 export {
   DEFAULT_LIGHT_DIR,
   DEFAULT_RENDER_OPTIONS,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "poppygl",
   "main": "dist/index.js",
-  "version": "0.0.37",
+  "version": "0.0.38",
   "repository": {
     "type": "git",
     "url": "https://github.com/tscircuit/poppygl.git"