omni::graph::core::IBundleFactory_abi

Defined in omni/graph/core/bundle/IBundleFactory1.h

Inheritance Relationships

Base Type

  • public omni::core::Inherits< omni::core::IObject, OMNI_TYPE_ID("omni.graph.core.IBundleFactory")>

class IBundleFactory_abi : public omni::core::Inherits<omni::core::IObject, OMNI_TYPE_ID("omni.graph.core.IBundleFactory")>

Interface to create new bundles.

Protected Functions

virtual omni::core::Result createBundles_abi(GraphContextObj const *const contextObj, fabric::PathC const *const paths, size_t pathCount, IBundle2 **const createdBundles) noexcept = 0

Create bundles at given paths and acquire instances of IBundle2 interface.

Parameters

  • contextObj – The context where bundles are created.

  • paths – Locations for new bundles.

  • pathCount – Length of paths array.

  • createdBundles – Output instances of IBundle2 interface.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getConstBundles_abi(GraphContextObj const *const contextObj, ConstBundleHandle const *const bundleHandles, size_t bundleCount, IConstBundle2 **const bundles) noexcept = 0

Acquire instances of IConstBundle2 interface from const bundle handles.

Parameters

  • contextObj – The context where bundles belong to.

  • bundleHandles – The bundle handles.

  • bundleCount – Length of bundleHandles array.

  • bundles – Output instances of IConstBundle2 interface.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.

virtual omni::core::Result getBundles_abi(GraphContextObj const *const contextObj, BundleHandle const *const bundleHandles, size_t bundleCount, IBundle2 **const bundles) noexcept = 0

Acquire instances of IBundle2 interface from bundle handles.

Parameters

  • contextObj – The context where bundles belong to.

  • bundleHandles – The bundle handles.

  • bundleCount – Length of bundleHandles array.

  • bundles – Output instances of IConstBundle2 interface.

Returns

Success if executed successfully, Fail for unsuccessful execution, InvalidArgument if arguments are invalid.