@ikijs/editor 0.20.0 → 0.21.0

package/README.md

@@ -57,7 +57,7 @@ leaves the document untouched.
 ## Auto-rig
 
 `generateIkiFromLayerSet` turns role-named layers (`face`, `eye_L`, `eye_R`,
-`mouth`, plus optional `iris_*`, `brow_*`, `lash_*`, `lash_lower_*`, `hair_front`, `hair_back`,
+and `mouth` — or the lip set `mouth_inner`, `lip_lower`, `lip_upper`, which folds open instead of crossfading — plus optional `iris_*`, `brow_*`, `lash_*`, `lash_lower_*`, `hair_front`, `hair_back`,
 `body`, `arm_*`, …) into a rigged model that blinks, gazes, opens its mouth, turns its head over
 a body warp that breathes, follows the head a little and turns on
 `ParamBodyAngleX/Y/Z`, and emotes with its brows — including a

package/dist/index.d.mts

@@ -714,14 +714,17 @@ interface LayerInput {
     /** Face only: half the opaque span of each crop row, canvas px (0 = none). */
     rowHalfWidths?: number[];
     /** `face` / `hair_front` / `hair_back` / `body` / `arm_L` / `arm_R` /
-     *  `forearm_pose_L` / `forearm_pose_R` only:
+     *  `forearm_pose_L` / `forearm_pose_R` /
+     *  `mouth_inner` / `lip_lower` / `lip_upper` only:
      *  per crop row, its opaque (alpha ≥ 128) runs as a flat list of canvas
      *  columns `[start0, end0, start1, end1, …]`, each end exclusive (`[]` for a
      *  row with none). The actual pixels, so a gap in the hair is a gap here:
      *  the turn and the nod read off it where back hair is painted behind the
      *  front hair, and the crown's turn reads the face's so it never bares skin.
      *  The body's place the hips (where it splits into legs), and an arm's place
-     *  its shoulder and elbow pivots, a pose forearm's its elbow-end pivot. */
+     *  its shoulder and elbow pivots, a pose forearm's its elbow-end pivot, and
+     *  a lip set's place the mouth's opening: the upper line's bottom, the
+     *  interior's span, the skin's top. */
     rowRuns?: number[][];
     /** Nose only: the tight box of its alpha ≥ 128 pixels, canvas px. */
     denseCore?: {
@@ -768,9 +771,11 @@ declare class TurnTargetError extends Error {
     constructor(message: string);
 }
 /**
- * Art geometry the rig cannot build on — today a body whose hips leave no row
- * line under its pivots, or too little room for its motion (`body.ts`). A fact about the layers, not a bug, so a
- * host reports it as an input error.
+ * Art geometry the rig cannot build on — a body whose hips leave no row line
+ * under its pivots, or too little room for its motion (`body.ts`), an arm
+ * without room for its pivots, a lip set whose interior has no opaque pixel
+ * (`mouth.ts`). A fact about the layers, not a bug, so a host reports it as an
+ * input error.
  */
 declare class LayerGeometryError extends Error {
     constructor(message: string);
@@ -993,8 +998,9 @@ declare function forearmPoseGeometry(layer: LayerInput): ForearmPoseGeometry;
 declare function partIdsOfRole(role: string): readonly string[];
 /**
  * Map file names to roles. Throws on an unknown role, a role named twice, a
- * required role (`face`, `eye_L`, `eye_R`, `mouth`) missing, an arm without a
- * body, or a pose forearm without its arm.
+ * required role (`face`, `eye_L`, `eye_R`) missing, no mouth (`mouth`, or the
+ * lip set) or a partial or mixed one, an arm without a body, or a pose forearm
+ * without its arm.
  */
 declare function parseLayerRoles(fileNames: string[]): {
     role: string;
@@ -1018,7 +1024,9 @@ declare function parseLayerRoles(fileNames: string[]): {
  * and two ears that lag. Blink, gaze, brows, mouth, breath and
  * hair sway are part warps and bindings under those. The model also declares
  * the default expressions and the Nod, Shake and Tilt motions, and
- * with a pose forearm the Wave (`animations.ts`).
+ * with a pose forearm the Wave (`animations.ts`). The mouth has two paths,
+ * chosen by the layers: `mouth` alone stretches, with `mouth_open` it
+ * crossfades; the lip set folds open like the eyelid (`mouth.ts`).
  */
 
 declare function generateIkiFromLayerSet(layers: LayerInput[], canvas: {
@@ -1158,8 +1166,8 @@ interface LayerSetMeasurer {
      * of it and of the per-role edges), this layer's per-row opaque extent and
      * the `LayerInput` it returns outlive the call, so the host may drop `rgba`
      * as soon as it returns. Returns the layer's `LayerInput` — its crop
-     * box, the face's `rowHalfWidths`, the face's, hair layers', body's, arms'
-     * and pose forearms' `rowRuns`, the nose's
+     * box, the face's `rowHalfWidths`, the face's, hair layers', body's, arms',
+     * pose forearms' and lip set's `rowRuns`, the nose's
      * `denseCore` unless that is a speck of its crop (`isSpeckCore`) — or
      * `null` for an empty layer, one with no pixel at or above
      * `ALPHA_BBOX_THRESHOLD`, which it records nothing for: the host reports

package/dist/index.d.ts

@@ -714,14 +714,17 @@ interface LayerInput {
     /** Face only: half the opaque span of each crop row, canvas px (0 = none). */
     rowHalfWidths?: number[];
     /** `face` / `hair_front` / `hair_back` / `body` / `arm_L` / `arm_R` /
-     *  `forearm_pose_L` / `forearm_pose_R` only:
+     *  `forearm_pose_L` / `forearm_pose_R` /
+     *  `mouth_inner` / `lip_lower` / `lip_upper` only:
      *  per crop row, its opaque (alpha ≥ 128) runs as a flat list of canvas
      *  columns `[start0, end0, start1, end1, …]`, each end exclusive (`[]` for a
      *  row with none). The actual pixels, so a gap in the hair is a gap here:
      *  the turn and the nod read off it where back hair is painted behind the
      *  front hair, and the crown's turn reads the face's so it never bares skin.
      *  The body's place the hips (where it splits into legs), and an arm's place
-     *  its shoulder and elbow pivots, a pose forearm's its elbow-end pivot. */
+     *  its shoulder and elbow pivots, a pose forearm's its elbow-end pivot, and
+     *  a lip set's place the mouth's opening: the upper line's bottom, the
+     *  interior's span, the skin's top. */
     rowRuns?: number[][];
     /** Nose only: the tight box of its alpha ≥ 128 pixels, canvas px. */
     denseCore?: {
@@ -768,9 +771,11 @@ declare class TurnTargetError extends Error {
     constructor(message: string);
 }
 /**
- * Art geometry the rig cannot build on — today a body whose hips leave no row
- * line under its pivots, or too little room for its motion (`body.ts`). A fact about the layers, not a bug, so a
- * host reports it as an input error.
+ * Art geometry the rig cannot build on — a body whose hips leave no row line
+ * under its pivots, or too little room for its motion (`body.ts`), an arm
+ * without room for its pivots, a lip set whose interior has no opaque pixel
+ * (`mouth.ts`). A fact about the layers, not a bug, so a host reports it as an
+ * input error.
  */
 declare class LayerGeometryError extends Error {
     constructor(message: string);
@@ -993,8 +998,9 @@ declare function forearmPoseGeometry(layer: LayerInput): ForearmPoseGeometry;
 declare function partIdsOfRole(role: string): readonly string[];
 /**
  * Map file names to roles. Throws on an unknown role, a role named twice, a
- * required role (`face`, `eye_L`, `eye_R`, `mouth`) missing, an arm without a
- * body, or a pose forearm without its arm.
+ * required role (`face`, `eye_L`, `eye_R`) missing, no mouth (`mouth`, or the
+ * lip set) or a partial or mixed one, an arm without a body, or a pose forearm
+ * without its arm.
  */
 declare function parseLayerRoles(fileNames: string[]): {
     role: string;
@@ -1018,7 +1024,9 @@ declare function parseLayerRoles(fileNames: string[]): {
  * and two ears that lag. Blink, gaze, brows, mouth, breath and
  * hair sway are part warps and bindings under those. The model also declares
  * the default expressions and the Nod, Shake and Tilt motions, and
- * with a pose forearm the Wave (`animations.ts`).
+ * with a pose forearm the Wave (`animations.ts`). The mouth has two paths,
+ * chosen by the layers: `mouth` alone stretches, with `mouth_open` it
+ * crossfades; the lip set folds open like the eyelid (`mouth.ts`).
  */
 
 declare function generateIkiFromLayerSet(layers: LayerInput[], canvas: {
@@ -1158,8 +1166,8 @@ interface LayerSetMeasurer {
      * of it and of the per-role edges), this layer's per-row opaque extent and
      * the `LayerInput` it returns outlive the call, so the host may drop `rgba`
      * as soon as it returns. Returns the layer's `LayerInput` — its crop
-     * box, the face's `rowHalfWidths`, the face's, hair layers', body's, arms'
-     * and pose forearms' `rowRuns`, the nose's
+     * box, the face's `rowHalfWidths`, the face's, hair layers', body's, arms',
+     * pose forearms' and lip set's `rowRuns`, the nose's
      * `denseCore` unless that is a speck of its crop (`isSpeckCore`) — or
      * `null` for an empty layer, one with no pixel at or above
      * `ALPHA_BBOX_THRESHOLD`, which it records nothing for: the host reports