1. Epic GamesDeveloper
  3. UMoviePipelineExecutorShot

UMoviePipelineExecutorShot

This class represents a segment of work within the Executor Job.

API > API/Plugins > API/Plugins/MovieRenderPipelineCore

Inheritance Hierarchy

  • UObject
  • UMoviePipelineExecutorShot

References

   
Module MovieRenderPipelineCore
Header /Engine/Plugins/MovieScene/MovieRenderPipeline/Source/MovieRenderPipelineCore/Public/MoviePipelineQueue.h
Include #include "MoviePipelineQueue.h"

Syntax

UCLASS (BlueprintType)  
class UMoviePipelineExecutorShot : public UObject

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category BlueprintReadWrite bool bEnabled Does the user want to render this shot?
Public variable UProperty Category BlueprintReadWrite FString InnerName The name of the camera cut section that this shot represents. Can be empty.
Public variable FOnMoviePipelineShotGraphPresetChanged OnShotGraphPresetChanged Called when the graph preset assigned to the shot changes.
Public variable UProperty Category BlueprintReadWrite FString OuterName The name of the shot section that contains this shot. Can be empty.
Protected variable UProperty Transient float Progress  
Public variable FMoviePipelineCameraCutInfo ShotInfo Transient information used by the active Movie Pipeline working on this shot.
Public variable UProperty Category BlueprintReadWrite TArray< FMoviePipelineSidecarCamera > SidecarCameras List of cameras to render for this shot.
Protected variable UProperty Transient FString StatusMessage  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function UFunction BlueprintCallable, Category, Meta UMoviePipelineShotConfig *  
Public function Virtual void  
Public function Const UFunction BlueprintPure, Category FString

GetCameraName ( int32 InCameraIndex
)

  
Public function Const UFunction BlueprintPure, Category UMovieGraphConfig * Gets the graph-style preset that this job is using.
Public function TArray< TObjectPtr< UMovieJobVariableAssignmentContainer > > &

GetGraphVariableAssignments ( const bool bUpdateAssignments
)

 Gets overrides on the variables in graph presets associated with this job.
Public function UFunction BlueprintCallable, Category, Meta displayname 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.
Public function TArray< TObjectPtr< UMovieJobVariableAssignmentContainer > > &

GetPrimaryGraphVariableAssignments ( const bool bUpdateAssignments
)

 Gets overrides on the variables in the primary graph (and its subgraphs) associated with this job.
Public function Const UFunction BlueprintPure, Category UMoviePipelineShotConfig *  
Public function Const UFunction BlueprintPure, Category UMoviePipelineShotConfig *  
Public function Const UFunction BlueprintPure, Category blueprintnativeevent FString Get the current status message for this shot.
Protected function Virtual Const FString  
Public function Const UFunction BlueprintPure, Category blueprintnativeevent float Get the current progress as last set by SetStatusProgress.
Protected function Virtual Const float  
Public function Const UFunction BlueprintPure, Category bool Returns true if this job is using graph-style configuration, else false.
Protected function void

OnGraphPreSave ( UObject* InObject,
FObjectPreSaveContext InObjectPreSaveContext
)

  
Public function Virtual void  
Public function Virtual void

PreSave ( FObjectPreSaveContext ObjectSaveContext
)

  
Public function void Refreshes the variable assignments associated with this shot, both for the shot's own graph preset and the associated primary graph.
Public function UFunction BlueprintCallable, Category void

SetGraphPreset ( const UMovieGraphConfig* InGraphPreset,
const bool bUpdateVariableAssignments
)

 Sets the graph-style preset that this job will use.
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category void  
Public function UFunction BlueprintCallable, Category blueprintnativeevent void

SetStatusMessage ( const FString& InStatus
)

 Set the status of this shot to the given value.
Protected function Virtual void  
Public function UFunction BlueprintCallable, Category blueprintnativeevent void

SetStatusProgress ( const float InProgress
)

 Set the progress of this shot to the given value.
Protected function Virtual void

SetStatusProgress_Implementation ( const float InProgress
)

  
Public function Const UFunction BlueprintPure, Category bool Returns whether this should should be rendered

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page