@ikijs/editor 0.12.1 → 0.13.0

package/README.md

@@ -62,16 +62,17 @@ leaves the document untouched.
 a torso that breathes, and emotes with its brows — including a
 hair-sway physics rig when a `hair_front` layer is present.
 
-The rig reproduces a Live2D default rig, measured on the Cubism sample models
-(the numbers are in `auto-rig/profile.ts`): the turn reads through parallax,
-not a reshaped face. The face plate translates, changing its width by a few
-percent, the chin leading it; the features lead the plate by their own amounts
-(the nose most, then the brows, eyes and mouth), the eyes foreshortening mildly
+The rig turns the head by parallax, not a reshaped face, with values of our
+own picked by eye (`auto-rig/profile.ts`, `AUTO-RIG.md`). The face plate
+translates, the chin leading it; the features lead the plate by their depth
+(the nose most, then the eyes, brows and mouth), the eyes foreshortening mildly
 about their own centres; the front hair rides the face where it lies over it and holds the head's
-outline where it draws it, and the back hair stays behind; the neck and the
+outline where it draws it — though on its cap the turn never carries its outer
+edge further outside the back hair painted behind it than the nod alone does —
+and the back hair stays behind; the neck and the
 ears the face layer paints are cut off into islands of the plate's own mesh,
 drawn behind the head — the neck stays (only the chin's shade slides across
-it), the ears lag the face. AngleZ rolls the head 10° about the chin; the torso only
+it), the ears lag the face, the far one narrowing. AngleZ rolls the head 14° about the chin; the torso only
 breathes.
 
 On a layer set with a `nose`, `options.turnTargets` — the cues a 30° reference
@@ -80,7 +81,7 @@ whether the silhouette holds) — are **fitted** each by the one knob it reads:
 the turn's amount, the eyes' foreshortening, the hair's width, a feature's own
 shift. With none given the profile itself renders (`DEFAULT_TURN_TARGETS`
 expresses it in the cues' units). `options.style` tunes a character from the
-profile where the Live2D samples themselves disagree: the whole turn, the
+profile: the whole turn, the
 features' lead, the front hair's follow and its outline's, the blink and the
 hair sway. The turn
 is bounded by the art: the far eye stays inside the plate's outline and, given
@@ -95,9 +96,11 @@ how much it covers at rest, and whether the bound held.
 An `eyeShift` you passed that runs past the room the art leaves the far eye —
 the face plate's edge, or the bangs' strand — is **clamped** and the rig is
 built, since that room is a fact about these layers, not about the reference;
-so is the profile's own turn where the art has less room than it needs. Every
-other target you passed that this layer set cannot reach **throws**, naming the
-field and the range it could have had: a `farEyeRatio` or `silhouetteRatio`
+so is the profile's own turn where the art has less room than it needs, and
+a `silhouetteRatio` that would narrow a plate drawn without hair too far for
+its head to cover the far ear's slide (see AUTO-RIG.md). Every other target
+you passed that this layer set cannot reach **throws**, naming the field and
+the range it could have had: a `farEyeRatio` or `silhouetteRatio`
 out of the rig's reach, or a `noseShift` / `mouthShift` outside what that
 feature can reach. Pass `options.onTurnSolved` to see what the turn settled on
 and which targets were clamped.

package/dist/index.d.mts

@@ -657,32 +657,32 @@ interface AlphaBbox {
 declare function detectAlphaBbox(rgba: ArrayLike<number>, width: number, height: number): AlphaBbox | null;
 
 /**
- * Per-character tuning, starting from the profile: only the quantities the
- * Live2D samples themselves disagree on by more than their own median
- * (style, not construction). `turn`, `featureLead` and `sway` multiply the
- * profile (1 = as measured); `hairFollow`, `outlineFollow` and `blink`
- * replace its value.
+ * Per-character tuning, starting from the profile. `turn`, `featureLead` and
+ * `sway` multiply the profile (1 = the profile); `hairFollow`,
+ * `outlineFollow` and `blink` replace its value. `AUTO-RIG.md` lists the
+ * ranges that read well.
  */
 interface RigStyle {
-    /** The whole turn — plate, features and hair (the samples' face slides
-     *  0.05–0.25 hh). Ignored when a `turnTargets.eyeShift` is given, which
-     *  fits it instead. */
+    /** The whole turn — plate, features and hair. Ignored when a
+     *  `turnTargets.eyeShift` is given, which fits it instead. */
     turn?: number;
-    /** How far the features lead the plate (the nose leads it 2.2–4.4×). */
+    /** How far the features lead the plate. */
     featureLead?: number;
-    /** The front hair's share of the face's turn (the samples' 1.0–1.37;
-     *  profile 1.1). */
+    /** The front hair's share of the face's turn. */
     hairFollow?: number;
     /** Its outer edge's share, where the front hair draws the head's outline
      *  and no back hair paints behind that edge (profile 0: the outline holds;
      *  `hairFollow` rides it whole). Where back hair does, the edge rides
      *  further, as far as that back hair stays behind it through the turn and
      *  the nod, up to the front hair's follow there (`hairFollow`; over the
-     *  far eye's rows, as far as that eye's outer corner goes). */
+     *  far eye's rows, as far as that eye's outer corner goes). On the cap
+     *  (the rows above the eyes) the edge follows less where the turn would
+     *  otherwise carry it further outside its back hair than the nod alone
+     *  does. */
     outlineFollow?: number;
-    /** How far the upper lid comes down, over the eye's height (0.30–0.67). */
+    /** How far the upper lid comes down, over the eye's height. */
     blink?: number;
-    /** Hair sway amplitude (0.02–0.36 hh at the extremes). */
+    /** Hair sway amplitude. */
     sway?: number;
 }
 
@@ -762,12 +762,11 @@ declare class TurnTargetError extends Error {
     constructor(message: string);
 }
 /**
- * The Live2D profile's own turn (`profile.ts`), in the cues' units — what a
- * rig with no `turnTargets` renders on a head whose silhouette at the eye row
- * is back hair about 1 hh (eye row → chin) wide. eyeShift: the eye pair moves
- * 0.211 hh at ±30 and that silhouette's centre −0.009 hh, over a 1 hh head
- * half-width, 0.22. farEyeRatio: the far eye narrows to 0.85 and the near one
- * widens to 1.085, and the cue is their ratio, 0.78. silhouetteRatio: the
+ * The profile's own turn (`profile.ts`), in the cues' units — what a rig with
+ * no `turnTargets` renders on a head whose silhouette at the eye row is back
+ * hair about 1 hh (eye row → chin) wide. eyeShift: the eye pair's mean shift
+ * at ±30 less the back hair's drift, over a 1 hh head half-width.
+ * farEyeRatio: the far eye's width over the near one's. silhouetteRatio: the
  * silhouette holds its width.
  *
  * With no target given the rig renders the profile itself, whatever the cues
@@ -855,7 +854,7 @@ declare function parseLayerRoles(fileNames: string[]): {
 /**
  * `generateIkiFromLayerSet`: role layers in, a rigged `.iki` out.
  *
- * The rig's shape follows a Live2D default rig (`profile.ts`): a torso that
+ * The rig's shape is a 2D head rig's usual one (`profile.ts`): a torso that
  * only breathes; a head deformer that rolls about the chin and breathes; one
  * small warp grid per feature (each eye, each brow, the nose, the mouth),
  * translating and foreshortening it by its own lead over the plate; and the

package/dist/index.d.ts

@@ -657,32 +657,32 @@ interface AlphaBbox {
 declare function detectAlphaBbox(rgba: ArrayLike<number>, width: number, height: number): AlphaBbox | null;
 
 /**
- * Per-character tuning, starting from the profile: only the quantities the
- * Live2D samples themselves disagree on by more than their own median
- * (style, not construction). `turn`, `featureLead` and `sway` multiply the
- * profile (1 = as measured); `hairFollow`, `outlineFollow` and `blink`
- * replace its value.
+ * Per-character tuning, starting from the profile. `turn`, `featureLead` and
+ * `sway` multiply the profile (1 = the profile); `hairFollow`,
+ * `outlineFollow` and `blink` replace its value. `AUTO-RIG.md` lists the
+ * ranges that read well.
  */
 interface RigStyle {
-    /** The whole turn — plate, features and hair (the samples' face slides
-     *  0.05–0.25 hh). Ignored when a `turnTargets.eyeShift` is given, which
-     *  fits it instead. */
+    /** The whole turn — plate, features and hair. Ignored when a
+     *  `turnTargets.eyeShift` is given, which fits it instead. */
     turn?: number;
-    /** How far the features lead the plate (the nose leads it 2.2–4.4×). */
+    /** How far the features lead the plate. */
     featureLead?: number;
-    /** The front hair's share of the face's turn (the samples' 1.0–1.37;
-     *  profile 1.1). */
+    /** The front hair's share of the face's turn. */
     hairFollow?: number;
     /** Its outer edge's share, where the front hair draws the head's outline
      *  and no back hair paints behind that edge (profile 0: the outline holds;
      *  `hairFollow` rides it whole). Where back hair does, the edge rides
      *  further, as far as that back hair stays behind it through the turn and
      *  the nod, up to the front hair's follow there (`hairFollow`; over the
-     *  far eye's rows, as far as that eye's outer corner goes). */
+     *  far eye's rows, as far as that eye's outer corner goes). On the cap
+     *  (the rows above the eyes) the edge follows less where the turn would
+     *  otherwise carry it further outside its back hair than the nod alone
+     *  does. */
     outlineFollow?: number;
-    /** How far the upper lid comes down, over the eye's height (0.30–0.67). */
+    /** How far the upper lid comes down, over the eye's height. */
     blink?: number;
-    /** Hair sway amplitude (0.02–0.36 hh at the extremes). */
+    /** Hair sway amplitude. */
     sway?: number;
 }
 
@@ -762,12 +762,11 @@ declare class TurnTargetError extends Error {
     constructor(message: string);
 }
 /**
- * The Live2D profile's own turn (`profile.ts`), in the cues' units — what a
- * rig with no `turnTargets` renders on a head whose silhouette at the eye row
- * is back hair about 1 hh (eye row → chin) wide. eyeShift: the eye pair moves
- * 0.211 hh at ±30 and that silhouette's centre −0.009 hh, over a 1 hh head
- * half-width, 0.22. farEyeRatio: the far eye narrows to 0.85 and the near one
- * widens to 1.085, and the cue is their ratio, 0.78. silhouetteRatio: the
+ * The profile's own turn (`profile.ts`), in the cues' units — what a rig with
+ * no `turnTargets` renders on a head whose silhouette at the eye row is back
+ * hair about 1 hh (eye row → chin) wide. eyeShift: the eye pair's mean shift
+ * at ±30 less the back hair's drift, over a 1 hh head half-width.
+ * farEyeRatio: the far eye's width over the near one's. silhouetteRatio: the
  * silhouette holds its width.
  *
  * With no target given the rig renders the profile itself, whatever the cues
@@ -855,7 +854,7 @@ declare function parseLayerRoles(fileNames: string[]): {
 /**
  * `generateIkiFromLayerSet`: role layers in, a rigged `.iki` out.
  *
- * The rig's shape follows a Live2D default rig (`profile.ts`): a torso that
+ * The rig's shape is a 2D head rig's usual one (`profile.ts`): a torso that
  * only breathes; a head deformer that rolls about the chin and breathes; one
  * small warp grid per feature (each eye, each brow, the nose, the mouth),
  * translating and foreshortening it by its own lead over the plate; and the