omni.graph.core Classes#

Classes Summary:

Attribute

An attribute, defining a data type and value that belongs to a node

AttributeData

Reference to data defining an attribute’s value

AttributeDataValueHelper

Class to manage getting and setting of omni.graph.core.AttributeData values.

AttributePortType

Port side of the attribute on its node

AttributeRole

Interpretation applied to the attribute data

AttributeType

Utilities for operating with the attribute data type class omni.graph.core.Type and related types

AttributeValueHelper

Class to manage getting and setting of Attribute values.

BaseDataType

Basic data type for attribute data

BucketId

internal Use only, and obsolete: This type was only useful for writing back to USD, which cannot be achieved anymore through this type.

Bundle

—– FOR USE BY GENERATED CODE ONLY —–

BundleChangeType

Enumeration representing the type of change that occurred in a bundle.

BundleChanges

—– FOR USE BY GENERATED CODE ONLY —–

BundleContainer

—– FOR USE BY GENERATED CODE ONLY —–

BundleContents

—– FOR USE BY GENERATED CODE ONLY —–

BundleWriteBlock

Creates a thread-local scope to ensure that each bundle

ComputeGraph

Main OmniGraph interface registered with the extension system

ConnectionInfo

Attribute and connection type in a given graph connection

ConnectionType

Type of connection)

Controller

Class to provide a simple interface to a variety OmniGraph manipulation functions.

DataView

Helper class for getting and setting attribute data values. The setting operation is undoable.

DataWrapper

Wrapper around typed memory data.

Database

Base class for the generated database class for .ogn nodes (Python and C++ implementations)

Device

Device type for memory location of the data types

Dtype

Common base type for dtypes, defining the members each needs to populate

DynamicAttributeAccess

Base class for the generated classes that contain the access properties for all attributes.

DynamicAttributeInterface

Class providing a container for dynamic attribute access interfaces.

ExecutionAttributeState

Current execution state of an attribute [DEPRECATED: See omni.graph.action.IActionGraph]

ExtendedAttributeType

Extended attribute type, if any

ExtensionInformation

Class that manages information about the relationships between nodes and node types, and extensions

FileFormatVersion

Version number for the OmniGraph file format

FunctionResult

Value indicating whether a function call succeeded

Graph

Object containing everything necessary to execute a connected set of nodes.

GraphBackingType

Location of the data backing the graph

GraphContext

Execution context for a graph

GraphController

Helper class that provides a simple interface to modifying the contents of a graph

GraphEvaluationMode

How the graph evaluation is scheduled

GraphEvent

Graph modification event.

GraphPipelineStage

Pipeline stage in which the graph lives

GraphRegistry

Manager of the node types registered to OmniGraph.

GraphRegistryEvent

Graph Registry modification event.

GraphSettings

Container for the set of settings in a graph. This is a class instead of a tuple so that future

IBundle2

Provide read write access to recursive bundles.

IBundleChanges

Interface for monitoring and handling changes in bundles and attributes.

IBundleFactory

Interface to create new bundles

IBundleFactory2

IBundleFactory version 2.

IConstBundle2

Provide read only access to recursive bundles.

INodeCategories

Interface to the list of categories that a node type can belong to

INodeTypeForwarding

@brief Interface that creates a forward on a request for a node type to a different node type

INodeTypeForwarding2

@brief Interface that creates a forward on a request for a node type to a different node type

IPrimView

PrimView is an interface that provides a view to a set of prims for use with OmniGraph instancing.

ISchedulingHints

Interface to the list of scheduling hints that can be applied to a node type

ISchedulingHints2

Interface extension for ISchedulingHints that adds a new “pure” hint

IVariable

Object that contains a value that is local to a graph, available from anywhere in the graph

MemoryType

Default memory location for an attribute or node’s data

Node

An element of execution within a graph, containing attributes and connected to other nodes

NodeController

Helper class that provides a simple interface to modifying the contents of a node

NodeEvent

Node modification event.

NodeType

Definition of a node’s interface and structure

NodeTypeConstructionError

Exception specific to caught errors in the node type construction process

ObjectLookup

Helper to extract OmniGraph types from various types of descriptions for them.

OmniGraphAttributeError

Exception to raise when an OmniGraph operation encountered an unrecognized or illegal attribute value

OmniGraphBindingError

Common base class for all non-exit exceptions.

OmniGraphError

Exception to raise when there is an error in an OmniGraph operation

OmniGraphInspector

Provides simple interfaces for inspection of OmniGraph objects

OmniGraphTypeError

Exception to raise when an OmniGraph operation encountered an unrecognized or illegal type

OmniGraphValueError

Exception to raise when an OmniGraph operation encountered an illegal value

PerNodeKeys

Set of key values for per-node data.

PtrToPtrKind

Memory type for the pointer to a GPU data array

ReadOnlyError

Exception to raise when there is a write operation on a read-only attribute (i.e. an input)

RuntimeAttribute

—– FOR USE BY GENERATED CODE ONLY —–

Settings

Class that packages up all of the OmniGraph settings handling into a common location. The settings themselves

Severity

Severity level of the log message

ThreadsafetyTestUtils

Utilities for Running Threadsafety Unit Tests from Python Generators for OG nodes

Type

Full definition of the data type owned by an attribute

TypedValue

Class that encapsulates an arbitrary value with an explicit data type. This can be used when the

WrappedArrayType

Enum for the type of array data returned from the get methods

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

eThreadSafety

How thread safe is the node during evaluation

eVariableScope

Scope in which the variable has been made available