Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
| Name | UMovieGraphPipeline |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/Graph/MovieGraphPipeline.h |
| Include Path | #include "Graph/MovieGraphPipeline.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType)
class UMovieGraphPipeline : public UMoviePipelineBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineBase → UMovieGraphPipeline
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMovieGraphPipeline() |
Graph/MovieGraphPipeline.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DefaultPreviewWidgetAsset | FString | Graph/MovieGraphPipeline.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddOutputFuture
(
TFuture< bool >&& InOutputFuture, |
Writing images to disk is an async process. | Graph/MovieGraphPipeline.h | |
void CreateLayersInRenderLayerSubsystem
(
const UMovieGraphEvaluatedConfig* EvaluatedConfig |
Resets the render layer subsystem and updates it to reflect the render layers that are present in the evaluated graph. | Graph/MovieGraphPipeline.h | |
const TArray< TObjectPtr< UMoviePipelineExecutorShot > > & GetActiveShotList() |
Get the Active Shot list, which is the full shot list generated from the external data source, with disabled shots removed. | Graph/MovieGraphPipeline.h | |
| Used occasionally to cross-reference other components. | Graph/MovieGraphPipeline.h | ||
const TMap< TWeakObjectPtr< UObject >, TArray< MoviePipeline::FClothSimSettingsCache > > & GetClothSimCache () |
Gets cached data for cloth simulations, needed to save/restore cloth sub-stepping. | Graph/MovieGraphPipeline.h | |
| Gets cached data for cloth simulations, needed to save/restore cloth sub-stepping. | Graph/MovieGraphPipeline.h | ||
| Returns the internal job being used by the Movie Graph Pipeline, which is a duplicate of the job provided originaly by Initialize. | Graph/MovieGraphPipeline.h |
|
|
int32 GetCurrentShotIndex() |
Which index of the Active Shot List are we currently on | Graph/MovieGraphPipeline.h | |
FMovieGraphTraversalContext GetCurrentTraversalContext
(
const bool bForShot |
Graph/MovieGraphPipeline.h |
|
|
| Get the pointer to the Custom Engine Timestep we use to control engine ticking. | Graph/MovieGraphPipeline.h | ||
| Used occasionally to cross-reference other components. | Graph/MovieGraphPipeline.h | ||
| Gets render data that was generated for each shot. | Graph/MovieGraphPipeline.h | ||
FDateTime GetInitializationTime() |
Returns the time this movie pipeline was initialized at. | Graph/MovieGraphPipeline.h |
|
| The offset that should be applied to the GetInitializationTime() when generating the {time} related filename tokens. | Graph/MovieGraphPipeline.h |
|
|
TSharedPtr< UE::MovieGraph::IMovieGraphOutputMerger > GetOutputMerger() |
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. | Graph/MovieGraphPipeline.h | |
| Used occasionally to cross-reference other components. | Graph/MovieGraphPipeline.h |
|
|
UMovieGraphConfig * GetRootGraphForShot
(
UMoviePipelineExecutorShot* InShot |
Gets the graph config for the shot if one was specified for the shot. | Graph/MovieGraphPipeline.h | |
| Used occasionally to cross-reference other components. | Graph/MovieGraphPipeline.h |
|
|
void Initialize
(
UMoviePipelineExecutorJob* InJob, |
Graph/MovieGraphPipeline.h |
|
|
void SetInitializationTime
(
const FDateTime& InDateTime |
Override the time this movie pipeline was initialized at. | Graph/MovieGraphPipeline.h |
|
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. | Graph/MovieGraphPipeline.h | |
void SetupShot
(
const TObjectPtr< UMoviePipelineExecutorShot >& InShot |
Called by the TimeStepInstance when it's time to set up for another shot. | Graph/MovieGraphPipeline.h | |
void TeardownShot
(
const TObjectPtr< UMoviePipelineExecutorShot >& InShot |
Called by the TimeStepInstance when it's time to tear down the current shot. | Graph/MovieGraphPipeline.h | |
void UpdateLayerContentsInRenderLayerSubsystem
(
const UMovieGraphEvaluatedConfig* EvaluatedConfig |
Updates the contents of the layers that are currently present in the render layer subsystem by evaluating all available collections and modifiers. | Graph/MovieGraphPipeline.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginExport() |
Begins the export process for a primary job (not called for shot jobs). | Graph/MovieGraphPipeline.h | |
virtual void BeginFinalize() |
Graph/MovieGraphPipeline.h | ||
virtual void BuildShotListFromDataSource() |
Graph/MovieGraphPipeline.h | ||
virtual void DuplicateJobAndConfiguration() |
Graph/MovieGraphPipeline.h | ||
virtual void ExecutePostJobScripts
(
const FMoviePipelineOutputData& InData |
Graph/MovieGraphPipeline.h | ||
virtual void ExecutePostShotScripts
(
const FMoviePipelineOutputData& InData |
Graph/MovieGraphPipeline.h | ||
virtual void ExecutePreJobScripts() |
Graph/MovieGraphPipeline.h | ||
virtual void ExecutePreShotScripts
(
const TObjectPtr< UMoviePipelineExecutorShot >& InShot |
Graph/MovieGraphPipeline.h | ||
virtual void ExpandShot
(
const TObjectPtr< UMoviePipelineExecutorShot >& InShot, |
Expand our data source (for a specific shot) for various rendering features (such as handle frames). | Graph/MovieGraphPipeline.h | |
virtual const TSet< TObjectPtr< UMovieGraphFileOutputNode > > GetOutputNodesUsed() |
Graph/MovieGraphPipeline.h | ||
virtual void LoadPreviewWidget() |
Graph/MovieGraphPipeline.h | ||
virtual void OnEngineTickBeginFrame() |
Graph/MovieGraphPipeline.h | ||
virtual void OnEngineTickEndFrame() |
Graph/MovieGraphPipeline.h | ||
virtual void OnMoviePipelineFinishedImpl() |
Graph/MovieGraphPipeline.h |
|
|
virtual void ProcessOutstandingFinishedFrames () |
Sends the rendered pixel data to all file output nodes (they will use the "mask" provided to determine if they need to process the data). | Graph/MovieGraphPipeline.h | |
virtual void ProcessOutstandingFutures
(
const bool bStallAndProcessAllFutures |
Processes any futures that have completed by updating GeneratedOutputData. | Graph/MovieGraphPipeline.h | |
virtual void RenderFrame() |
Graph/MovieGraphPipeline.h | ||
int32 ResolveVersionForShot
(
const TObjectPtr< UMoviePipelineExecutorShot >& Shot, |
Resolve the version number that should be used for the specified shot (in {version} tokens). | Graph/MovieGraphPipeline.h | |
virtual void SetPreviewWidgetVisibleImpl
(
bool bInIsVisible |
Graph/MovieGraphPipeline.h | ||
virtual void SetSoloShot
(
const TObjectPtr< UMoviePipelineExecutorShot >& InShot |
Update our data source to isolate the shot we're currently working on, so that expanded shots don't interfere with each other. | Graph/MovieGraphPipeline.h | |
void StartUnrealInsightsCapture
(
UMovieGraphEvaluatedConfig* EvaluatedConfig |
Attempts to start an Unreal Insights capture to a file on disk adjacent to the movie output. | Graph/MovieGraphPipeline.h | |
void StopUnrealInsightsCapture() |
Attempts to stop an already started Unreal Insights capture. | Graph/MovieGraphPipeline.h | |
virtual void TickFinalizeOutputContainers
(
const bool bInForceFinish |
Graph/MovieGraphPipeline.h | ||
virtual void TickPostFinalizeExport
(
const bool bInForceFinish |
Graph/MovieGraphPipeline.h | ||
virtual void TickProducingFrames() |
Graph/MovieGraphPipeline.h | ||
virtual void TransitionToState
(
const EMovieRenderPipelineState InNewState |
Graph/MovieGraphPipeline.h | ||
void UpdateVariableAssignmentsHelper
(
JobType* InTargetJob, |
Helps update variable assignments on the provided job to use duplicated graphs (reflected in the original-to-duplicate graph mapping). | Graph/MovieGraphPipeline.h |
Overridden from UMoviePipelineBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EMovieRenderPipelineState GetPipelineStateImpl() |
Graph/MovieGraphPipeline.h | ||
virtual bool IsPostShotCallbackNeeded() |
Graph/MovieGraphPipeline.h | ||
virtual bool IsShutdownRequestedImpl() |
Graph/MovieGraphPipeline.h | ||
virtual void RequestShutdownImpl
(
bool bIsError |
Graph/MovieGraphPipeline.h | ||
virtual void ShutdownImpl
(
bool bIsError |
Graph/MovieGraphPipeline.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
Graph/MovieGraphPipeline.h |