set_physics_properties
Set a USD prim's PhysX simulation properties—mass, density, friction, restitution, and collision—while leaving omitted values unchanged.
Instructions
Set a prim's mass or density, friction or restitution, or make it a collider or turn its collision off, for PhysX; a value left out stays as it is.
collision=true makes a static collider, such as a floor something should land on, with no rigid body and no physics material: only a Cube, Sphere, Capsule, Cylinder, Cone, Mesh or Plane collides, so an Xform is refused, its error naming the shapes under it. A Mesh that moves with a rigid body, its own or an ancestor's, not kinematic, gets a convexHull approximation unless one is set, as PhysX can't simulate a triangle mesh there. collision=false turns physics:collisionEnabled off and keeps the API. Mass or density goes through MassAPI and makes the prim a rigid body (RigidBodyAPI) if it isn't one, so a static collider starts to fall when the simulation plays. Friction or restitution adds the Collision API if missing, and sets them on the prim's own physics material, a child named PhysMat (/World/Cube/PhysMat for /World/Cube), bound to the prim for physics only; delete_prim removes it with the prim. That material starts from the body's own: the physics material bound to it before, else the physics scene's default, else PhysX's (friction 0.5, restitution 0), so the one left out, and anything else the replaced material held, stays. A copy made with clone_prim takes its own with it. A clone that inherits from its source, as Isaac Sim's cloner makes them, follows the source's material until a call on the clone, and the answer names the prims a call changes so. An instance or an inactive prim can hold no material of its own, so friction or restitution on one is refused, as collision is on an inactive prim or one inside an instance. A prim on an older extension's shared /World/PhysicsMaterials/_PhysMat moves to its own, and the call that moves the last prim off it deletes it. A call with friction or restitution reads the whole stage, about 1 s per 100,000 prims. The answer gives each value set, collision on or off, the material and the APIs applied, the rigid body a collider moves with, and whether the older shared material was deleted or kept, and why. For the prim's look, use set_material; to make a new prim physical in one call, create_prim with enable_physics.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"prim_path": "<prim_path>"
},
"name": "set_physics_properties"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| mass | No | Mass in kg (applies MassAPI); 0 unsets it, so density decides | |
| density | No | Density in kg/m^3 (applies MassAPI); 0 unsets it; a mass set wins over it | |
| friction | No | Friction coefficient, set as both static and dynamic friction | |
| collision | No | true makes the prim a collider (the Collision API), with no rigid body, such as a floor; false turns its collision off and keeps the API | |
| prim_path | Yes | Full USD path of the prim, e.g. "/World/Robot" | |
| restitution | No | Bounciness: 0 no bounce, 1 full bounce |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |