C++ guide and API reference#
Link against isaacsim::foundation-ovsim. Headers are split across three
namespaces matching their include paths.
Simulation#
#include <isaacsim/foundation/ovsim/control/simulation/Simulation.hpp>
Namespace: isaacsim::foundation::ovsim::control::simulation
play(), pause(), stop(), and step() currently accept requests
without advancing simulation state. initialize() copies the active OpenUSD
stage into a retained OVStage snapshot, and invalidate() releases that
snapshot. Simulation provider parameters are not implemented and raise
std::logic_error.
// automatic mode
play();
pause();
stop();
// manual mode
initialize();
step();
invalidate();
setParameter("provider", "parameterName", value);
OutputParameterType value = getParameter("provider", "parameterName");
Data#
#include <isaacsim/foundation/ovsim/data/Data.hpp>
Namespace: isaacsim::foundation::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);
The optional timestamp parameter is reserved for time-sampled values. The current implementation reads and writes default-time values.
API reference#
Fully qualified namespace: isaacsim::foundation::ovsim
-
namespace ovsim#