@rig-c/play 0.0.0-stage → 1.8.0

package/dist/posedFrame.d.ts

@@ -0,0 +1,99 @@
+/**
+ * The record the DOM tier draws: one posed moment of a rig, every slot the
+ * renderer shows, in draw order.
+ *
+ * The renderer never needed a skeleton. Per slot it needs the kind, four world
+ * corners or world vertices with page UVs and triangles, the bitmap or the
+ * page image with its alpha convention, a tint, a blend mode, a clip polygon
+ * and a stacking position — and every one of those is a field of a pose that
+ * `rig-c/core` computes from the compiled model document, plus that document's
+ * `pages` section. This module is the adapter from one to the other
+ * (`frameOf`), and these types are the whole of what crosses it.
+ *
+ * Coordinates are world space, Y up, exactly as the poser computed them; the
+ * renderer does the Y flip. Nothing here is rounded or re-ordered.
+ */
+export interface PosedFrame {
+    /** Every slot that draws, in draw order. */
+    order: PosedSlot[];
+}
+/** The four blend modes, spelled as the runtime's enum names them. */
+export type BlendMode = 'Normal' | 'Additive' | 'Multiply' | 'Screen';
+/**
+ * A clip polygon in world space and whether it keeps what is outside it.
+ *
+ * One object per clip in force: every slot a clip covers carries the *same*
+ * object, which is how the renderer tells a clip that covers the whole frame
+ * (one `clip-path` on the root) from one that covers a range of it.
+ */
+export interface PosedClip {
+    /** Flat x, y pairs, world space. */
+    polygon: number[];
+    inverse: boolean;
+    /**
+     * The clipping attachment's `convex` flag: a polygon that is not convex is
+     * clipped against its hull rather than decomposed. The DOM tier's CSS
+     * `clip-path` takes the polygon as authored and does not read it; the canvas
+     * mode's triangle cut does (`clipThrough` in `rig-c/core`).
+     */
+    convex: boolean;
+}
+interface PosedSlotCommon {
+    /** The slot's name — the renderer keys its element on it. */
+    slot: string;
+    /** The slot's index in the full draw order (hidden slots included): its z-index. */
+    z: number;
+    blend: BlendMode;
+    /** Slot colour × attachment colour × the player's own colour, r g b a in [0, 1]. */
+    tint: [number, number, number, number];
+    /** The slot's dark (two-colour) tint, where it carries one. The DOM tier cannot draw it. */
+    dark?: [number, number, number];
+    /** The clip in force over this slot, where one is. */
+    clip?: PosedClip;
+}
+/** A rigid slot: an unpacked region bitmap posed by its four world corners. */
+export interface PosedRegion extends PosedSlotCommon {
+    kind: 'region';
+    /** The region drawn — the key into the region bitmap map (a sequence frame's own name). */
+    region: string;
+    /** Four world corners, bottom-left, upper-left, upper-right, bottom-right: x0 y0 … x3 y3. */
+    corners: number[];
+    /**
+     * The page the region sits on — the key into the page image map. The DOM tier
+     * draws the region's own bitmap and never reads it; the canvas mode samples
+     * the page through `uvs`.
+     */
+    page: string;
+    /** Whether the page's texels are premultiplied by their alpha. */
+    pma: boolean;
+    /**
+     * The region's page UVs at its four corners, in the corners' order (u, v
+     * pairs, the page spanning [0, 1]) — the runtime's region UVs, a 90°-packed
+     * region's turn included. The same array object from frame to frame for the
+     * same region.
+     */
+    uvs: number[];
+}
+/** A deform slot: world vertices over page UVs, rastered from the page image. */
+export interface PosedMesh extends PosedSlotCommon {
+    kind: 'mesh';
+    /** The page drawn — the key into the page image map. */
+    page: string;
+    /** Whether the page's texels are premultiplied by their alpha. */
+    pma: boolean;
+    /** World vertices, flat x, y pairs. */
+    vertices: number[];
+    /**
+     * Page UVs, flat u, v pairs, the page spanning [0, 1]. The same array object
+     * from frame to frame for the same region and attachment, so the renderer
+     * can tell a mesh whose texture did not change by identity.
+     */
+    uvs: number[];
+    /** Triangle indices into `vertices`, three per triangle. Stable by identity like `uvs`. */
+    triangles: number[];
+    /** The sequence frame drawn (0 for an attachment with no series). */
+    sequence: number;
+}
+export type PosedSlot = PosedRegion | PosedMesh;
+export {};
+//# sourceMappingURL=posedFrame.d.ts.map

package/dist/posedFrame.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"posedFrame.d.ts","sourceRoot":"","sources":["../src/posedFrame.ts"],"names":[],"mappings":"AAiBA;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,UAAU;IACzB,4CAA4C;IAC5C,KAAK,EAAE,SAAS,EAAE,CAAC;CACpB;AAED,sEAAsE;AACtE,MAAM,MAAM,SAAS,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC;AAEtE;;;;;;GAMG;AACH,MAAM,WAAW,SAAS;IACxB,oCAAoC;IACpC,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,OAAO,EAAE,OAAO,CAAC;IACjB;;;;;OAKG;IACH,MAAM,EAAE,OAAO,CAAC;CACjB;AAED,UAAU,eAAe;IACvB,6DAA6D;IAC7D,IAAI,EAAE,MAAM,CAAC;IACb,oFAAoF;IACpF,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,EAAE,SAAS,CAAC;IACjB,oFAAoF;IACpF,IAAI,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IACvC,4FAA4F;IAC5F,IAAI,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;IAChC,sDAAsD;IACtD,IAAI,CAAC,EAAE,SAAS,CAAC;CAClB;AAED,+EAA+E;AAC/E,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD,IAAI,EAAE,QAAQ,CAAC;IACf,2FAA2F;IAC3F,MAAM,EAAE,MAAM,CAAC;IACf,6FAA6F;IAC7F,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,GAAG,EAAE,OAAO,CAAC;IACb;;;;;OAKG;IACH,GAAG,EAAE,MAAM,EAAE,CAAC;CACf;AAED,iFAAiF;AACjF,MAAM,WAAW,SAAU,SAAQ,eAAe;IAChD,IAAI,EAAE,MAAM,CAAC;IACb,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IACb,kEAAkE;IAClE,GAAG,EAAE,OAAO,CAAC;IACb,uCAAuC;IACvC,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB;;;;OAIG;IACH,GAAG,EAAE,MAAM,EAAE,CAAC;IACd,2FAA2F;IAC3F,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,MAAM,SAAS,GAAG,WAAW,GAAG,SAAS,CAAC"}

package/package.json

@@ -1,6 +1,64 @@
 {
   "name": "@rig-c/play",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.8.0",
+  "description": "Plays skeleton.model.json written by rigc build as plain DOM elements — rigid slots as <img> posed by CSS matrix, deform meshes on small per-part canvases — or as one canvas.",
+  "type": "module",
+  "license": "MIT",
+  "author": "firejune",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/firejune/rig-play.git"
+  },
+  "homepage": "https://github.com/firejune/rig-play#readme",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/firejune"
+  },
+  "bugs": "https://github.com/firejune/rig-play/issues",
+  "keywords": [
+    "rigc",
+    "rig-c",
+    "skeletal-animation",
+    "mesh-deformation",
+    "dom",
+    "css-transform",
+    "renderer",
+    "2d",
+    "animation",
+    "character-animation"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "NOTICE.md"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "predev": "bash scripts/fetch-assets.sh",
+    "dev": "vite",
+    "prebuild": "bash scripts/fetch-assets.sh",
+    "build": "tsc --noEmit && vite build",
+    "build:lib": "rm -rf dist && node scripts/build-lib.mjs dist",
+    "prepublishOnly": "npm run build:lib",
+    "preview": "vite preview",
+    "test": "playwright test",
+    "bench": "bash scripts/fetch-assets.sh && node scripts/bench.mjs",
+    "bench:dev": "bash scripts/fetch-assets.sh && vite --config bench/vite.config.ts",
+    "bench:build": "bash scripts/fetch-assets.sh && vite build --config bench/vite.config.ts",
+    "fetch-assets": "bash scripts/fetch-assets.sh"
+  },
+  "devDependencies": {
+    "@playwright/test": "1.62.1",
+    "@types/node": "^22",
+    "rig-c": "2.39.0",
+    "typescript": "^5.6.0",
+    "vite": "^6.0.0"
+  }
+}