@layoutit/polycss 0.2.0 → 0.2.2

package/README.md

@@ -1,200 +1,202 @@
-> **Status: pre-1.0. APIs may still change before a stable 1.0 release.**
+# PolyCSS
 
-# polycss
+A CSS polygon mesh library. A 3D engine for the DOM. Renders OBJ/MTL, STL, glTF/GLB, and VOX as real HTML elements transformed with CSS `matrix3d(...)`. Supports colors, textures, lighting, shadows, shapes and animations. Works with React, Vue or plain JavaScript.
 
-Vanilla JS / custom elements package for CSS-based polygon mesh rendering. Loads OBJ, glTF, GLB, and MagicaVoxel `.vox` files; renders each polygon as a real DOM element (atlas-backed `<i>` for both textured and flat-color faces) positioned with `transform: matrix3d(...)`. No WebGL, no canvas-as-scene.
+Visit [polycss.com](https://polycss.com) for docs and model examples.
 
-Two entry points:
+<img width="1600" height="300" alt="PolyCSS primitives banner" src="https://github.com/user-attachments/assets/b05e2204-9323-4f83-8d1b-01ea0dd000db" />
 
-- **`polycss`**: imperative `createPolyScene` API + custom element classes (without auto-registering them).
-- **`polycss/elements`**: side-effect import that registers the scene, mesh, polygon, controls, camera, helper, select, and transform-control custom elements.
-
-## Install
+## Installation
 
 ```bash
+
+# Vanilla
 npm install @layoutit/polycss
-```
 
-Or via CDN (no build step):
+# React
+npm install @layoutit/polycss-react
+
+# Vue
+npm install @layoutit/polycss-vue
 
-```html
-<script type="module" src="https://esm.sh/@layoutit/polycss/elements"></script>
 ```
 
-## Custom elements (declarative, primary path)
 
-Register elements with the side-effect import:
+You can also load PolyCSS directly from a CDN. Here is a minimal custom-element scene:
 
 ```html
 <script type="module" src="https://esm.sh/@layoutit/polycss/elements"></script>
 
-<poly-scene perspective="1000" rot-x="65" rot-y="45">
-  <poly-mesh src="/cottage.glb"></poly-mesh>
-</poly-scene>
+<poly-camera rot-x="65" rot-y="45">
+  <poly-scene>
+    <poly-orbit-controls drag wheel></poly-orbit-controls>
+    <poly-box size="100" color="#ffd166"></poly-box>
+  </poly-scene>
+</poly-camera>
 ```
 
-With per-polygon elements:
+<img width="2500" height="1145" alt="PolyCSS intro" src="https://github.com/user-attachments/assets/0e5df0d8-04a8-4e50-8e3a-1097a96ce42f" />
 
-```html
-<poly-scene perspective="1000" rot-x="65" rot-y="45">
-  <poly-polygon
-    vertices="[[0,0,0],[1,0,0],[0,1,0]]"
-    color="#ff0000"
-  ></poly-polygon>
-  <poly-polygon
-    vertices="[[2,0,0],[3,0,0],[2,1,0]]"
-    color="#0000ff"
-  ></poly-polygon>
-</poly-scene>
-```
+## Framework Components
 
-Custom elements accept standard DOM events: no framework needed:
+React and Vue expose the same component model. `<PolyCamera>` owns the viewpoint, `<PolyScene>` owns lighting and atlas options, and `<PolyMesh>` loads or receives polygon data.
 
-```html
-<poly-scene id="scene" perspective="1000" rot-x="65" rot-y="45"></poly-scene>
+```tsx
+import { PolyCamera, PolyScene, PolyOrbitControls, PolyMesh } from "@layoutit/polycss-react";
+
+export default function App() {
+  return (
+    <PolyCamera rotX={65} rotY={45}>
+      <PolyScene textureLighting="dynamic">
+        <PolyOrbitControls drag wheel />
+        <PolyMesh src="/gallery/obj/cottage.obj" mtl="/gallery/obj/cottage.mtl" />
+      </PolyScene>
+    </PolyCamera>
+  );
+}
+```
 
-<script type="module">
-import "https://esm.sh/@layoutit/polycss/elements";
+## API Reference
 
-const scene = document.querySelector("#scene");
+### PolyCamera
 
-const polygons = [
-  { vertices: [[0,0,0],[1,0,0],[0,1,0]], color: "#f00", id: "a" },
-  { vertices: [[2,0,0],[3,0,0],[2,1,0]], color: "#00f", id: "b" },
-];
+- `rotX`, `rotY` control the orbit angle in degrees.
+- `zoom` scales the projected scene.
+- `target` pans the camera target in world coordinates.
+- `distance` adds dolly pull-back.
+- `PolyCamera` is the orthographic default. Use `PolyPerspectiveCamera` when you want perspective depth.
 
-polygons.forEach(p => {
-  const el = document.createElement("poly-polygon");
-  el.setAttribute("vertices", JSON.stringify(p.vertices));
-  el.setAttribute("color", p.color);
-  el.addEventListener("click", () => console.log("clicked", p.id));
-  el.addEventListener("mouseenter", () => el.classList.add("hover"));
-  el.addEventListener("mouseleave", () => el.classList.remove("hover"));
-  scene.appendChild(el);
-});
-</script>
+### PolyScene
 
-<style>
-poly-polygon.hover { filter: brightness(1.5); }
-</style>
-```
+- `polygons` renders a static `Polygon[]` directly.
+- `directionalLight` and `ambientLight` control scene lighting.
+- `textureLighting` chooses `"baked"` or `"dynamic"`.
+- `textureQuality` controls atlas raster budget.
+- `strategies` can disable selected render strategies for diagnostics.
+- `autoCenter` rotates around the rendered mesh bounds instead of world origin.
 
-### Custom element attributes
+### PolyMesh
 
-**`<poly-scene>`**
+- `src` loads `.obj`, `.gltf`, `.glb`, or `.vox` files.
+- `mtl` loads companion OBJ materials.
+- `polygons` accepts pre-parsed geometry.
+- `position`, `scale`, and `rotation` transform the mesh wrapper.
+- `autoCenter` shifts the mesh bbox center to local origin.
+- `meshResolution` chooses `"lossy"` (default) or `"lossless"` optimization. STL imports use the conservative lossless path in both modes.
+- `castShadow` emits CSS-projected shadows in dynamic lighting mode.
 
-| Attribute | Description |
-|---|---|
-| `perspective` | CSS perspective distance in pixels |
-| `rot-x` | Camera X-axis rotation in degrees |
-| `rot-y` | Camera Y-axis rotation in degrees |
-| `zoom` | Scale factor |
-| `directional-direction` | Comma-separated `x, y, z` e.g. `"0.5, -0.7, 0.6"` |
-| `directional-color` | Directional light color hex |
-| `directional-intensity` | Directional light intensity |
-| `ambient-intensity` | Ambient light intensity |
-| `ambient-color` | Ambient light color hex |
-| `texture-lighting` | `"baked"` or `"dynamic"` |
-| `atlas-scale` | Atlas bitmap budget and compositor sprite size; lower numeric values reduce memory/detail |
-
-For pointer drag, wheel zoom, and autorotate, drop a `<poly-orbit-controls>` child inside the scene (or wire `createPolyOrbitControls(scene, ...)` against the imperative API). For pan-first map-style input use `<poly-map-controls>` / `createPolyMapControls` instead. Mirrors Three.js's split between camera state (`<poly-scene>`) and camera input.
-
-**`<poly-mesh>`**
-
-| Attribute | Description |
-|---|---|
-| `src` | URL to `.obj`, `.glb`, `.gltf`, or `.vox` |
-| `position` | Comma-separated `x, y, z` |
-| `scale` | Uniform scale factor |
-| `rotation` | Comma-separated euler degrees `x, y, z` |
-| `auto-center` | Boolean: shift mesh bbox center to origin |
+### Controls
 
-**`<poly-polygon>`**
+- `<PolyOrbitControls>` adds drag orbit, shift-drag pan, wheel zoom, and optional auto-rotate.
+- `<PolyMapControls>` uses pan-first map-style input.
+- `<PolyFirstPersonControls>` provides keyboard and pointer-look navigation.
+- `<PolyTransformControls>` adds translate/rotate gizmos for selected mesh handles.
 
-| Attribute | Description |
-|---|---|
-| `vertices` | JSON array of `[x,y,z]` arrays |
-| `color` | CSS color |
-| `texture` | Image URL |
-| `uvs` | JSON array of `[u,v]` pairs |
-| `position` | Comma-separated `x, y, z` |
-| `scale` | Uniform scale factor |
-| `rotation` | Comma-separated euler degrees `x, y, z` |
-
-## Imperative API (escape hatch)
-
-For programmatic control without custom elements:
-
-```js
-import { createPolyScene, loadMesh } from "@layoutit/polycss";
-
-const scene = createPolyScene(document.querySelector("#scene"), {
-  perspective: 1000,
-  rotX: 65,
-  rotY: 45,
-  directionalLight: { direction: [0.5, -0.7, 0.6] },
-});
+### Snapshot Export
 
-const mesh = await loadMesh("/cottage.glb", {
-  gltfOptions: { targetSize: 60 },
-});
-const handle = scene.add(mesh, { position: [0, 0, 0] });
+The vanilla package exports `exportPolySceneSnapshot(target)`. It clones the current rendered `.polycss-camera` / `.polycss-scene` DOM, injects only the PolyCSS CSS needed by that snapshot, inlines CSS `url(...)` image assets as `data:image/...;base64,...`, strips scripts and inline event handlers, and returns a standalone HTML document string with no PolyCSS runtime import. It works with rendered React/Vue scenes too; import it from `@layoutit/polycss` and pass the rendered camera or scene element.
+
+```ts
+import { exportPolySceneSnapshot } from "@layoutit/polycss";
 
-// Later:
-handle.setTransform({ position: [5, 0, 0] });
-handle.remove();
-mesh.dispose();
+const html = await exportPolySceneSnapshot(scene.host);
 ```
 
-### Imperative API reference
+If any referenced asset cannot be inlined, the function throws `PolySceneSnapshotError` with `code: "ASSET_INLINE_FAILED"`.
 
-**`createPolyScene(host, options)`**
+### Polygon Data Model
 
-| Option | Type | Description |
-|---|---|---|
-| `perspective` | `number` | CSS perspective distance |
-| `rotX` | `number` | Camera X rotation in degrees |
-| `rotY` | `number` | Camera Y rotation in degrees |
-| `zoom` | `number` | Camera zoom scale |
-| `distance` | `number` | Camera dolly pull-back in CSS pixels |
-| `target` | `Vec3` | World-coordinate camera target |
-| `directionalLight` | `PolyDirectionalLight` | Directional light config |
-| `ambientLight` | `PolyAmbientLight` | Ambient light config |
-| `textureLighting` | `"baked" \| "dynamic"` | Texture lighting mode |
-| `textureQuality` | `number \| "auto"` | Atlas bitmap budget and compositor sprite size |
-| `autoCenter` | `boolean` | Rotate around the union bbox center of added meshes |
+Each polygon describes one renderable face:
 
-Returns a `PolySceneHandle`:
+```ts
+const polygons = [
+  {
+    vertices: [[0, 0, 0], [60, 0, 0], [0, 60, 0]],
+    color: "#f97316",
+  },
+  {
+    vertices: [[0, 0, 0], [60, 0, 0], [60, 60, 0], [0, 60, 0]],
+    texture: "/texture.png",
+    uvs: [[0, 0], [1, 0], [1, 1], [0, 1]],
+  },
+];
+```
+
+Render polygons directly when you need per-face DOM events or custom styling:
+
+```tsx
+<PolyCamera>
+  <PolyScene>
+    {polygons.map((polygon, index) => (
+      <Poly
+        key={index}
+        {...polygon}
+        onClick={() => console.log("clicked polygon", index)}
+        className="my-polygon"
+      />
+    ))}
+  </PolyScene>
+</PolyCamera>
+```
+
+## Loading Mesh Files
+
+Use `loadMesh()` to parse supported model formats:
 
 ```ts
-interface PolySceneHandle {
-  add(mesh: ParseResult, opts?: { position?: Vec3; scale?: number | Vec3; rotation?: Vec3 }): PolyMeshHandle;
-  setOptions(partial: Partial<PolySceneOptions>): void;
-  destroy(): void;
-}
+import { createPolyCamera, createPolyScene, loadMesh } from "@layoutit/polycss";
+
+const host = document.getElementById("polycss")!;
+const camera = createPolyCamera({ rotX: 65, rotY: 45 });
+const scene = createPolyScene(host, { camera });
+
+const mesh = await loadMesh("https://polycss.com/gallery/obj/cottage.obj", {
+  mtlUrl: "https://polycss.com/gallery/obj/cottage.mtl",
+});
+
+scene.add(mesh);
 ```
 
-**`loadMesh(url, options?)`**
+Supported formats:
+
+- OBJ + MTL, including `map_Kd` textures and UV coordinates.
+- STL triangle meshes, including binary Magics face colors. STL has no standard units, textures, UVs, or hierarchy, so imports skip lossy simplification and ray-based interior culling.
+- glTF / GLB, including embedded images and `TEXCOORD_0`.
+- MagicaVoxel `.vox`, with direct voxel fast paths when eligible.
+- Generated primitives: box, plane, ring, sphere, torus, cylinder, cone, and Platonic solids.
+
+## Performance
+
+PolyCSS renders through the DOM, so performance is mostly shaped by two things: the number of mounted leaves, and the amount of texture atlas area the browser has to paint. The renderer tries to keep the common cases cheap. Simple surfaces stay as solid CSS elements, while textured, irregular, or high-detail geometry falls back to atlas-backed slices only when needed.
 
-Fetches and parses a mesh by URL (dispatches by extension: `.obj`, `.glb`, `.gltf`, `.vox`). Returns `Promise<ParseResult>`.
-Mesh optimization defaults to `meshResolution: "lossy"`; pass `"lossless"` for exact planar candidates only.
+Each visible polygon is emitted as one leaf element; the renderer chooses the least expensive CSS primitive that can represent the polygon, then uses `matrix3d(...)` to place that primitive in 3D space.
 
-## Subpath imports
+- `<b>` uses `background: currentColor` on a fixed box for solid rectangles and stable quads.
+- `<u>` uses `corner-shape` for stable triangles and beveled-corner solids, with a `border-width` triangle fallback when needed.
+- `<i>` clips solid polygons with `border-shape: polygon(...)` when the browser supports it.
+- `<s>` maps a packed texture-atlas slice with `background-image`, and is the fallback for textured or unsupported shapes.
 
-| Import | Effect |
+## Packages
+
+| Package | Description |
 |---|---|
-| `import { createPolyScene } from "@layoutit/polycss"` | Imperative API + custom element classes (no auto-registration) |
-| `import "@layoutit/polycss/elements"` | Side-effect: registers the polycss custom elements |
+| `@layoutit/polycss-core` | Pure math, parsers, lighting, camera helpers, mesh optimization. Zero browser globals. |
+| `@layoutit/polycss` | Vanilla custom elements and imperative `createPolyScene` API. |
+| `@layoutit/polycss-react` | React components, hooks, controls, and core re-exports. |
+| `@layoutit/polycss-vue` | Vue 3 components, composables, controls, and core re-exports. |
 
-## Re-exports from `@layoutit/polycss-core`
+## Made with PolyCSS
 
-All `@layoutit/polycss-core` exports are re-exported from `@layoutit/polycss`, so vanilla users install one package:
+[Layoutit Voxels](https://voxels.layoutit.com)
+-> A CSS Voxel editor
 
-```ts
-import { parseObj, parseGltf, parseVox, loadMesh, normalizePolygons } from "@layoutit/polycss";
-import type { Polygon, Vec3, ParseResult } from "@layoutit/polycss";
-```
+<img width="1000" height="600" alt="layoutit-voxels" src="https://polycss.com/layoutit-voxels.png" />
+
+[Layoutit Terra](https://terra.layoutit.com)
+-> A CSS Terrain Generator
+
+<img width="1000" height="601" alt="layoutit-terra" src="https://polycss.com/layoutit-terra.png" />
 
-## Docs
+## License
 
-Full documentation at [polycss.com](https://polycss.com).
+MIT.