Navigation
API > API/Plugins > API/Plugins/MovieRenderPipelineCore
A base class for all Movie Render Pipeline settings.
| Name | UMoviePipelineSetting |
| Type | class |
| Header File | /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineSetting.h |
| Include Path | #include "MoviePipelineSetting.h" |
Syntax
UCLASS (MinimalAPI, BlueprintType, Abstract)
class UMoviePipelineSetting : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineSetting
Derived Classes
UMoviePipelineSetting derived class hierarchy
- UAvaMRQRundownPageSetting
- UMoviePipelineOutputBase
- UDisplayClusterMoviePipelineSettings
- UMoviePipelineRenderPass
- UMoviePipelineAntiAliasingSetting
- UMoviePipelineCameraSetting
- UMoviePipelineColorSetting
- UMoviePipelineCommandLineEncoder
- UMoviePipelineConsoleVariableSetting
- UMoviePipelineDebugSettings
- UMoviePipelineGameOverrideSetting
- UMoviePipelineHighResSetting
- UMoviePipelineOutputSetting
- UMoviePipelineSetting_BlueprintBase
- UMoviePipelineViewFamilySetting
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipelineSetting() |
MoviePipelineSetting.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bEnabled | bool | Is this setting currently enabled? Disabled settings are like they never existed. | MoviePipelineSetting.h | |
| CachedPipeline | TWeakObjectPtr< UMoviePipeline > | MoviePipelineSetting.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void BeginExport() |
MoviePipelineSetting.h | ||
virtual void BeginExportImpl() |
Called once when all files have been finalized. | MoviePipelineSetting.h | |
| When rendering in a new process some settings may need to provide command line arguments to affect engine settings that need to be set before most of the engine boots up. | MoviePipelineSetting.h |
|
|
| Modify the Unreal URL and Command Line Arguments when preparing the setting to be run in a new process. | MoviePipelineSetting.h | ||
virtual bool CanBeDisabled() |
Can this setting be disabled? UI only. | MoviePipelineSetting.h | |
virtual FText GetCategoryText() |
Warning: This gets called on the CDO of the object | MoviePipelineSetting.h | |
FText GetDescriptionText() |
What tooltip should be displayed for this setting when hovered in the tree list? | MoviePipelineSetting.h | |
const FSlateBrush * GetDisplayIcon() |
What icon should this setting use when displayed in the tree list. | MoviePipelineSetting.h | |
virtual FText GetDisplayText() |
Warning: This gets called on the CDO of the object | MoviePipelineSetting.h | |
virtual FText GetFooterText
(
UMoviePipelineExecutorJob* InJob |
Return a string to show in the footer of the details panel. | MoviePipelineSetting.h | |
virtual void GetFormatArguments
(
FMoviePipelineFormatArgs& InOutFormatArgs |
Return Key/Value pairs that you wish to be usable in the Output File Name format string or file metadata. | MoviePipelineSetting.h | |
virtual int32 GetPriority () |
Higher priority settings are run after lower priority settings when setting up shots during rendering. | MoviePipelineSetting.h | |
| Get a human-readable text describing what validation errors (if any) the call to ValidateState() produced. | MoviePipelineSetting.h | ||
virtual EMoviePipelineValidationState GetValidationState () |
Validation. | MoviePipelineSetting.h | |
virtual UWorld * GetWorld() |
MoviePipelineSetting.h | ||
bool HasFinishedExporting() |
Post Finalize Export. | MoviePipelineSetting.h | |
virtual bool HasFinishedExportingImpl() |
Has this setting finished any export-related things it needs to do post-finalize? | MoviePipelineSetting.h | |
virtual bool IgnoreTransientFilters () |
If true, then this setting will be included when searching for settings even if it was added transiently. | MoviePipelineSetting.h | |
virtual bool IsEnabled() |
Is this setting enabled by the user in the UI? | MoviePipelineSetting.h |
|
virtual bool IsSolo() |
Can only one of these settings objects be active in a valid pipeline? | MoviePipelineSetting.h | |
virtual bool IsValidOnPrimary() |
Can this configuration setting be added to the primary configuration? If not, it will throw an error when trying to add it to the primary configuration. | MoviePipelineSetting.h | |
virtual bool IsValidOnShots() |
Can this configuration setting be added to shots? If not, it will throw an error when trying to add it to a shot config. | MoviePipelineSetting.h | |
void OnMoviePipelineInitialized
(
UMoviePipeline* InPipeline |
This is called once on a setting when the movie pipeline is first set up. | MoviePipelineSetting.h | |
void OnMoviePipelineShutdown
(
UMoviePipeline* InPipeline |
This is called once on a setting when the movie pipeline is shut down. | MoviePipelineSetting.h | |
void OnSetupForShot
(
UMoviePipelineExecutorShot* InShot |
Called only on settings that have been added to the Primary Configuration to let you know that a shot is about to be rendered. | MoviePipelineSetting.h | |
void OnTeardownForShot
(
UMoviePipelineExecutorShot* InShot |
Called only on settings that have been added to the Primary Configuration to let you know that a shot has finished rendering and is being torn down. | MoviePipelineSetting.h | |
virtual void SetIsEnabled
(
bool bInEnabled |
MoviePipelineSetting.h |
|
|
virtual void UpdateTelemetry
(
FMoviePipelineShotRenderTelemetry* InTelemetry |
Updates telemetry data for this setting. | MoviePipelineSetting.h | |
void ValidateState () |
Attempt to validate the configuration the user has chosen for this setting. | MoviePipelineSetting.h | |
virtual void ValidateStateImpl () |
Attempt to validate the configuration the user has chosen for this setting. | MoviePipelineSetting.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
MoviePipelineSetting.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UMoviePipeline * GetPipeline() |
MoviePipelineSetting.h | ||
virtual void OnSetupForShotImpl
(
UMoviePipelineExecutorShot* InShot |
MoviePipelineSetting.h | ||
virtual void OnTeardownForShotImpl
(
UMoviePipelineExecutorShot* InShot |
MoviePipelineSetting.h | ||
virtual void SetupForPipelineImpl
(
UMoviePipeline* InPipeline |
MoviePipelineSetting.h | ||
virtual void TeardownForPipelineImpl
(
UMoviePipeline* InPipeline |
MoviePipelineSetting.h |