List saved models.

Return a model's stored spec (JSON) plus a measurement summary.

Parameters and defaults for the kits (hand, face), strokes (clay, crease, flatten) and plans.

Create a model or replace its whole spec. Missing keys get defaults. Returns a summary.

Apply a batch of edits atomically. Ops: {"op":"set","kind":"joints|bones|blobs|kits|strokes","name":n,"value":{...}} merge fields, creates if new; a null field removes it {"op":"delete","kind":...,"name":n} {"op":"rename","kind":...,"name":n,"to":m} joint/bone renames update references {"op":"move","joints":[names],"delta":[dx,dy,dz]} shift a group of joints (e.g. a whole leg) {"op":"scale_r","joints":[names],"factor":f} thicken/thin at those joints {"op":"global","value":{"blend":0.04}} Edit only ".L" and centre elements; ".R" follows automatically.

Build the mesh and return a clay contact sheet. views: any of front, side, top, three_quarter (default set), back, left, three_quarter_back, below. All panels share one scale; front/side/top get rulers in world units (grid=True adds grid lines). focus=[x,y,z] + zoom>1 for close-ups (e.g. the face). resolution = voxels across the longest axis (160 is quick; 256-320 for detail). In a close-up, resolution counts across the region around the focus instead, so small features (lids, lips, fingers) get proportionally finer voxels; parts outside that region are left out. strokes=True draws every stroke's path on the views (orange clay, blue crease, green flatten, named at their start; hidden parts left out): check placement before judging form. shading: "clay" (soft studio matcap), "raking" (one low light from the left: shows shallow forms, planes and dents the clay hides), "curvature" (warm = convex, cool = concave, grey = flat, stronger = tighter: an evenly tinted area is blobby; crisp forms show as bright lines).

Cross-section sizes as numbers, from the exact field (independent of build resolution). along = a bone name or a list of bones (a chain, e.g. a tail or leg): planes perpendicular to each bone at samples evenly spaced t, giving the distance from the axis to the surface on each side (w-/w+ along the bone's width axis, h-/h+ along its height axis; compare with joint radii) and the connected section area. Use it to find pinches, bulges and lumps along a limb. along = "x" | "y" | "z": planes across that world axis (optionally only between lo and hi), listing every separate part in each slice with its ranges on the other two axes, e.g. "y" gives body width and height from nose to tail, "z" shows where the legs merge into the body.

Attach a reference image for view "front", "side" or "top". The silhouette comes from the alpha channel if present, else from difference against the corner background colour (threshold). Our side view shows the creature facing LEFT; set flip=True if the reference faces right. Returns the extracted mask so you can check it.

Compare model silhouettes to the references. Per view: IoU, a diff image (grey = match, red = model has extra, blue = model is missing) and band tables of edge errors in world units, which tell you which joint/blob to move and by how much. fit: "auto" searches the reference scale/offset for best overlap, so only shape differences remain (absolute size is ignored); "height"/"width" instead match that dimension, bottom-aligned. against: "refs" (set_reference images), "plan" (the model's plan, placed exactly: no rescaling), or "auto" (the plan if there is one).

Auto-fit the model to its reference silhouettes and save the result as a new version. Moves joints, joint/bone radii, blob offsets and blob sizes (params: any of "pos", "r", "offset", "size") to minimise the distance between model and reference outlines. Only what the given views can see changes: a side-only fit leaves X alone. Details (subtract ops, layer>=1 blobs) stay fixed unless named in only; only/lock take joint, bone and blob names. max_step caps any move per iteration (m); stiffness is a spring toward the starting values (higher = more conservative). Block out the body plan by hand first: fitting is local and can't fix a missing or misplaced limb. against: "refs", "plan" (fit the blockout onto the plan's outlines, placed exactly; joints tied to plan landmarks keep their planned height) or "auto" (the plan if there is one). Returns the diff images, IoU before/after and every change; revert undoes it.

Set (or replace) a model's plan: the 2D blockout you model against. Creates the model if it doesn't exist. Returns the plan drawn with rulers, so you can check proportions before modelling anything. plan = {"views": {"front"|"side"|"top": {"shapes": {name: shape}}}, "landmarks": {name: {"z", "joint"?}}, "sections": {name: {"z", "near": [x, y], "width", "depth"}}} shape = {"ellipse": [cu, cv, ru, rv], "rot"?} | {"capsule": [u0, v0, u1, v1], "r": r | [r0, r1]} | {"poly": [[u, v], ...], "smooth"?: true}, plus "op": "subtract" to cut out. u, v are the view's world axes (front X,Z; side Y,Z with the creature facing -Y; top X,Y); ".L" shapes mirror in front/top. kit_reference has the details.

Check the model against its plan: per view, the plan against the model's silhouette (grey = both, blue = plan only: the model is missing it, red = the model sticks out); IoU and edge-error bands in world units (placed exactly, no rescaling); landmark joints vs their planned heights; planned sections vs measured width and depth. Run it after every stage.

List saved versions of a model.

Restore an earlier version (saved as a new version, so nothing is lost).

Build at the given resolution and write an OBJ (Z up, metres). Import it into Blender with bpy.ops.wm.obj_import(filepath=..., forward_axis='Y', up_axis='Z').