Functions#
- Array isaacsim::common::array::absolute(const Array &a)
Computes the element-wise absolute value.
- Array isaacsim::common::array::add(const Array &a, const Array &b)
Adds two arrays element-wise.
- Array isaacsim::common::array::add(const Array &a, const details::SupportedInputSpecification &b)
Overload of
add(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::add(const details::SupportedInputSpecification &a, const Array &b)
Overload of
add(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::all(const Array &a)
Tests whether all array elements evaluate to
true.- Array isaacsim::common::array::amax(const Array &a)
Returns the largest array element.
- Array isaacsim::common::array::amin(const Array &a)
Returns the smallest array element.
- Array isaacsim::common::array::any(const Array &a)
Tests whether any array element evaluates to
true.- bool isaacsim::common::array::details::isPyScalar(nanobind::handle object)
- bool isaacsim::common::array::details::isPySequence(nanobind::handle object)
- Array isaacsim::common::array::divide(const Array &a, const Array &b)
Divides two arrays element-wise using true division.
- Array isaacsim::common::array::divide(const Array &a, const details::SupportedInputSpecification &b)
Overload of
divide(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::divide(const details::SupportedInputSpecification &a, const Array &b)
Overload of
divide(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::empty(const Shape &shape, Dtype dtype=Dtype::Float64(), const Device &device=Device::Cpu())
Creates an array of the given shape without initializing its elements.
- Array isaacsim::common::array::fromDLPack(const DLTensor &tensor)
Creates an Array view of a DLPack tensor without copying its data.
- Array isaacsim::common::array::logicalNot(const Array &a)
Computes the element-wise truth value of
NOT x.- Array isaacsim::common::array::multiply(const details::SupportedInputSpecification &a, const Array &b)
Overload of
multiply(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::multiply(const Array &a, const Array &b)
Multiplies two arrays element-wise.
- Array isaacsim::common::array::multiply(const Array &a, const details::SupportedInputSpecification &b)
Overload of
multiply(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::negative(const Array &a)
Negates an array element-wise.
- Array isaacsim::common::array::ones(const Shape &shape, Dtype dtype=Dtype::Float64(), const Device &device=Device::Cpu())
Creates an array of the given shape with every element set to one.
- Array isaacsim::common::array::operator!(const Array &a)
Operator form of
logicalNot().- Array isaacsim::common::array::operator*(const details::SupportedInputSpecification &a, const Array &b)
Operator form of
multiply().- Array isaacsim::common::array::operator*(const Array &a, const Array &b)
Operator form of
multiply().- Array isaacsim::common::array::operator*(const Array &a, const details::SupportedInputSpecification &b)
Operator form of
multiply().- Array isaacsim::common::array::operator+(const Array &a, const Array &b)
Operator form of
add().- Array isaacsim::common::array::operator+(const details::SupportedInputSpecification &a, const Array &b)
Operator form of
add().- Array isaacsim::common::array::operator+(const Array &a, const details::SupportedInputSpecification &b)
Operator form of
add().- Array isaacsim::common::array::operator-(const Array &a, const details::SupportedInputSpecification &b)
Operator form of
subtract().- Array isaacsim::common::array::operator-(const Array &a, const Array &b)
Operator form of
subtract().- Array isaacsim::common::array::operator-(const Array &a)
Operator form of
negative().- Array isaacsim::common::array::operator-(const details::SupportedInputSpecification &a, const Array &b)
Operator form of
subtract().- Array isaacsim::common::array::operator/(const details::SupportedInputSpecification &a, const Array &b)
Operator form of
divide().- Array isaacsim::common::array::operator/(const Array &a, const details::SupportedInputSpecification &b)
Operator form of
divide().- Array isaacsim::common::array::operator/(const Array &a, const Array &b)
Operator form of
divide().- Array isaacsim::common::array::prod(const Array &a)
Multiplies all array elements.
- Array isaacsim::common::array::subtract(const Array &a, const details::SupportedInputSpecification &b)
Overload of
subtract(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::subtract(const Array &a, const Array &b)
Subtracts two arrays element-wise.
- Array isaacsim::common::array::subtract(const details::SupportedInputSpecification &a, const Array &b)
Overload of
subtract(const Array&, const Array&)accepting a scalar,std::vector, orstd::vector<std::vector>operand, converted to an Array with its dtype inferred from the value and matching the other operand's device.- Array isaacsim::common::array::sum(const Array &a)
Sums all array elements.
- Array isaacsim::common::array::take(const Array &a, const std::vector< int64_t > &indices, const std::optional< int64_t > &axis=std::nullopt)
Gathers elements along a single axis by index.
- DLTensor isaacsim::common::array::toDLPack(const Array &array)
Creates a borrowed DLPack tensor view of an Array without copying its data.
- Array isaacsim::common::array::transpose(const Array &a, const std::optional< std::vector< int64_t > > &axes=std::nullopt)
Permutes an array's axes.
- Array isaacsim::common::array::zeros(const Shape &shape, Dtype dtype=Dtype::Float64(), const Device &device=Device::Cpu())
Creates an array of the given shape with every element set to zero.
- ConfigureResult isaacsim::common::logging::configureGlobalLogging(const GlobalLoggingConfiguration &configuration) noexcept
Apply selected process-wide logging settings.
- void isaacsim::common::logging::flush() noexcept
Flush all records currently pending in the process-wide Carbonite backend.
- void isaacsim::common::profiling::flow(bool begin, std::uint64_t identifier, std::string_view name={}, Mask mask=0, SourceLocation location=makeSourceLocation()) noexcept
Emit one endpoint of a cross-thread flow.
- void isaacsim::common::profiling::frame(std::string_view name, Mask mask=0) noexcept
Emit a frame marker for the calling thread.
- void isaacsim::common::profiling::instant(std::string_view name, InstantType type=InstantType::eThread, Mask mask=0, SourceLocation location=makeSourceLocation()) noexcept
Emit an instant event.
- bool isaacsim::common::profiling::isEnabled(Mask mask=0) noexcept
Return whether the attached Carbonite profiler admits the selected mask.
- SourceLocation isaacsim::common::profiling::makeSourceLocation(const char *file=nullptr, const char *function=nullptr, std::uint32_t line=0) noexcept
Create source metadata for one event.
- void isaacsim::common::profiling::setThreadName(std::string_view name) noexcept
Assign a profiler-visible name to the calling thread.
- void isaacsim::common::profiling::value(std::string_view name, std::int32_t selected, Mask mask=0) noexcept
Emit a signed integer value.
- void isaacsim::common::profiling::value(std::string_view name, float selected, Mask mask=0) noexcept
Emit a floating-point value.
- std::string isaacsim::common::string::join(const std::vector< std::string > &strings, const std::string &separator)
Join a vector of strings with a separator.
- std::vector< float > isaacsim::common::string::resolveColor(const std::string &color)
Resolve a matplotlib-style color specification to a vector of 3 normalized RGB float components.
- std::vector< std::string > isaacsim::common::string::sort(const std::vector< std::string > &strings, bool ascending=true)
Sort a vector of strings.
- std::vector< std::string > isaacsim::common::string::split(const std::string &text, const std::string &separator)
Split a string into a vector of strings using a separator.
- std::string isaacsim::common::string::toLower(const std::string &text)
Convert all characters in a string to lowercase.
- std::string isaacsim::common::string::toUpper(const std::string &text)
Convert all characters in a string to uppercase.
- Stage isaacsim::foundation::objects::details::getActiveStage()
- Stage isaacsim::foundation::objects::details::getDefaultStage()
- void isaacsim::foundation::objects::details::setActiveStage(std::optional< Stage > stage)
- void isaacsim::foundation::objects::details::setDefaultStage(std::optional< Stage > stage)
- bool isaacsim::foundation::ovsim::control::authoring::addReferenceToStage(const std::string &usdPath, const std::string &path, const std::string &typeName="Xform")
Add a reference to the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::closeStage()
Release retained stage wrappers, clear cached prim wrappers, and close the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::createPrimAttribute(const std::string &path, const std::string &attributeName, const std::string &typeName)
Create an attribute on a prim in the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::createStage()
Create an empty OpenUSD stage and make it the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::definePrim(const std::string &path, const std::string &typeName="Xform")
Define a prim on the active authoring stage.
- std::string isaacsim::foundation::ovsim::control::authoring::exportStageToString()
Export the active authoring stage as USDA text.
- OutputParameterType isaacsim::foundation::ovsim::control::authoring::getParameter(const std::string &provider, const std::string ¶meterName)
Query a retained stage identifier or pointer.
- bool isaacsim::foundation::ovsim::control::authoring::importStageFromString(const std::string &usdString)
Import a serialized USD stage and make it the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::movePrim(const std::string &targetPath, const std::string &destinationPath)
Move a prim on the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::openStage(const std::string &usdPath)
Open a USD stage and make it the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::removePrim(const std::string &path)
Remove a prim from the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::removePrimAttribute(const std::string &path, const std::string &attributeName)
Remove an attribute from a prim in the active authoring stage.
- bool isaacsim::foundation::ovsim::control::authoring::saveStage(const std::string &usdPath)
Save the active authoring stage.
- void isaacsim::foundation::ovsim::control::authoring::setParameter(const std::string &provider, const std::string ¶meterName, const InputParameterType &value)
Accept an authoring provider parameter without changing stage state.
- OutputParameterType isaacsim::foundation::ovsim::control::simulation::getParameter(const std::string &provider, const std::string ¶meterName)
Reject a simulation provider query because simulation configuration is not implemented.
- void isaacsim::foundation::ovsim::control::simulation::initialize()
Copy the active OpenUSD stage into a retained OVStage simulation snapshot.
- void isaacsim::foundation::ovsim::control::simulation::invalidate()
Close and release the retained OVStage simulation snapshot, if one exists.
- void isaacsim::foundation::ovsim::control::simulation::pause()
Accept a pause request without changing simulation state.
- void isaacsim::foundation::ovsim::control::simulation::play()
Accept a play request without changing simulation state.
- void isaacsim::foundation::ovsim::control::simulation::setParameter(const std::string &provider, const std::string ¶meterName, const InputParameterType &value)
Reject a simulation provider parameter because simulation configuration is not implemented.
- void isaacsim::foundation::ovsim::control::simulation::step()
Accept a manual simulation step request without changing simulation state.
- void isaacsim::foundation::ovsim::control::simulation::stop()
Accept a stop request without changing simulation state.
- OutputValueType isaacsim::foundation::ovsim::data::read(const PathType &paths, const std::string &attributeName, std::optional< double > timestamp=std::nullopt)
Read one attribute from one or more prims on the active stage.
- void isaacsim::foundation::ovsim::data::write(const PathType &paths, const std::string &attributeName, const InputValueType &values, std::optional< double > timestamp=std::nullopt)
Write one attribute on one or more prims on the active stage.
- void isaacsim::foundation::usd::openusd::addReferenceToStage(int64_t stageId, const std::string &path, const std::string &usdPath, const std::string &typeName="Xform")
Adds a USD reference arc to a prim, defining it first if it does not exist.
- bool isaacsim::foundation::usd::openusd::applyApi(int64_t stageId, const std::string &path, const std::string &schemaType, const std::optional< std::string > &instanceName=std::nullopt)
Applies an API schema to a prim.
- bool isaacsim::foundation::usd::openusd::closeStage(int64_t stageId)
Closes and releases a previously created or opened stage.
- bool isaacsim::foundation::usd::openusd::createPrimAttribute(int64_t stageId, const std::string &path, const std::string &attributeName, const std::string &typeName)
Creates a new attribute on a prim.
- int64_t isaacsim::foundation::usd::openusd::createStage()
Creates a new, empty in-memory USD stage.
- void isaacsim::foundation::usd::openusd::definePrim(int64_t stageId, const std::string &path, const std::string &typeName="Xform")
Defines a prim at the given path, creating ancestor prims as needed.
- std::string isaacsim::foundation::usd::openusd::exportStageToString(int64_t stageId)
Serializes the stage's root layer to a USDA string.
- std::vector< std::string > isaacsim::foundation::usd::openusd::findMatchingPrimPaths(int64_t stageId, const std::string &path, bool traverse=false)
Finds prim paths on the stage whose path string matches a pattern.
- std::string isaacsim::foundation::usd::openusd::generateStageRepresentation(int64_t stageId, const std::string &mode="tree")
Generates a human-readable representation of the stage hierarchy.
- std::vector< std::string > isaacsim::foundation::usd::openusd::getAppliedSchemas(int64_t stageId, const std::string &path)
Returns the list of API schema names applied to a prim.
- std::vector< std::string > isaacsim::foundation::usd::openusd::getChildren(int64_t stageId, const std::string &path)
Returns the absolute paths of a prim's direct children.
- std::string isaacsim::foundation::usd::openusd::getName(int64_t stageId, const std::string &path)
Returns the name component of a prim's path.
- std::string isaacsim::foundation::usd::openusd::getParent(int64_t stageId, const std::string &path)
Returns the absolute path of a prim's parent.
- std::vector< std::string > isaacsim::foundation::usd::openusd::getPrimAttributeNames(int64_t stageId, const std::string &path)
Returns the names of all attributes on a prim.
- std::string isaacsim::foundation::usd::openusd::getPrimAttributeTypeName(int64_t stageId, const std::string &path, const std::string &attributeName)
Returns the SdfValueTypeName string of an attribute (e.g.
- AttributeValues isaacsim::foundation::usd::openusd::getPrimAttributeValues(int64_t stageId, const std::vector< std::string > &paths, const std::string &attributeName)
Reads an attribute's value from multiple prims in a single call.
- void * isaacsim::foundation::usd::openusd::getStagePtr(int64_t stageId)
Returns an opaque pointer to the underlying UsdStage object.
- std::tuple< float, float, float > isaacsim::foundation::usd::openusd::getStageTimeCode(int64_t stageId)
Returns the stage's start time code, end time code, and time codes per second.
- std::tuple< float, float > isaacsim::foundation::usd::openusd::getStageUnits(int64_t stageId)
Returns the stage's metersPerUnit and kilogramsPerUnit scale factors.
- std::string isaacsim::foundation::usd::openusd::getStageUpAxis(int64_t stageId)
Returns the stage's up-axis token (e.g.
- std::string isaacsim::foundation::usd::openusd::getTypeName(int64_t stageId, const std::string &path)
Returns the schema type name of a prim (e.g.
- std::unordered_map< std::string, std::vector< std::string > > isaacsim::foundation::usd::openusd::getVariants(int64_t stageId, const std::string &path, bool selection=true)
Returns the variant sets and their available or selected variants for a prim.
- std::tuple< array::Array, array::Array > isaacsim::foundation::usd::openusd::getXformLocalPoses(int64_t stageId, const std::vector< std::string > &paths)
Returns the local poses of the given Xformable prims.
- array::Array isaacsim::foundation::usd::openusd::getXformLocalScales(int64_t stageId, const std::vector< std::string > &paths)
Returns the local scales of the given Xformable prims.
- std::tuple< array::Array, array::Array > isaacsim::foundation::usd::openusd::getXformWorldPoses(int64_t stageId, const std::vector< std::string > &paths)
Returns the world poses of the given Xformable prims.
- bool isaacsim::foundation::usd::openusd::hasApi(int64_t stageId, const std::string &path, const std::string &schemaType, const std::optional< std::string > &instanceName=std::nullopt)
Checks whether an applied API schema is applied to a prim.
- int64_t isaacsim::foundation::usd::openusd::importStageFromString(const std::string &usdString)
Creates a new in-memory stage populated from a USDA string.
- bool isaacsim::foundation::usd::openusd::isA(int64_t stageId, const std::string &path, const std::string &schemaType)
Checks whether a prim is or derives from a given schema type.
- bool isaacsim::foundation::usd::openusd::isPrimValid(int64_t stageId, const std::string &path)
Checks whether the prim at
pathexists and is valid on the stage.- bool isaacsim::foundation::usd::openusd::isStageValid(int64_t stageId)
Checks whether a stage identifier refers to a live stage.
- bool isaacsim::foundation::usd::openusd::isValidPathString(const std::string &path)
Checks whether a string is a syntactically valid SdfPath.
- std::tuple< bool, std::string > isaacsim::foundation::usd::openusd::movePrim(int64_t stageId, const std::string &targetPath, const std::string &destinationPath)
Moves a prim from one path to another within the same stage.
- int64_t isaacsim::foundation::usd::openusd::openStage(const std::string &usdPath)
Opens a USD stage from a URL.
- bool isaacsim::foundation::usd::openusd::removeApi(int64_t stageId, const std::string &path, const std::string &schemaType, const std::optional< std::string > &instanceName=std::nullopt)
Removes an applied API schema from a prim.
- bool isaacsim::foundation::usd::openusd::removePrim(int64_t stageId, const std::string &path)
Removes a prim and all of its descendants from the stage.
- bool isaacsim::foundation::usd::openusd::removePrimAttribute(int64_t stageId, const std::string &path, const std::string &attributeName)
Removes an attribute from a prim.
- void isaacsim::foundation::usd::openusd::resetXformOpProperties(int64_t stageId, const std::string &path)
Ensures a prim has the canonical transform ops order [xformOp:translate, xformOp:orient, xformOp:scale].
- bool isaacsim::foundation::usd::openusd::saveStage(int64_t stageId, const std::string &usdPath)
Saves a stage to a USD file.
- std::vector< bool > isaacsim::foundation::usd::openusd::setPrimAttributeValues(int64_t stageId, const std::vector< std::string > &paths, const std::string &attributeName, const AttributeValues &values)
Writes an attribute's value to multiple prims in a single call.
- void isaacsim::foundation::usd::openusd::setStageTimeCode(int64_t stageId, std::optional< float > startTimeCode=std::nullopt, std::optional< float > endTimeCode=std::nullopt, std::optional< float > timeCodesPerSecond=std::nullopt)
Sets the stage's time code range and rate.
- void isaacsim::foundation::usd::openusd::setStageUnits(int64_t stageId, std::optional< float > metersPerUnit=std::nullopt, std::optional< float > kilogramsPerUnit=std::nullopt)
Sets the stage's physical unit scale factors.
- void isaacsim::foundation::usd::openusd::setStageUpAxis(int64_t stageId, const std::string &upAxis)
Sets the stage's up-axis.
- void isaacsim::foundation::usd::openusd::setVariants(int64_t stageId, const std::string &path, const std::unordered_map< std::string, std::vector< std::string > > &variants)
Sets variant selections on a prim's variant sets.
- void isaacsim::foundation::usd::openusd::setXformLocalPoses(int64_t stageId, const std::vector< std::string > &paths, const std::optional< array::Array > &translations=std::nullopt, const std::optional< array::Array > &orientations=std::nullopt)
Sets the local poses of the given Xformable prims.
- void isaacsim::foundation::usd::openusd::setXformLocalScales(int64_t stageId, const std::vector< std::string > &paths, const array::Array &scales)
Sets the local scales of the given Xformable prims.
- void isaacsim::foundation::usd::openusd::setXformWorldPoses(int64_t stageId, const std::vector< std::string > &paths, const std::optional< array::Array > &positions=std::nullopt, const std::optional< array::Array > &orientations=std::nullopt)
Sets the world poses of the given Xformable prims.
- void isaacsim::foundation::usd::openusd::traversePrim(int64_t stageId, const std::string &path, std::function< bool(const std::string &)> callback)
Traverses the prim subtree rooted at
path, invokingcallbackfor each prim.- void isaacsim::foundation::usd::ovstage::addReferenceToStage(int64_t stageId, const std::string &path, const std::string &usdPath, const std::string &typeName="Xform")
Adds a USD reference arc to a prim, defining it first if it does not exist.
- bool isaacsim::foundation::usd::ovstage::applyApi(int64_t stageId, const std::string &path, const std::string &schemaType, const std::optional< std::string > &instanceName=std::nullopt)
Applies an API schema to a prim.
- bool isaacsim::foundation::usd::ovstage::closeStage(int64_t stageId)
Closes and releases a previously created or opened stage.
- bool isaacsim::foundation::usd::ovstage::createPrimAttribute(int64_t stageId, const std::string &path, const std::string &attributeName, const std::string &typeName)
Creates a new attribute on a prim.
- int64_t isaacsim::foundation::usd::ovstage::createStage()
Creates a new, empty in-memory USD stage.
- void isaacsim::foundation::usd::ovstage::definePrim(int64_t stageId, const std::string &path, const std::string &typeName="Xform")
Defines a prim at the given path, creating ancestor prims as needed.
- std::string isaacsim::foundation::usd::ovstage::exportStageToString(int64_t stageId)
Serializes the stage's root layer to a USDA string.
- std::vector< std::string > isaacsim::foundation::usd::ovstage::findMatchingPrimPaths(int64_t stageId, const std::string &path, bool traverse=false)
Finds prim paths on the stage whose path string matches a pattern.
- std::string isaacsim::foundation::usd::ovstage::generateStageRepresentation(int64_t stageId, const std::string &mode="tree")
Generates a human-readable representation of the stage hierarchy.
- std::vector< std::string > isaacsim::foundation::usd::ovstage::getAppliedSchemas(int64_t stageId, const std::string &path)
Returns the list of API schema names applied to a prim.
- std::vector< std::string > isaacsim::foundation::usd::ovstage::getChildren(int64_t stageId, const std::string &path)
Returns the absolute paths of a prim's direct children.
- std::string isaacsim::foundation::usd::ovstage::getName(int64_t stageId, const std::string &path)
Returns the name component of a prim's path.
- std::string isaacsim::foundation::usd::ovstage::getParent(int64_t stageId, const std::string &path)
Returns the absolute path of a prim's parent.
- std::vector< std::string > isaacsim::foundation::usd::ovstage::getPrimAttributeNames(int64_t stageId, const std::string &path)
Returns the names of all attributes on a prim.
- std::string isaacsim::foundation::usd::ovstage::getPrimAttributeTypeName(int64_t stageId, const std::string &path, const std::string &attributeName)
Returns the SdfValueTypeName string of an attribute (e.g.
- AttributeValues isaacsim::foundation::usd::ovstage::getPrimAttributeValues(int64_t stageId, const std::vector< std::string > &paths, const std::string &attributeName)
Reads an attribute's value from multiple prims in a single call.
- void * isaacsim::foundation::usd::ovstage::getStagePtr(int64_t stageId)
Returns an opaque pointer to the underlying ovstage_instance_t struct.
- std::tuple< float, float, float > isaacsim::foundation::usd::ovstage::getStageTimeCode(int64_t stageId)
Returns the stage's start time code, end time code, and time codes per second.
- std::tuple< float, float > isaacsim::foundation::usd::ovstage::getStageUnits(int64_t stageId)
Returns the stage's metersPerUnit and kilogramsPerUnit scale factors.
- std::string isaacsim::foundation::usd::ovstage::getStageUpAxis(int64_t stageId)
Returns the stage's up-axis token (e.g.
- std::string isaacsim::foundation::usd::ovstage::getTypeName(int64_t stageId, const std::string &path)
Returns the schema type name of a prim (e.g.
- std::unordered_map< std::string, std::vector< std::string > > isaacsim::foundation::usd::ovstage::getVariants(int64_t stageId, const std::string &path, bool selection=true)
Returns the variant sets and their available or selected variants for a prim.
- std::tuple< array::Array, array::Array > isaacsim::foundation::usd::ovstage::getXformLocalPoses(int64_t stageId, const std::vector< std::string > &paths)
Returns the local poses of the given Xformable prims.
- array::Array isaacsim::foundation::usd::ovstage::getXformLocalScales(int64_t stageId, const std::vector< std::string > &paths)
Returns the local scales of the given Xformable prims.
- std::tuple< array::Array, array::Array > isaacsim::foundation::usd::ovstage::getXformWorldPoses(int64_t stageId, const std::vector< std::string > &paths)
Returns the world poses of the given Xformable prims.
- bool isaacsim::foundation::usd::ovstage::hasApi(int64_t stageId, const std::string &path, const std::string &schemaType, const std::optional< std::string > &instanceName=std::nullopt)
Checks whether an applied API schema is applied to a prim.
- int64_t isaacsim::foundation::usd::ovstage::importStageFromString(const std::string &usdString)
Creates a new in-memory stage populated from a USDA string.
- bool isaacsim::foundation::usd::ovstage::isA(int64_t stageId, const std::string &path, const std::string &schemaType)
Checks whether a prim is or derives from a given schema type.
- bool isaacsim::foundation::usd::ovstage::isPrimValid(int64_t stageId, const std::string &path)
Checks whether the prim at
pathexists and is valid on the stage.- bool isaacsim::foundation::usd::ovstage::isStageValid(int64_t stageId)
Checks whether a stage identifier refers to a live stage.
- bool isaacsim::foundation::usd::ovstage::isValidPathString(const std::string &path)
Checks whether a string is a syntactically valid SdfPath.
- std::tuple< bool, std::string > isaacsim::foundation::usd::ovstage::movePrim(int64_t stageId, const std::string &targetPath, const std::string &destinationPath)
Moves a prim from one path to another within the same stage.
- int64_t isaacsim::foundation::usd::ovstage::openStage(const std::string &usdPath)
Opens a USD stage from a URL.
- bool isaacsim::foundation::usd::ovstage::removeApi(int64_t stageId, const std::string &path, const std::string &schemaType, const std::optional< std::string > &instanceName=std::nullopt)
Removes an applied API schema from a prim.
- bool isaacsim::foundation::usd::ovstage::removePrim(int64_t stageId, const std::string &path)
Removes a prim and all of its descendants from the stage.
- bool isaacsim::foundation::usd::ovstage::removePrimAttribute(int64_t stageId, const std::string &path, const std::string &attributeName)
Removes an attribute from a prim.
- void isaacsim::foundation::usd::ovstage::resetXformOpProperties(int64_t stageId, const std::string &path)
Ensures a prim has the canonical transform ops order [xformOp:translate, xformOp:orient, xformOp:scale].
- bool isaacsim::foundation::usd::ovstage::saveStage(int64_t stageId, const std::string &usdPath)
Saves a stage to a USD file.
- std::vector< bool > isaacsim::foundation::usd::ovstage::setPrimAttributeValues(int64_t stageId, const std::vector< std::string > &paths, const std::string &attributeName, const AttributeValues &values)
Writes an attribute's value to multiple prims in a single call.
- void isaacsim::foundation::usd::ovstage::setStageTimeCode(int64_t stageId, std::optional< float > startTimeCode=std::nullopt, std::optional< float > endTimeCode=std::nullopt, std::optional< float > timeCodesPerSecond=std::nullopt)
Sets the stage's time code range and rate.
- void isaacsim::foundation::usd::ovstage::setStageUnits(int64_t stageId, std::optional< float > metersPerUnit=std::nullopt, std::optional< float > kilogramsPerUnit=std::nullopt)
Sets the stage's physical unit scale factors.
- void isaacsim::foundation::usd::ovstage::setStageUpAxis(int64_t stageId, const std::string &upAxis)
Sets the stage's up-axis.
- void isaacsim::foundation::usd::ovstage::setVariants(int64_t stageId, const std::string &path, const std::unordered_map< std::string, std::vector< std::string > > &variants)
Sets variant selections on a prim's variant sets.
- void isaacsim::foundation::usd::ovstage::setXformLocalPoses(int64_t stageId, const std::vector< std::string > &paths, const std::optional< array::Array > &translations=std::nullopt, const std::optional< array::Array > &orientations=std::nullopt)
Sets the local poses of the given Xformable prims.
- void isaacsim::foundation::usd::ovstage::setXformLocalScales(int64_t stageId, const std::vector< std::string > &paths, const array::Array &scales)
Sets the local scales of the given Xformable prims.
- void isaacsim::foundation::usd::ovstage::setXformWorldPoses(int64_t stageId, const std::vector< std::string > &paths, const std::optional< array::Array > &positions=std::nullopt, const std::optional< array::Array > &orientations=std::nullopt)
Sets the world poses of the given Xformable prims.
- void isaacsim::foundation::usd::ovstage::traversePrim(int64_t stageId, const std::string &path, std::function< bool(const std::string &)> callback)
Traverses the prim subtree rooted at
path, invokingcallbackfor each prim.- void isaacsim::foundation::utils::addLabels(const std::string &path, const std::variant< std::string, std::vector< std::string > > &labels, const std::string &taxonomy="class")
Adds semantic labels to a prim under the given taxonomy.
- std::vector< std::string > isaacsim::foundation::utils::findMatchingPrimPaths(const std::string &path, bool traverse=false)
Returns all prim paths on the default stage that match the given path expression.
- objects::Stage isaacsim::foundation::utils::getActiveStage()
Get the active stage for the calling thread.
- std::vector< std::string > isaacsim::foundation::utils::getAllMatchingChildPrims(const std::string &path, std::function< bool(const std::string &)> predicate, bool includeSelf=false, std::optional< std::size_t > maxDepth=std::nullopt)
Returns all prims in the subtree rooted at
pathfor whichpredicatereturnstrue.- std::string isaacsim::foundation::utils::getCurrentBackend(const std::initializer_list< std::string > &supportedBackends, std::optional< bool > raiseOnUnsupported=std::nullopt)
Returns the currently active backend name for this thread.
- std::string isaacsim::foundation::utils::getCurrentBackend(const std::vector< std::string > &supportedBackends, std::optional< bool > raiseOnUnsupported=std::nullopt)
Returns the currently active backend name for this thread.
- objects::Stage isaacsim::foundation::utils::getDefaultStage()
Get the process-wide default stage.
- std::optional< std::string > isaacsim::foundation::utils::getFirstMatchingChildPrim(const std::string &path, std::function< bool(const std::string &)> predicate, bool includeSelf=false, std::optional< std::size_t > maxDepth=std::nullopt)
Returns the first prim in the subtree rooted at
pathfor whichpredicatereturnstrue.- std::optional< std::string > isaacsim::foundation::utils::getFirstMatchingParentPrim(const std::string &path, std::function< bool(const std::string &)> predicate, bool includeSelf=false)
Returns the first ancestor of
pathfor whichpredicatereturnstrue.- std::unordered_map< std::string, std::vector< std::string > > isaacsim::foundation::utils::getLabels(const std::string &path, bool includeDescendants=false)
Returns all semantic labels on a prim, grouped by taxonomy.
- bool isaacsim::foundation::utils::isBackendSet()
Checks whether a backend is currently set on this thread.
- void isaacsim::foundation::utils::removeAllLabels(const std::string &path, bool removeTaxonomies=false, bool includeDescendants=false)
Removes all semantic labels from a prim.
- void isaacsim::foundation::utils::removeLabels(const std::string &path, const std::variant< std::string, std::vector< std::string > > &labels, const std::optional< std::string > &taxonomy=std::nullopt, bool includeDescendants=false)
Removes specific semantic labels from a prim.
- void isaacsim::foundation::utils::setDefaultStage(objects::Stage stage)
Set the process-wide default stage.
- bool isaacsim::foundation::utils::shouldRaiseOnFallback()
Checks whether the current context requests an exception on a fallback backend.
- bool isaacsim::foundation::utils::shouldRaiseOnUnsupported()
Checks whether the current context requests an exception on an unsupported backend.
- types::Implementation isaacsim::ovsim::api::makeClient(const std::string &name, const std::optional< std::unordered_map< std::string, std::string > > &configuration=std::nullopt)
Create an OV SIM client implementation.
- bool isaacsim::ovsim::clients::local::control::authoring::addReferenceToStage(const std::string &usdPath, const std::string &path, const std::string &typeName="Xform")
Report that adding a USD reference is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::closeStage()
Report that closing a stage is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::createPrimAttribute(const std::string &path, const std::string &attributeName, const std::string &typeName)
Report that creating a prim attribute is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::createStage()
Report that creating a stage is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::definePrim(const std::string &path, const std::string &typeName="Xform")
Report that defining a prim is unavailable in this adapter.
- std::string isaacsim::ovsim::clients::local::control::authoring::exportStageToString()
Report that exporting stage contents is unavailable in this adapter.
- OutputParameterType isaacsim::ovsim::clients::local::control::authoring::getParameter(const std::string &provider, const std::string ¶meterName)
Report that reading an authoring parameter is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::importStageFromString(const std::string &usdString)
Report that importing stage contents is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::movePrim(const std::string &targetPath, const std::string &destinationPath)
Report that moving a prim is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::openStage(const std::string &usdPath)
Report that opening a stage is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::removePrim(const std::string &path)
Report that removing a prim is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::removePrimAttribute(const std::string &path, const std::string &attributeName)
Report that removing a prim attribute is unavailable in this adapter.
- bool isaacsim::ovsim::clients::local::control::authoring::saveStage(const std::string &usdPath)
Report that saving a stage is unavailable in this adapter.
- void isaacsim::ovsim::clients::local::control::authoring::setParameter(const std::string &provider, const std::string ¶meterName, const InputParameterType &value)
Report that setting an authoring parameter is unavailable in this adapter.
- OutputParameterType isaacsim::ovsim::clients::local::control::simulation::getParameter(const std::string &provider, const std::string ¶meterName)
Get a simulation parameter exposed by a provider.
- void isaacsim::ovsim::clients::local::control::simulation::initialize()
Initialize the simulation for manual stepping.
- void isaacsim::ovsim::clients::local::control::simulation::invalidate()
Invalidate the manually stepped simulation state.
- void isaacsim::ovsim::clients::local::control::simulation::pause()
Preserve OV SIM pause-state compatibility without changing manual simulation state.
- void isaacsim::ovsim::clients::local::control::simulation::play()
Preserve OV SIM play-state compatibility without changing manual simulation state.
- void isaacsim::ovsim::clients::local::control::simulation::setParameter(const std::string &provider, const std::string ¶meterName, const InputParameterType &value)
Set a simulation parameter exposed by a provider.
- void isaacsim::ovsim::clients::local::control::simulation::step()
Advance a manually controlled simulation by one step.
- void isaacsim::ovsim::clients::local::control::simulation::stop()
Preserve OV SIM stop-state compatibility without changing manual simulation state.
- OutputValueType isaacsim::ovsim::clients::local::data::read(const PathType &paths, const std::string &attributeName, std::optional< double > timestamp=std::nullopt)
Read an attribute from one or more prims.
- void isaacsim::ovsim::clients::local::data::write(const PathType &paths, const std::string &attributeName, const InputValueType &values, std::optional< double > timestamp=std::nullopt)
Write an attribute on one or more prims.
- bool isaacsim::physics::manager::checkResults()
Collects result-readiness status from active physics backends.
- bool isaacsim::physics::manager::close()
Requests every active physics backend to close and detach its stage.
- void isaacsim::physics::manager::fetchResults()
Waits for active simulations to finish and fetches their results.
- void isaacsim::physics::manager::flushChanges()
Forces every active physics backend to process buffered scene changes.
- long isaacsim::physics::manager::getAttachedStage()
Gets the USD stage identifier reported by the first active backend that exposes the query.
- registration::DebugDataDictionary isaacsim::physics::manager::getPrimDebugData(const std::string &primPath)
Gets aggregated physics debug data for a prim.
- uint64_t isaacsim::physics::manager::getSimulationStepCount(registration::SimulationId simulationId)
Gets the physics step count reported by a simulation.
- uint32_t isaacsim::physics::manager::getSimulationTimeStepsPerSecond(registration::SimulationId simulationId, long stageId, registration::PathToken scenePath)
Gets the configured simulation frequency for a physics scene.
- uint64_t isaacsim::physics::manager::getSimulationTimestamp(registration::SimulationId simulationId)
Gets a simulation's monotonically increasing step timestamp.
- void isaacsim::physics::manager::handleRaycast(const registration::Float3 &origin, const registration::Float3 &direction, bool input)
Dispatches an interaction raycast request to every active physics backend.
- InitializeResult isaacsim::physics::manager::initialize(void *ovstage, const char *usdIdentifier)
Initializes all active physics backends from a stage.
- bool isaacsim::physics::manager::isCapableOfSimulating(registration::SimulationId simulationId, const char **schemaNames, size_t schemaNamesCount, bool *isCapable)
Queries whether a simulation supports USD schema types or applied schema APIs.
- bool isaacsim::physics::manager::isChangeTrackingPaused(registration::SimulationId simulationId)
Checks whether scene-change tracking is paused for a simulation.
- uint32_t isaacsim::physics::manager::overlapBox(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, registration::OverlapHitReportFunction reportFunction)
Reports objects that overlap an oriented box.
- bool isaacsim::physics::manager::overlapBoxAny(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation)
Tests whether an oriented box overlaps any object in the scene.
- uint32_t isaacsim::physics::manager::overlapShape(registration::PathToken geometryPrimitivePath, registration::OverlapHitReportFunction reportFunction)
Reports objects that overlap a USD geometric primitive.
- bool isaacsim::physics::manager::overlapShapeAny(registration::PathToken geometryPrimitivePath)
Tests whether a USD geometric primitive overlaps any object in the scene.
- uint32_t isaacsim::physics::manager::overlapSphere(float radius, const isaacsim::physics::registration::Float3 &position, registration::OverlapHitReportFunction reportFunction)
Reports objects that overlap a sphere.
- bool isaacsim::physics::manager::overlapSphereAny(float radius, const isaacsim::physics::registration::Float3 &position)
Tests whether a sphere overlaps any object in the scene.
- void isaacsim::physics::manager::pauseChangeTracking(bool pause)
Pauses or resumes scene-change tracking for every active physics backend.
- bool isaacsim::physics::manager::publishTransformsToStage()
Publishes the latest simulated transforms to the stages attached to active physics backends.
- void isaacsim::physics::manager::raycastAll(const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::RaycastHitReportFunction reportFunction, bool bothSides)
Reports raycast hits from all active physics backends.
- bool isaacsim::physics::manager::raycastAny(const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a ray hits any object in an active physics backend.
- bool isaacsim::physics::manager::raycastClosest(const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::RaycastHit &hit, bool bothSides)
Finds the closest raycast hit across all active physics backends.
- void isaacsim::physics::manager::simulate(float elapsedTime, float currentTime)
Runs a synchronous simulation step on every active physics backend.
- void isaacsim::physics::manager::simulateAsynchronously(float elapsedTime, float currentTime)
Starts an asynchronous simulation step on every active physics backend.
- registration::SubscriptionId isaacsim::physics::manager::subscribePhysicsContactReportEvents(registration::OnContactReportEventFunction onEvent)
Subscribes to contact-report events from physics backends.
- registration::SubscriptionId isaacsim::physics::manager::subscribePhysicsOnStepEvents(bool preStep, int order, registration::OnPhysicsStepEventFunction onUpdate)
Subscribes to events before or after each physics step.
- registration::SubscriptionId isaacsim::physics::manager::subscribeProfileStatisticsEvents(registration::ProfileStatisticsNotificationFunction onEvent)
Subscribes to physics simulation profiling events.
- void isaacsim::physics::manager::sweepBoxAll(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHitReportFunction reportFunction, bool bothSides)
Reports hits produced by sweeping an oriented box through the scene.
- bool isaacsim::physics::manager::sweepBoxAny(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a swept oriented box encounters any object in the scene.
- bool isaacsim::physics::manager::sweepBoxClosest(const isaacsim::physics::registration::Float3 &halfExtent, const isaacsim::physics::registration::Float3 &position, const isaacsim::physics::registration::Float4 &rotation, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHit &hit, bool bothSides)
Finds the closest hit produced by sweeping an oriented box through the scene.
- void isaacsim::physics::manager::sweepShapeAll(registration::PathToken geometryPrimitivePath, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHitReportFunction reportFunction, bool bothSides)
Reports hits produced by sweeping a USD geometric primitive through the scene.
- bool isaacsim::physics::manager::sweepShapeAny(registration::PathToken geometryPrimitivePath, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a swept USD geometric primitive encounters any object in the scene.
- bool isaacsim::physics::manager::sweepShapeClosest(registration::PathToken geometryPrimitivePath, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHit &hit, bool bothSides)
Finds the closest hit produced by sweeping a USD geometric primitive through the scene.
- void isaacsim::physics::manager::sweepSphereAll(float radius, const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHitReportFunction reportFunction, bool bothSides)
Reports hits produced by sweeping a sphere through the scene.
- bool isaacsim::physics::manager::sweepSphereAny(float radius, const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, bool bothSides)
Tests whether a swept sphere encounters any object in the scene.
- bool isaacsim::physics::manager::sweepSphereClosest(float radius, const isaacsim::physics::registration::Float3 &origin, const isaacsim::physics::registration::Float3 &unitDirection, float distance, registration::SweepHit &hit, bool bothSides)
Finds the closest hit produced by sweeping a sphere through the scene.
- void isaacsim::physics::manager::unsubscribePhysicsContactReportEvents(registration::SubscriptionId subscriptionId)
Unsubscribes from physics contact-report events.
- void isaacsim::physics::manager::unsubscribePhysicsOnStepEvents(registration::SubscriptionId subscriptionId)
Unsubscribes from physics step events.
- void isaacsim::physics::manager::unsubscribeProfileStatisticsEvents(registration::SubscriptionId subscriptionId)
Unsubscribes from physics simulation profiling events.
- bool isaacsim::physics::ovsim::control::authoring::addReferenceToStage(const std::string &usdPath, const std::string &path, const std::string &typeName="Xform")
Report that adding a USD reference is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::closeStage()
Report that closing a stage is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::createPrimAttribute(const std::string &path, const std::string &attributeName, const std::string &typeName)
Report that creating a prim attribute is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::createStage()
Report that creating a stage is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::definePrim(const std::string &path, const std::string &typeName="Xform")
Report that defining a prim is unavailable in this adapter.
- std::string isaacsim::physics::ovsim::control::authoring::exportStageToString()
Report that exporting stage contents is unavailable in this adapter.
- OutputParameterType isaacsim::physics::ovsim::control::authoring::getParameter(const std::string &provider, const std::string ¶meterName)
Report that reading an authoring parameter is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::importStageFromString(const std::string &usdString)
Report that importing stage contents is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::movePrim(const std::string &targetPath, const std::string &destinationPath)
Report that moving a prim is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::openStage(const std::string &usdPath)
Report that opening a stage is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::removePrim(const std::string &path)
Report that removing a prim is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::removePrimAttribute(const std::string &path, const std::string &attributeName)
Report that removing a prim attribute is unavailable in this adapter.
- bool isaacsim::physics::ovsim::control::authoring::saveStage(const std::string &usdPath)
Report that saving a stage is unavailable in this adapter.
- void isaacsim::physics::ovsim::control::authoring::setParameter(const std::string &provider, const std::string ¶meterName, const InputParameterType &value)
Report that setting an authoring parameter is unavailable in this adapter.
- OutputParameterType isaacsim::physics::ovsim::control::simulation::getParameter(const std::string &provider, const std::string ¶meterName)
Get a simulation parameter exposed by a provider.
- void isaacsim::physics::ovsim::control::simulation::initialize()
Initialize the simulation for manual stepping.
- void isaacsim::physics::ovsim::control::simulation::invalidate()
Invalidate the manually stepped simulation state.
- void isaacsim::physics::ovsim::control::simulation::pause()
Preserve OV SIM pause-state compatibility without changing manual simulation state.
- void isaacsim::physics::ovsim::control::simulation::play()
Preserve OV SIM play-state compatibility without changing manual simulation state.
- void isaacsim::physics::ovsim::control::simulation::setParameter(const std::string &provider, const std::string ¶meterName, const InputParameterType &value)
Set a simulation parameter exposed by a provider.
- void isaacsim::physics::ovsim::control::simulation::step()
Advance a manually controlled simulation by one step.
- void isaacsim::physics::ovsim::control::simulation::stop()
Preserve OV SIM stop-state compatibility without changing manual simulation state.
- OutputValueType isaacsim::physics::ovsim::data::read(const PathType &paths, const std::string &attributeName, std::optional< double > timestamp=std::nullopt)
Read an attribute from one or more prims.
- void isaacsim::physics::ovsim::data::write(const PathType &paths, const std::string &attributeName, const InputValueType &values, std::optional< double > timestamp=std::nullopt)
Write an attribute on one or more prims.
- void isaacsim::physics::registration::activateSimulation(const SimulationId &simulationId)
Activates a registered simulation.
- void isaacsim::physics::registration::deactivateSimulation(const SimulationId &simulationId)
Deactivates a registered simulation.
- SimulationId isaacsim::physics::registration::getActiveSimulationId(const std::string &simulationName)
Retrieves the active simulation registered under a given name.
- const Simulation * isaacsim::physics::registration::getSimulation(const SimulationId &simulationId)
Retrieves a registered simulation.
- size_t isaacsim::physics::registration::getSimulationCount()
Returns the number of registered simulations.
- size_t isaacsim::physics::registration::getSimulationIds(SimulationId *simulationIds, size_t bufferSize)
Copies registered simulation identifiers into a caller-provided buffer.
- std::string isaacsim::physics::registration::getSimulationName(const SimulationId &simulationId)
Retrieves the name of a registered simulation.
- bool isaacsim::physics::registration::isSimulationActive(const SimulationId &simulationId)
Reports whether a registered simulation is active.
- DebugDataItem isaacsim::physics::registration::makeDebugDataBoolean(const std::string &description, bool value)
Creates a Boolean debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataDouble(const std::string &description, double value)
Creates a double-precision debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataFloat(const std::string &description, float value)
Creates a single-precision debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataInteger(const std::string &description, int32_t value)
Creates an integer debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataPoint(const std::string &description, const Double3 &value)
Creates a double-precision three-dimensional point debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataPoint(const std::string &description, const Float3 &value)
Creates a single-precision three-dimensional point debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataQuaternion(const std::string &description, const Double4 &value)
Creates a double-precision quaternion debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataQuaternion(const std::string &description, const Float4 &value)
Creates a single-precision quaternion debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataString(const std::string &description, const std::string &value)
Creates a string debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataVector(const std::string &description, const Float3 &value)
Creates a single-precision three-dimensional vector debug-data item.
- DebugDataItem isaacsim::physics::registration::makeDebugDataVector(const std::string &description, const Double3 &value)
Creates a double-precision three-dimensional vector debug-data item.
- SimulationId isaacsim::physics::registration::registerSimulation(const Simulation &simulation, const std::string &simulationName)
Registers a simulation with the physics system.
- SubscriptionId isaacsim::physics::registration::subscribeSimulationRegistryEvents(OnSimulationRegistryEventFunction onEvent, void *userData=nullptr)
Subscribes to simulation registry events.
- void isaacsim::physics::registration::unregisterSimulation(const SimulationId &simulationId)
Unregisters a simulation from the physics system.
- void isaacsim::physics::registration::unsubscribeSimulationRegistryEvents(SubscriptionId subscriptionId)
Unsubscribes from simulation registry events.
- bool isaacsim::physics_engines::ovphysx::activate()
Activates the process-wide ovphysx simulation backend.
- int isaacsim::physics_engines::ovphysx::getTensorDeviceOrdinal()
Gets the declared tensor-device ordinal.
- void isaacsim::physics_engines::ovphysx::setSuppressReadback(bool enable)
Sets whether PhysX readback is suppressed for subsequently created scenes.
- void isaacsim::physics_engines::ovphysx::setTensorDeviceOrdinal(int ordinal)
Declares the device on which this backend's tensors reside.
- void isaacsim::physics_engines::ovphysx::shutdown()
Shuts down the process-wide ovphysx simulation backend.
- void isaacsim::robot::schema::ApplyAttachmentPointAPI(pxr::UsdPrim &prim)
Apply the IsaacAttachmentPointAPI schema to a prim.
- void isaacsim::robot::schema::ApplyJointAPI(pxr::UsdPrim &prim)
Apply the IsaacJointAPI schema to a prim.
- void isaacsim::robot::schema::ApplyLinkAPI(pxr::UsdPrim &prim)
Apply the IsaacLinkAPI schema to a prim.
- void isaacsim::robot::schema::ApplyReferencePointAPI(pxr::UsdPrim &prim)
Apply the IsaacReferencePointAPI schema to a prim.
- void isaacsim::robot::schema::ApplyRobotAPI(pxr::UsdPrim &prim)
Apply the IsaacRobotAPI schema to a prim.
- void isaacsim::robot::schema::ApplySiteAPI(pxr::UsdPrim &prim)
Apply the IsaacSiteAPI schema to a prim.
- pxr::UsdPrim isaacsim::robot::schema::CreateSurfaceGripper(pxr::UsdStagePtr stage, const std::string &primPath)
Create a Surface Gripper prim.
- std::shared_ptr< RobotLinkNode > isaacsim::robot::schema::GenerateRobotLinkTree(const pxr::UsdStagePtr &stage, const pxr::UsdPrim &robotLinkPrim)
Build a RobotLinkNode tree from a robot prim.
- std::vector< pxr::UsdPrim > isaacsim::robot::schema::GetAllRobotComponents(const pxr::UsdStagePtr &stage, const pxr::UsdPrim &robotPrim)
Collect every prim in a robot's subtree that applies an Isaac robot-schema API.
- std::vector< pxr::UsdPrim > isaacsim::robot::schema::GetAllRobotJoints(const pxr::UsdStagePtr &stage, const pxr::UsdPrim &robotLinkPrim, bool parseNestedRobots=true)
Gather all joint prims referenced by a robot prim.
- std::vector< pxr::UsdPrim > isaacsim::robot::schema::GetAllRobotLinks(const pxr::UsdStagePtr &stage, const pxr::UsdPrim &robotLinkPrim, bool includeReferencePoints=false)
Gather all link prims referenced by a robot prim.
- pxr::SdfPath isaacsim::robot::schema::GetJointBodyRelationship(const pxr::UsdPrim &jointPrim, int bodyIndex)
Obtain the path of a joint body relationship.
- std::optional< pxr::GfMatrix4d > isaacsim::robot::schema::GetJointPose(const pxr::UsdPrim &robotPrim, const pxr::UsdPrim &jointPrim)
Compute a joint pose relative to the robot prim.
- std::pair< std::vector< pxr::UsdPrim >, std::vector< pxr::UsdPrim > > isaacsim::robot::schema::GetLinksFromJoint(const std::shared_ptr< RobotLinkNode > &root, const pxr::UsdPrim &jointPrim)
Split links before and after a joint.
- std::unordered_map< std::string, std::string > isaacsim::robot::schema::GetRobotLinkParentMap(const pxr::UsdStagePtr &stage, const pxr::UsdPrim &robotPrim)
Build a child-link to parent-link path map from an
IsaacRobotAPIprim.- std::pair< pxr::UsdPrim, pxr::UsdPrim > isaacsim::robot::schema::PopulateRobotSchemaFromArticulation(const pxr::UsdStagePtr &stage, pxr::UsdPrim &robotPrim, pxr::UsdPrim articulationPrim)
Populate robot schema data from a physics articulation.
- void isaacsim::robot::schema::PrintRobotTree(const std::shared_ptr< RobotLinkNode > &root, std::size_t indent=0)
Print the link tree to stdout.
- void isaacsim::robot::schema::UpdateDeprecatedSchemas(pxr::UsdPrim &robotPrim)
Update deprecated schemas on a robot prim hierarchy.
- const pxr::TfToken isaacsim::robot::schema::className(Classes name)
Get the TfToken for a schema class.
- bool isaacsim::robot::schema::details::UpdateDeprecatedJointDofOrder(pxr::UsdPrim &jointPrim)
Update deprecated joint DOF order attributes.
- bool isaacsim::robot::schema::details::axisHasValidLimits(const pxr::UsdPrim &jointPrim, const pxr::TfToken &axisToken)
Check if a joint axis has valid limit values.
- std::vector< std::string > isaacsim::robot::schema::details::collectDeprecatedDofEntries(const pxr::UsdPrim &jointPrim)
Collect deprecated DOF entries from a joint prim.
- std::size_t isaacsim::robot::schema::details::computeFallbackOrder(const std::string &tokenName, int orderIndex)
Compute the fallback order index for a DOF token.
- bool isaacsim::robot::schema::details::isMultiAxisJoint(const pxr::UsdPrim &jointPrim)
Check if a joint prim is a multi-axis joint.
- pxr::TfToken isaacsim::robot::schema::getAttributeName(Attributes attr)
Get the full attribute name token for an attribute type.
- IsaacSimCommonLoggingHostResult isaacsimCommonLoggingAttachCarboniteHost(void *carboniteLogging, IsaacSimCommonLoggingHostToken *token)
Use an existing Carbonite logging interface without taking framework ownership.
- IsaacSimCommonLoggingConfigureResult isaacsimCommonLoggingConfigureGlobal(const IsaacSimCommonLoggingGlobalConfig *configuration)
Apply selected process-wide logging settings.
- IsaacSimCommonLoggingHostResult isaacsimCommonLoggingDetachCarboniteHost(IsaacSimCommonLoggingHostToken token)
Detach the borrowed Carbonite interface owned by
token.- void isaacsimCommonLoggingFlush(void)
Flush records currently pending in the process-wide Carbonite backend.
- IsaacSimCommonLoggingChannelConfig isaacsimCommonLoggingMakeChannelConfig(void)
Return an unchanged channel patch with the ABI size initialized.
- IsaacSimCommonLoggingGlobalConfig isaacsimCommonLoggingMakeGlobalConfig(void)
Return a zero-valued configuration patch with the ABI size initialized.
- void isaacsimCommonLoggingReport(const char *channel, const char *message, const char *file, const char *function, unsigned int line)
Print one channel-prefixed line to standard output and submit the message to Carbonite at INFO.
- void isaacsimCommonLoggingWrite(IsaacSimCommonLoggingLogLevel severity, const char *channel, const char *message, const char *file, const char *function, unsigned int line)
Submit an already formatted message to Carbonite.
- IsaacSimCommonProfilingHostResult isaacsimCommonProfilingAttachCarboniteHost(void *carboniteProfiler, IsaacSimCommonProfilingHostToken *token)
Attach an application-owned Carbonite
IProfiler.- IsaacSimCommonProfilingZone isaacsimCommonProfilingBegin(IsaacSimCommonProfilingMask mask, const char *name, const IsaacSimCommonProfilingSourceLocation *location)
Begin a CPU zone and return zero when profiling is disabled or the input is invalid.
- IsaacSimCommonProfilingHostResult isaacsimCommonProfilingDetachCarboniteHost(IsaacSimCommonProfilingHostToken token)
Detach the owned Carbonite profiler and close any remaining facade zones.
- void isaacsimCommonProfilingEnd(IsaacSimCommonProfilingZone zone)
End a zone returned by
isaacsimCommonProfilingBegin().- void isaacsimCommonProfilingFlow(IsaacSimCommonProfilingMask mask, uint32_t begin, uint64_t identifier, const char *name, const IsaacSimCommonProfilingSourceLocation *location)
Emit one endpoint of a cross-thread flow.
- void isaacsimCommonProfilingFrame(IsaacSimCommonProfilingMask mask, const char *name)
Emit a frame marker for the calling thread.
- uint32_t isaacsimCommonProfilingHasCarboniteHost(void)
Return whether an application currently owns the Carbonite profiler attachment.
- void isaacsimCommonProfilingInstant(IsaacSimCommonProfilingMask mask, int32_t type, const char *name, const IsaacSimCommonProfilingSourceLocation *location)
Emit an instant event.
- uint32_t isaacsimCommonProfilingIsEnabled(IsaacSimCommonProfilingMask mask)
Return whether the attached Carbonite profiler admits the selected mask.
- IsaacSimCommonProfilingSourceLocation isaacsimCommonProfilingMakeSourceLocation(void)
Create empty source metadata with the ABI size initialized.
- void isaacsimCommonProfilingSetThreadName(const char *name)
Assign a profiler-visible name to the calling thread.
- void isaacsimCommonProfilingValueFloat(IsaacSimCommonProfilingMask mask, const char *name, float value)
Emit a floating-point value.
- void isaacsimCommonProfilingValueInt(IsaacSimCommonProfilingMask mask, const char *name, int32_t value)
Emit a signed integer value.