GraphRegistry#

class omni.graph.core.GraphRegistry#

Bases: pybind11_object

Manager of the node types registered to OmniGraph.

Methods

__init__(self)

get_event_stream(self)

Get the event stream for the graph registry change notification.

get_node_type_version(self, node_type_name)

Finds the version number of the given node type.

inspect(self, inspector)

Runs the inspector on the graph registry

__init__(
self: omni.graph.core._omni_graph_core.GraphRegistry,
) None#
get_event_stream(
self: omni.graph.core._omni_graph_core.GraphRegistry,
) carb.events._events.IEventStream#

Get the event stream for the graph registry change notification.

The events that are raised are specified by GraphRegistryEvent. The payload for the added and removed events is the name of the node type being added or removed, and uses the key “node_type”.

Returns:

Event stream to monitor for graph registry changes

Return type:

carb.events.IEventStream

get_node_type_version(
self: omni.graph.core._omni_graph_core.GraphRegistry,
node_type_name: str,
) int#

Finds the version number of the given node type.

Parameters:

node_type_name (str) – Name of the node type to check

Returns:

Version number registered for the node type, None if it is not registered

Return type:

int

inspect(
self: omni.graph.core._omni_graph_core.GraphRegistry,
inspector: omni::core::Api<omni::inspect::IInspector_abi>,
) bool#

Runs the inspector on the graph registry

Parameters:

inspector (omni.inspect.Inspector) – The inspector to run

Returns:

True if the inspector was successfully run on the graph registry, False if it is not supported

Return type:

bool