C++ guide and API reference#

Link against isaacsim::physics-ovsim. Headers are split across three namespaces matching their include paths.

Authoring#

#include <isaacsim/physics/ovsim/control/authoring/Authoring.hpp>

Namespace: isaacsim::physics::ovsim::control::authoring

Stage lifecycle#

bool created = createStage();
bool opened  = openStage("/path/to/scene.usd");
bool saved   = saveStage("/path/to/output.usd");
std::string usdString = exportStageToString();
bool imported = importStageFromString(usdString);
bool closed  = closeStage();

References#

// Add a USD reference arc, defining the prim first if needed.
bool ok = addReferenceToStage("/path/to/ref.usd", "/World/Prim", "Xform");

Prim authoring#

bool ok      = definePrim("/World/Prim", "Xform");
bool moved   = movePrim("/World/OldName", "/World/NewName");
bool removed = removePrim("/World/Prim");

Attributes#

bool created = createPrimAttribute("/World/Prim", "mass", "float");
bool removed = removePrimAttribute("/World/Prim", "mass");

Parameters#

setParameter("provider", "parameterName", value);
OutputParameterType value = getParameter("provider", "parameterName");

Simulation#

#include <isaacsim/physics/ovsim/control/simulation/Simulation.hpp>

Namespace: isaacsim::physics::ovsim::control::simulation

initialize();
play();
pause();
stop();
step();
invalidate();

setParameter("provider", "parameterName", value);
OutputParameterType value = getParameter("provider", "parameterName");

Data#

#include <isaacsim/physics/ovsim/data/Data.hpp>

Namespace: isaacsim::physics::ovsim::data

Types re-exported from the OV SIM interface:

  • PathType — list of absolute prim path strings.

  • InputValueType — value(s) to write.

  • OutputValueType — value(s) read back.

// Read an attribute from one or more prims.
OutputValueType values = read(paths, "mass");

// Write an attribute to one or more prims.
write(paths, "mass", inputValues);

API reference#

Fully qualified namespace: isaacsim::physics::ovsim

namespace ovsim#

Namespaces Summary#