Python API Docs

class omni.graph.core.Attribute

Bases: pybind11_builtins.pybind11_object

connect(self: omni.graph.core.bindings._omni_graph_core.Attribute, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool)bool

Connects this attribute with another attribute.

disconnect(self: omni.graph.core.bindings._omni_graph_core.Attribute, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool)bool

Disconnects this attribute with another attribute.

get_all_metadata(self: omni.graph.core.bindings._omni_graph_core.Attribute)dict

Returns a dictionary of metadata on the attribute.

get_downstream_connection_count(self: omni.graph.core.bindings._omni_graph_core.Attribute)int

Returns the number of downstream connections for this attribute.

get_downstream_connections(self: omni.graph.core.bindings._omni_graph_core.Attribute) → List[omni.graph.core.bindings._omni_graph_core.Attribute]

Returns the list of upstream connections for this attribute.

get_metadata(self: omni.graph.core.bindings._omni_graph_core.Attribute, arg0: str)str

Returns the metadata value for the given key.

Parameters

arg0 (str) – The metadata keyword

Returns

Metadata value for the given keyword, or None if it is not defined

Return type

(str)

get_metadata_count(self: omni.graph.core.bindings._omni_graph_core.Attribute)int

Returns the number of metadata values currently defined on the attribute.

get_name(self: omni.graph.core.bindings._omni_graph_core.Attribute)str

Returns the name of the current attribute.

get_node(self: omni.graph.core.bindings._omni_graph_core.Attribute) → omni::graph::core::Py_Node

Returns the node associated with the attribute.

get_type_name(self: omni.graph.core.bindings._omni_graph_core.Attribute)str

Returns the type name of the current attribute.

get_upstream_connection_count(self: omni.graph.core.bindings._omni_graph_core.Attribute)int

Returns the number of upstream connections for this attribute.

get_upstream_connections(self: omni.graph.core.bindings._omni_graph_core.Attribute) → List[omni.graph.core.bindings._omni_graph_core.Attribute]

Returns the list of upstream connections for this attribute.

is_connected(self: omni.graph.core.bindings._omni_graph_core.Attribute, arg0: omni.graph.core.bindings._omni_graph_core.Attribute)bool

Returns whether this attribute is connected to another.

is_valid(self: omni.graph.core.bindings._omni_graph_core.Attribute)bool

Returns whether the current attribute is valid.

set_metadata(self: omni.graph.core.bindings._omni_graph_core.Attribute, arg0: str, arg1: str)bool

Sets the metadata value for the given key.

Parameters
  • arg0 (str) – The metadata keyword

  • arg1 (str) – The value of the metadata

update_attribute_value(self: omni.graph.core.bindings._omni_graph_core.Attribute, arg0: bool)bool

Requests the value of an attribute. In the cases of lazy evaluation systems, this generates the “pull” that causes the attribute to update its value.

Parameters

arg0 (bool) – Whether to update the attribute value immediately. If True, the function will block until the attribute is update and then return. If False, the attribute will be updated in the next update loop.

Returns

The value of the attribute (Any)

class omni.graph.core.ComputeGraph

Bases: pybind11_builtins.pybind11_object

class omni.graph.core.Graph

Bases: pybind11_builtins.pybind11_object

create_node(self: omni.graph.core.bindings._omni_graph_core.Graph, arg0: str, arg1: str, arg2: bool) → omni.graph.core.bindings._omni_graph_core.Node

Given the path to the node and the type of the node, creates a node of that type at that path.

Parameters
  • arg0 (str) – The path to the node

  • arg1 (str) – The type of the node

  • arg2 (bool) – Whether or not to create the USD backing for the node

destroy_node(self: omni.graph.core.bindings._omni_graph_core.Graph, arg0: str, arg1: bool)bool

Given the path to the node, destroys the node at that path.

Parameters
  • arg0 (str) – The path to the node

  • arg1 (bool) – Whether or not to destroy the USD backing for the node

get_default_graph_context(self: omni.graph.core.bindings._omni_graph_core.Graph) → omni::graph::core::Py_GraphContext

Returns default graph context associated with this graph.

get_node(self: omni.graph.core.bindings._omni_graph_core.Graph, arg0: str) → omni.graph.core.bindings._omni_graph_core.Node

Given a path to the node, returns the object for the node.

Parameters

arg0 (str) – The path to the node

Returns

Node object for the given path, None if it does not exist

Return type

(omni.graph.core.Node)

get_nodes(self: omni.graph.core.bindings._omni_graph_core.Graph) → List[omni.graph.core.bindings._omni_graph_core.Node]

Returns a list of the nodes in this graph.

get_path_to_graph(self: omni.graph.core.bindings._omni_graph_core.Graph)str

Returns the path to the graph (may be empty).

get_subgraphs(self: omni.graph.core.bindings._omni_graph_core.Graph) → List[omni.graph.core.bindings._omni_graph_core.Graph]

Returns a list of the subgraphs contained in this graph.

is_disabled(self: omni.graph.core.bindings._omni_graph_core.Graph)bool

Returns whether this graph object is disabled.

is_valid(self: omni.graph.core.bindings._omni_graph_core.Graph)bool

Returns whether this graph object is valid or not.

print_diagnostic(self: omni.graph.core.bindings._omni_graph_core.Graph)None

Prints out the graph in text form for inspection of its state.

rename_node(self: omni.graph.core.bindings._omni_graph_core.Graph, arg0: str, arg1: str)bool

Given the path to the node, renames the node at that path.

Parameters
  • arg0 (str) – The path to the node

  • arg1 (str) – The new path

set_disabled(self: omni.graph.core.bindings._omni_graph_core.Graph, arg0: bool)None

Sets whether this graph object is to be disabled or not.

class omni.graph.core.GraphContext

Bases: pybind11_builtins.pybind11_object

get_attribute_as_bool(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)bool

Return the value of a boolean attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(bool)

get_attribute_as_boolarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[bool]

Return the value of a bool array attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[int])

get_attribute_as_double(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)float

Return the value of a double attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(float)

get_attribute_as_doublearray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[float64]

Return the value of a double array attribute.

Parameters
Returns

Value of the attribute

Return type

(numpy.array[float])

get_attribute_as_doublearray_tensor(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int) → PyTorchTensor<double>

Return the value of a double array attributein tensor form.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not the tensor is on the GPU

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(PyTorch[float])

get_attribute_as_float(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)float

Return the value of a float attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(float)

get_attribute_as_floatarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[float32]

Return the value of a float array attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[float])

get_attribute_as_floatarray_tensor(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int) → PyTorchTensor<float>

Return the value of a float array attribute in tensor form.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not the tensor is on the GPU

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(PyTorch[float])

get_attribute_as_half(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)float

Return the value of a half-precision float attribute

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute as a float

Return type

(float)

get_attribute_as_halfarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[float32]

Set the value of an attribute that is an array of half-precision floats.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[float])

get_attribute_as_int(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int)int

Return the value of an integer attribute

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value.

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(int)

get_attribute_as_int64(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)int

Return the value of a 64-bit integer attribute

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value.

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(int)

get_attribute_as_int64array(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[int64]

Return the value of a 64-bit integer array attribute.

Parameters
Returns

Value of the attribute

Return type

(numpy.array[int])

get_attribute_as_intarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int) → numpy.ndarray[int32]

Return the value of an integer array attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[int])

get_attribute_as_intarray_tensor(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int) → PyTorchTensor<int>

Return the value of an integer array attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[int])

get_attribute_as_nested_doublearray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[float64]

Return the value of a double array having a component count greater than 1 (e.g. double[3]).

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[double][double])

get_attribute_as_nested_doublearray_tensor(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int) → PyTorchTensor<double>

Return the value of a double array having a component count greater than 1 (e.g. double[3]) as a tensor.

Parameters

arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

Returns

Value of the attribute

Return type

(PyTorch[double][double])

get_attribute_as_nested_floatarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[float32]

Return the value of a float array having a component count greater than 1 (e.g. float[3]).

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[float][float])

get_attribute_as_nested_floatarray_tensor(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int) → PyTorchTensor<float>

Return the value of a float array having a component count greater than 1 (e.g. float[3]) as a tensor.

Parameters

arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

Returns

Value of the attribute

Return type

(PyTorch[float][float])

get_attribute_as_nested_halfarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[float32]

Return the value of a half-precision float array having a component count greater than 1 (e.g. half[3]).

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[float][float])

get_attribute_as_nested_intarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[int32]

Return the value of a int array having a component count greater than 1 (e.g. int[3]).

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[int][int])

get_attribute_as_nested_intarray_tensor(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute, arg1: bool, arg2: bool, arg3: int) → PyTorchTensor<int>

Return the value of a int array having a component count greater than 1 (e.g. int[3]) as a tensor.

Parameters

arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

Returns

Value of the attribute

Return type

(PyTorch[float][float])

get_attribute_as_string(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)str

Return the value of a string attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(str)

get_attribute_as_stringlist(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)list

Return the value of a string list attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

list(str)

get_attribute_as_uchar(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)int

Return the value of an unsigned char attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(int)

get_attribute_as_uchararray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[uint8]

Return the value of an unsigned char array attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[int])

get_attribute_as_uint(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)int

Return the value of an unsigned integer attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(int)

get_attribute_as_uint64(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0)int

Return the value of an unsigned 64-bit integer attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(int)

get_attribute_as_uint64array(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[uint64]

Return the value of an unsigned 64-bit integer array attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[int])

get_attribute_as_uintarray(self: omni.graph.core.bindings._omni_graph_core.GraphContext, attribute: omni.graph.core.bindings._omni_graph_core.Attribute, getDefault: bool = False, write: bool = False, writeElemCount: int = 0) → numpy.ndarray[uint32]

Return the value of an unsigned integer array attribute.

Parameters
  • arg0 (omni.graph.core.Attribute) – The attribute whose value is to be retrieved

  • arg1 (bool) – Whether or not to get the default value

  • arg2 (bool) – Whether or not to get the value for writing

  • arg3 (int) – Number of elements to be written, if getting the value for writing

Returns

Value of the attribute

Return type

(numpy.array[int])

get_elem_count(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: omni.graph.core.bindings._omni_graph_core.Attribute)int

Get the number of elements in an array attribute.

Parameters

arg0 (omni.graph.core.Attribute) – the attribute identifying the location

Returns

The number of elements in the array attribute

Return type

(int)

get_graph(self: omni.graph.core.bindings._omni_graph_core.GraphContext) → omni.graph.core.bindings._omni_graph_core.Graph

Returns the graph associated with this graph context.

is_valid(self: omni.graph.core.bindings._omni_graph_core.GraphContext)bool

Returns whether this compute graph context object is valid or not.

set_bool_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: bool, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a boolean attribute.

Parameters
set_boolarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[bool], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a bool array attribute.

Parameters
set_double_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: float, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a double attribute.

Parameters
set_double_matrix_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[float], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a double matrix attribute The length of the list must match the expected type. For matrix2d, it’s 4, for matrix3d it’s 9, and for matrix4d, it’s 16

Parameters
  • arg0 (List, numpy.array) – The list of values in row major format representing a matrix to set

  • arg1 (omni.graph.core.Attribute) – the attribute identifying the location

set_doublearray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[float], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a double array attribute.

Args :

arg0: The list of values to set arg1(omni.graph.core.Attribute): the attribute identifying the location

set_float_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: float, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a float attribute.

Parameters
set_floatarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[float], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a float array attribute.

Parameters
set_half_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: float, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a half-precision float attribute.

Parameters
set_halfarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[float], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a half-precision float array attribute.

Parameters
set_int64_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: int, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a 64-bit integer attribute.

Parameters
set_int64array_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[int], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a 64-bit integer array attribute.

Parameters
set_int_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: int, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an integer attribute.

Parameters
set_intarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[int], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an integer array attribute.

Parameters
set_nested_doublearray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[List[float]], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a double array attribute with component count > 1 (e.g. double[3]).

Parameters
  • arg0 (List, numpy.array) – The list of nested values to set (array of array of 3 elements, for example)

  • arg1 (omni.graph.core.Attribute) – the attribute identifying the location

set_nested_floatarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[List[float]], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a float array attribute with component count > 1 (e.g. float[3]).

Parameters
  • arg0 (List, numpy.array) – The list of nested values to set (array of array of 3 elements, for example)

  • arg1 (omni.graph.core.Attribute) – the attribute identifying the location

set_nested_halfarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[List[float]], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a half-precision float array attribute with component count > 1 (e.g. half[3]).

Parameters
  • arg0 (List, numpy.array) – The list of nested values to set (array of array of 3 elements, for example)

  • arg1 (omni.graph.core.Attribute) – the attribute identifying the location

set_nested_intarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[List[int]], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an integer array attribute.

Parameters
set_string_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: str, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a string attribute.

Parameters
set_stringarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[str], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a string array attribute.

Parameters
set_uchar_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: int, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an unsigned char attribute.

Parameters
set_uchararray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[int], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an unsigned char array attribute.

Parameters
set_uint64_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: int, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an unsigned 64-bit integer attribute.

Parameters
set_uint64array_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[int], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of a 64-bit unsigned integer array attribute.

Parameters
set_uint_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: int, arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an unsigned integer attribute.

Parameters
set_uintarray_attribute(self: omni.graph.core.bindings._omni_graph_core.GraphContext, arg0: List[int], arg1: omni.graph.core.bindings._omni_graph_core.Attribute)None

Set the value of an unsigned integer array attribute.

Parameters
class omni.graph.core.Node

Bases: pybind11_builtins.pybind11_object

create_float_attribute(self: omni.graph.core.bindings._omni_graph_core.Node, arg0: str, arg1: float)bool

Creates a float attribute with the specified name and value and returns success state.

Parameters
  • arg0 (str) – Name of the attribute.

  • arg1 (float) – Value of the float attribute.

Returns

(bool) True if the creation was successful, else False

get_attribute(self: omni.graph.core.bindings._omni_graph_core.Node, arg0: str) → omni.graph.core.bindings._omni_graph_core.Attribute

Given the name of an attribute returns an attribute object to it.

Parameters

arg0 (str) – The name of the attribute

Returns

Attribute with the given name, or None if it does not exist on the node

Return type

(omni.graph.core.Attribute)

get_attribute_exists(self: omni.graph.core.bindings._omni_graph_core.Node, arg0: str)bool

Given an attribute name, returns whether this attribute exists or not.

Parameters

arg0 (str) – The name of the attribute

Returns

(bool) True if the attribute exists on this node, else False

get_attributes(self: omni.graph.core.bindings._omni_graph_core.Node) → List[omni.graph.core.bindings._omni_graph_core.Attribute]

Returns the list of attributes on this node.

get_graph(self: omni.graph.core.bindings._omni_graph_core.Node) → omni::graph::core::Py_Graph

Returns the graph associated with the current node

get_prim_path(self: omni.graph.core.bindings._omni_graph_core.Node)str

Returns the path to the prim currently backing the node.

get_python_type_name(self: omni.graph.core.bindings._omni_graph_core.Node)str

For Python nodes only, returns the python type name of the node

get_type_name(self: omni.graph.core.bindings._omni_graph_core.Node)str

Returns the type name of the current node.

is_backed_by_usd(self: omni.graph.core.bindings._omni_graph_core.Node)bool

Returns whether the current node is by an USD prim on the stage.

is_disabled(self: omni.graph.core.bindings._omni_graph_core.Node)bool

Returns whether the current node is disabled.

is_valid(self: omni.graph.core.bindings._omni_graph_core.Node)bool

Returns whether the current node is valid or not.

remove_attribute(self: omni.graph.core.bindings._omni_graph_core.Node, arg0: str, arg1: str)bool

Removes an attribute with the specified name and type and returns success state.

Parameters
  • arg0 (str) – Name of the attribute.

  • arg1 (str) – Typename of the attribute.

Returns

True if the removal was successful, else False

Return type

(bool)

set_disabled(self: omni.graph.core.bindings._omni_graph_core.Node, arg0: bool)None

Sets whether the current node is disabled or not.

Parameters

arg0 (bool) – True for disabled, False for not.

class omni.graph.core.NodeType

Bases: pybind11_builtins.pybind11_object

add_input(self: omni.graph.core.bindings._omni_graph_core.NodeType, arg0: str, arg1: str, arg2: bool)None

Adds an input to this node type. Every node of this node type would then have this input.

Parameters
  • arg0 (str) – The name of the input

  • arg1 (str) – The type name of the input

  • arg2 (bool) –

add_output(self: omni.graph.core.bindings._omni_graph_core.NodeType, arg0: str, arg1: str, arg2: bool)None

Adds an output to this node type. Every node of this node type would then have this output.

Parameters
  • arg0 (str) – The name of the output

  • arg1 (str) – The type name of the output

  • arg2 (bool) –

add_state(self: omni.graph.core.bindings._omni_graph_core.NodeType, arg0: str, arg1: str, arg2: bool)None

Adds an state to this node type. Every node of this node type would then have this state.

Parameters
  • arg0 (str) – The name of the state

  • arg1 (str) – The type name of the state

  • arg2 (bool) –

get_all_metadata(self: omni.graph.core.bindings._omni_graph_core.NodeType)dict

Returns a dictionary of metadata on the node type.

get_metadata(self: omni.graph.core.bindings._omni_graph_core.NodeType, arg0: str)str

Returns the metadata value for the given key.

Parameters

arg0 (str) – The metadata keyword

Returns

Metadata value for the given keyword, or None if it is not defined

Return type

(str)

get_metadata_count(self: omni.graph.core.bindings._omni_graph_core.NodeType)int

Returns the number of metadata values currently defined on the node type.

get_node_type(self: omni.graph.core.bindings._omni_graph_core.NodeType)str

Returns the name of the node type.

has_state(self: omni.graph.core.bindings._omni_graph_core.NodeType)bool

Returns True if the node has internal state data, False if not.

set_metadata(self: omni.graph.core.bindings._omni_graph_core.NodeType, arg0: str, arg1: str)bool

Sets the metadata value for the given key.

Parameters
  • arg0 (str) – The metadata keyword

  • arg1 (str) – The value of the metadata

class omni.graph.core.PlugFlags(self: omni.graph.core.bindings._omni_graph_core.PlugFlags, arg0: int)None

Bases: pybind11_builtins.pybind11_object

Members:

PLUG_FLAG_NONE

PLUG_FLAG_FOLLOW_UPSTREAM

PLUG_FLAG_FOLLOW_UPSTREAM = PlugFlags.PLUG_FLAG_FOLLOW_UPSTREAM
PLUG_FLAG_NONE = PlugFlags.PLUG_FLAG_NONE
property name

handle) -> str

Type

(self

class omni.graph.core.PublicExtension(self: omni.ext._extensions.IExt)None

Bases: omni.ext._extensions.IExt

Mandatory extension instantiation required by the Carbonite extension handler

on_shutdown()

Shutting down this part of the extension prepares it for hot reload

on_startup()

Set up initial conditions for the Python part of the extension

class omni.graph.core.PyTorchTensorDouble(self: omni.graph.core.bindings._omni_graph_core.PyTorchTensorDouble)None

Bases: pybind11_builtins.pybind11_object

property data_ptr
property device
property dtype
property ndim
property shape
class omni.graph.core.PyTorchTensorFloat(self: omni.graph.core.bindings._omni_graph_core.PyTorchTensorFloat)None

Bases: pybind11_builtins.pybind11_object

property data_ptr
property device
property dtype
property ndim
property shape
omni.graph.core.acquire_interface(plugin_name: str = None, library_path: str = None) → omni::graph::core::ComputeGraph
omni.graph.core.attach(arg0: int, arg1: float)None

Attach the graph to a particular stage.

Parameters
  • arg0 (int) – The stage id of the stage to attach to

  • arg1 (float) – the meters per second setting for the stage

omni.graph.core.detach()None

Detaches the graph from the currently attached stage.

omni.graph.core.get_compute_graph_contexts() → List[omni.graph.core.bindings._omni_graph_core.GraphContext]

Returns a list of the compute graph contexts in Omnigraph.

omni.graph.core.get_current_graph() → omni.graph.core.bindings._omni_graph_core.Graph

Returns the current graph.

omni.graph.core.get_node_type(arg0: str) → omni.graph.core.bindings._omni_graph_core.NodeType

Returns the registered NodeType object of the given name.

Parameters

arg0 (str) – Name of the registered NodeType to find and return

Returns

NodeType object registered with the given name, None if it is not registered

Return type

(omni.graph.core.NodeType)

omni.graph.core.get_registered_nodes() → List[str]

Returns the list of names of node types currently registered

omni.graph.core.register_node(arg0: object, arg1: int_)None

Registers a new python subnode type with OmniGraph. See compute graph documentation for details.

Parameters
  • arg0 (str) – Name of the Python node type being registered

  • arg1 (int) – Version number of the Python node type being registered

omni.graph.core.register_python_node()None

Register the Python node type with OmniGraph.

omni.graph.core.release_interface(arg0: omni::graph::core::ComputeGraph)None
omni.graph.core.shutdown_compute_graph()None

Shuts down the compute graph.

omni.graph.core.update(arg0: float, arg1: float)None

Ticks the graph with the current time and elapsed time.

Parameters
  • arg0 (float) – The current time

  • arg1 (float) – The elapsed time since the last tick