omni.graph.core

Submodules Summary:

omni.graph.core.autonode

AutoNode - module for decorating code to populate it into OmniGraph nodes.

omni.graph.core.typing

OmniGraph submodule that handles all of the OmniGraph API typing information.

Classes Summary:

Attribute

AttributeData

AttributeDataValueHelper

Class to manage getting and setting of og.AttributeData values.

AttributePortType

Members:

AttributeRole

Members:

AttributeType

AttributeValueHelper

Class to manage getting and setting of og.Attribute values.

BaseDataType

Members:

BucketId

Bundle

Deferred implementation of the bundle concept

BundleContainer

——– FOR GENERATED CODE USE ONLY ——–

BundleContents

Manage the allowed types of attributes, providing a static set of convenience values

ComputeGraph

ConnectionInfo

ConnectionType

Members:

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

Members:

ExtendedAttributeType

Members:

ExtensionInformation

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

FileFormatVersion

Graph

GraphBackingType

Members:

GraphContext

GraphController

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

GraphEvaluationMode

Members:

GraphEvent

Graph modification event.

GraphPipelineStage

Members:

GraphRegistry

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.

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

ISchedulingHints

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

IVariable

MemoryType

Members:

Node

NodeController

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

NodeEvent

Node modification event.

NodeType

ObjectLookup

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

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

OmniGraphValueError

Exception to raise when an OmniGraph operation encountered an illegal value

PerNodeKeys

Set of key values for per-node data.

PtrToPtrKind

Members:

PyTorchTensorDouble

PyTorchTensorFloat

ReadOnlyError

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

RuntimeAttribute

Settings

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

Severity

Members:

ThreadsafetyTestUtils

Type

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

eThreadSafety

How thread safe is the node during evaluation

eVariableScope

Members:

Functions Summary:

attribute_value_as_usd

Returns the value, converted into a type suitable for setting through the USD API compatible with

data_shape_from_type

Return the dtype,shape information that corresponds to the given attribute type.

get_graph_settings

Return the current settings for the graph. This is just a copy of the settings. Changing it will not

get_kit_version

Returns the currently running version of Kit as a tuple of (major, minor) numbers.

get_port_type_namespace

Returns a string representing the namespace attributes of the named port type reside in

in_compute

Mark block of code executed at runtime. Optimizations can apply like setting values without undo support.

is_in_compute

Mark entry of OmniGraph runtime computation.

python_value_as_usd

Converts the given python value to the equivalent USD value

resolve_base_coupled

Resolves attribute types given a set of attributes, that can have differing tuple counts and/or array depth,

resolve_fully_coupled

Resolves attribute types given a set of attributes which are fully type coupled.

traverse_downstream_graph

Traverses the nodes downstream from the input nodes and apply the predicate on visited nodes.

traverse_upstream_graph

Traverses the nodes upstream from the input nodes and apply the predicate on visited nodes.

acquire_interface

acquire_interface(plugin_name: str = None, library_path: str = None) -> omni.graph.core._omni_graph_core.ComputeGraph

attach

attach(stage_id: int, mps: float) -> None

deregister_node_type

deregister_node_type(name: str) -> bool

deregister_post_load_file_format_upgrade_callback

deregister_post_load_file_format_upgrade_callback(postload_handle: int) -> None

deregister_pre_load_file_format_upgrade_callback

deregister_pre_load_file_format_upgrade_callback(preload_handle: int) -> None

detach

detach() -> None

get_all_graphs

get_all_graphs() -> List[omni.graph.core._omni_graph_core.Graph]

get_all_graphs_and_subgraphs

get_all_graphs_and_subgraphs() -> List[omni.graph.core._omni_graph_core.Graph]

get_bundle_tree_factory_interface

get_bundle_tree_factory_interface() -> omni.graph.core._omni_graph_core.IBundleFactory

get_compute_graph_contexts

get_compute_graph_contexts() -> List[omni.graph.core._omni_graph_core.GraphContext]

get_current_graph

get_current_graph() -> omni.graph.core._omni_graph_core.Graph

get_global_container_graphs

get_global_container_graphs() -> List[omni.graph.core._omni_graph_core.Graph]

get_global_orchestration_graphs

get_global_orchestration_graphs() -> List[omni.graph.core._omni_graph_core.Graph]

get_global_orchestration_graphs_in_pipeline_stage

get_global_orchestration_graphs_in_pipeline_stage(pipeline_stage: omni.graph.core._omni_graph_core.GraphPipelineStage) -> List[omni.graph.core._omni_graph_core.Graph]

get_graph_by_path

get_graph_by_path(path: str) -> object

get_graphs_in_pipeline_stage

get_graphs_in_pipeline_stage(pipeline_stage: omni.graph.core._omni_graph_core.GraphPipelineStage) -> List[omni.graph.core._omni_graph_core.Graph]

get_node_by_path

get_node_by_path(arg0: str) -> object

get_node_categories_interface

get_node_categories_interface() -> omni.graph.core._omni_graph_core.INodeCategories

get_node_type

get_node_type(node_type_name: str) -> omni.graph.core._omni_graph_core.NodeType

get_registered_nodes

get_registered_nodes() -> List[str]

is_global_graph_prim

is_global_graph_prim(prim_path: str) -> bool

on_shutdown

on_shutdown() -> None

register_node

register_node(name: object, version: int) -> None

register_node_type

register_node_type(name: object, version: int) -> None

register_post_load_file_format_upgrade_callback

register_post_load_file_format_upgrade_callback(callback: object) -> int

register_pre_load_file_format_upgrade_callback

register_pre_load_file_format_upgrade_callback(callback: object) -> int

register_python_node

register_python_node() -> None

release_interface

release_interface(arg0: omni.graph.core._omni_graph_core.ComputeGraph) -> None

set_test_failure

set_test_failure(has_failure: bool) -> None

shutdown_compute_graph

shutdown_compute_graph() -> None

test_failure_count

test_failure_count() -> int

update

update(current_time: float, elapsed_time: float) -> None