@ikijs/editor 0.31.0 → 0.32.0

package/dist/index.mjs

@@ -1023,6 +1023,14 @@ var DeletePart = class {
         `parts."${this.partId}": cannot delete \u2014 used as a clip mask by part "${masker.id}"; remove its clip first`
       );
     }
+    const occluded = parts.find(
+      (p) => p.id !== this.partId && p.occlusion?.by.includes(this.partId)
+    );
+    if (occluded) {
+      throw new Error(
+        `parts."${this.partId}": cannot delete \u2014 used as an occluder by part "${occluded.id}"; remove its occlusion first`
+      );
+    }
     const i = parts.indexOf(part);
     if (!this.captured) {
       this.removed = structuredClone(part);
@@ -1227,6 +1235,14 @@ var SetPartMesh = class {
           `parts."${this.partId}": cannot remove mesh \u2014 used as a clip mask by part "${masker.id}" (masks require a mesh); remove its clip first`
         );
       }
+      const occluded = doc.getModel().parts.find(
+        (p) => p.id !== this.partId && p.occlusion?.by.includes(this.partId)
+      );
+      if (occluded) {
+        throw new IkiFormatError(
+          `parts."${this.partId}": cannot remove mesh \u2014 used as an occluder by part "${occluded.id}" (occluders require a mesh); remove its occlusion first`
+        );
+      }
     } else {
       if ((part.warps?.length ?? 0) > 0) {
         throw new IkiFormatError(
@@ -1306,6 +1322,14 @@ function validatePhysicsCandidate(doc, candidatePhysics) {
     }
     throw e;
   }
+  for (const rig of candidatePhysics) {
+    const part = doc.getModel().parts.find((p) => p.occlusion?.parameter === rig.output.parameter);
+    if (part !== void 0) {
+      throw new IkiFormatError(
+        `physics."${rig.id}".output.parameter "${rig.output.parameter}" keys parts."${part.id}".occlusion; an occlusion amount cannot be keyed on a physics output`
+      );
+    }
+  }
 }
 var AddPhysicsRig = class {
   label = "Add physics rig";
@@ -7058,7 +7082,18 @@ function span2(name, v) {
 }
 
 // src/auto-rig/custom-parts.ts
-var KEYS = ["id", "layer", "anchor", "tie", "after", "deformer", "rigid"];
+var KEYS = [
+  "id",
+  "layer",
+  "anchor",
+  "tie",
+  "after",
+  "deformer",
+  "rigid",
+  "occlusion"
+];
+var OCCLUSION_KEYS = ["by", "parameter", "stops"];
+var STOP_KEYS = ["value", "amount"];
 var LAYER_KEYS = ["fileName", "bbox"];
 var finite4 = (v) => typeof v === "number" && Number.isFinite(v);
 var isObject3 = (v) => typeof v === "object" && v !== null && !Array.isArray(v);
@@ -7066,7 +7101,7 @@ var inside = (b, [x, y]) => x >= b.x && x < b.x + b.w && y >= b.y && y < b.y + b
 var RESERVED = new Set(
   ROLE_TABLE.flatMap((r) => [r.role, ...partIdsOfRole(r.role)])
 );
-function checkCustomParts(customParts, byRole, canvas) {
+function checkCustomParts(customParts, byRole, canvas, parameters, physicsOutputs) {
   if (!Array.isArray(customParts)) {
     throw new CustomPartError(
       `customParts must be an array, got ${customParts === null ? "null" : typeof customParts}`
@@ -7089,7 +7124,7 @@ function checkCustomParts(customParts, byRole, canvas) {
       throw new CustomPartError(`${at} must be a plain object`);
     }
     checkedKeys(at, entry, KEYS, CustomPartError);
-    const { id, layer, anchor, tie, after, deformer, rigid } = entry;
+    const { id, layer, anchor, tie, after, deformer, rigid, occlusion } = entry;
     if (typeof id !== "string" || !/^[A-Za-z_][A-Za-z0-9_]*$/.test(id)) {
       throw new CustomPartError(
         `${at}.id must be a plain identifier (letters, digits, underscore; not starting with a digit), got ${JSON.stringify(id)}`
@@ -7140,9 +7175,84 @@ function checkCustomParts(customParts, byRole, canvas) {
         `${at}.rigid must be true or false, got ${JSON.stringify(rigid)}`
       );
     }
+    if (occlusion !== void 0) {
+      checkOcclusion(
+        `${at}.occlusion`,
+        occlusion,
+        present,
+        parameters,
+        physicsOutputs
+      );
+    }
   });
   return customParts;
 }
+function checkOcclusion(at, occlusion, present, parameters, physicsOutputs) {
+  if (!isObject3(occlusion)) {
+    throw new CustomPartError(`${at} must be a plain object`);
+  }
+  checkedKeys(at, occlusion, OCCLUSION_KEYS, CustomPartError);
+  const { by, parameter, stops } = occlusion;
+  if (!Array.isArray(by) || by.length === 0) {
+    throw new CustomPartError(
+      `${at}.by must be a non-empty array of roles of the set, one of ${present.join(", ")}`
+    );
+  }
+  by.forEach((role, j) => {
+    if (typeof role !== "string" || !present.includes(role)) {
+      throw new CustomPartError(
+        `${at}.by[${j}] must be a role of the set, one of ${present.join(", ")}; got ${JSON.stringify(role)}`
+      );
+    }
+    if (by.indexOf(role) !== j) {
+      throw new CustomPartError(
+        `${at}.by[${j}] "${role}" repeats an earlier role`
+      );
+    }
+  });
+  const descriptor = parameters.find((p) => p.id === parameter);
+  if (typeof parameter !== "string" || descriptor === void 0) {
+    throw new CustomPartError(
+      `${at}.parameter must be a parameter the rig declares, got ${JSON.stringify(parameter)}`
+    );
+  }
+  if (physicsOutputs.has(parameter)) {
+    throw new CustomPartError(
+      `${at}.parameter "${parameter}" is a physics output; an occlusion amount cannot be keyed on one`
+    );
+  }
+  if (!Array.isArray(stops) || stops.length === 0) {
+    throw new CustomPartError(`${at}.stops must be a non-empty array`);
+  }
+  const { min, max } = descriptor;
+  let previous = -Infinity;
+  stops.forEach((stop, k) => {
+    const s = `${at}.stops[${k}]`;
+    if (!isObject3(stop))
+      throw new CustomPartError(`${s} must be a plain object`);
+    checkedKeys(s, stop, STOP_KEYS, CustomPartError);
+    const { value, amount } = stop;
+    if (!finite4(value)) {
+      throw new CustomPartError(
+        `${s}.value must be a finite number, got ${JSON.stringify(value)}`
+      );
+    }
+    if (value < min || value > max) {
+      throw new CustomPartError(
+        `${s}.value ${value} is outside parameter "${parameter}" range [${min},${max}]`
+      );
+    }
+    if (value <= previous) {
+      throw new CustomPartError(`${s}.value must be strictly ascending`);
+    }
+    previous = value;
+    if (!finite4(amount) || amount < 0 || amount > 1) {
+      throw new CustomPartError(
+        `${s}.amount must be a number in 0..1, got ${JSON.stringify(amount)}`
+      );
+    }
+  });
+}
 var CELL_PX2 = 20;
 function buildCustomParts(customParts, canvas) {
   return customParts.map(({ id, layer }) => {
@@ -7162,6 +7272,32 @@ function buildCustomParts(customParts, canvas) {
     };
   });
 }
+function writeOcclusion(customParts, built, parts) {
+  const byId = new Map(parts.map((p) => [p.id, p]));
+  customParts.forEach((entry, i) => {
+    if (entry.occlusion === void 0) return;
+    const { by, parameter, stops } = entry.occlusion;
+    const ids = [];
+    by.forEach((role, j) => {
+      for (const id of partIdsOfRole(role)) {
+        const part = byId.get(id);
+        if (part === void 0) continue;
+        const fault = part.clip !== void 0 ? { is: "is clipped", kind: "a clipped part" } : part.mesh === void 0 ? { is: "has no mesh", kind: "a part without a mesh" } : void 0;
+        if (fault !== void 0) {
+          throw new CustomPartError(
+            `customParts[${i}].occlusion.by[${j}] "${role}" yields part "${id}", which ${fault.is}; ${fault.kind} cannot occlude`
+          );
+        }
+        ids.push(id);
+      }
+    });
+    built[i].occlusion = {
+      by: ids,
+      parameter,
+      stops: stops.map((s) => ({ value: s.value, amount: s.amount }))
+    };
+  });
+}
 
 // src/auto-rig/generate.ts
 var MESH_CELLS = {
@@ -7204,8 +7340,15 @@ function generateIkiFromLayerSet(layers, canvas, options = {}) {
   const hasNose = has("nose");
   const plateHalf = byRole.get("face").cropW / 2;
   checkHeadEdges(options.headEdges, byRole);
-  const entries = options.customParts !== void 0 && !(Array.isArray(options.customParts) && options.customParts.length === 0) ? checkCustomParts(options.customParts, byRole, canvas) : [];
+  const physics = has("hair_front") ? hairPhysics(has("hair_back")) : void 0;
   const parameters = declareParameters(new Set(byRole.keys()));
+  const entries = options.customParts !== void 0 && !(Array.isArray(options.customParts) && options.customParts.length === 0) ? checkCustomParts(
+    options.customParts,
+    byRole,
+    canvas,
+    parameters,
+    new Set((physics ?? []).map((r) => r.output.parameter))
+  ) : [];
   const bakes = options.bakes === void 0 ? void 0 : parseBakes(options.bakes, entries, parameters);
   checkStrandEdges(
     options.strandEdges,
@@ -7386,6 +7529,7 @@ function generateIkiFromLayerSet(layers, canvas, options = {}) {
     parts.forEach((p, i) => {
       p.order = i;
     });
+    writeOcclusion(entries, built, parts);
     if (bakes !== void 0) {
       bakeReports = applyBakes(bakes, built, entries, {
         canvas,
@@ -7402,7 +7546,7 @@ function generateIkiFromLayerSet(layers, canvas, options = {}) {
     parameters,
     parts,
     deformers: deformerList,
-    ...has("hair_front") ? { physics: hairPhysics(has("hair_back")) } : {},
+    ...physics !== void 0 ? { physics } : {},
     expressions: defaultExpressions(new Set(parameters.map((p) => p.id))),
     motions: defaultMotions(new Set(parameters.map((p) => p.id)))
   };