C++ guide and API reference#

All declarations live in the isaacsim::foundation::prims::physics namespace.

#include <isaacsim/foundation/prims/physics/Articulation.hpp>
#include <isaacsim/foundation/prims/physics/ColliderBody.hpp>
#include <isaacsim/foundation/prims/physics/GroundPlane.hpp>
#include <isaacsim/foundation/prims/physics/RigidBody.hpp>

using namespace isaacsim::foundation::prims::physics;

Articulation#

Articulation extends Xform and wraps prims that carry the PhysicsArticulationRootAPI. Structural metadata (DOF/joint/link names, counts, paths, and types) is parsed once at construction and cached:

Articulation robot("/World/Robot");

// Inspect structure
int   dofs  = robot.numDofs();
auto  names = robot.dofNames();

// Drive gains and targets
robot.setDofGains(/*stiffnesses=*/Array{800.f}, /*dampings=*/Array{40.f});
robot.setDofPositionTargets(Array{0.f, 1.57f, 0.f});

ColliderBody#

ColliderBody extends Xform and applies the PhysicsCollisionAPI. The collision mesh approximation can be set at construction or updated later:

ColliderBody mesh("/World/Mesh", /*approximations=*/"convexHull");
mesh.setCollisionApproximations("convexDecomposition");
auto [contactOffsets, restOffsets] = mesh.getOffsets();

GroundPlane#

GroundPlane extends Xform and wraps a composite prim made of a Plane (collision) and a Mesh (rendering) child. It creates the prims if they do not exist, or wraps them if they do:

GroundPlane ground("/World/GroundPlane", /*sizes=*/Array{100.f});
ground.setOffsets(/*contactOffsets=*/Array{0.02f});
ground.setEnabledCollisions(Array{true});

RigidBody#

RigidBody extends Xform and applies the PhysicsRigidBodyAPI and PhysicsMassAPI schemas to one or more prims. Optional constructor parameters set initial mass, density, and transform in one call:

RigidBody box("/World/Box", /*masses=*/Array{1.5f});
box.setVelocities(/*linear=*/Array{{0.f, 0.f, 1.f}});
auto [linear, angular] = box.getVelocities();

API reference#

Fully qualified namespace: isaacsim::foundation::prims

namespace prims#

Namespaces Summary#