Omniverse Kit API

Class Hierarchy

• • namespace omni
    • namespace graph
      • namespace core
        • namespace ogn
          • template struct is_array
          • template struct is_array< array< T > >
          • template struct is_array< base_array< T, HandleType > >
          • template struct is_array< const_array< T > >
          • template class array
          • template class base_array
          • template class base_string
          • template class const_array
          • class const_string
          • class NodeTypeABI
          • class OmniGraphDatabase
          • template class OmniGraphNode_ABI
          • class string
        • enum AttributePortType
        • enum eAccessLocation
        • enum eAccessType
        • enum eComputeRule
        • enum ePurityStatus
        • enum eThreadSafety
        • enum eVariableScope
        • enum ExecutionAttributeState
        • enum GraphBackingType
        • enum GraphEvaluationMode
        • enum GraphPipelineStage
        • enum IGraphEvent
        • enum IGraphRegistryEvent
        • enum INodeEvent
        • struct AttributeObj
        • struct AttrKeyHash
        • struct ConnectionCallback
        • struct ConnectionInfo
        • struct ConstAttributeDataHandleHash
        • struct ConstBundleHandleHash
        • struct CreateGraphAsNodeOptions
        • struct ErrorStatusChangeCallback
        • struct FileFormatUpgrade
        • struct FileFormatVersion
        • struct GraphContextObj
        • struct GraphObj
        • struct IAttribute
        • struct IAttributeData
        • struct IAttributeType
        • struct IBundle
        • struct IDataModel
        • struct IDataStealingPrototype
        • struct IGraph
        • struct IGraphContext
        • struct IGraphRegistry
        • struct INode
        • struct INodeType
        • struct InstanceIndex
        • struct IScheduleNode
        • struct NodeObj
        • struct NodeTypeObj
        • struct OptionalMethod
        • struct PathChangedCallback
        • struct ScheduleNodeObj
        • class AttributeDataHandle
        • class BundleHandle
        • class ConstAttributeDataHandle
        • class ConstBundleHandle
        • class DataModelEditScope
        • template class HandleBase
        • class IBundle2_abi
        • class IBundleFactory2_abi
        • class IBundleFactory_abi
        • class IConstBundle2_abi
        • class INodeCategories_abi
        • class ISchedulingHints2_abi
        • class ISchedulingHints_abi
        • class IVariable2_abi
        • class IVariable_abi
        • class NodeContextHandle
        • enum ConnectionType
        • enum ExtendedAttributeType

File Hierarchy

• • Directory omni
    • Directory graph
      • Directory core
        • Directory bundle
          • File IBundle1.h
          • File IBundle2.h
          • File IBundleFactory1.h
          • File IBundleFactory2.h
          • File IConstBundle2.h
        • Directory ogn
          • File array.h
          • File Database.h
          • File OmniGraphNodeABI.h
          • File string.h
        • File Handle.h
        • File iAttributeData.h
        • File IAttributeType.h
        • File iComputeGraph.h
        • File IDataModel.h
        • File IGraphRegistry.h
        • File INodeCategories.h
        • File ISchedulingHints.h
        • File ISchedulingHints2.h
        • File IVariable.h
        • File IVariable2.h
  • Directory rendering
    • Directory include
      • Directory omni
        • Directory fabric
          • File Type.h

Namespaces

• omni

• omni::core

• omni::graph

• omni::graph::core

• omni::graph::core::ogn

• std

Classes and Structs

• omni::graph::core::AttributeObj: Object representing an OmniGraph Attribute.

• omni::graph::core::AttrKeyHash: This is here so we can use AttrKey and omni::graph::core::ConstAttributeDataHandle as a key to std::unordered_map. There is another below in omni::graph::core::ConstAttributeDataHandleHash, intentionally the same as they represent the same data.

• omni::graph::core::ConnectionCallback: Callback object used when a connection is made or broken between two attributes.

• omni::graph::core::ConnectionInfo: Information passed to define the opposite end of a connection.

• omni::graph::core::ConstAttributeDataHandleHash: Hash definition so that omni::graph::core::AttributeDataHandle can be used in a map.

• omni::graph::core::ConstBundleHandleHash: Hash definition so that omni::graph::core::BundleHandle can be used in a map.

• omni::graph::core::CreateGraphAsNodeOptions: Parameters for IGraph::CreateGraphAsNode.

• omni::graph::core::ErrorStatusChangeCallback: Encapsulation of a callback that happens when a node’s error status changes.

• omni::graph::core::FileFormatUpgrade: Callback object to instantiate for use as a callback when an older version of an OmniGraph file is read.

• omni::graph::core::FileFormatVersion: Encapsulates the information required to define a file format version number.

• omni::graph::core::GraphContextObj: Object representing an OmniGraph GraphContext.

• omni::graph::core::GraphObj: Object representing an OmniGraph Graph.

• omni::graph::core::IAttribute: Interface to provide functionality to access and modify properties of an OmniGraph attribute.

• omni::graph::core::IAttributeData: Interface to data belonging to a specific attribute.

• omni::graph::core::IAttributeType: Interface class managing various features of attribute types.

• omni::graph::core::IBundle: Interface for bundle attribute data.

• omni::graph::core::IDataModel: Interface to the underlying data access for OmniGraph.

• omni::graph::core::IDataStealingPrototype: Retired prototype.

• omni::graph::core::IGraph: Interface to an OmniGraph, several of which may be present in a scene.

• omni::graph::core::IGraphContext: Use this interface to pull data for compute node, and also push data to compute graph/cache.

• omni::graph::core::IGraphRegistry: Interface that manages the registration and deregistration of node types.

• omni::graph::core::INode: Interface to a single node in a graph.

• omni::graph::core::INodeType: Each node type in a plugin must implement this interface.

• omni::graph::core::InstanceIndex: Value representing an instance.

• omni::graph::core::IScheduleNode: The underlying schedule node represents the scheduled task(s) corresponding to the representational node in the graph.

• omni::graph::core::NodeObj: Object representing an OmniGraph Node.

• omni::graph::core::NodeTypeObj: Object representing an OmniGraph NodeType.

• omni::graph::core::ogn::is_array: Default trait indicating if the class is one of our array types.

• omni::graph::core::ogn::is_array< array< T > >: Trait indicating that mutable templated types are array types.

• omni::graph::core::ogn::is_array< base_array< T, HandleType > >: Trait indicating that specific templated types are array types.

• omni::graph::core::ogn::is_array< const_array< T > >: Trait indicating that constant templated types are array types.

• omni::graph::core::OptionalMethod: Helper struct to make it easy to reference methods on a class that may or may not be defined.

• omni::graph::core::PathChangedCallback: Callback object used when a path has changed, requiring a path attribute update.

• omni::graph::core::ScheduleNodeObj: Object representing an OmniGraph ScheduleNode.

• omni::graph::core::AttributeDataHandle: Object representing a handle to a variable AttributeData type.

• omni::graph::core::BundleHandle: Object representing a handle to an OmniGraph Bundle.

• omni::graph::core::ConstAttributeDataHandle: Object representing a handle to an AttributeData type.

• omni::graph::core::ConstBundleHandle: Object representing a handle to a constant OmniGraph Bundle.

• omni::graph::core::DataModelEditScope: Scoping object to enter and exist editing mode for the DataModel.

• omni::graph::core::HandleBase: Template class for defining handles to various OmniGraph data types.

• omni::graph::core::IBundle2_abi: Provide read write access to recursive bundles.

• omni::graph::core::IBundleFactory2_abi: IBundleFactory version 2.

• omni::graph::core::IBundleFactory_abi: Interface to create new bundles.

• omni::graph::core::IConstBundle2_abi: Provide read only access to recursive bundles.

• omni::graph::core::INodeCategories_abi: Interface to the list of categories that a node type can belong to.

• omni::graph::core::ISchedulingHints2_abi: Interface extension for ISchedulingHints that adds a new “pure” hint.

• omni::graph::core::ISchedulingHints_abi: Interface to the list of scheduling hints that can be applied to a node type.

• omni::graph::core::IVariable2_abi: Interface extension for IVariable that adds the ability to set a variable type.

• omni::graph::core::IVariable_abi: Object that contains a value that is local to a graph, available from anywhere in the graph.

• omni::graph::core::NodeContextHandle: Object representing a handle to an OmniGraph NodeContext.

• omni::graph::core::ogn::array: std::vector-like wrapper class for array attribute data in the Ogn Database.

• omni::graph::core::ogn::base_array: std::span-like wrapper class for array attribute data in the Ogn Database.

• omni::graph::core::ogn::base_string: std::string_view-like wrapper class for string attribute data in the Ogn Database.

• omni::graph::core::ogn::const_array: std::vector-like wrapper class for constant array attribute data in the Ogn Database.

• omni::graph::core::ogn::const_string: std::string_view-like wrapper class for constant string attribute data in the Ogn Database.

• omni::graph::core::ogn::NodeTypeABI: Common base class for all node type implementation definitions, so that they can be in a common container.

• omni::graph::core::ogn::OmniGraphDatabase: Class defining the minimal amount of shared interface for the generated database interface classes.

• omni::graph::core::ogn::OmniGraphNode_ABI: ABI proxy class for OGN generated nodes.

• omni::graph::core::ogn::string: std::string_view-like class for string output attribute data in the Ogn Database.

Enums

• omni::graph::core::AttributePortType

• omni::graph::core::ConnectionType

• omni::graph::core::eAccessLocation

• omni::graph::core::eAccessType

• omni::graph::core::eComputeRule

• omni::graph::core::ePurityStatus

• omni::graph::core::eThreadSafety

• omni::graph::core::eVariableScope

• omni::graph::core::ExecutionAttributeState

• omni::graph::core::ExtendedAttributeType

• omni::graph::core::GraphBackingType

• omni::graph::core::GraphEvaluationMode

• omni::graph::core::GraphPipelineStage

• omni::graph::core::IGraphEvent

• omni::graph::core::IGraphRegistryEvent

• omni::graph::core::INodeEvent

Functions

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

• createAttributeMetadata: Create attribute metadata fields.

• createAttributeMetadata: Create attribute metadata field.

• createBundleMetadata: Create bundle metadata fields in this bundle.

• createBundleMetadata: Create bundle metadata field in this bundle.

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

• getAttributeMetadataCount: Return Number of metadata fields in the attribute.

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

• getBundleMetadataByName: Search for bundle metadata field based on provided name.

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

• getConstBundleMetadataByName: Search for field handles in this bundle by using field names.

• omni::graph::core::ogn::constructInputFromOutput

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• omni::graph::core::OMNI_DECLARE_INTERFACE

• removeAttributeMetadata: Remove attribute metadata fields.

• removeAttributeMetadata: Remove attribute metadata field.

• removeBundleMetadata: Remove bundle metadata based on provided field names.

• removeBundleMetadata: Remove bundle metadata based on provided field name.

Variables

• omni::graph::core::INVALID_TOKEN_VALUE

• omni::graph::core::kAccordingToContextIndex

• omni::graph::core::kAuthoringGraphIndex

• omni::graph::core::kInstancingGraphTargetPath

• omni::graph::core::kInvalidAttributeHandle

• omni::graph::core::kInvalidGraphContextHandle

• omni::graph::core::kInvalidGraphHandle

• omni::graph::core::kInvalidHandleIntValue

• omni::graph::core::kInvalidInstanceIndex

• omni::graph::core::kInvalidNodeHandle

• omni::graph::core::kInvalidNodeTypeHandle

• omni::graph::core::kInvalidScheduleNodeHandle

• omni::graph::core::kReadAndWrite

• omni::graph::core::kReadOnly

• omni::graph::core::kUninitializedTypeCount

• omni::graph::core::kWriteOnly

Defines

• COMPUTE_GRAPH_VERBOSE_LOGGING: If 1 then extra logging is enabled (which affects performance)

• kOgnMetadataAllowedTokens

• kOgnMetadataAllowedTokensRaw

• kOgnMetadataAllowMultiInputs

• kOgnMetadataCategories

• kOgnMetadataCategoryDescriptions

• kOgnMetadataCudaPointers

• kOgnMetadataDefault

• kOgnMetadataDescription

• kOgnMetadataExclusions

• kOgnMetadataExtension

• kOgnMetadataHidden

• kOgnMetadataIconBackgroundColor

• kOgnMetadataIconBorderColor

• kOgnMetadataIconColor

• kOgnMetadataIconPath

• kOgnMetadataInternal

• kOgnMetadataLanguage

• kOgnMetadataLiteralOnly

• kOgnMetadataMemoryType

• kOgnMetadataObjectId

• kOgnMetadataOptional

• kOgnMetadataOutputOnly

• kOgnMetadataTags

• kOgnMetadataTokens

• kOgnMetadataUiName

• kOgnMetadataUiType

• kOgnSingletonName

• OG_INVALID_HANDLE_INT_VALUE: Representation of an invalid handle as an integer.

• OGN_DBG

• RESOLVED_ATTRIBUTE_PREFIX: Deprecated, do not use.

• STRUCT_INTEGRITY_CHECK: Macro to validate the structure of the interface definitions.

Typedefs

• omni::graph::core::AttributeHandle

• omni::graph::core::AttributeHash

• omni::graph::core::AttrKey

• omni::graph::core::BucketId

• omni::graph::core::ConstPrimHandle

• omni::graph::core::ConstPrimHandleHash

• omni::graph::core::ConstRawPtr

• omni::graph::core::CreateDbFunc

• omni::graph::core::DataAccessFlags

• omni::graph::core::GraphContextHandle

• omni::graph::core::GraphHandle

• omni::graph::core::HandleInt

• omni::graph::core::has_setContext

• omni::graph::core::has_setHandle

• omni::graph::core::IVariablePtr

• omni::graph::core::NameToken

• omni::graph::core::NodeHandle

• omni::graph::core::NodeTypeHandle

• omni::graph::core::ObjectId

• omni::graph::core::ogn::DynamicInput

• omni::graph::core::ogn::DynamicOutput

• omni::graph::core::ogn::DynamicState

• omni::graph::core::ogn::has_addExtendedInput

• omni::graph::core::ogn::has_addExtendedOutput

• omni::graph::core::ogn::has_addExtendedState

• omni::graph::core::ogn::has_addInput

• omni::graph::core::ogn::has_addOutput

• omni::graph::core::ogn::has_addState

• omni::graph::core::ogn::has_addSubNodeType

• omni::graph::core::ogn::has_computeABI

• omni::graph::core::ogn::has_computeOGNT

• omni::graph::core::ogn::has_computeVectorizedABI

• omni::graph::core::ogn::has_computeVectorizedOGNT

• omni::graph::core::ogn::has_createNodeType

• omni::graph::core::ogn::has_getAllMetadata

• omni::graph::core::ogn::has_getMetadata

• omni::graph::core::ogn::has_getMetadataCount

• omni::graph::core::ogn::has_getNodeType

• omni::graph::core::ogn::has_getScheduleNodeCount

• omni::graph::core::ogn::has_getScheduleNodes

• omni::graph::core::ogn::has_getSubNodeType

• omni::graph::core::ogn::has_getTypeName

• omni::graph::core::ogn::has_hasState

• omni::graph::core::ogn::has_initialize

• omni::graph::core::ogn::has_initializeType

• omni::graph::core::ogn::has_inspect

• omni::graph::core::ogn::has_onConnectionTypeResolve

• omni::graph::core::ogn::has_registerTasks

• omni::graph::core::ogn::has_release

• omni::graph::core::ogn::has_setHasState

• omni::graph::core::ogn::has_setMetadata

• omni::graph::core::ogn::has_updateNodeVersion

• omni::graph::core::ogn::InputAttribute

• omni::graph::core::ogn::OmniGraphNodeDeregisterFn

• omni::graph::core::ogn::OmniGraphNodeRegisterAliasFn

• omni::graph::core::ogn::OmniGraphNodeRegisterFn

• omni::graph::core::ogn::OutputAttribute

• omni::graph::core::ogn::VariableAttribute

• omni::graph::core::PrimHandle

• omni::graph::core::RawPtr

• omni::graph::core::ScheduleNodeHandle

• omni::graph::core::TargetPath