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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@deepblend/dsh-blender-provider-local",
-  "version": "0.2.16",
+  "version": "0.2.18",
   "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.16"
+    "@deepblend/dsh-blender-contracts": "0.2.18"
   },
   "license": "MIT",
   "repository": {

package/python/bootstrap.py

@@ -233,6 +233,13 @@ def action_compile_scene(request, options):
         # 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.
+        # WHAT THE PHYSICS DID, per entity. Not the settings: a body that is configured and never
+        # enabled looks exactly like one that fell, and only a reading of where it ended up tells them
+        # apart.
+        "simulation": [
+            {"entityId": entity_id, **entry}
+            for entity_id, entry in sorted((report.get("simulation") or {}).items())
+        ],
         "skinned": [
             {
                 "entityId": entity_id,

package/python/deepblend_scene.py

@@ -1486,6 +1486,200 @@ def skin_entity(obj, armature_obj, armature_id, guard):
     return True
 
 
+def build_rigid_bodies(spec, entity_objects, guard, cloth_entities=None):
+    """Give the entities their physics, and BAKE the result into the checkpoint.
+
+    WHY THE COMPILE BAKES: a rigid body that has not been baked is a SETTING, not a motion — Blender
+    evaluates it on the fly in the viewport and a batch render of an unbaked simulation renders the
+    initial pose. Baking here is what makes the checkpoint mean "this is what the simulation did", and
+    it is why `simulation.bake: false` exists for a build that only wants the setup.
+
+    Returns a reading of what the physics DID, not of what it was told: each active body's height at the
+    first and the last frame of the scene's range. MEASURED, and the lesson from the animation slice is
+    why this is not just "the setup exists": a body that is configured correctly and never enabled looks
+    exactly like one that fell, unless something reads where it ended up.
+    """
+    cloth_entities = cloth_entities or {}
+    settings = spec.get("simulation") or {}
+    scene = bpy.context.scene
+    if "gravity" in settings:
+        scene.gravity[2] = -abs(float(settings["gravity"]))
+
+    # THE PHYSICS WORLD HAS TO EXIST BEFORE A BODY CAN BE ATTACHED TO IT. MEASURED: without this line
+    # `obj.rigid_body` is None and the assignment fails with an AttributeError — Blender's rigid-body
+    # settings live on a scene-level world, and a scene that has never had one has nowhere to put them.
+    if scene.rigidbody_world is None:
+        bpy.ops.rigidbody.world_add()
+    # AND THE WORLD NEEDS A COLLECTION, which a fresh one does not have. MEASURED, in three steps that
+    # each looked like it should work: without the world there is nowhere to put a body; with the world
+    # but no collection, `world.collection` is None; and only an object LINKED INTO that collection
+    # gets its `rigid_body` materialised. The Blender UI does all three when a user clicks "Rigid Body".
+    if scene.rigidbody_world.collection is None:
+        collection = bpy.data.collections.new("DeepBlendRigidBodies")
+        scene.collection.children.link(collection)
+        scene.rigidbody_world.collection = collection
+
+    bodies = {}
+    for entity in spec.get("entities") or []:
+        entry = entity.get("rigidBody")
+        if entry is None:
+            continue
+        obj = entity_objects.get(entity["id"])
+        if obj is None:
+            raise ActionError(
+                "SCENE_SPEC_INVALID",
+                'entity "%s" declares a rigid body but has no object to attach it to' % (entity["id"],),
+            )
+        # JOINING THE PHYSICS COLLECTION IS WHAT CREATES `obj.rigid_body`. MEASURED, twice: adding the
+        # world is not enough — Blender materialises the rigid-body settings when the object is linked
+        # into the world's own collection, so an object that has "a rigid body" the obvious way is an
+        # object with `None`.
+        if obj.name not in scene.rigidbody_world.collection.objects:
+            scene.rigidbody_world.collection.objects.link(obj)
+
+        obj.rigid_body.type = "ACTIVE" if entry["kind"] == "active" else "PASSIVE"
+        if entry.get("mass") is not None:
+            obj.rigid_body.mass = float(entry["mass"])
+        if entry.get("friction") is not None:
+            obj.rigid_body.friction = float(entry["friction"])
+        bodies[entity["id"]] = entry
+
+    if not bodies and not cloth_entities:
+        return {}
+
+    # A SCENE WITH CLOTH AND NO RIGID BODIES STILL HAS CACHES TO BAKE. MEASURED: the first version
+    # returned early when there were no bodies, and a cloth-only scene reported an empty reading — the
+    # bake and the whole reading sat behind a condition that had nothing to do with cloth.
+    _ = bodies
+
+    # THE GROUND BODIES DO NOT MOVE, so they need the physics world to have something to collide against
+    # and Blender needs to be told the world exists at all.
+    scene.use_gravity = True
+
+    # THE CLOTH MODIFIERS ARE CREATED BEFORE THE BAKE, which is the whole reason they are built here
+    # rather than in `build_scene`. MEASURED, and the comment above this loop said so before the code
+    # did: created after it, the bake had nothing to walk and the reading saw an object with no
+    # modifiers — a fabric that never moved, reported as a simulation that did nothing.
+    for entity_id, entry in cloth_entities.items():
+        build_cloth(entry, entity_objects[entity_id], guard)
+
+    reading = {}
+    first_frame = int((spec.get("project") or {}).get("frameStart", 1))
+    last_frame = int((spec.get("project") or {}).get("frameEnd", first_frame))
+    if settings.get("bake", True):
+        scene.frame_set(first_frame)
+        # `bake_all` walks every cache in the scene, which is what a compile wants: the caller asked for
+        # a checkpoint that shows the simulation, not for one cache to be fresh.
+        try:
+            bpy.ops.ptcache.bake_all(bake=True)
+        except Exception as exc:
+            guard.warnings.append({
+                "code": "SIMULATION_BAKE_FAILED",
+                "message": "the simulation could not be baked: %s" % (error_text(exc),),
+            })
+
+    for entity_id in cloth_entities:
+        # INTO THE SAME READING as the rigid bodies: one report of what the physics did, whatever the
+        # mechanism, because a caller asking "what happened in this scene" should not have to know which
+        # kind of simulation each entity used.
+        reading[entity_id] = {"kind": "cloth", **cloth_reading(entity_objects[entity_id], first_frame, last_frame)}
+
+    for entity_id in bodies:
+        obj = entity_objects[entity_id]
+        scene.frame_set(first_frame)
+        bpy.context.view_layer.update()
+        first = float((obj.matrix_world.translation)[2])
+        scene.frame_set(last_frame)
+        bpy.context.view_layer.update()
+        last = float((obj.matrix_world.translation)[2])
+        reading[entity_id] = {
+            "kind": bodies[entity_id]["kind"],
+            "firstFrameZ": round(first, 6),
+            "lastFrameZ": round(last, 6),
+            "droppedZ": round(first - last, 6),
+        }
+    scene.frame_set(first_frame)
+    bpy.context.view_layer.update()
+    return reading
+
+
+def build_cloth(entry, obj, guard):
+    """Hang a mesh as fabric, and report where its lowest point ended up.
+
+    WHY THE PIN GROUP IS BUILT FROM GEOMETRY: Blender pins cloth through a vertex group, and a
+    SceneSpec that named one would be referring to something no generator creates. What the spec says
+    is the RELATIONSHIP ("hang this from its top edge"); the group is the compiler's answer to it.
+
+    MEASURED, AND IT DIFFERS FROM RIGID BODIES: cloth is evaluated LIVE, so it drapes with or without a
+    bake — but the BAKED result differs from the unbaked one, because cloth integrates frame by frame
+    and a bake walks every frame while a jump to the last one does not. That is why nothing here claims
+    "no bake means no motion": for cloth that claim would be false, and a false assertion is worse than
+    none.
+    """
+    settings = entry or {}
+    pin_top = settings.get("pinTop", True)
+    group_name = None
+    if pin_top:
+        ys = [vertex.co.y for vertex in obj.data.vertices]
+        if ys:
+            top = max(ys)
+            pinned = [vertex.index for vertex in obj.data.vertices if abs(vertex.co.y - top) < 1e-4]
+            group = obj.vertex_groups.new(name="DeepBlendClothPin")
+            group.add(pinned, 1.0, "REPLACE")
+            group_name = group.name
+
+    # CLOTH NEEDS GEOMETRY TO BEND, AND THE PRODUCT'S PRIMITIVES ARE LOW-POLY. MEASURED: a cube has eight
+    # vertices, so a cloth modifier on one has nothing to drape with — the reading came back with the
+    # fabric exactly where it started, and it looked like a broken simulation rather than a mesh with no
+    # interior. A SIMPLE subdivision keeps the shape and gives the solver something to work with; the
+    # reading reports the vertex count so the subdivision is visible rather than assumed.
+    subdivision = obj.modifiers.new(name="DeepBlendClothSubdivision", type="SUBSURF")
+    subdivision.subdivision_type = "SIMPLE"
+    subdivision.levels = int(settings.get("subdivisions", 3))
+    subdivision.render_levels = subdivision.levels
+
+    modifier = obj.modifiers.new(name="DeepBlendCloth", type="CLOTH")
+    cloth_settings = modifier.settings
+    if group_name is not None:
+        cloth_settings.vertex_group_mass = group_name
+    if settings.get("mass") is not None:
+        cloth_settings.mass = float(settings["mass"])
+    if settings.get("stiffness") is not None:
+        cloth_settings.tension_stiffness = float(settings["stiffness"]) * 15.0
+    return obj
+
+
+def cloth_reading(obj, first_frame, last_frame):
+    """The lowest and the highest simulated vertex, at each end of the range.
+
+    Read off the EVALUATED mesh rather than the modifier: what the fabric did is the geometry, and the
+    modifier only says what was asked for. The highest point is the pinned edge, which is how the
+    reading says "it draped FROM somewhere" rather than merely "it moved".
+    """
+    scene = bpy.context.scene
+    reading = {}
+    depsgraph = bpy.context.evaluated_depsgraph_get()
+    for label, frame in (("firstFrame", first_frame), ("lastFrame", last_frame)):
+        scene.frame_set(frame)
+        bpy.context.view_layer.update()
+        depsgraph = bpy.context.evaluated_depsgraph_get()
+        evaluated = obj.evaluated_get(depsgraph)
+        mesh = evaluated.to_mesh()
+        heights = [(obj.matrix_world @ vertex.co).z for vertex in mesh.vertices]
+        evaluated.to_mesh_clear()
+        if heights:
+            reading[label + "LowestZ"] = round(min(heights), 6)
+            reading[label + "HighestZ"] = round(max(heights), 6)
+            # THE VERTEX COUNT IS PART OF THE READING, not a diagnostic: cloth needs geometry to bend and
+            # the product's primitives are low-poly, so the compiler subdivides — and a reading that says
+            # how many vertices the fabric had is how "it draped" can be told apart from "it had nothing
+            # to drape with".
+            reading[label + "Vertices"] = len(heights)
+    if "firstFrameLowestZ" in reading and "lastFrameLowestZ" in reading:
+        reading["droppedZ"] = round(reading["firstFrameLowestZ"] - reading["lastFrameLowestZ"], 6)
+    return reading
+
+
 def build_scene(spec, options, guard):
     """Compile a SceneSpec into a live Blender scene.
 
@@ -1664,6 +1858,22 @@ def build_scene(spec, options, guard):
             "dataPaths": sorted({curve.data_path for curve in action_fcurves(action)}),
         })
 
+    # CLOTH ENTRIES ARE RESOLVED HERE, and the modifiers are created inside the simulation step so that
+    # everything the bake has to walk is in place before it runs.
+    report_progress("build_simulation", 70)
+    cloth_entities = {}
+    for entity in spec.get("entities") or []:
+        entry = entity.get("cloth")
+        if entry is None:
+            continue
+        if entity_objects.get(entity["id"]) is None:
+            raise ActionError(
+                "SCENE_SPEC_INVALID",
+                'entity "%s" declares cloth but has no object to hang it on' % (entity["id"],),
+            )
+        cloth_entities[entity["id"]] = entry
+    simulation_reading = build_rigid_bodies(spec, entity_objects, guard, cloth_entities)
+
     report_progress("configure_render", 85)
     render_config = configure_scene(scene, spec, profile, guard)
 
@@ -1708,6 +1918,7 @@ 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()},
+        "simulation": simulation_reading,
         "skinned": {
             key: {
                 "armatureId": entry["armatureId"],