core#
Fully qualified name: omni::graph::core
-
namespace core#
Classes#
- AttributeDataHandle
Object representing a handle to a variable AttributeData type.
- BundleHandle
Object representing a handle to an OmniGraph Bundle.
- ConstAttributeDataHandle
Object representing a handle to an AttributeData type.
- ConstBundleHandle
Object representing a handle to a constant OmniGraph Bundle.
- DataModelEditScope
Scoping object to enter and exist editing mode for the DataModel.
- HandleBase
Template class for defining handles to various OmniGraph data types.
- IBundle2_abi
Provide read write access to recursive bundles.
- IBundleFactory2_abi
IBundleFactory version 2.
- IBundleFactory_abi
Interface to create new bundles.
- IConstBundle2_abi
Provide read only access to recursive bundles.
- INodeCategories_abi
Interface to the list of categories that a node type can belong to.
- ISchedulingHints2_abi
Interface extension for ISchedulingHints that adds a new "pure" hint.
- ISchedulingHints_abi
Interface to the list of scheduling hints that can be applied to a node type.
- IVariable2_abi
Interface extension for IVariable that adds the ability to set a variable type.
- IVariable3_abi
Interface extension for IVariable that adds the ability to check if the variable is backed by Usd.
- IVariable_abi
Object that contains a value that is local to a graph, available from anywhere in the graph.
- NodeContextHandle
Object representing a handle to an OmniGraph NodeContext.
Enumerations#
- IGraphEvent
Defines the graph event types.
- IGraphRegistryEvent
An event that occurs on the graph registry.
- INodeEvent
Defines the node event types.
- eAccessLocation
What type of non-attribute data does this node access.
- eAccessType
How does the node access the data described by the enum eAccessLocation.
- eComputeRule
How the node is allowed to be computed.
- ePurityStatus
The purity of the node implementation. For some context, a "pure" node is one whose initialize, compute, and release methods are entirely deterministic, i.e. they will always produce the same output attribute values for a given set of input attribute values, and do not access, rely on, or otherwise mutate data external to the node's scope.
- eThreadSafety
How thread safe is the node during evaluation.
- eVariableScope
Scope in which the variable has been made available.
Functions#
- OMNI_DECLARE_INTERFACE(IBundle2)
Declare the IBundle2 interface definition.
- OMNI_DECLARE_INTERFACE(IBundleFactory)
- OMNI_DECLARE_INTERFACE(IBundleFactory2)
- OMNI_DECLARE_INTERFACE(IConstBundle2)
Declare the interface definition.
- OMNI_DECLARE_INTERFACE(INodeCategories)
Declare the INodeCategories interface definition.
- OMNI_DECLARE_INTERFACE(ISchedulingHints2)
Declare the ISchedulingHints2 interface definition.
- OMNI_DECLARE_INTERFACE(ISchedulingHints)
Declare the ISchedulingHints interface definition.
- OMNI_DECLARE_INTERFACE(IVariable2)
- OMNI_DECLARE_INTERFACE(IVariable3)
- OMNI_DECLARE_INTERFACE(IVariable)
Declare the IVariable interface definition.
Namespaces#
Structs#
- AttrKey
Handle type representing attributes, which require two parts to be valid.
- AttrKeyHash
Make sure to warn developer if an incompatibility is introduced.
- AttributeObj
Object representing an OmniGraph Attribute.
- ConnectionCallback
Callback object used when a connection is made or broken between two attributes.
- ConnectionInfo
Information passed to define the opposite end of a connection.
- ConstAttributeDataHandleHash
Hash definition so that AttributeDataHandle can be used in a map.
- ConstBundleHandleHash
Hash definition so that BundleHandle can be used in a map.
- CreateGraphAsNodeOptions
Parameters for IGraph::CreateGraphAsNode.
- ErrorStatusChangeCallback
Encapsulation of a callback that happens when a node's error status changes.
- FileFormatUpgrade
Callback object to instantiate for use as a callback when an older version of an OmniGraph file is read.
- FileFormatVersion
Encapsulates the information required to define a file format version number.
- GraphContextObj
Object representing an OmniGraph GraphContext.
- GraphInstanceID
Permanent value representing an instance.
- GraphObj
Object representing an OmniGraph Graph.
- IAttribute
Interface to provide functionality to access and modify properties of an OmniGraph attribute.
- IAttributeData
Interface to data belonging to a specific attribute.
- IAttributeType
Interface class managing various features of attribute types.
- IBundle
Interface for bundle attribute data.
- IDataModel
Interface to the underlying data access for OmniGraph.
- IGraph
Interface to an OmniGraph, several of which may be present in a scene.
- IGraphContext
Use this interface to pull data for compute node, and also push data to compute graph/cache.
- IGraphRegistry
Interface that manages the registration and deregistration of node types.
- INode
Interface to a single node in a graph.
- InstanceIndex
Temp value representing an instance during a compute or a loop.
- NodeObj
Object representing an OmniGraph Node.
- NodeTypeObj
Object representing an OmniGraph NodeType.
- OptionalMethod
Helper struct to make it easy to reference methods on a class that may or may not be defined.
- PathChangedCallback
Callback object used when a path has changed, requiring a path attribute update.
Typedefs#
- AttributeHandle
Handle to an OmniGraph Attribute.
- AttributeHash
Hash value type for OmniGraph Attributes.
- BucketId
Location of rows of data in Fabric.
- ConstPrimHandle
Deprecated - for backward compatibility only.
- ConstPrimHandleHash
Deprecated - for backward compatibility only.
- ConstRawPtr
Type for casting const byte arrays to actual values.
- CreateDbFunc
A callback allocate, initialize, and returns an OGN database for a given node.
- DataAccessFlags
Data type for specifying read/write access abilities.
- GraphContextHandle
Handle to an OmniGraph GraphContext.
- GraphHandle
- HandleInt
Underlying data type for a handle being represented as an integer.
- IVariablePtr
Data type to use for a reference to an IVariable interface definition.
- NameToken
Representation of a string that is referenced via a unique token. Note that although this token is reference counted this is the raw value which is not. Use ogn::Token at the high level to get that reference counting if you intend to hang on to copies of the token.
- NodeHandle
- NodeTypeHandle
Handle to an OmniGraph NodeType.
- ObjectId
Representation of an internal type used by AutoNode.
- PrimHandle
Deprecated - for backward compatibility only.
- RawPtr
Type for casting byte arrays to actual values.
- TargetPath
Representation of a path. Note that although this path is reference counted this is the raw value which is not. Use ogn::Path at the high level to get that reference counting if you intend to hang on to copies of the path.
- has_setContext
SFINAE function that will call setContext on an object if it exists as "void setContext(GraphContextObj&)".
- has_setHandle
SFINAE function that will call setHandle on an object if it exists as "void setHandle(GraphContextObj&)".
Variables#
- constexpr HandleInt INVALID_TOKEN_VALUE
Deprecated - use kInvalidTokenValue.
- constexpr InstanceIndex kAccordingToContextIndex
Special index for a context.
- constexpr InstanceIndex kAuthoringGraphIndex
Some default instance value.
- constexpr char kInstancingGraphTargetPath
The path used to identify the targeted prim, when graph instancing is used.
- constexpr AttributeHandle kInvalidAttributeHandle
Constant representing an invalid attribute handle.
- constexpr GraphContextHandle kInvalidGraphContextHandle
Constant representing an invalid graph context handle.
- constexpr GraphHandle kInvalidGraphHandle
Constant representing an invalid graph handle.
- constexpr HandleInt kInvalidHandleIntValue
Representation of an invalid handle as an integer.
- constexpr InstanceIndex kInvalidInstanceIndex
Special index indicating an invalid instance.
- constexpr NodeHandle kInvalidNodeHandle
Constant representing an invalid node handle.
- constexpr NodeTypeHandle kInvalidNodeTypeHandle
Constant representing an invalid node type handle.
- constexpr DataAccessFlags kReadAndWrite
Data is accessible for both read and write.
- constexpr DataAccessFlags kReadOnly
Data is only accessible for reading.
- constexpr GraphInstanceID kUninitializedGraphId
- constexpr uint8_t kUninitializedTypeCount
The value of an uninitialized attribute for a type (eg: tuple_count, array_depth)
- constexpr DataAccessFlags kWriteOnly
Data is only accessible for writing.