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&40;BlueprintType&41;  
class UMovieGraphPipeline : public UMoviePipelineBase

Variables

  Type Name Description
Protected variable UProperty Transient TArray< TObjectPtr< UMoviePipelineExecutorShot > > ActiveShotList  
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  
Protected variable int32 CurrentShotIndex  
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< 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  
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 EMovieRenderPipelineState PipelineState Which step of the rendering process is the graph currently in.

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  
Protected function Virtual void  
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 UFunction BlueprintCallable, Category UMoviePipelineExecutorJob *  
Public function Const int32 Which index of the Active Shot List are we currently on
Public function Const FMovieGraphTraversalContext  
Public function Const UMovieGraphDataSourceBase * Used occasionally to cross-reference other components.
Public function Const UFunction BlueprintPure, Category FDateTime Returns the time this movie pipeline was initialized at.
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 UMovieGraphRendererBase * Used occasionally to cross-reference other components.
Public function Const UMovieGraphConfig *  
Public function Const 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 UFunction BlueprintCallable, Category void  
Protected function Virtual void  
Protected function Virtual void  
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category void

SetInitializationTime ( const FDateTime& InDateTime
)

 Override the time this movie pipeline was initialized at.
Public function void Called by the TimeStepInstance when it's time to set up for another shot.
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  

Overridden from UMoviePipelineBase

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

RequestShutdownImpl ( bool bIsError
)

  
Protected function Virtual void

ShutdownImpl ( bool bIsError
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page