omni::graph::exec::unstable::INodeFactory

Defined in omni/graph/exec/unstable/INodeFactory.h

class INodeFactory : public omni::core::Generated<omni::graph::exec::unstable::INodeFactory_abi>

Factory interface for creating omni::graph::exec::unstable::INode objects.

Usually used in conjunction with omni::graph::exec::unstable::INodeGraphDef.

Factory objects are used by passes (e.g. omni::graph::exec::unstable::IPartitionPass) to create new nodes in a graph definition.

It is the responsibility of the factory to hold a reference to the created node. This reference is generally released when the graph is updated.

See omni::graph::exec::unstable::createNodeFactory() to generate one of these objects from an invocable object (e.g. std::function).

Public Functions

inline INode *createNode(const std::string &name, omni::core::ObjectParam<IDef> def) noexcept

Creates and returns a new node within the topology from which this factory was created.

The given node name must not be nullptr.

The given definition must be either nullptr, an instance of omni::graph::exec::unstable::INodeDef, or an instance of omni::graph::exec::unstable::INodeGraphDef.

It is the responsibility of the factory to hold a reference to the created node. This reference is generally released when the graph is updated.

The returned omni::graph::exec::unstable::INode will not have omni::core::IObject::acquire() called on it.

The returned pointer must not be nullptr.

Thread Safety

This method is not thread safe.

inline omni::graph::exec::unstable::INode *createNode(const char *name, omni::core::ObjectParam<omni::graph::exec::unstable::IDef> def) noexcept

Creates and returns a new node within the topology from which this factory was created.

The given node name must not be nullptr.

The given definition must be either nullptr, an instance of omni::graph::exec::unstable::INodeDef, or an instance of omni::graph::exec::unstable::INodeGraphDef.

It is the responsibility of the factory to hold a reference to the created node. This reference is generally released when the graph is updated.

The returned omni::graph::exec::unstable::INode will not have omni::core::IObject::acquire() called on it.

The returned pointer must not be nullptr.

Thread Safety

This method is not thread safe.

inline void *castWithoutAcquire(omni::core::TypeId id) noexcept

Casts this object to the type described the the given id.

Returns nullptr if the cast was not successful.

Unlike omni::core::IObject::cast(), this casting method does not call omni::core::IObject::acquire().

Thread Safety

This method is thread safe.

inline uint32_t getUseCount() noexcept

Returns the number of different instances (this included) referencing the current object.

Thread Safety

This method is thread safe.

inline void *cast(omni::core::TypeId id) noexcept

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety

This method is thread safe.

inline void acquire() noexcept

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

inline void release() noexcept

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

Protected Functions

virtual INode *createNode_abi(const char *name, IDef *def) noexcept = 0

Creates and returns a new node within the topology from which this factory was created.

The given node name must not be nullptr.

The given definition must be either nullptr, an instance of omni::graph::exec::unstable::INodeDef, or an instance of omni::graph::exec::unstable::INodeGraphDef.

It is the responsibility of the factory to hold a reference to the created node. This reference is generally released when the graph is updated.

The returned omni::graph::exec::unstable::INode will not have omni::core::IObject::acquire() called on it.

The returned pointer must not be nullptr.

Thread Safety

This method is not thread safe.

virtual void *castWithoutAcquire_abi(omni::core::TypeId id) noexcept = 0

Casts this object to the type described the the given id.

Returns nullptr if the cast was not successful.

Unlike omni::core::IObject::cast(), this casting method does not call omni::core::IObject::acquire().

Thread Safety

This method is thread safe.

virtual uint32_t getUseCount_abi() noexcept = 0

Returns the number of different instances (this included) referencing the current object.

Thread Safety

This method is thread safe.

virtual void *cast_abi(TypeId id) noexcept = 0

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety

This method is thread safe.

virtual void acquire_abi() noexcept = 0

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

virtual void release_abi() noexcept = 0

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.