@layoutit/polycss-react 0.2.8 → 0.2.9

package/README.md

@@ -4,6 +4,8 @@ A CSS polygon mesh library. A 3D engine for the DOM. Renders OBJ/MTL, STL, glTF/
 
 Visit [polycss.com](https://polycss.com) for docs and model examples.
 
+Join [chat.polycss.com](https://chat,polycss.com) for support and community discussions.
+
 <img width="1600" height="300" alt="PolyCSS primitives banner" src="https://github.com/user-attachments/assets/b05e2204-9323-4f83-8d1b-01ea0dd000db" />
 
 ## Installation
@@ -151,6 +153,61 @@ const html = await exportPolySceneSnapshot(scene.host);
 
 If any referenced asset cannot be inlined, the function throws `PolySceneSnapshotError` with `code: "ASSET_INLINE_FAILED"`.
 
+### Prepared retained models
+
+The source tree includes `@layoutit/polycss-morph`, an imperative,
+framework-agnostic package for models prepared ahead of time and updated through
+one retained PolyCSS DOM graph. Version `0.0.1` is qualified for publication;
+this documentation does not announce npm registry availability.
+
+Preparation is explicitly Node-only:
+
+```ts
+import { preparePolyMorphModel } from "@layoutit/polycss-morph/prepare";
+
+await preparePolyMorphModel({
+  configPath: "./source/prepare.json",
+  outputRoot: "./public/model/package",
+});
+```
+
+The browser entry loads, mounts, samples, and applies updates:
+
+```ts
+import {
+  createPolyMorphDeformationRuntime,
+  loadPolyMorphPackage,
+  mountPolyMorphModel,
+} from "@layoutit/polycss-morph";
+
+const loaded = await loadPolyMorphPackage("/model/");
+const mounted = mountPolyMorphModel(host, loaded.model, {
+  resources: loaded.resources,
+});
+const deformation = createPolyMorphDeformationRuntime(loaded.model);
+const frame = deformation.sample({
+  tick: 0,
+  morphWeights: { "corner-lift": 0.5 },
+});
+
+mounted.apply({ leaves: frame.leafUpdates });
+```
+
+Morph supports `static-prepared`, `morph-regions`, `joint-skin`, and
+`prepared-playback` profiles. It does not own an animation scheduler: callers
+sample controls, springs, clips, skinning, or playback and pass only changed
+rows to `mounted.apply(...)`. Mounted leaf identity stays stable, and runtime
+updates do not rebuild topology or redraw prepared image resources.
+Prepared playback uses a two-phase sample: apply `sample.update`, then call
+`runtime.commit(sample)` only after the retained mount accepts the update.
+
+Prepared solid triangles use the native CSS triangle primitive when supported.
+Preparation also emits packed alpha-atlas pages for WebKit/Safari and other
+browsers without a supported CSS triangle primitive. Every polygon receives a
+slice sized to its local-2D bounding rect. Mount creates object URLs from the
+already-verified package bytes, selects the fallback once, and revokes those
+URLs at teardown; it never refetches, generates, or redraws the atlas.
+
 ### Polygon Data Model
 
 Each polygon describes one renderable face:
@@ -231,6 +288,7 @@ Each visible polygon is emitted as one leaf element; the renderer chooses the le
 | `@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. |
+| `@layoutit/polycss-morph` | Prepared retained-model contracts, Node preparation, browser loading, sparse deformation, controls, springs, animation, skinning, and playback. |
 
 ## Made with PolyCSS
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@layoutit/polycss-react",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "React components for the CSS-based polygon mesh rendering engine",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -53,7 +53,7 @@
     "access": "public"
   },
   "dependencies": {
-    "@layoutit/polycss-core": "^0.2.8"
+    "@layoutit/polycss-core": "^0.2.9"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",