create_compound_node_type#

omni.graph.core.create_compound_node_type(
compound_name: str,
graph_name: str = 'Graph',
namespace: str = None,
compound_folder: str = None,
evaluator_type: str = 'push',
) → omni.graph.core._omni_graph_core._og_unstable.CompoundNodeType#

Create a Compound Node Type object at the given path.

Parameters:

  • compound_name (str) – The name of the compound to be created. This will be the name of the compound USD object, and the default name in registration. Must conform to USD naming standards.

  • graph_name (str) – The name of OmniGraph definition to create that will define the function of the compound. Cannot be None and must conform to USD naming standards.

  • namespace (str) – The namespace of the compound when registered in the node library. Can be None, which indicates to use the default “local.nodes” namespace.

  • compound_folder (str) – Sdf style Path the compound folder to store the compound in. Can be None, which indicates to use the default folder, which is a scope named “Compounds” parented to the default prim of the stage. If the folder does not exist, it will be created.

  • evaluator_type (str) – The associated evaluator, for example “push”. Only used if a graph is created for this compound.

Returns:

the new type object

Return type:

(omni.graph.core.CompoundNodeType)