Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
This is an abstract base class designed for executing an array of movie pipelines in linear fashion. It is generally the case that you only want to execute one at a time on a local machine and a different executor approach should be taken for a render farm that distributes out jobs to many different machines.
| Name | UMoviePipelineLinearExecutorBase |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineLinearExecutor.h |
| Include Path | #include "MoviePipelineLinearExecutor.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, Abstract)
class UMoviePipelineLinearExecutorBase : public UMoviePipelineExecutorBase
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineExecutorBase → UMoviePipelineLinearExecutorBase
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipelineLinearExecutorBase() |
MoviePipelineLinearExecutor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InitializationTime | FDateTime | Used to track total processing duration. | MoviePipelineLinearExecutor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnIndividualPipelineFinished
(
UMoviePipeline* |
Note: When using a Movie Graph Pipeline this pointer will always be null. | MoviePipelineLinearExecutor.h | |
virtual void OnPipelineErrored
(
UMoviePipeline* InPipeline, |
Note: When using a Movie Graph Pipeline InPipeline will always be null. | MoviePipelineLinearExecutor.h |
Overridden from UMoviePipelineExecutorBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void CancelAllJobs_Implementation() |
MoviePipelineLinearExecutor.h | ||
virtual void CancelCurrentJob_Implementation() |
MoviePipelineLinearExecutor.h | ||
virtual void OnExecutorFinishedImpl () |
This should be called when the Executor has finished executing all of the things it has been asked to execute. | MoviePipelineLinearExecutor.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual float GetCompletionPercentageFromActivePipeline() |
MoviePipelineLinearExecutor.h | ||
virtual FText GetWindowTitle() |
MoviePipelineLinearExecutor.h | ||
virtual void Start
(
const UMoviePipelineExecutorJob* InJob |
MoviePipelineLinearExecutor.h | ||
virtual void StartPipelineByIndex
(
int32 InPipelineIndex |
MoviePipelineLinearExecutor.h |
Overridden from UMoviePipelineExecutorBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Execute_Implementation
(
UMoviePipelineQueue* InPipelineQueue |
MoviePipelineLinearExecutor.h | ||
virtual bool IsRendering_Implementation() |
MoviePipelineLinearExecutor.h |