unreal.RigVMGraph
¶
- class unreal.RigVMGraph(outer=None, name='None')¶
Bases:
unreal.Object
The Graph represents a Function definition using Nodes as statements. Graphs can be compiled into a URigVM using the FRigVMCompiler. Graphs provide access to its Nodes, Pins and Links.
C++ Source:
Module: RigVMDeveloper
File: RigVMGraph.h
- find_link(link_pin_path_representation) RigVMLink ¶
Returns a link given its string representation, for example “NodeA.Color.R -> NodeB.Translation.X”
- find_node(node_path) RigVMNode ¶
Returns a Node given its path (or nullptr). (for now this is the same as finding a node by its name.)
- get_contained_graphs(recursive=False)¶
Returns all of the contained graphs
- Parameters
recursive (bool) –
- Return type
- get_default_function_library() RigVMFunctionLibrary ¶
Returns the locally available function library
- Return type
- get_entry_node() RigVMFunctionEntryNode ¶
Returns the entry node of this graph
- Return type
- get_input_arguments()¶
Returns the input arguments of this graph
- Return type
- get_local_variables(include_input_arguments=False)¶
Returns the local variables of this function
- Parameters
include_input_arguments (bool) –
- Return type
- get_output_arguments()¶
Returns the output arguments of this graph
- Return type
- get_parameter_descriptions()¶
Returns a list of unique Parameter descriptions within this Graph. Multiple Parameter Nodes can share the same description.
- Return type
- get_parent_graph() RigVMGraph ¶
Returns the parent graph of this graph
- Return type
- get_return_node() RigVMFunctionReturnNode ¶
Returns the return node of this graph
- Return type
- get_root_graph() RigVMGraph ¶
Returns the root / top level parent graph of this graph (or this if it is the root graph)
- Return type
- get_variable_descriptions()¶
Returns a list of unique Variable descriptions within this Graph. Multiple Variable Nodes can share the same description.
- Return type
- set_default_function_library(function_library) None ¶
Set Default Function Library
- Parameters
function_library (RigVMFunctionLibrary) –