1. Epic GamesDeveloper
  3. UMovieGraphConfig

UMovieGraphConfig

This is the runtime representation of the UMoviePipelineEdGraph which contains the actual strongly typed graph network that is read by the MoviePipeline.

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

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).

   
Name UMovieGraphConfig
Type class
Header File /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphConfig.h
Include Path #include "Graph/MovieGraphConfig.h"

Syntax

UCLASS (BlueprintType)  
class UMovieGraphConfig : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UMovieGraphConfig()

   Graph/MovieGraphConfig.h  

Typedefs

Name Type Remarks Include Path
FVisitNodesCallback TBaseDelegate_TwoParams< bool, UMovieGraphNode *, const UMovieGraphPin * > Callback for when a node is visited. Graph/MovieGraphConfig.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnGraphChangedDelegate FOnMovieGraphChanged   Graph/MovieGraphConfig.h  
OnGraphInputAddedDelegate FOnMovieGraphInputAdded   Graph/MovieGraphConfig.h  
OnGraphNodesDeletedDelegate FOnMovieGraphNodesDeleted   Graph/MovieGraphConfig.h  
OnGraphOutputAddedDelegate FOnMovieGraphOutputAdded   Graph/MovieGraphConfig.h  
OnGraphVariablesChangedDelegate FOnMovieGraphVariablesChanged   Graph/MovieGraphConfig.h  
PipelineEdGraph TObjectPtr< UEdGraph > Not strongly typed to avoid a circular dependency between the editor only module and the runtime module, but it should be a UMoviePipelineEdGraph. Graph/MovieGraphConfig.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
EditorOnlyNodes TArray< TObjectPtr< UObject > > Nodes which are only useful in the editor (like comments) and have no runtime equivalent Graph/MovieGraphConfig.h  
GlobalVariables TArray< TObjectPtr< UMovieGraphGlobalVariable > > All global variables which are available for use in the graph. Graph/MovieGraphConfig.h  
Inputs TArray< TObjectPtr< UMovieGraphInput > > All inputs which have been defined on the graph. Graph/MovieGraphConfig.h  
Outputs TArray< TObjectPtr< UMovieGraphOutput > > All outputs which have been defined on the graph. Graph/MovieGraphConfig.h  
Variables TArray< TObjectPtr< UMovieGraphVariable > > All user (not global) variables which are available for use in the graph. Graph/MovieGraphConfig.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

UMovieGraphInput * AddInput ( const FText& InBaseName
)

 Adds a new input member to the graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool AddLabeledEdge ( UMovieGraphNode* FromNode,
const FName& FromPinLabel,
UMovieGraphNode* ToNode,
const FName& ToPinLabel
)

 Add a connection in the graph between the given nodes and pin names. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

void AddNode ( UMovieGraphNode* InNode
)

 Add the specified node instance to the graph. Graph/MovieGraphConfig.h  

UMovieGraphOutput * AddOutput ( const FText& InBaseName
)

 Adds a new output member to the graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

UMovieGraphVariable * AddVariable ( const FName InCustomBaseName
)

 Adds a new variable member with default values to the graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

T * ConstructRuntimeNode ( TSubclassOf< UMovieGraphNode > PipelineGraphNodeClass
)

   Graph/MovieGraphConfig.h  
Given a user-defined evaluation context, evaluate the graph and build a "flattened" list of settings for each branch discovered. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"
Creates the given node type in this graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="InClass")
  • Category="Movie Graph"

bool DeleteMember ( UMovieGraphMember* MemberToDelete
)

 Remove the specified member (input, output, variable) from the graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

UMovieGraphVariable * DuplicateVariable ( UMovieGraphVariable* InVariableToDuplicate
)

 Duplicates the provided variable. Returns the new variable on success, else nullptr. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

void GetAllContainedSubgraphs ( TSet< UMovieGraphConfig* >& OutSubgraphs
) const

 Get all subgraphs that this graph contains, recursively (ie, subgraphs of subgraphs are included, etc). Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

TArray< FName > GetBranchNames()

 Returns an array of the branch names for the OutputNode on this Graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

TArray< FString > GetDownstreamBranchNames ( UMovieGraphNode* FromNode,
const UMovieGraphPin* FromPin,
const bool bStopAtSubgraph
) const

 Determines the name(s) of the branches downstream from FromNode, starting at FromPin. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

const TArray< TObjectPtr< UObject > > & GetEditorOnlyNodes()

 Gets the editor-only nodes in this graph. Editor-only nodes do not have an equivalent runtime node. Graph/MovieGraphConfig.h  

UMovieGraphNode * GetInputNode()

 Gets the automatically generated "Inputs" node in the Graph. Graph/MovieGraphConfig.h
  • BlueprintPure
  • Category="Movie Graph"

TArray< UMovieGraphInput * > GetInputs()

 Gets all inputs that have been defined on the graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

UMovieGraphNode * GetNodeForBranch ( UClass* InClass,
const FName& InBranchName,
bool bExactMatch
) const

 Finds a node (by type) for the given branch name (see GetBranchNames()). Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="InClass")
  • Category="Movie Graph"

UMovieGraphNode * GetNodeForTag ( const FString& ScriptTag,
UClass* OptionalClassFilter,
const FName OptionalBranchFilter,
bool bExactMatch
) const

 Finds a node by ScriptTag field. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="OptionalClassFilter")
  • Category="Movie Graph"

const TArray< TObjectPtr< UMovieGraphNode > > & GetNodes()

   Graph/MovieGraphConfig.h  

TArray< UMovieGraphNode * > GetNodesForBranch ( UClass* InClass,
const FName& InBranchName,
bool bExactMatch
) const

 Finds all nodes (by type) for the given branch name (see GetBranchNames()). Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="InClass")
  • Category="Movie Graph"

TArray< UMovieGraphNode * > GetNodesForTag ( const FString& ScriptTag,
UClass* OptionalClassFilter,
const FName OptionalBranchFilter,
bool bExactMatch
) const

 Finds nodes by ScriptTag field. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Meta=(DeterminesOutputType="OptionalClassFilter")
  • Category="Movie Graph"

void GetOutputDirectory ( FString& OutOutputDirectory
) const

 Walks the graph backward recursively from the output node searching for a UMovieGraphOutputSettings node. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

UMovieGraphNode * GetOutputNode()

 Gets the automatically generated "Outputs" node in the Graph. Graph/MovieGraphConfig.h
  • BlueprintPure
  • Category="Movie Graph"

TArray< UMovieGraphOutput * > GetOutputs()

 Gets all outputs that have been defined on the graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

TArray< FString > GetUpstreamBranchNames ( UMovieGraphNode* FromNode,
const UMovieGraphPin* FromPin,
const bool bStopAtSubgraph
) const

 Determines the name(s) of the branches upstream from FromNode, starting at FromPin. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

UMovieGraphVariable * GetVariableByGuid ( const FGuid& InGuid
) const

 Gets the variable in the graph with the specified GUID, else nullptr if one could not be found. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

UMovieGraphVariable * GetVariableByName ( const FString& InVariableName
) const

 Gets the variable in the graph with the specified name (including global variables), else nullptr if one could not be found. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

TArray< UMovieGraphVariable * > GetVariables ( const bool bIncludeGlobal
) const

 Gets all variables that are available to be used in the graph. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

void MoveCategoryBefore ( const FString& InCategoryToMove,
const FString& InCategoryBefore
)

 Moves one category (InCategoryToMove) and its variables before another category (InCategoryBefore). Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

void MoveVariableBefore ( UMovieGraphVariable* InTargetVariable,
UMovieGraphVariable* InBeforeVariable
)

 Moves one variable (InTargetVariable) before another variable (InBeforeVariable). Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

void MoveVariableToIndex ( UMovieGraphVariable* InTargetVariable,
int32 NewIndex
)

 Moves one variable (InTargetVariable) to the specified index among all user graph variables. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool RemoveAllInboundEdges ( UMovieGraphNode* InNode
)

 Convenience function which removes all Inbound (pins on the left side of a node) edges for the given node. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool RemoveAllOutboundEdges ( UMovieGraphNode* InNode
)

 Convenience function which removes all Outbound (pins on the right side of a node) edges for the given node. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool RemoveInboundEdges ( UMovieGraphNode* InNode,
const FName& InPinName
)

 Convenience 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. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool RemoveLabeledEdge ( UMovieGraphNode* FromNode,
const FName& FromPinName,
UMovieGraphNode* ToNode,
const FName& ToPinName
)

 Like AddLabeledEdge, removes the given connection between Node A and Node B (for the specified pins by name). Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool RemoveNode ( UMovieGraphNode* InNode
)

 Removes the specified node from the graph, disconnecting connected edges as it goes. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool RemoveNodes ( TArray< UMovieGraphNode* > InNodes
)

 Like RemoveNode but takes an entire array at once for convenience. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

bool RemoveOutboundEdges ( UMovieGraphNode* InNode,
const FName& InPinName
)

 Convenience function which removes all Outbound (pins on the right side of a node) edges connected to the given outbound pin by name, for the given node. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

void SetEditorOnlyNodes ( const TArray< TObjectPtr< const UObject > >& InNodes
)

 Sets the editor-only nodes in this graph. Graph/MovieGraphConfig.h  

void UpdateGlobalVariableValues ( const UMovieGraphPipeline* InPipeline
)

 Updates the values of all global variables. Graph/MovieGraphConfig.h
  • BlueprintCallable
  • Category="Movie Graph"

void VisitDownstreamNodes ( UMovieGraphNode* FromNode,
const FVisitNodesCallback& VisitCallback
) const

 Visits all nodes downstream from FromNode, running VisitCallback on each one. Graph/MovieGraphConfig.h  

void VisitUpstreamNodes ( UMovieGraphNode* FromNode,
const FVisitNodesCallback& VisitCallback
) const

 Visits all nodes upstream from FromNode, running VisitCallback on each one. Graph/MovieGraphConfig.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   Graph/MovieGraphConfig.h  

Protected

Name Remarks Include Path Unreal Specifiers

void CopyOverriddenProperties ( UMovieGraphNode* FromNode,
UMovieGraphNode* ToNode,
const FMovieGraphEvaluationContext& InEvaluationContext
)

 Copies properties in FromNode that are marked for override into ToNode, but only if ToNode doesn't already override that value. Graph/MovieGraphConfig.h  

bool CreateFlattenedGraph_Recursive ( UMovieGraphEvaluatedConfig* InOwningConfig,
FMovieGraphEvaluatedBranchConfig& OutBranchConfig,
FMovieGraphEvaluationContext& InEvaluationContext,
UMovieGraphPin* InPinToFollow
)

 Traverse the graph, generating a combined "flatten" graph as it goes. Graph/MovieGraphConfig.h  

void InitializeFlattenedNode ( UMovieGraphNode* InNode
)

 Find all "Overrideable" marked properties, then find their edit condition properties, then set those to false. Graph/MovieGraphConfig.h  

void RecurseUpGlobalsBranchToFindOutputDirectory ( const UMovieGraphNode* InNode,
FString& OutOutputDirectory,
TArray< const UMovieGraphConfig* >& VisitedGraphStack
) const

 Look for the output directory in the UMovieGraphOutputSettings nodes found upstream of InNode. Graph/MovieGraphConfig.h  

void VisitDownstreamNodes_Recursive ( UMovieGraphNode* FromNode,
const FVisitNodesCallback& VisitCallback,
TSet< UMovieGraphNode* >& VisitedNodes
) const

 Recursive helper for VisitDownstreamNodes(). Graph/MovieGraphConfig.h  

void VisitUpstreamNodes_Recursive ( UMovieGraphNode* FromNode,
const FVisitNodesCallback& VisitCallback,
TSet< UMovieGraphNode* >& VisitedNodes
) const

 Recursive helper for VisitUpstreamNodes(). Graph/MovieGraphConfig.h  

Static

Name Remarks Include Path Unreal Specifiers

static FBoolProperty * FindOverridePropertyForRealProperty ( UClass* InClass,
const FProperty* InRealProperty
)

 Given a class and FProperty that belongs to that class, search for a FBoolProperty that matches the name "bOverride_. Graph/MovieGraphConfig.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page