@deepblend/dsh-blender-provider-local 0.2.14 → 0.2.16

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepblend/dsh-blender-provider-local",
-  "version": "0.2.14",
+  "version": "0.2.16",
   "type": "module",
   "description": "Local Blender Provider: the BlenderRuntime Service over ctx.subprocess (batch execution).",
   "main": "lib/index.js",
@@ -11,7 +11,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@deepblend/dsh-blender-contracts": "0.2.14"
+    "@deepblend/dsh-blender-contracts": "0.2.16"
   },
   "license": "MIT",
   "repository": {

package/python/bootstrap.py

@@ -230,6 +230,17 @@ def action_compile_scene(request, options):
         # THE RIGS THIS SCENE DECLARES, with their bones. A count alone would say an armature exists;
         # a rig is only useful if the bones are the ones the spec named, so the names travel with it and
         # a test can read them back rather than trust the count.
+        # WHICH ENTITIES ARE SKINNED, AND TO WHAT. The vertex groups are the evidence that weights
+        # exist at all: an entity bound to an armature with no groups renders as a static object while
+        # the file says it is rigged, and the reading is where that difference becomes visible.
+        "skinned": [
+            {
+                "entityId": entity_id,
+                "armatureId": entry["armatureId"],
+                "vertexGroups": entry["vertexGroups"],
+            }
+            for entity_id, entry in sorted((report.get("skinned") or {}).items())
+        ],
         "armatures": [
             {
                 "id": armature_id,

package/python/deepblend_scene.py

@@ -1030,6 +1030,82 @@ def _apply_interpolation(action, data_path, axis, keyframes, track, guard):
         )
 
 
+def _insert_keyframes(target, bpy_attr, axis, keyframes):
+    """Insert one component's keyframes on a target that has `keyframe_insert`.
+
+    EXTRACTED RATHER THAN COPIED: an object and a pose bone are keyframed by the same three lines, and
+    a second copy is the one that would miss the next fix — the identity-first rule below is exactly the
+    kind of thing that gets learned once and applied in one place.
+    """
+    for keyframe in keyframes:
+        frame = int(keyframe["frame"])
+        value = float(keyframe["value"])
+        setattr(target, bpy_attr, _with_component(getattr(target, bpy_attr), axis, value))
+        target.keyframe_insert(data_path=bpy_attr, index=axis, frame=frame)
+
+
+def build_bone_animation(armature_obj, track, guard):
+    """Animate ONE pose bone of an armature.
+
+    WHY A BONE IS NOT AN OBJECT: the values live on the ARMATURE's pose, so the keyframes are inserted
+    through the pose bone while the action belongs to the armature. Everything else — the property
+    vocabulary, the two-keyframe minimum, the interpolation — is the same, which is why the insertion
+    itself is shared rather than re-implemented.
+
+    The bone is named by the track; a name the armature does not have is refused, because a track that
+    silently animates nothing is a scene that claims to move and does not.
+    """
+    bone_name = track.get("boneName")
+    if not isinstance(bone_name, str) or bone_name == "":
+        raise ActionError(
+            "SCENE_VALIDATION_FAILED",
+            'animation track "%s" targets a bone but names none' % (track.get("id"),),
+        )
+    pose_bone = armature_obj.pose.bones.get(bone_name)
+    if pose_bone is None:
+        raise ActionError(
+            "SCENE_VALIDATION_FAILED",
+            'animation track "%s" targets bone "%s", which armature "%s" does not have'
+            % (track.get("id"), bone_name, armature_obj.get("deepblend_id")),
+        )
+
+    property_name = track.get("property", "")
+    if "." not in property_name:
+        raise ActionError(
+            "SCENE_VALIDATION_FAILED",
+            'animation track "%s" names property "%s" without a component' % (track.get("id"), property_name),
+        )
+    attr, _, component = property_name.rpartition(".")
+    bpy_attr = TRACK_PROPERTY_ATTR.get(attr)
+    if bpy_attr is None or component not in ("x", "y", "z"):
+        raise ActionError(
+            "SCENE_VALIDATION_FAILED",
+            'animation track "%s" names unsupported property "%s"' % (track.get("id"), property_name),
+            {"supported": sorted("%s.%s" % (name, axis) for name in TRACK_PROPERTY_ATTR for axis in "xyz")},
+        )
+
+    keyframes = track.get("keyframes") or []
+    if len(keyframes) < 2:
+        raise ActionError(
+            "SCENE_VALIDATION_FAILED",
+            'animation track "%s" has %d keyframe(s); at least 2 are required to describe motion'
+            % (track.get("id"), len(keyframes)),
+        )
+
+    axis = "xyz".index(component)
+    pose_bone.rotation_mode = "XYZ"
+    _insert_keyframes(pose_bone, bpy_attr, axis, keyframes)
+
+    action = armature_obj.animation_data.action if armature_obj.animation_data is not None else None
+    if action is None:
+        raise ActionError(
+            "BLENDER_SCRIPT_ERROR",
+            'animation track "%s" inserted keyframes but produced no action' % (track.get("id"),),
+        )
+    _apply_interpolation(action, bpy_attr, axis, keyframes, track, guard)
+    return action
+
+
 def build_animation(obj, track, guard):
     """Key one animation track onto an object, returning the action name.
 
@@ -1072,11 +1148,7 @@ def build_animation(obj, track, guard):
     # values, or the first insert would capture a value from a different property.
     obj.rotation_mode = "XYZ"
 
-    for keyframe in keyframes:
-        frame = int(keyframe["frame"])
-        value = float(keyframe["value"])
-        setattr(obj, bpy_attr, _with_component(getattr(obj, bpy_attr), axis, value))
-        obj.keyframe_insert(data_path=bpy_attr, index=axis, frame=frame)
+    _insert_keyframes(obj, bpy_attr, axis, keyframes)
 
     action = obj.animation_data.action if obj.animation_data is not None else None
     if action is None:
@@ -1375,6 +1447,45 @@ def build_armature(entry, guard):
     return obj
 
 
+def skin_entity(obj, armature_obj, armature_id, guard):
+    """Bind a mesh to an armature with Blender's own automatic weights.
+
+    WHY AUTOMATIC WEIGHTS RATHER THAN A WEIGHT TABLE. A per-vertex weight table in the SceneSpec would
+    be a second, hand-written copy of something Blender already computes from the geometry — and the
+    copy would be the one that goes stale, because nothing regenerates it when a generator's parameters
+    change. What the spec states is the RELATIONSHIP ("this entity is skinned to that armature"); the
+    weights are Blender's answer to it.
+
+    Bone heat can fail on a degenerate mesh (Blender reports "failed to find solution for one or more
+    bones"), and that is a WARNING rather than a refusal: the binding still exists and the bones that
+    did solve still deform, so the honest outcome is a scene that mostly works with the failure named.
+    """
+    for target in bpy.context.selected_objects:
+        target.select_set(False)
+    obj.select_set(True)
+    bpy.context.view_layer.objects.active = armature_obj
+    try:
+        bpy.ops.object.parent_set(type="ARMATURE_AUTO")
+    except Exception as exc:
+        guard.warnings.append({
+            "code": "SKIN_WEIGHTS_FAILED",
+            "message": 'entity "%s" could not be skinned to armature "%s": %s'
+            % (obj.get("deepblend_id"), armature_id, error_text(exc)),
+        })
+        return False
+    finally:
+        obj.select_set(False)
+
+    if len(obj.vertex_groups) == 0:
+        guard.warnings.append({
+            "code": "SKIN_WEIGHTS_EMPTY",
+            "message": 'entity "%s" is bound to armature "%s" but Blender produced no vertex groups, so '
+                       "it will not deform" % (obj.get("deepblend_id"), armature_id),
+        })
+        return False
+    return True
+
+
 def build_scene(spec, options, guard):
     """Compile a SceneSpec into a live Blender scene.
 
@@ -1521,6 +1632,10 @@ def build_scene(spec, options, guard):
             target = cameras.get(target_id)
         elif kind == "material":
             target = materials.get(target_id)
+        elif kind == "bone":
+            # A BONE TRACK TARGETS THE ARMATURE, because the bones belong to it: the armature id is
+            # what resolves, and `boneName` picks the bone inside it.
+            target = armature_objects.get(target_id)
         else:
             target = entity_objects.get(target_id)
         if target is None:
@@ -1531,9 +1646,23 @@ def build_scene(spec, options, guard):
             )
         if kind == "material":
             action = build_material_animation(target, track, guard)
+        elif kind == "bone":
+            action = build_bone_animation(target, track, guard)
         else:
             action = build_animation(target, track, guard)
-        actions.append({"id": track.get("id"), "targetKind": kind, "targetEntityId": target_id, "action": action.name})
+        actions.append({
+            "id": track.get("id"),
+            "targetKind": kind,
+            "targetEntityId": target_id,
+            "action": action.name,
+            **({"boneName": track.get("boneName")} if kind == "bone" else {}),
+            # WHAT THE ACTION ACTUALLY DROVE, read off its own fcurves. MEASURED, and a surviving
+            # mutation is why: keying the ARMATURE OBJECT instead of the pose bone still moves the mesh
+            # — the mesh is parented to the armature, so the two frames differ either way — and the
+            # two-frame proof passed. The data paths are the difference: `pose.bones["chest"]…` is the
+            # bone, `rotation_euler` on the object is not.
+            "dataPaths": sorted({curve.data_path for curve in action_fcurves(action)}),
+        })
 
     report_progress("configure_render", 85)
     render_config = configure_scene(scene, spec, profile, guard)
@@ -1550,6 +1679,25 @@ def build_scene(spec, options, guard):
     bpy.context.view_layer.update()
 
     report_progress("compile_done", 90)
+    # SKINNING LAST: it needs both the mesh and the rig, and doing it before either exists would mean
+    # ordering the compile around a step that is about the RELATIONSHIP between them.
+    report_progress("skin_entities", 60)
+    skinned_entities = {}
+    for entity in spec.get("entities") or []:
+        armature_id = entity.get("armatureId")
+        if armature_id is None:
+            continue
+        obj = entity_objects.get(entity["id"])
+        armature_obj = armature_objects.get(armature_id)
+        if obj is None or armature_obj is None:
+            raise ActionError(
+                "SCENE_SPEC_INVALID",
+                'entity "%s" is skinned to armature "%s", which the same SceneSpec does not declare'
+                % (entity["id"], armature_id),
+            )
+        skin_entity(obj, armature_obj, armature_id, guard)
+        skinned_entities[entity["id"]] = entity
+
     return {
         "objects": describe_objects(),
         "actions": actions,
@@ -1560,6 +1708,16 @@ def build_scene(spec, options, guard):
         "profileName": profile_name,
         "entityObjectNames": {key: value.name for key, value in entity_objects.items()},
         "armatureNames": {key: value.name for key, value in armature_objects.items()},
+        "skinned": {
+            key: {
+                "armatureId": entry["armatureId"],
+                # THE GROUPS COME FROM THE OBJECT, not from the spec entry: what the file asked for is
+                # the relationship, and what Blender produced is the weights. Reading the latter back is
+                # the whole point — an entity bound with no groups renders as a static object.
+                "vertexGroups": sorted(group.name for group in entity_objects[key].vertex_groups),
+            }
+            for key, entry in skinned_entities.items()
+        },
         "cameraNames": {key: value.name for key, value in cameras.items()},
     }