unreal.MovieGraphConfig
¶
- class unreal.MovieGraphConfig(outer: Object | None = None, name: Name | str = 'None')¶
Bases:
Object
This is the runtime representation of the UMoviePipelineEdGraph which contains the actual strongly typed graph network that is read by the MoviePipeline. There is an editor-only representation of this graph (UMoviePipelineEdGraph).
C++ Source:
Plugin: MovieRenderPipeline
Module: MovieRenderPipelineCore
File: MovieGraphConfig.h
- add_input() MovieGraphInput ¶
Adds a new input member to the graph. Returns the new input on success, else nullptr.
- Return type:
- add_labeled_edge(from_node, from_pin_label, to_node, to_pin_label) bool ¶
Add a connection in the graph between the given nodes and pin names. Pin name may be empty for basic nodes (if no name is displayed in the UI). Can be used for either input or output pins. Returns False if the pin could not be found, or the connection could not be made (type mismatches).
- Parameters:
from_node (MovieGraphNode) –
from_pin_label (Name) –
to_node (MovieGraphNode) –
to_pin_label (Name) –
- Return type:
- add_output() MovieGraphOutput ¶
Adds a new output member to the graph. Returns the new output on success, else nullptr.
- Return type:
- add_variable(custom_base_name='None') MovieGraphVariable ¶
Adds a new variable member with default values to the graph. The new variable will have a base name of “Variable” unless specified in InCustomBaseName. Returns the new variable on success, else nullptr.
- Parameters:
custom_base_name (Name) –
- Return type:
- create_flattened_graph(context) -> (MovieGraphEvaluatedConfig, out_error=str)¶
Given a user-defined evaluation context, evaluate the graph and build a “flattened” list of settings for each branch discovered. If there was an error while evaluating the graph, nullptr will be returned and OutError will be populated with a description of the problem.
- Parameters:
context (MovieGraphTraversalContext) –
- Returns:
out_error (str):
- Return type:
- create_node_by_class(class_) MovieGraphNode ¶
Creates the given node type in this graph. Does not create any connections, and a node will not be considered during evaluation unless it is connected to other nodes in the graph.
- Parameters:
- Return type:
- delete_member(member_to_delete) bool ¶
Remove the specified member (input, output, variable) from the graph.
- Parameters:
member_to_delete (MovieGraphMember) –
- Return type:
- get_input_node() MovieGraphNode ¶
Gets the automatically generated “Inputs” node in the Graph.
- Return type:
- get_inputs() Array[MovieGraphInput] ¶
Gets all inputs that have been defined on the graph.
- Return type:
- get_output_node() MovieGraphNode ¶
Gets the automatically generated “Outputs” node in the Graph.
- Return type:
- get_outputs() Array[MovieGraphOutput] ¶
Gets all outputs that have been defined on the graph.
- Return type:
- get_variables(include_global=False) Array[MovieGraphVariable] ¶
Gets all variables that are available to be used in the graph. Global variables can optionally be included if bIncludeGlobal is set to true.
- Parameters:
include_global (bool) –
- Return type:
- remove_all_inbound_edges(node) bool ¶
Convinence function which removes all Inbound (pins on the left side of a node) edges for the given node.
- Parameters:
node (MovieGraphNode) –
- Return type:
- remove_all_outbound_edges(node) bool ¶
Convinence function which removes all Outbound (pins on the right side of a node) edges for the given node.
- Parameters:
node (MovieGraphNode) –
- Return type:
- remove_inbound_edges(node, pin_name) bool ¶
Convinence function which removes all Inbound (pins on the left side of a node) edges connected to the given inbound pin by name, for the given node.
- Parameters:
node (MovieGraphNode) –
pin_name (Name) –
- Return type:
- remove_labeled_edge(from_node, from_pin_name, to_node, to_pin_name) bool ¶
Like AddLabeledEdge, removes the given connection between Node A and Node B (for the specified pins by name).
- Parameters:
from_node (MovieGraphNode) –
from_pin_name (Name) –
to_node (MovieGraphNode) –
to_pin_name (Name) –
- Return type:
- remove_node(node) bool ¶
Removes the specified node from the graph, disconnecting connected edges as it goes.
- Parameters:
node (MovieGraphNode) –
- Return type:
- remove_nodes(nodes) bool ¶
Like RemoveNode but takes an entire array at once for convinence.
- Parameters:
nodes (Array[MovieGraphNode]) –
- Return type:
- remove_outbound_edges(node, pin_name) bool ¶
Convinence function which removes all Outobund (pins on the right side of a node) edges connected to the given outbound pin by name, for the given node.
- Parameters:
node (MovieGraphNode) –
pin_name (Name) –
- Return type:
- update_global_variable_values(pipeline) None ¶
Updates the values of all global variables.
- Parameters:
pipeline (MovieGraphPipeline) –