@ikijs/editor 0.14.0 → 0.16.0

package/dist/index.mjs

@@ -447,11 +447,24 @@ function validateDeformerReparent(deformers2, deformerId, newParentId) {
       `deformers."${deformerId}".parent "${newParentId}" is not a declared deformer`
     );
   }
-  if (kindOf(parent) === "warp") {
+  if (kindOf(parent) === "warp" && kindOf(target) === "warp") {
     throw new Error(
-      `deformers."${deformerId}".parent "${newParentId}" must be a matrix deformer (warp deformers cannot be parents)`
+      `deformers."${deformerId}".parent "${newParentId}" must be a matrix deformer (warp deformers cannot be nested under a warp deformer)`
     );
   }
+  if (parent.kind === "warp" && target.kind !== "warp") {
+    const { pivot } = target;
+    const { cols, rows, points } = parent.grid;
+    const xMin = points[0];
+    const xMax = points[2 * cols];
+    const yMax = points[1];
+    const yMin = points[rows * (cols + 1) * 2 + 1];
+    if (pivot.x < xMin || pivot.x > xMax || pivot.y < yMin || pivot.y > yMax) {
+      throw new Error(
+        `deformers."${deformerId}".pivot (${pivot.x}, ${pivot.y}) lies outside its warp parent "${newParentId}" rest grid x ${xMin}..${xMax}, y ${yMin}..${yMax}`
+      );
+    }
+  }
   const parentOf = /* @__PURE__ */ new Map();
   for (const d of deformers2) {
     if (d.parent !== void 0) parentOf.set(d.id, d.parent);
@@ -1910,7 +1923,8 @@ var PROFILE_VALUES = {
   mouthWiden: 1.2,
   brow: 0.15,
   breath: 0.03,
-  sway: 0.08
+  sway: 0.08,
+  blushRest: 0.4
 };
 function deriveProfile(v) {
   const farLead = v.lead * (1 - v.fore / 2);
@@ -1997,6 +2011,8 @@ function deriveProfile(v) {
     breathHead: v.breath * 2 / 3,
     /** Hair tip travel at full sway (±20), hh. */
     sway: v.sway,
+    /** The blush's opacity at Cheek 0; at Cheek 1 it is as drawn. */
+    blushRest: v.blushRest,
     /** The neck under the face reaches this far above the jaw, hh — what the
      *  chin uncovers as it slides off it: half again the chin's full-turn
      *  slide, to the next 0.05. */
@@ -2116,10 +2132,161 @@ function parseLayerRoles(fileNames) {
 // src/auto-rig/generate.ts
 import {
   IKI_FORMAT_VERSION as IKI_FORMAT_VERSION2,
-  StandardParameter as P3,
+  StandardParameter as P4,
   parseIkiModel as parseIkiModel3
 } from "@ikijs/format";
 
+// src/auto-rig/animations.ts
+import {
+  StandardParameter as P
+} from "@ikijs/format";
+function browsY(y) {
+  return [
+    { parameter: P.BrowLeftY, value: y, blend: "add" },
+    { parameter: P.BrowRightY, value: y, blend: "add" }
+  ];
+}
+function browsTilt(innerDown) {
+  return [
+    { parameter: P.BrowLeftAngle, value: innerDown, blend: "add" },
+    { parameter: P.BrowRightAngle, value: -innerDown, blend: "add" }
+  ];
+}
+function cheek(value) {
+  return { parameter: P.Cheek, value, blend: "add" };
+}
+var BROWS = [P.BrowLeftY, P.BrowRightY, P.BrowLeftAngle, P.BrowRightAngle];
+var EXPRESSIONS = [
+  {
+    id: "smile",
+    description: "Smiling and pleased: warm, friendly, content. For greetings, thanks, agreement and gentle happiness.",
+    parameters: [
+      { parameter: P.MouthForm, value: 1, blend: "add" },
+      ...browsY(0.25),
+      cheek(0.4)
+    ]
+  },
+  {
+    id: "laugh",
+    description: "Laughing, eyes shut and mouth open: delighted, amused. For jokes, playfulness and big joy.",
+    parameters: [
+      { parameter: P.EyeOpenLeft, value: 0, blend: "multiply" },
+      { parameter: P.EyeOpenRight, value: 0, blend: "multiply" },
+      { parameter: P.MouthForm, value: 1, blend: "add" },
+      { parameter: P.MouthOpen, value: 0.8, blend: "overwrite" },
+      ...browsY(0.4),
+      cheek(0.65)
+    ]
+  },
+  {
+    id: "angry",
+    description: "Angry or annoyed, frowning. For irritation, frustration, indignation or scolding.",
+    needs: BROWS,
+    parameters: [
+      ...browsY(-0.5),
+      ...browsTilt(0.8),
+      { parameter: P.MouthForm, value: -0.9, blend: "add" }
+    ]
+  },
+  {
+    id: "sad",
+    description: "Sad or disappointed, downcast. For sorrow, regret, apology or sympathy.",
+    needs: BROWS,
+    parameters: [
+      ...browsY(0.35),
+      ...browsTilt(-0.8),
+      { parameter: P.MouthForm, value: -0.8, blend: "add" }
+    ]
+  },
+  {
+    id: "surprised",
+    description: "Surprised, mouth dropped open: startled, amazed. For shock, sudden news or disbelief.",
+    parameters: [
+      ...browsY(0.8),
+      { parameter: P.MouthOpen, value: 0.9, blend: "overwrite" }
+    ]
+  },
+  {
+    id: "shy",
+    description: "Shy or embarrassed: bashful, flustered. For being praised, teased or caught off guard.",
+    needs: [P.Cheek],
+    parameters: [
+      cheek(1),
+      // Gaze down.
+      { parameter: P.EyeballY, value: -0.65, blend: "add" },
+      { parameter: P.MouthForm, value: 0.4, blend: "add" },
+      ...browsTilt(-0.25)
+    ]
+  }
+];
+function defaultExpressions(declared) {
+  return EXPRESSIONS.filter(
+    (e) => e.needs === void 0 || e.needs.some((id) => declared.has(id))
+  ).map(({ needs: _needs, ...e }) => ({
+    ...e,
+    parameters: e.parameters.filter((t) => declared.has(t.parameter))
+  }));
+}
+var DEFAULT_MOTIONS = {
+  Nod: [
+    {
+      description: "Nods yes: agreement, acknowledgement, understanding.",
+      duration: 1,
+      curves: [
+        {
+          parameter: P.AngleY,
+          keys: [
+            [0, 0],
+            [0.3, -18],
+            [0.6, 4],
+            [0.8, -1],
+            [1, 0]
+          ]
+        }
+      ]
+    }
+  ],
+  Shake: [
+    {
+      description: "Shakes the head no: disagreement, refusal, disbelief.",
+      duration: 1.2,
+      // The first swing peaks at 0.2 s, which the default fade would still
+      // be damping.
+      fadeIn: 0.15,
+      curves: [
+        {
+          parameter: P.AngleX,
+          keys: [
+            [0, 0],
+            [0.2, -18],
+            [0.45, 18],
+            [0.7, -16],
+            [0.95, 10],
+            [1.2, 0]
+          ]
+        }
+      ]
+    }
+  ],
+  Tilt: [
+    {
+      description: "Tilts the head to one side and back: curiosity, puzzlement, a question.",
+      duration: 1.4,
+      curves: [
+        {
+          parameter: P.AngleZ,
+          keys: [
+            [0, 0],
+            [0.35, 20],
+            [1, 20],
+            [1.4, 0]
+          ]
+        }
+      ]
+    }
+  ]
+};
+
 // src/auto-rig/layout.ts
 function boxOfLayer(layer) {
   return boxOfPixels(layer.bbox, layer.canvasW, layer.canvasH);
@@ -2413,7 +2580,7 @@ function checkStrandEdges(strand, irises, hair) {
 }
 
 // src/auto-rig/context.ts
-import { StandardParameter as P } from "@ikijs/format";
+import { StandardParameter as P2 } from "@ikijs/format";
 
 // src/auto-rig/grid.ts
 var X_STOPS = [-30, 0, 30];
@@ -3629,7 +3796,7 @@ function renderedLander(turn, parts, grids, from = /* @__PURE__ */ new Map()) {
     const family = roleSpec(role).family;
     const part = parts.find((p) => p.id === role);
     const g = grids.get(family);
-    const warp = part?.warps?.find((w) => w.parameter === P.AngleX);
+    const warp = part?.warps?.find((w) => w.parameter === P2.AngleX);
     if (part === void 0 || part.mesh === void 0 || !g && !warp) {
       return x + field(role)(x, y, ax, 0)[0];
     }
@@ -4340,7 +4507,7 @@ function buildTurn(frame, landmarks, q) {
 
 // src/auto-rig/drivers.ts
 import {
-  StandardParameter as P2
+  StandardParameter as P3
 } from "@ikijs/format";
 var SWAY_RANGE = 20;
 var SWAY_CURVE = 1.4;
@@ -4419,13 +4586,13 @@ function gazeBindings(irisW, share = 1) {
   const gy = AMPLITUDE.gazeY * irisW * share;
   return [
     {
-      parameter: P2.EyeballX,
+      parameter: P3.EyeballX,
       channel: "translateX",
       from: -round1(gx),
       to: round1(gx)
     },
     {
-      parameter: P2.EyeballY,
+      parameter: P3.EyeballY,
       channel: "translateY",
       from: -round1(gy),
       to: round1(gy)
@@ -4439,8 +4606,8 @@ function browReach(hh) {
   return AMPLITUDE.brow * hh;
 }
 function browBindings(side, reach) {
-  const y = side === "L" ? P2.BrowLeftY : P2.BrowRightY;
-  const a = side === "L" ? P2.BrowLeftAngle : P2.BrowRightAngle;
+  const y = side === "L" ? P3.BrowLeftY : P3.BrowRightY;
+  const a = side === "L" ? P3.BrowLeftAngle : P3.BrowRightAngle;
   return [
     {
       parameter: y,
@@ -4456,7 +4623,7 @@ function mouthForm(mesh, box) {
   const a = 0.3 * bh(box);
   const c = cx(box);
   const half = bw(box) / 2;
-  return localWarp(P2.MouthForm, mesh, box, [-1, 0, 1], ([x], v) => {
+  return localWarp(P3.MouthForm, mesh, box, [-1, 0, 1], ([x], v) => {
     if (v === 0) return [0, 0];
     const u = (x - c) / half;
     const widen = v > 0 ? 0.05 : 0.03;
@@ -4466,7 +4633,7 @@ function mouthForm(mesh, box) {
 function mouthOpenGrow(mesh, box) {
   const c = cx(box);
   return localWarp(
-    P2.MouthOpen,
+    P3.MouthOpen,
     mesh,
     box,
     [0, 1],
@@ -4475,7 +4642,7 @@ function mouthOpenGrow(mesh, box) {
 }
 function mouthWiden(mesh, box) {
   const c = cx(box);
-  return localWarp(P2.MouthOpen, mesh, box, [0, 1], ([x], v) => [
+  return localWarp(P3.MouthOpen, mesh, box, [0, 1], ([x], v) => [
     v * (AMPLITUDE.mouthOpenWidth - 1) * (x - c),
     0
   ]);
@@ -4493,7 +4660,7 @@ function hairSway(param, mesh, box, amp) {
   );
 }
 function tiltHang(mesh, box, pivot, weight) {
-  return localWarp(P2.AngleZ, mesh, box, Z_STOPS, ([x, y], v, i) => {
+  return localWarp(P3.AngleZ, mesh, box, Z_STOPS, ([x, y], v, i) => {
     const g = weight(y, i);
     if (g === 0 || v === 0) return [0, 0];
     const a = -g * rollOf(v);
@@ -4646,14 +4813,17 @@ function generateIkiFromLayerSet(layers, canvas, options = {}) {
       ...part.warps ?? []
     ];
   }
+  const parameters = declareParameters(new Set(byRole.keys()));
   const model = {
     version: IKI_FORMAT_VERSION2,
     name: "auto-rigged",
     canvas: { width: canvas.width, height: canvas.height },
-    parameters: declareParameters(new Set(byRole.keys())),
+    parameters,
     parts,
     deformers: deformers(frame, grids, has("body") ? box("body") : void 0),
-    ...has("hair_front") ? { physics: hairPhysics() } : {}
+    ...has("hair_front") ? { physics: hairPhysics() } : {},
+    expressions: defaultExpressions(new Set(parameters.map((p) => p.id))),
+    motions: DEFAULT_MOTIONS
   };
   const valid = parseIkiModel3(model);
   if (hasNose && options.onTurnSolved) {
@@ -4670,14 +4840,14 @@ function generateIkiFromLayerSet(layers, canvas, options = {}) {
 function turnWarps(mesh, b, fieldOf) {
   return [
     localWarp(
-      P3.AngleX,
+      P4.AngleX,
       mesh,
       b,
       X_STOPS,
       ([x, y], v, i) => v === 0 ? [0, 0] : [fieldOf(i)(x, y, v, 0)[0], 0]
     ),
     localWarp(
-      P3.AngleY,
+      P4.AngleY,
       mesh,
       b,
       Y_STOPS,
@@ -4725,7 +4895,7 @@ function buildPart(spec, b, order, frame, byRole, style, frontGrid) {
   }
   if (mesh !== void 0) part.mesh = mesh;
   const side = spec.role.endsWith("_L") ? "L" : "R";
-  const eyeOpen = side === "L" ? P3.EyeOpenLeft : P3.EyeOpenRight;
+  const eyeOpen = side === "L" ? P4.EyeOpenLeft : P4.EyeOpenRight;
   const hh = frame.hh;
   switch (spec.role) {
     case "face":
@@ -4734,7 +4904,7 @@ function buildPart(spec, b, order, frame, byRole, style, frontGrid) {
         warps.push(
           tiltHang(mesh, b, pivot, (_y, i) => isNeck[i] ? 1 : 0),
           localWarp(
-            P3.Breath,
+            P4.Breath,
             mesh,
             b,
             [0, 1],
@@ -4781,8 +4951,8 @@ function buildPart(spec, b, order, frame, byRole, style, frontGrid) {
       if (byRole.has("mouth_open")) {
         warps.push(mouthWiden(mesh, b));
         bindings.push(
-          { parameter: P3.MouthOpen, channel: "opacity", from: 1, to: 0 },
-          { parameter: P3.MouthOpen, channel: "opacity", from: 1, to: 0 }
+          { parameter: P4.MouthOpen, channel: "opacity", from: 1, to: 0 },
+          { parameter: P4.MouthOpen, channel: "opacity", from: 1, to: 0 }
         );
         extra = [(AMPLITUDE.mouthOpenWidth - 1) * (bw(b) / 2), 0];
       } else {
@@ -4792,19 +4962,19 @@ function buildPart(spec, b, order, frame, byRole, style, frontGrid) {
         );
         bindings.push(
           {
-            parameter: P3.MouthOpen,
+            parameter: P4.MouthOpen,
             channel: "scaleY",
             from: 0,
             to: roundTo(grow, 0.01)
           },
           {
-            parameter: P3.MouthOpen,
+            parameter: P4.MouthOpen,
             channel: "scaleX",
             from: 0,
             to: roundTo(AMPLITUDE.mouthOpenWidth - 1, 0.01)
           },
           {
-            parameter: P3.MouthOpen,
+            parameter: P4.MouthOpen,
             channel: "translateY",
             from: 0,
             to: -roundTo(grow * bh(b) / 2, 0.01)
@@ -4816,20 +4986,29 @@ function buildPart(spec, b, order, frame, byRole, style, frontGrid) {
     case "mouth_open":
       warps.push(mouthForm(mesh, b), mouthOpenGrow(mesh, b));
       bindings.push({
-        parameter: P3.MouthOpen,
+        parameter: P4.MouthOpen,
         channel: "opacity",
         from: 0,
         to: 1
       });
       extra = [(AMPLITUDE.mouthOpenWidth - 1) * (bw(b) / 2), 0];
       break;
+    case "blush_L":
+    case "blush_R":
+      bindings.push({
+        parameter: P4.Cheek,
+        channel: "opacity",
+        from: AMPLITUDE.blushRest,
+        to: 1
+      });
+      break;
     case "hair_front":
     case "hair_back":
       if (byRole.has("hair_front")) {
         const amp = style.sway * AMPLITUDE.sway * hh;
         warps.push(
-          hairSway(P3.HairSwayX, mesh, b, amp),
-          hairSway(P3.HairSwayZ, mesh, b, amp)
+          hairSway(P4.HairSwayX, mesh, b, amp),
+          hairSway(P4.HairSwayZ, mesh, b, amp)
         );
       }
       warps.push(tiltHang(mesh, b, pivot, hairHangWeight(frame.chinY, b.y0)));
@@ -4910,7 +5089,7 @@ function deformers(frame, grids, body) {
       pivot: { x: roundTo(cx(body), 0.01), y: roundTo(body.y1, 0.01) },
       bindings: [
         {
-          parameter: P3.Breath,
+          parameter: P4.Breath,
           channel: "translateY",
           from: 0,
           to: roundTo(AMPLITUDE.breathBody * frame.hh, 0.01)
@@ -4923,9 +5102,9 @@ function deformers(frame, grids, body) {
     pivot: { x: roundTo(frame.axisX, 0.01), y: roundTo(frame.chinY, 0.01) },
     bindings: [
       // AngleZ is clockwise-positive (Live2D's); a rotation is CCW-positive.
-      { parameter: P3.AngleZ, channel: "rotate", from: ROLL_DEG, to: -ROLL_DEG },
+      { parameter: P4.AngleZ, channel: "rotate", from: ROLL_DEG, to: -ROLL_DEG },
       {
-        parameter: P3.Breath,
+        parameter: P4.Breath,
         channel: "translateY",
         from: 0,
         to: roundTo(AMPLITUDE.breathHead * frame.hh, 0.01)
@@ -4943,8 +5122,8 @@ function deformers(frame, grids, body) {
         points: g.lattice.points
       },
       warp2d: {
-        parameter: P3.AngleX,
-        parameterY: P3.AngleY,
+        parameter: P4.AngleX,
+        parameterY: P4.AngleY,
         valuesX: X_STOPS,
         valuesY: Y_STOPS,
         keyforms2d: g.keyforms.map((offsets) => ({ offsets }))
@@ -4957,16 +5136,16 @@ function hairPhysics() {
   return [
     {
       id: "hairSway",
-      input: { parameter: P3.AngleX, weight: 1 },
-      output: { parameter: P3.HairSwayX, scale: 5 },
+      input: { parameter: P4.AngleX, weight: 1 },
+      output: { parameter: P4.HairSwayX, scale: 5 },
       mass: 1,
       stiffness: 30,
       damping: 3
     },
     {
       id: "hairTilt",
-      input: { parameter: P3.AngleZ, weight: 1 },
-      output: { parameter: P3.HairSwayZ, scale: 8 },
+      input: { parameter: P4.AngleZ, weight: 1 },
+      output: { parameter: P4.HairSwayZ, scale: 8 },
       mass: 1,
       stiffness: 25,
       damping: 2.5
@@ -4976,29 +5155,32 @@ function hairPhysics() {
 function declareParameters(roles) {
   const out = [];
   const add = (id, name, min, max, def) => out.push({ id, name, min, max, default: def });
-  add(P3.AngleX, "Head Angle", -30, 30, 0);
-  add(P3.AngleY, "Head Angle Y", -30, 30, 0);
-  add(P3.AngleZ, "Head Angle Z", -30, 30, 0);
-  add(P3.EyeOpenLeft, "Eye L", 0, 1, 1);
-  add(P3.EyeOpenRight, "Eye R", 0, 1, 1);
+  add(P4.AngleX, "Head Angle", -30, 30, 0);
+  add(P4.AngleY, "Head Angle Y", -30, 30, 0);
+  add(P4.AngleZ, "Head Angle Z", -30, 30, 0);
+  add(P4.EyeOpenLeft, "Eye L", 0, 1, 1);
+  add(P4.EyeOpenRight, "Eye R", 0, 1, 1);
   if ([...roles].some((r) => /^(iris|pupil|highlight)_/.test(r))) {
-    add(P3.EyeballX, "Gaze X", -1, 1, 0);
-    add(P3.EyeballY, "Gaze Y", -1, 1, 0);
+    add(P4.EyeballX, "Gaze X", -1, 1, 0);
+    add(P4.EyeballY, "Gaze Y", -1, 1, 0);
   }
-  add(P3.MouthOpen, "Mouth Open", 0, 1, 0);
-  add(P3.MouthForm, "Mouth Form", -1, 1, 0);
+  add(P4.MouthOpen, "Mouth Open", 0, 1, 0);
+  add(P4.MouthForm, "Mouth Form", -1, 1, 0);
   if (roles.has("brow_L")) {
-    add(P3.BrowLeftY, "Brow L Y", -1, 1, 0);
-    add(P3.BrowLeftAngle, "Brow L Angle", -1, 1, 0);
+    add(P4.BrowLeftY, "Brow L Y", -1, 1, 0);
+    add(P4.BrowLeftAngle, "Brow L Angle", -1, 1, 0);
   }
   if (roles.has("brow_R")) {
-    add(P3.BrowRightY, "Brow R Y", -1, 1, 0);
-    add(P3.BrowRightAngle, "Brow R Angle", -1, 1, 0);
+    add(P4.BrowRightY, "Brow R Y", -1, 1, 0);
+    add(P4.BrowRightAngle, "Brow R Angle", -1, 1, 0);
+  }
+  if (roles.has("blush_L") || roles.has("blush_R")) {
+    add(P4.Cheek, "Cheek", 0, 1, 0);
   }
-  add(P3.Breath, "Breath", 0, 1, 0);
+  add(P4.Breath, "Breath", 0, 1, 0);
   if (roles.has("hair_front")) {
-    add(P3.HairSwayX, "Hair Sway X", -SWAY_RANGE, SWAY_RANGE, 0);
-    add(P3.HairSwayZ, "Hair Sway Z", -SWAY_RANGE, SWAY_RANGE, 0);
+    add(P4.HairSwayX, "Hair Sway X", -SWAY_RANGE, SWAY_RANGE, 0);
+    add(P4.HairSwayZ, "Hair Sway Z", -SWAY_RANGE, SWAY_RANGE, 0);
   }
   return out;
 }