1. Epic GamesDeveloper
  3. URenderGridJob

URenderGridJob

This class represents a render grid job, in other words, an entry (a row) of a render grid.

API > API/Plugins > API/Plugins/RenderGrid

This class represents a render grid job, in other words, an entry (a row) of a render grid. It contains a level sequence and custom properties that will be applied while rendering.

Each RenderGridJob must belong to a RenderGrid.

   
Name URenderGridJob
Type class
Header File /Engine/Plugins/Experimental/RenderGrid/Source/RenderGrid/Public/RenderGrid/RenderGrid.h
Include Path #include "RenderGrid/RenderGrid.h"

Syntax

UCLASS (BlueprintType, Meta=(DontUseGenericSpawnObject="true"))  
class URenderGridJob : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URenderGridJob()

   RenderGrid/RenderGrid.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsEnabled bool If this is true, this job will be rendered during a batch rendering, otherwise it will be skipped. RenderGrid/RenderGrid.h  
bOverrideEndFrame bool If this is true, the CustomEndFrame property will override the end frame of the level sequence. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true", InlineEditConditionToggle)
bOverrideResolution bool If this is true, the CustomResolution property will override the resolution of the render. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true", InlineEditConditionToggle)
bOverrideStartFrame bool If this is true, the CustomStartFrame property will override the start frame of the level sequence. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true", InlineEditConditionToggle)
CustomEndFrame int32 If bOverrideEndFrame is true, this property will override the end frame of the level sequence. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true", EditCondition="bOverrideEndFrame")
CustomResolution FIntPoint If bOverrideResolution is true, this property will override the resolution of the render. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true", EditCondition="bOverrideResolution", ClampMin="1", UIMin="1")
CustomStartFrame int32 If bOverrideStartFrame is true, this property will override the start frame of the level sequence. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true", EditCondition="bOverrideStartFrame")
Guid FGuid The unique ID of this job. RenderGrid/RenderGrid.h  
JobId FString The 'ID' of this job, this 'ID' is set by users. RenderGrid/RenderGrid.h  
JobName FString The name of this job, this can be anything, it's set by the user, it serves as a way for the user to understand what job this is. RenderGrid/RenderGrid.h  
LevelSequence TObjectPtr< ULevelSequence > The level sequence, this is what will be rendered during rendering. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true")
OutputDirectory FString This is the folder in which the output files (of rendering) are placed into. RenderGrid/RenderGrid.h  
RemoteControlValues TMap< FGuid, FRenderGridRemoteControlPropertyData > The remote control plugin can be used to customize and modify the way a job is rendered. RenderGrid/RenderGrid.h  
RenderPreset TObjectPtr< UMoviePipelinePrimaryConfig > The movie pipeline render preset. RenderGrid/RenderGrid.h  
WaitFramesBeforeRendering int32 Waits the given number of frames before it will render this job. RenderGrid/RenderGrid.h
  • EditInstanceOnly
  • Category="Render Grid Job"
  • Meta=(AllowPrivateAccess="true", ClampMin="0")

Functions

Public

Name Remarks Include Path Unreal Specifiers

void GenerateNewGuid()

 Randomly generates a new GUID. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

int32 GetCustomEndFrame()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FIntPoint GetCustomResolution()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

int32 GetCustomStartFrame()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

void GetDuration ( bool& bSuccess,
double& Duration
) const

 Gets the calculated duration in seconds, if possible. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

TOptional< double > GetDuration ()

 Gets the calculated duration (in seconds), if possible. RenderGrid/RenderGrid.h  

void GetEndFrame ( bool& bSuccess,
int32& EndFrame
) const

 Gets the calculated end frame, if possible. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

TOptional< int32 > GetEndFrame ()

 Gets the calculated end frame, if possible. RenderGrid/RenderGrid.h  

TOptional< double > GetEndTime ()

 Gets the calculated end time (in seconds), if possible. RenderGrid/RenderGrid.h  

void GetEndTime ( bool& bSuccess,
double& EndTime
) const

 Gets the calculated end time, if possible. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FGuid GetGuid()

 Returns the GUID, which is randomly generated at creation. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool GetIsEnabled()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool GetIsUsingCustomEndFrame()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool GetIsUsingCustomResolution()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool GetIsUsingCustomStartFrame()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FString GetJobId()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FString GetJobName()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

ULevelSequence * GetLevelSequence()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

double GetOutputAspectRatio()

 Gets the aspect ratio that this job will be rendered in. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FString GetOutputDirectory()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FString GetOutputDirectoryForDisplay()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FString GetOutputDirectoryRaw()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

FIntPoint GetOutputResolution()

 Gets the resolution that this job will be rendered in. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool GetRemoteControlFieldIdFromLabel ( const FString& Label,
FGuid& FieldId
) const

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool GetRemoteControlLabelFromFieldId ( const FGuid& FieldId,
FString& Label
) const

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

TArray< URemoteControlPreset * > GetRemoteControlPresets()

   RenderGrid/RenderGrid.h  

bool GetRemoteControlValue ( const FGuid& FieldId,
FString& Json
) const

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool GetRemoteControlValueBytes ( const TSharedPtr< FRemoteControlEntity >& RemoteControlEntity,
TArray< uint8 >& OutBytes
) const

   RenderGrid/RenderGrid.h  

bool GetRemoteControlValueBytes ( const FGuid& FieldId,
TArray< uint8 >& OutBytes
) const

   RenderGrid/RenderGrid.h  

TMap< FGuid, FString > GetRemoteControlValues()

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

TMap< FGuid, FRenderGridRemoteControlPropertyData > & GetRemoteControlValuesBytesRef()

   RenderGrid/RenderGrid.h  

UMoviePipelinePrimaryConfig * GetRenderPreset()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

UMoviePipelineOutputSetting * GetRenderPresetOutputSettings()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

TOptional< int32 > GetSequenceEndFrame()

 Gets the calculated end frame, not taking the framerate of the render preset into account. RenderGrid/RenderGrid.h  

TOptional< int32 > GetSequenceStartFrame()

 Gets the calculated start frame, not taking the framerate of the render preset into account. RenderGrid/RenderGrid.h  

void GetStartFrame ( bool& bSuccess,
int32& StartFrame
) const

 Gets the calculated start frame, if possible. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

TOptional< int32 > GetStartFrame ()

 Gets the calculated start frame, if possible. RenderGrid/RenderGrid.h  

void GetStartTime ( bool& bSuccess,
double& StartTime
) const

 Gets the calculated start time, if possible. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

TOptional< double > GetStartTime ()

 Gets the calculated start time (in seconds), if possible. RenderGrid/RenderGrid.h  

int32 GetWaitFramesBeforeRendering()

   RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

bool HasStoredRemoteControlValueBytes ( const FGuid& FieldId
) const

   RenderGrid/RenderGrid.h  

bool HasStoredRemoteControlValueBytes ( const TSharedPtr< FRemoteControlEntity >& RemoteControlEntity
) const

   RenderGrid/RenderGrid.h  

bool MatchesSearchTerm ( const FString& SearchTerm
) const

 Checks whether the job contains data that matches the search terms. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"

void SetCustomEndFrame ( const int32 NewCustomEndFrame
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetCustomResolution ( const FIntPoint NewCustomResolution
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetCustomStartFrame ( const int32 NewCustomStartFrame
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetIsEnabled ( const bool bEnabled
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetIsUsingCustomEndFrame ( const bool bNewOverrideEndFrame
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetIsUsingCustomResolution ( const bool bNewOverrideResolution
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetIsUsingCustomStartFrame ( const bool bNewOverrideStartFrame
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetJobId ( const FString& NewJobId
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetJobIdRaw ( const FString& NewJobId
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetJobName ( const FString& NewJobName
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetJobNameRaw ( const FString& NewJobName
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetLevelSequence ( ULevelSequence* NewSequence
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetOutputDirectory ( const FString& NewOutputDirectory
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

void SetOutputDirectoryRaw ( const FString& NewOutputDirectory
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

bool SetRemoteControlValue ( const FGuid& FieldId,
const FString& Json
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

bool SetRemoteControlValueBytes ( const TSharedPtr< FRemoteControlEntity >& RemoteControlEntity,
const TArray< uint8 >& Bytes
)

   RenderGrid/RenderGrid.h  

bool SetRemoteControlValueBytes ( const FGuid& FieldId,
const TArray< uint8 >& Bytes
)

   RenderGrid/RenderGrid.h  

void SetRenderPreset ( UMoviePipelinePrimaryConfig* NewRenderPreset
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"

bool SetSequenceEndFrame ( const int32 NewCustomEndFrame
)

 Sets the custom end frame to match the given sequence end frame. RenderGrid/RenderGrid.h  

bool SetSequenceStartFrame ( const int32 NewCustomStartFrame
)

 Sets the custom start frame to match the given sequence start frame. RenderGrid/RenderGrid.h  

void SetWaitFramesBeforeRendering ( const int32 NewWaitFramesBeforeRendering
)

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid Job"
Obtains a JSON representation of this object. RenderGrid/RenderGrid.h  
Obtains a string representation of this object. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid Job"
  • Meta=(DisplayName="To Debug String (Render Grid Job)", CompactNodeTitle="DEBUG")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page