omni.graph.core

Submodules Summary:

omni.graph.core.typing

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

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

Functions Summary:

attribute_value_as_usd	Returns the value, converted into a type suitable for setting through the USD API compatible with
create_node_type	Decorator to transform a Python function into an OmniGraph node type definition.
data_shape_from_type	Return the dtype,shape information that corresponds to the given attribute type.
developer_mode_active	Check to see if AutoNode developer mode is active on the given extension:
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_attribute_plain_data	Is the given attribute numeric or string data?
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
create_prim_view_from_prims	create_prim_view_from_prims(prims: list) -> omni.graph.core._omni_graph_core.IPrimView
create_prim_view_from_query	create_prim_view_from_query(include: list, exclude: list = []) -> omni.graph.core._omni_graph_core.IPrimView
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_cuda_device	get_compute_cuda_device() -> int
get_compute_graph_contexts	get_compute_graph_contexts() -> List[omni.graph.core._omni_graph_core.GraphContext]
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(path: 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_node_type_forwarding_interface	get_node_type_forwarding_interface() -> omni::core::Api<omni::graph::core::unstable::INodeTypeForwarding_abi>
get_node_type_forwarding_interface2	get_node_type_forwarding_interface2() -> omni::core::Api<omni::graph::core::INodeTypeForwarding2_abi>
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_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