Functions

omni::core::Result clearContents(bool bundleMetadata=true, bool attributes=true, bool childBundles=true) noexcept

Remove all attributes, child bundles and metadata from this bundle, but keep the bundle itself.

omni::graph::core::AttributeDataHandle createAttributeMetadata(omni::graph::core::NameToken attribute, omni::graph::core::NameToken fieldName, omni::graph::core::Type const &fieldType, size_t elementCount=0) noexcept

Create attribute metadata field.

omni::core::Result createAttributeMetadata(omni::graph::core::NameToken attribute, omni::graph::core::NameToken const *const fieldNames, omni::graph::core::Type const *const fieldTypes, size_t fieldCount, size_t const *const elementCount=nullptr, omni::graph::core::AttributeDataHandle *const attributeMetadata=nullptr, size_t *const createdCount=nullptr) noexcept

Create attribute metadata fields.

omni::core::ObjectPtr< omni::graph::core::IBundle2 > createBundle(omni::graph::core::GraphContextObj const &contextObj, omni::fabric::PathC path) noexcept

Create a single bundle at the given path and acquire an IBundle2 interface instance. This function is a convenience wrapper for creating individual bundles.

omni::graph::core::AttributeDataHandle createBundleMetadata(omni::graph::core::NameToken fieldName, omni::graph::core::Type const &fieldType, size_t elementCount=0) noexcept

Create bundle metadata field in this bundle.

omni::core::Result createBundleMetadata(omni::graph::core::NameToken const *const fieldNames, omni::graph::core::Type const *const fieldTypes, size_t fieldCount, size_t const *const elementCount=nullptr, omni::graph::core::AttributeDataHandle *const bundleMetadata=nullptr, size_t *const createdCount=nullptr) noexcept

Create bundle metadata fields in this bundle.

omni::graph::core::AttributeDataHandle getAttributeMetadataByName(omni::graph::core::NameToken attribute, omni::graph::core::NameToken fieldName) noexcept

Search for read-write metadata field handle for the attribute by using field name.

size_t getAttributeMetadataCount(omni::graph::core::NameToken attribute) noexcept

Return Number of metadata fields in the attribute.

omni::core::Result getAttributeMetadataNamesAndTypes(omni::graph::core::NameToken attribute, omni::graph::core::NameToken *const fieldNames, omni::graph::core::Type *const fieldTypes, size_t fieldCount) noexcept

Get the names and types of all attribute metadata fields in the attribute.

omni::core::ObjectPtr< omni::graph::core::IConstBundle2 > getBundle(omni::graph::core::GraphContextObj const &contextObj, omni::graph::core::ConstBundleHandle const &bundleHandle) noexcept

Acquire a single IConstBundle2 interface instance from a constant bundle handle. This function retrieves a read-only interface for a specific immutable bundle.

omni::core::ObjectPtr< omni::graph::core::IBundle2 > getBundle(omni::graph::core::GraphContextObj const &contextObj, omni::graph::core::BundleHandle const &bundleHandle) noexcept

Acquire a single IBundle2 interface instance from a bundle handle. This function retrieves a writable interface for a specific bundle.

omni::graph::core::AttributeDataHandle getBundleMetadataByName(omni::graph::core::NameToken fieldName) noexcept

Search for bundle metadata field based on provided name.

bool getBundles(omni::graph::core::GraphContextObj const &contextObj, omni::graph::core::BundleHandle const *const bundleHandles, size_t bundleCount, omni::core::ObjectPtr< omni::graph::core::IBundle2 > *const bundles) noexcept

Acquire IBundle2 interface instances from bundle handles. This overloaded function retrieves writable bundle interfaces for the provided handles.

bool getBundles(omni::graph::core::GraphContextObj const &contextObj, omni::graph::core::ConstBundleHandle const *const bundleHandles, size_t bundleCount, omni::core::ObjectPtr< omni::graph::core::IConstBundle2 > *const bundles) noexcept

Acquire IConstBundle2 interface instances from constant bundle handles. This overloaded function retrieves read-only interfaces for constant bundles.

omni::core::Result getChildBundle(size_t bundleIndex, omni::graph::core::BundleHandle *const bundle) noexcept

omni::graph::core::ConstAttributeDataHandle getConstAttributeMetadataByName(omni::graph::core::NameToken attribute, omni::graph::core::NameToken fieldName) noexcept

Search for read only field handles in the attribute by using field names.

omni::core::ObjectPtr< omni::graph::core::IConstBundle2 > getConstBundle(omni::graph::core::GraphContextObj const &contextObj, omni::graph::core::ConstBundleHandle const &bundleHandle) noexcept

Acquire a single IConstBundle2 interface instance from a constant bundle handle. This function retrieves a read-only interface for a specific bundle.

omni::graph::core::ConstAttributeDataHandle getConstBundleMetadataByName(omni::graph::core::NameToken fieldName) noexcept

Search for field handles in this bundle by using field names.

bool getConstBundles(omni::graph::core::GraphContextObj const &contextObj, BUNDLE_HANDLE const *const bundleHandles, size_t bundleCount, omni::core::ObjectPtr< omni::graph::core::IConstBundle2 > *const bundles) noexcept

Acquire IConstBundle2 interface instances from constant bundle handles. This function retrieves read-only bundle interfaces from the provided handles.

omni::core::Result getConstChildBundle(size_t bundleIndex, omni::graph::core::ConstBundleHandle *const bundle) noexcept

bool isBackedByUsd() noexcept

Returns whether the variable has an USD representation on the stage.

omni::graph::core::OMNI_DECLARE_INTERFACE(IBundle2)

Declare the IBundle2 interface definition.

omni::graph::core::OMNI_DECLARE_INTERFACE(IBundleFactory)

omni::graph::core::OMNI_DECLARE_INTERFACE(IBundleFactory2)

omni::graph::core::OMNI_DECLARE_INTERFACE(IConstBundle2)

Declare the interface definition.

omni::graph::core::OMNI_DECLARE_INTERFACE(INodeCategories)

Declare the INodeCategories interface definition.

omni::graph::core::OMNI_DECLARE_INTERFACE(ISchedulingHints2)

Declare the ISchedulingHints2 interface definition.

omni::graph::core::OMNI_DECLARE_INTERFACE(ISchedulingHints)

Declare the ISchedulingHints interface definition.

omni::graph::core::OMNI_DECLARE_INTERFACE(IVariable2)

omni::graph::core::OMNI_DECLARE_INTERFACE(IVariable3)

omni::graph::core::OMNI_DECLARE_INTERFACE(IVariable)

Declare the IVariable interface definition.

ogn::RuntimeAttribute< ogn::kOgnInput, MemoryType > omni::graph::core::ogn::constructInputFromOutput(OmniGraphDatabase const &db, ogn::RuntimeAttribute< ogn::kOgnOutput, MemoryType > const &output, NameToken outputToken)

Creates an input RuntimeAttribute from an output RuntimeAttribute.

omni::core::Result removeAttributeMetadata(omni::graph::core::NameToken attribute, omni::graph::core::NameToken fieldName) noexcept

Remove attribute metadata field.

omni::core::Result removeAttributeMetadata(omni::graph::core::NameToken attribute, omni::graph::core::NameToken const *const fieldNames, size_t fieldCount, size_t *const removedCount=nullptr) noexcept

Remove attribute metadata fields.

omni::core::Result removeBundleMetadata(omni::graph::core::NameToken fieldName) noexcept

Remove bundle metadata based on provided field name.

omni::core::Result removeBundleMetadata(omni::graph::core::NameToken const *const fieldNames, size_t fieldCount, size_t *const removedCount=nullptr) noexcept

Remove bundle metadata based on provided field names.