1. Epic GamesDeveloper
  3. UMovieGraphPipeline

UMovieGraphPipeline

API > API/Plugins > API/Plugins/MovieRenderPipelineCore > API/Plugins/MovieRenderPipelineCore/Graph

Inheritance Hierarchy

References

   
Module MovieRenderPipelineCore
Header /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphPipeline.h
Include #include "Graph/MovieGraphPipeline.h"

Syntax

UCLASS (BlueprintType)  
class UMovieGraphPipeline : public UMoviePipelineBase

Variables

  Type Name Description
Protected variable UProperty Transient TArray< TObjectPtr< UMoviePipelineExecutorShot > > ActiveShotList  
Protected variable bool bIsTearingDownShot True if we're in a TeardownShot call. Used to prevent reentrancy.
Protected variable bool bIsTransitioningState True if we're in a TransitionToState call. Used to prevent reentrancy.
Protected variable FThreadSafeBool bShutdownRequested True if RequestShutdown() was called.
Protected variable FThreadSafeBool bShutdownSetErrorFlag Set to true during Shutdown/RequestShutdown if we are shutting down due to an error.
Protected variable UProperty Transient TObjectPtr< UMoviePipelineExecutorJob > CurrentJob This is the job as was provided to the Initialize() call, which we duplicate to allow modifications to scripting without leaking changes into assets.
Protected variable UProperty Transient TObjectPtr< UMoviePipelineExecutorJob > CurrentJobDuplicate This is the duplicated job, parented to the Transient package.
Protected variable UProperty Transient TArray< UMovieGraphScriptBase * > CurrentScriptInstances  
Protected variable int32 CurrentShotIndex  
Protected variable UProperty Transient TObjectPtr< UMovieGraphEngineTimeStep > CustomEngineTimeStep A custom timestep created by the Movie Graph Pipeline to allow the time step managers to set what the delta times for the frame should be.
Protected variable TSharedPtr< UE::MovieGraph::Private::FMovieGraphCVarManager > CVarManager Responsible for managing cvars throughout the lifetime of the pipeline.
Protected variable IImageWriteQueue * Debug_ImageWriteQueue A debug image sequence writer in the event they want to dump every sample generated on its own.
Protected variable TArray< FMovieGraphRenderOutputData > GeneratedOutputData An array of output data, one per shot.
Protected variable UProperty Transient TObjectPtr< UMovieGraphAudioRendererBase > GraphAudioRendererInstance  
Protected variable UProperty Transient TObjectPtr< UMovieGraphDataSourceBase > GraphDataSourceInstance  
Protected variable FDateTime GraphInitializationTime What time (in UTC) was Initialization called? Used internally for tracking total job duration.
Protected variable UProperty Transient TObjectPtr< UMovieGraphRendererBase > GraphRendererInstance  
Protected variable UProperty Transient TObjectPtr< UMovieGraphTimeStepBase > GraphTimeStepInstance Sometimes the shot index can be incremented before the time step instance should be changed, so the current time step instance is tracked.
Protected variable UProperty Transient TArray< TObjectPtr< UMovieGraphTimeStepBase > > GraphTimeStepInstances Time step instances for each shot, where the index into the array corresponds to the shot index.
Protected variable FTimespan InitializationTimeOffset When we originally initialize we store the offset from UTC (which is what GetInitializationTime() is in), but we clear this if you call SetInitializationTime.
Protected variable TSharedPtr< UE::MovieGraph::IMovieGraphOutputMerger > OutputMerger This gathers all of the produced data for an output frame (which may come in async, many frames later) before passing them onto the Output Containers.
Protected variable UProperty Transient TSet< TObjectPtr< UMovieGraphFileOutputNode > > OutputNodesDataSentTo An array of Node CDOs that we sent data through to write data to disk.
Protected variable TArray< UE::MovieGraph::FMovieGraphOutputFuture > OutstandingOutputFutures An array of Output Futures for files that have started writing to disk, but have not finished.
Protected variable UProperty Transient TObjectPtr< UMovieGraphTimeStepBase > PendingTimeStepInstance If set, on the next TickProducingFrames, the GraphTimeStepInstance pointer will be swapped with this one.
Protected variable EMovieRenderPipelineState PipelineState Which step of the rendering process is the graph currently in.
Protected variable UProperty Transient TObjectPtr< UMovieGraphEvaluatedConfig > PostRenderEvaluatedGraph The evaluated graph that should be referenced after all shot rendering is complete.
Protected variable UProperty Transient TObjectPtr< UEngineCustomTimeStep > PrevCustomEngineTimeStep The previous custom timestep the engine was using, if any.
Protected variable UProperty Transient TObjectPtr< UMovieGraphRenderPreviewWidget > PreviewWidget  
Protected variable UProperty Transient TSubclassOf< UMovieGraphRenderPreviewWidget > PreviewWidgetClassToUse  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void

AddOutputFuture ( TFuture< bool >&& InOutputFuture,
const UE::MovieGraph::FMovieGraphOutputFutureData& InData
)

 Writing images to disk is an async process.
Protected function Virtual void Begins the export process for a primary job (not called for shot jobs).
Protected function Virtual void  
Protected function Virtual void  
Public function Const void Resets the render layer subsystem and updates it to reflect the render layers that are present in the evaluated graph.
Protected function UMovieGraphConfig *

DuplicateConfigRecursive ( UMovieGraphConfig* InGraphToDuplicate,
TMap< UMovieGraphConfig*, UMovieGraphConfig* >& OutDuplicatedGraphs
)

 Helps duplicate graph configs.
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void

ExpandShot ( const TObjectPtr< UMoviePipelineExecutorShot >& InShot,
const int32 InNumHandleFrames,
const bool bInHasMultipleTemporalSamples,
const bool bIsPrePass,
const FFrameRate& InDisplayRate,
const FFrameRate& InTickResolution,
const int32 InWarmUpFrames
)

 Expand our data source (for a specific shot) for various rendering features (such as handle frames).
Public function Const const TArray< TObjectPtr< UMoviePipelineExecutorShot > > & Get the Active Shot list, which is the full shot list generated from the external data source, with disabled shots removed.
Public function Const UMovieGraphAudioRendererBase * Used occasionally to cross-reference other components.
Public function Const UFunction BlueprintCallable, Category UMoviePipelineExecutorJob * Returns the internal job being used by the Movie Graph Pipeline, which is a duplicate of the job provided originaly by Initialize.
Public function Const int32 Which index of the Active Shot List are we currently on
Public function Const UFunction BlueprintCallable, Category FMovieGraphTraversalContext

GetCurrentTraversalContext ( const bool bForShot
)

  
Public function Const TObjectPtr< UMovieGraphEngineTimeStep > Get the pointer to the Custom Engine Timestep we use to control engine ticking.
Public function Const UMovieGraphDataSourceBase * Used occasionally to cross-reference other components.
Public function TArray< FMovieGraphRenderOutputData > & Gets render data that was generated for each shot.
Public function Const UFunction BlueprintPure, Category FDateTime Returns the time this movie pipeline was initialized at.
Public function Const UFunction BlueprintPure, Category FTimespan The offset that should be applied to the GetInitializationTime() when generating the {time} related filename tokens.
Public function Const TSharedPtr< UE::MovieGraph::IMovieGraphOutputMerger > Gets the Output Merger for this Movie Pipeline which is responsible for gathering all of the data coming in for a given output frame, before making it available to the MovieGraphPipeline.
Protected function Virtual Const const TSet< TObjectPtr< UMovieGraphFileOutputNode > >  
Public function Const UFunction BlueprintCallable, Category UMovieGraphRendererBase * Used occasionally to cross-reference other components.
Public function Const UMovieGraphConfig * Gets the graph config for the shot if one was specified for the shot.
Public function Const UFunction BlueprintCallable, Category UMovieGraphTimeStepBase * Used occasionally to cross-reference other components.
Public function UFunction BlueprintCallable, Category void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual UFunction BlueprintCallable, Category void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Protected function int32 Resolve the version number that should be used for the specified shot (in {version} tokens).
Public function UFunction BlueprintCallable, Category void

SetInitializationTime ( const FDateTime& InDateTime
)

 Override the time this movie pipeline was initialized at.
Public function void

SetPreviewWidgetVisible ( bool bInIsVisible
)

 Used by the Renderer Instance to disable the preview widget before rendering so it isn't baked into the UI Renderer.
Protected function Virtual void

SetPreviewWidgetVisibleImpl ( bool bInIsVisible
)

  
Protected function Virtual void Update our data source to isolate the shot we're currently working on, so that expanded shots don't interfere with each other.
Public function void Called by the TimeStepInstance when it's time to set up for another shot.
Protected function void Attempts to start an Unreal Insights capture to a file on disk adjacent to the movie output.
Protected function void Attempts to stop an already started Unreal Insights capture.
Public function void Called by the TimeStepInstance when it's time to tear down the current shot.
Protected function Virtual void

TickFinalizeOutputContainers ( const bool bInForceFinish
)

  
Protected function Virtual void

TickPostFinalizeExport ( const bool bInForceFinish
)

  
Protected function Virtual void  
Protected function Virtual void  
Public function Const void Updates the contents of the layers that are currently present in the render layer subsystem by evaluating all available collections and modifiers.
Protected function void

UpdateVariableAssignmentsHelper ( JobType* InTargetJob,
TMap< UMovieGraphConfig*, UMovieGraphConfig* >& InOriginalToDuplicateGraphMap
)

 Helps update variable assignments on the provided job to use duplicated graphs (reflected in the original-to-duplicate graph mapping).

Overridden from UMoviePipelineBase

  Type Name Description
Protected function Virtual Const EMovieRenderPipelineState  
Protected function Virtual Const bool  
Protected function Virtual Const bool  
Protected function Virtual void

RequestShutdownImpl ( bool bIsError
)

  
Protected function Virtual void

ShutdownImpl ( bool bIsError
)

  

Constants

Name Description
DefaultPreviewWidgetAsset  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page