@ikijs/editor 0.17.0 → 0.18.0

package/README.md

@@ -40,19 +40,19 @@ leaves the document untouched.
 
 ## API
 
-| Area               | Exports                                                                                                                                                                             |
-| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| Document           | `EditorDocument`, `EditCommand`                                                                                                                                                     |
-| Part edits         | `AddPart`, `DeletePart`, `SetPartColor`, `SetPartWidth`, `SetPartHeight`, `SetPartOrder`, `SetPartTransform`, `SetPartBindings`, `SetPartMesh`, `SetPartDeformer`                   |
-| Deformer edits     | `AddDeformer`, `DeleteDeformer`, `SetDeformerParent`, `SetDeformerTransform`, `SetDeformerBindings`, `SetDeformerPivot` (+ `X`/`Y`), `CaptureGridKeyform`                           |
-| Physics edits      | `AddPhysicsRig`, `SetPhysicsRig`, `DeletePhysicsRig`                                                                                                                                |
-| Referential guards | `validateDeformerReparent`, `validateDeformerDelete`, `validatePartAttach`                                                                                                          |
-| Atlas              | `packAtlas`, `uvRectFor`, `ATLAS_PADDING`, `UV_INSET_PX`                                                                                                                            |
-| Grid keyforms      | `computeGridOffsets`, `interpolateGridOffsets`, `upsertGridKeyform`                                                                                                                 |
-| Factories          | `createDefaultPart`, `createDefaultMatrixDeformer`, `createDefaultWarpDeformer`, `createGridMesh`                                                                                   |
-| Pixels             | `detectAlphaBbox`, `ALPHA_BBOX_THRESHOLD`, `AlphaBbox`, `ALPHA_OPAQUE`, `HEAD_BAND`, `SPECK_CORE_FRACTION`, `denseCoreOf`, `isSpeckCore`, `foregroundSpan`, `headHalfOf`            |
-| Auto-rig           | `generateIkiFromLayerSet`, `parseLayerRoles`, `partIdsOfRole`, `createLayerSetMeasurer`, `TurnTargets`, `DEFAULT_TURN_TARGETS`, `TurnSolveReport`, `RigStyle`, `LayerGeometryError` |
-| Bindings           | `captureBindingEndpoint`                                                                                                                                                            |
+| Area               | Exports                                                                                                                                                                                                           |
+| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Document           | `EditorDocument`, `EditCommand`                                                                                                                                                                                   |
+| Part edits         | `AddPart`, `DeletePart`, `SetPartColor`, `SetPartWidth`, `SetPartHeight`, `SetPartOrder`, `SetPartTransform`, `SetPartBindings`, `SetPartMesh`, `SetPartDeformer`                                                 |
+| Deformer edits     | `AddDeformer`, `DeleteDeformer`, `SetDeformerParent`, `SetDeformerTransform`, `SetDeformerBindings`, `SetDeformerPivot` (+ `X`/`Y`), `CaptureGridKeyform`                                                         |
+| Physics edits      | `AddPhysicsRig`, `SetPhysicsRig`, `DeletePhysicsRig`                                                                                                                                                              |
+| Referential guards | `validateDeformerReparent`, `validateDeformerDelete`, `validatePartAttach`                                                                                                                                        |
+| Atlas              | `packAtlas`, `uvRectFor`, `ATLAS_PADDING`, `UV_INSET_PX`                                                                                                                                                          |
+| Grid keyforms      | `computeGridOffsets`, `interpolateGridOffsets`, `upsertGridKeyform`                                                                                                                                               |
+| Factories          | `createDefaultPart`, `createDefaultMatrixDeformer`, `createDefaultWarpDeformer`, `createGridMesh`                                                                                                                 |
+| Pixels             | `detectAlphaBbox`, `ALPHA_BBOX_THRESHOLD`, `AlphaBbox`, `ALPHA_OPAQUE`, `HEAD_BAND`, `SPECK_CORE_FRACTION`, `denseCoreOf`, `isSpeckCore`, `foregroundSpan`, `headHalfOf`                                          |
+| Auto-rig           | `generateIkiFromLayerSet`, `parseLayerRoles`, `partIdsOfRole`, `createLayerSetMeasurer`, `armGeometry`, `ArmGeometry`, `TurnTargets`, `DEFAULT_TURN_TARGETS`, `TurnSolveReport`, `RigStyle`, `LayerGeometryError` |
+| Bindings           | `captureBindingEndpoint`                                                                                                                                                                                          |
 
 ## Auto-rig
 

package/dist/index.d.mts

@@ -855,6 +855,69 @@ interface GenerateOptions {
     };
 }
 
+/**
+ * The arms. Each `arm_L` / `arm_R` layer is one drawing of the whole arm,
+ * hanging, its shoulder at the top. It becomes two parts on two nested matrix
+ * deformers hung from the body warp:
+ * - the upper arm (the role's own id) on `armDeformer_X`, which turns about
+ *   the shoulder, the deltoid cap's centre;
+ * - the forearm (`forearm_X`) on `forearmDeformer_X`, a child of the arm's,
+ *   which turns about the elbow.
+ * The shoulder pivot rides an all-weight-1 cell of the body warp (`body.ts`),
+ * so the arm breathes and turns with the chest rigidly, never sheared.
+ *
+ * Both parts are cut from the one crop: they share its box, transform and
+ * texture rect, and their meshes meet on the seam, the elbow pivot's row. The
+ * upper arm is the band above the seam. The forearm is the band below it plus
+ * a half-disc fan above it, centred on the elbow pivot. Iki has no glue
+ * between meshes, and two bands hinged at a seam open a wedge as wide as the
+ * arm on a bend; the half-disc turns about its own centre, so it rotates into
+ * itself and keeps the joint covered at any bend.
+ *
+ * Draw order: hair_back < body < arm_L, forearm_L, arm_R, forearm_R < face …
+ * < hair_front. The forearm draws over the upper arm, so its cap hides the
+ * seam.
+ *
+ * Signs: ParamArmX + raises the arm outward on either side and ParamElbowX +
+ * turns the forearm the same way, both in degrees 1:1. A rotation is
+ * CCW-positive, so an arm whose shoulder lies right of the body's axis (+x,
+ * the character's left) turns CCW for +, and one at −x turns CW.
+ */
+
+type Point = {
+    x: number;
+    y: number;
+};
+interface ArmGeometry {
+    /** The shoulder pivot, model space: the deltoid cap's centre. */
+    shoulder: Point;
+    /** r_u: the upper arm's half-width under the cap, px. */
+    shoulderRadius: number;
+    /** The elbow pivot, model space. Its y is the seam the two meshes meet on. */
+    elbow: Point;
+    /** The forearm's half-disc radius, px. */
+    capRadius: number;
+    /** +1 for a shoulder right of the body's axis (+ turns CCW), −1 left of it
+     *  (+ turns CW). */
+    side: 1 | -1;
+}
+/**
+ * The arm's pivots, read off the widest opaque run of each crop row
+ * (`rowRuns`); a row without one, or a layer without runs, reads as the
+ * crop:
+ * - r_u is half the median width over the `CAP_ROWS` rows;
+ * - the shoulder pivot lies r_u under the first painted row's centre, at the
+ *   run centre of the row it lands in;
+ * - the elbow is the centre of the row `ELBOW_AT` of the way from there to
+ *   the last painted row, at its run centre;
+ * - the cap radius is half the elbow's run + 1 px, kept inside the crop.
+ * Pivots are on the 0.01 grid, as the written model is. `bodyAxisX` is the
+ * body's axis, model x: the shoulder's side of it sets the sign. An arm too
+ * short for its width to put the elbow under the shoulder would rig
+ * inverted, so it throws `LayerGeometryError`.
+ */
+declare function armGeometry(layer: LayerInput, bodyAxisX: number): ArmGeometry;
+
 /** The part ids a `role`'s layer becomes, back to front: every one of them
  *  takes its texture from the layer's crop. Throws on an unknown role. */
 declare function partIdsOfRole(role: string): readonly string[];
@@ -1281,4 +1344,4 @@ declare function createGridMesh(cols: number, rows: number): IkiMesh;
  */
 declare function createDefaultWarpDeformer(model: IkiModel): IkiWarpDeformer;
 
-export { ALPHA_BBOX_THRESHOLD, ALPHA_OPAQUE, ATLAS_PADDING, AddDeformer, AddPart, AddPhysicsRig, type AlphaBbox, type ApplyAtlasInput, type AtlasAssignment, type AtlasLayout, type AtlasPlacement, type AtlasSource, CaptureGridKeyform, DEFAULT_TURN_TARGETS, type DeformerTransformChannel, DeleteDeformer, DeletePart, DeletePhysicsRig, type EditCommand, type EditTransformChannel, EditorDocument, HEAD_BAND, type IrisStrand, LayerGeometryError, type LayerInput, type LayerSetMeasurement, type LayerSetMeasurer, type RgbaLayer, type RigStyle, SPECK_CORE_FRACTION, SetDeformerBindings, SetDeformerParent, SetDeformerPivot, SetDeformerPivotX, SetDeformerPivotY, SetDeformerTransform, SetPartBindings, SetPartColor, SetPartDeformer, SetPartHeight, SetPartMesh, SetPartOrder, SetPartTransform, SetPartWidth, SetPhysicsRig, type StrandOverlap, type TurnDepths, type TurnSolveReport, TurnTargetError, type TurnTargets, UV_INSET_PX, captureBindingEndpoint, computeGridOffsets, createDefaultMatrixDeformer, createDefaultPart, createDefaultWarpDeformer, createGridMesh, createLayerSetMeasurer, denseCoreOf, detectAlphaBbox, foregroundSpan, generateIkiFromLayerSet, headHalfOf, interpolateGridOffsets, isSpeckCore, packAtlas, parseLayerRoles, partIdsOfRole, upsertGridKeyform, uvRectFor, validateDeformerDelete, validateDeformerReparent, validatePartAttach };
+export { ALPHA_BBOX_THRESHOLD, ALPHA_OPAQUE, ATLAS_PADDING, AddDeformer, AddPart, AddPhysicsRig, type AlphaBbox, type ApplyAtlasInput, type ArmGeometry, type AtlasAssignment, type AtlasLayout, type AtlasPlacement, type AtlasSource, CaptureGridKeyform, DEFAULT_TURN_TARGETS, type DeformerTransformChannel, DeleteDeformer, DeletePart, DeletePhysicsRig, type EditCommand, type EditTransformChannel, EditorDocument, HEAD_BAND, type IrisStrand, LayerGeometryError, type LayerInput, type LayerSetMeasurement, type LayerSetMeasurer, type RgbaLayer, type RigStyle, SPECK_CORE_FRACTION, SetDeformerBindings, SetDeformerParent, SetDeformerPivot, SetDeformerPivotX, SetDeformerPivotY, SetDeformerTransform, SetPartBindings, SetPartColor, SetPartDeformer, SetPartHeight, SetPartMesh, SetPartOrder, SetPartTransform, SetPartWidth, SetPhysicsRig, type StrandOverlap, type TurnDepths, type TurnSolveReport, TurnTargetError, type TurnTargets, UV_INSET_PX, armGeometry, captureBindingEndpoint, computeGridOffsets, createDefaultMatrixDeformer, createDefaultPart, createDefaultWarpDeformer, createGridMesh, createLayerSetMeasurer, denseCoreOf, detectAlphaBbox, foregroundSpan, generateIkiFromLayerSet, headHalfOf, interpolateGridOffsets, isSpeckCore, packAtlas, parseLayerRoles, partIdsOfRole, upsertGridKeyform, uvRectFor, validateDeformerDelete, validateDeformerReparent, validatePartAttach };

package/dist/index.d.ts

@@ -855,6 +855,69 @@ interface GenerateOptions {
     };
 }
 
+/**
+ * The arms. Each `arm_L` / `arm_R` layer is one drawing of the whole arm,
+ * hanging, its shoulder at the top. It becomes two parts on two nested matrix
+ * deformers hung from the body warp:
+ * - the upper arm (the role's own id) on `armDeformer_X`, which turns about
+ *   the shoulder, the deltoid cap's centre;
+ * - the forearm (`forearm_X`) on `forearmDeformer_X`, a child of the arm's,
+ *   which turns about the elbow.
+ * The shoulder pivot rides an all-weight-1 cell of the body warp (`body.ts`),
+ * so the arm breathes and turns with the chest rigidly, never sheared.
+ *
+ * Both parts are cut from the one crop: they share its box, transform and
+ * texture rect, and their meshes meet on the seam, the elbow pivot's row. The
+ * upper arm is the band above the seam. The forearm is the band below it plus
+ * a half-disc fan above it, centred on the elbow pivot. Iki has no glue
+ * between meshes, and two bands hinged at a seam open a wedge as wide as the
+ * arm on a bend; the half-disc turns about its own centre, so it rotates into
+ * itself and keeps the joint covered at any bend.
+ *
+ * Draw order: hair_back < body < arm_L, forearm_L, arm_R, forearm_R < face …
+ * < hair_front. The forearm draws over the upper arm, so its cap hides the
+ * seam.
+ *
+ * Signs: ParamArmX + raises the arm outward on either side and ParamElbowX +
+ * turns the forearm the same way, both in degrees 1:1. A rotation is
+ * CCW-positive, so an arm whose shoulder lies right of the body's axis (+x,
+ * the character's left) turns CCW for +, and one at −x turns CW.
+ */
+
+type Point = {
+    x: number;
+    y: number;
+};
+interface ArmGeometry {
+    /** The shoulder pivot, model space: the deltoid cap's centre. */
+    shoulder: Point;
+    /** r_u: the upper arm's half-width under the cap, px. */
+    shoulderRadius: number;
+    /** The elbow pivot, model space. Its y is the seam the two meshes meet on. */
+    elbow: Point;
+    /** The forearm's half-disc radius, px. */
+    capRadius: number;
+    /** +1 for a shoulder right of the body's axis (+ turns CCW), −1 left of it
+     *  (+ turns CW). */
+    side: 1 | -1;
+}
+/**
+ * The arm's pivots, read off the widest opaque run of each crop row
+ * (`rowRuns`); a row without one, or a layer without runs, reads as the
+ * crop:
+ * - r_u is half the median width over the `CAP_ROWS` rows;
+ * - the shoulder pivot lies r_u under the first painted row's centre, at the
+ *   run centre of the row it lands in;
+ * - the elbow is the centre of the row `ELBOW_AT` of the way from there to
+ *   the last painted row, at its run centre;
+ * - the cap radius is half the elbow's run + 1 px, kept inside the crop.
+ * Pivots are on the 0.01 grid, as the written model is. `bodyAxisX` is the
+ * body's axis, model x: the shoulder's side of it sets the sign. An arm too
+ * short for its width to put the elbow under the shoulder would rig
+ * inverted, so it throws `LayerGeometryError`.
+ */
+declare function armGeometry(layer: LayerInput, bodyAxisX: number): ArmGeometry;
+
 /** The part ids a `role`'s layer becomes, back to front: every one of them
  *  takes its texture from the layer's crop. Throws on an unknown role. */
 declare function partIdsOfRole(role: string): readonly string[];
@@ -1281,4 +1344,4 @@ declare function createGridMesh(cols: number, rows: number): IkiMesh;
  */
 declare function createDefaultWarpDeformer(model: IkiModel): IkiWarpDeformer;
 
-export { ALPHA_BBOX_THRESHOLD, ALPHA_OPAQUE, ATLAS_PADDING, AddDeformer, AddPart, AddPhysicsRig, type AlphaBbox, type ApplyAtlasInput, type AtlasAssignment, type AtlasLayout, type AtlasPlacement, type AtlasSource, CaptureGridKeyform, DEFAULT_TURN_TARGETS, type DeformerTransformChannel, DeleteDeformer, DeletePart, DeletePhysicsRig, type EditCommand, type EditTransformChannel, EditorDocument, HEAD_BAND, type IrisStrand, LayerGeometryError, type LayerInput, type LayerSetMeasurement, type LayerSetMeasurer, type RgbaLayer, type RigStyle, SPECK_CORE_FRACTION, SetDeformerBindings, SetDeformerParent, SetDeformerPivot, SetDeformerPivotX, SetDeformerPivotY, SetDeformerTransform, SetPartBindings, SetPartColor, SetPartDeformer, SetPartHeight, SetPartMesh, SetPartOrder, SetPartTransform, SetPartWidth, SetPhysicsRig, type StrandOverlap, type TurnDepths, type TurnSolveReport, TurnTargetError, type TurnTargets, UV_INSET_PX, captureBindingEndpoint, computeGridOffsets, createDefaultMatrixDeformer, createDefaultPart, createDefaultWarpDeformer, createGridMesh, createLayerSetMeasurer, denseCoreOf, detectAlphaBbox, foregroundSpan, generateIkiFromLayerSet, headHalfOf, interpolateGridOffsets, isSpeckCore, packAtlas, parseLayerRoles, partIdsOfRole, upsertGridKeyform, uvRectFor, validateDeformerDelete, validateDeformerReparent, validatePartAttach };
+export { ALPHA_BBOX_THRESHOLD, ALPHA_OPAQUE, ATLAS_PADDING, AddDeformer, AddPart, AddPhysicsRig, type AlphaBbox, type ApplyAtlasInput, type ArmGeometry, type AtlasAssignment, type AtlasLayout, type AtlasPlacement, type AtlasSource, CaptureGridKeyform, DEFAULT_TURN_TARGETS, type DeformerTransformChannel, DeleteDeformer, DeletePart, DeletePhysicsRig, type EditCommand, type EditTransformChannel, EditorDocument, HEAD_BAND, type IrisStrand, LayerGeometryError, type LayerInput, type LayerSetMeasurement, type LayerSetMeasurer, type RgbaLayer, type RigStyle, SPECK_CORE_FRACTION, SetDeformerBindings, SetDeformerParent, SetDeformerPivot, SetDeformerPivotX, SetDeformerPivotY, SetDeformerTransform, SetPartBindings, SetPartColor, SetPartDeformer, SetPartHeight, SetPartMesh, SetPartOrder, SetPartTransform, SetPartWidth, SetPhysicsRig, type StrandOverlap, type TurnDepths, type TurnSolveReport, TurnTargetError, type TurnTargets, UV_INSET_PX, armGeometry, captureBindingEndpoint, computeGridOffsets, createDefaultMatrixDeformer, createDefaultPart, createDefaultWarpDeformer, createGridMesh, createLayerSetMeasurer, denseCoreOf, detectAlphaBbox, foregroundSpan, generateIkiFromLayerSet, headHalfOf, interpolateGridOffsets, isSpeckCore, packAtlas, parseLayerRoles, partIdsOfRole, upsertGridKeyform, uvRectFor, validateDeformerDelete, validateDeformerReparent, validatePartAttach };