UMoviePipelineExecutorShot

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

This class represents a segment of work within the Executor Job. This should be owned by the UMoviePipelineExecutorJob and can be created before the movie pipeline starts to configure some aspects about the segment (such as disabling it). When the movie pipeline starts, it will use the already existing ones, or generate new ones as needed.


Name	UMoviePipelineExecutorShot
Type	class
Header File	/Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineQueue.h
Include Path	#include "MoviePipelineQueue.h"

Syntax

UCLASS (MinimalAPI, BlueprintType)  
class UMoviePipelineExecutorShot : public UObject

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UMoviePipelineExecutorShot

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UMoviePipelineExecutorShot()		MoviePipelineQueue.h

Variables

Public

Name	Type	Remarks	Include Path	Unreal Specifiers
bEnabled	bool	Does the user want to render this shot?	MoviePipelineQueue.h	BlueprintReadWrite Category="Movie Render Pipeline"
ConsoleVariableOverrides	TArray< FMoviePipelineConsoleVariableEntry >	(Optional) Console variable overrides which are applied after cvars set via nodes.	MoviePipelineQueue.h	BlueprintReadWrite EditAnywhere Category="Console Variable Overrides" Meta=(DisplayName="Console Variables", EditCondition="IsUsingGraphConfiguration()", EditConditionHides)
InnerName	FString	The name of the camera cut section that this shot represents. Can be empty.	MoviePipelineQueue.h	BlueprintReadWrite Category="Movie Render Pipeline"
OnShotGraphPresetChanged	FOnMoviePipelineShotGraphPresetChanged	Called when the graph preset assigned to the shot changes.	MoviePipelineQueue.h
OuterName	FString	The name of the shot section that contains this shot. Can be empty.	MoviePipelineQueue.h	BlueprintReadWrite Category="Movie Render Pipeline"
ShotInfo	FMoviePipelineCameraCutInfo	Transient information used by the active Movie Pipeline working on this shot.	MoviePipelineQueue.h
SidecarCameras	TArray< FMoviePipelineSidecarCamera >	List of cameras to render for this shot.	MoviePipelineQueue.h	BlueprintReadWrite Category="Movie Render Pipeline"

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
GraphPreset	TSoftObjectPtr< UMovieGraphConfig >	The graph-based configuration preset that this shot is using. Can be nullptr.	MoviePipelineQueue.h
GraphVariableAssignments	TArray< TObjectPtr< UMovieJobVariableAssignmentContainer > >	Overrides on the variables in the graph (and subgraphs) associated with this job.	MoviePipelineQueue.h	EditAnywhere Instanced Category="Variable Assignments"
PrimaryGraphVariableAssignments	TArray< TObjectPtr< UMovieJobVariableAssignmentContainer > >	Overrides on the variables in the primary graph (and its subgraphs) associated with this job.	MoviePipelineQueue.h	EditAnywhere Instanced Category="Variable Assignments"
ShotOverrideConfig	TObjectPtr< UMoviePipelineShotConfig >		MoviePipelineQueue.h
ShotOverridePresetOrigin	TSoftObjectPtr< UMoviePipelineShotConfig >		MoviePipelineQueue.h

Functions

Public

Name	Remarks	Include Path	Unreal Specifiers
UMoviePipelineShotConfig * AllocateNewShotOverrideConfig ( TSubclassOf< UMoviePipelineShotConfig > InConfigType )		MoviePipelineQueue.h	BlueprintCallable Meta=(DeterminesOutputType="InConfigType") Category="Movie Render Pipeline" Meta=(InConfigType="/Script/MovieRenderPipelineCore.MoviePipelineShotConfig")
FString GetCameraName ( int32 InCameraIndex ) const		MoviePipelineQueue.h	BlueprintPure Category="Movie Render Pipeline"
UMovieGraphConfig * GetGraphPreset ()	Gets the graph-style preset that this job is using.	MoviePipelineQueue.h	BlueprintPure Category="Movie Render Pipeline"
TArray< TObjectPtr< UMovieJobVariableAssignmentContainer > > & GetGraphVariableAssignments ( const bool bUpdateAssignments )	Gets overrides on the variables in graph presets associated with this job.	MoviePipelineQueue.h
UMovieJobVariableAssignmentContainer * GetOrCreateJobVariableAssignmentsForGraph ( const UMovieGraphConfig* InGraph, const bool bIsForPrimaryOverrides )	This method will return you the object which contains variable overrides for either the Job's Primary or the Shot's GraphPreset.	MoviePipelineQueue.h	BlueprintCallable Category="Movie Render Pipeline" DisplayName="Get or Create Variable Overrides" Meta=(ScriptName="GetOrCreateVariableOverrides")
TArray< TObjectPtr< UMovieJobVariableAssignmentContainer > > & GetPrimaryGraphVariableAssignments ( const bool bUpdateAssignments )	Gets overrides on the variables in the primary graph (and its subgraphs) associated with this job.	MoviePipelineQueue.h
UMoviePipelineShotConfig * GetShotOverrideConfiguration()		MoviePipelineQueue.h	BlueprintPure Category="Movie Render Pipeline"
UMoviePipelineShotConfig * GetShotOverridePresetOrigin()		MoviePipelineQueue.h	BlueprintPure Category="Movie Render Pipeline"
FString GetStatusMessage ()	Get the current status message for this shot.	MoviePipelineQueue.h	BlueprintPure BlueprintNativeEvent Category="Movie Render Pipeline"
float GetStatusProgress ()	Get the current progress as last set by SetStatusProgress.	MoviePipelineQueue.h	BlueprintPure BlueprintNativeEvent Category="Movie Render Pipeline"
bool IsUsingGraphConfiguration()	Returns true if this job is using graph-style configuration, else false.	MoviePipelineQueue.h	BlueprintPure Category="Movie Render Pipeline"
void RefreshAllVariableAssignments()	Refreshes the variable assignments associated with this shot, both for the shot's own graph preset and the associated primary graph.	MoviePipelineQueue.h
void SetGraphPreset ( const UMovieGraphConfig* InGraphPreset, const bool bUpdateVariableAssignments )	Sets the graph-style preset that this job will use.	MoviePipelineQueue.h	BlueprintCallable Category="Movie Render Pipeline"
void SetShotOverrideConfiguration ( UMoviePipelineShotConfig* InPreset )		MoviePipelineQueue.h	BlueprintCallable Category="Movie Render Pipeline"
void SetShotOverridePresetOrigin ( UMoviePipelineShotConfig* InPreset )		MoviePipelineQueue.h	BlueprintCallable Category="Movie Render Pipeline"
void SetStatusMessage ( const FString& InStatus )	Set the status of this shot to the given value.	MoviePipelineQueue.h	BlueprintCallable BlueprintNativeEvent Category="Movie Render Pipeline"
void SetStatusProgress ( const float InProgress )	Set the progress of this shot to the given value.	MoviePipelineQueue.h	BlueprintCallable BlueprintNativeEvent Category="Movie Render Pipeline"
bool ShouldRender()	Returns whether this should should be rendered	MoviePipelineQueue.h	BlueprintPure Category="Movie Render Pipeline"

Overridden from UObject

Name	Remarks	Include Path	Unreal Specifiers
virtual void BeginDestroy()		MoviePipelineQueue.h
virtual void PostLoad()		MoviePipelineQueue.h
virtual void PreSave ( FObjectPreSaveContext ObjectSaveContext )		MoviePipelineQueue.h

Protected

Name	Remarks	Include Path	Unreal Specifiers
virtual FString GetStatusMessage_Implementation()		MoviePipelineQueue.h
virtual float GetStatusProgress_Implementation()		MoviePipelineQueue.h
void OnGraphPreSave ( UObject* InObject, FObjectPreSaveContext InObjectPreSaveContext )		MoviePipelineQueue.h
virtual void SetStatusMessage_Implementation ( const FString& InMessage )		MoviePipelineQueue.h
virtual void SetStatusProgress_Implementation ( const float InProgress )		MoviePipelineQueue.h

Can't find any content

Navigation

Syntax

Inheritance Hierarchy

Constructors

Variables

Public

Protected

Functions

Public

Overridden from UObject

Protected