1. Epic GamesDeveloper
  3. URenderGrid

URenderGrid

This class represents a render grid, which is basically just a collection of render grid jobs.

API > API/Plugins > API/Plugins/RenderGrid

This class represents a render grid, which is basically just a collection of render grid jobs. A render grid is the asset that is shown in the content browser, it's the asset that can be opened and edited using the editor.

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

Syntax

UCLASS (Blueprintable, BlueprintType, EditInlineNew, Meta=(DontUseGenericSpawnObject="true"))  
class URenderGrid : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

URenderGrid()

   RenderGrid/RenderGrid.h  

Typedefs

Name Type Remarks Include Path
FRenderGridRunRenderJobsCallback TBaseDelegate_TwoParams< URenderGridQueue *, URenderGrid *, TArray< URenderGridJob * > >   RenderGrid/RenderGrid.h
FRenderGridRunRenderJobsDefaultObjectCallback TBaseDelegate_TwoParams< URenderGridQueue *, URenderGrid *, TArray< URenderGridJob * > >   RenderGrid/RenderGrid.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bExecutingBlueprintEvent bool True when it's currently executing a blueprint event, false otherwise. RenderGrid/RenderGrid.h
  • Transient
CachedWorldWeakPtr TWeakObjectPtr< UWorld > GetWorld calls can be expensive, we speed them up by caching the last found world until it goes away. RenderGrid/RenderGrid.h  
Defaults TObjectPtr< URenderGridDefaults > The default values for new jobs. RenderGrid/RenderGrid.h
  • Instanced
Guid FGuid The unique ID of this render grid. RenderGrid/RenderGrid.h  
RenderGridJobs TArray< TObjectPtr< URenderGridJob > > The jobs of this render grid. RenderGrid/RenderGrid.h
  • Instanced
Settings TObjectPtr< URenderGridSettings > The settings of this render grid. RenderGrid/RenderGrid.h
  • Instanced

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddRenderGridJob ( URenderGridJob* Job
)

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

virtual void BeginBatchRender ( URenderGridQueue* Queue
)

 Overridable native event for when batch rendering begins. RenderGrid/RenderGrid.h  

virtual void BeginEditor ()

 Overridable native event for when this asset is opened in the editor. RenderGrid/RenderGrid.h  

virtual void BeginJobRender ( URenderGridQueue* Queue,
URenderGridJob* Job
)

 Overridable native event for when job rendering begins. RenderGrid/RenderGrid.h  

virtual void BeginViewportRender ( URenderGridJob* Job
)

 Overridable native event for when job rendering for the viewport viewer-mode begins. RenderGrid/RenderGrid.h  

void ClearRenderGridJobs()

   RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"
  • Meta=(Keywords="remove delete all")

void CopyAllProperties ( URenderGrid* From
)

 Copy all properties from the given RenderGrid to self. RenderGrid/RenderGrid.h  

void CopyAllPropertiesExceptJobs ( URenderGrid* From
)

 Copy all properties except jobs from the given RenderGrid to self. RenderGrid/RenderGrid.h  

void CopyAllUserVariables ( URenderGrid* From
)

 Copy all user variables (configured in the blueprint graph) from the given RenderGrid to self. RenderGrid/RenderGrid.h  

void CopyJobs ( URenderGrid* From
)

 Copy jobs from the given RenderGrid to self. RenderGrid/RenderGrid.h  

URenderGridJob * CreateAndAddNewRenderGridJob()

 Creates a new job and adds it to this grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridJob * CreateTempRenderGridJob()

 Creates a new job. This job won't be added to the grid, so it will eventually be garbage collected. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

bool DoesJobIdExist ( const FString& JobId
)

 Finds whether given job ID already exists in this grid. RenderGrid/RenderGrid.h
  • BlueprintPure
  • Category="Render Grid"

URenderGridJob * DuplicateAndAddRenderGridJob ( URenderGridJob* Job
)

 Copy the given job in this grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

virtual void EndBatchRender ( URenderGridQueue* Queue
)

 Overridable native event for when batch rendering ends. RenderGrid/RenderGrid.h  

virtual void EndEditor ()

 Overridable native event for when this asset is closed in the editor. RenderGrid/RenderGrid.h  

virtual void EndJobRender ( URenderGridQueue* Queue,
URenderGridJob* Job
)

 Overridable native event for when job rendering ends. RenderGrid/RenderGrid.h  

virtual void EndViewportRender ( URenderGridJob* Job
)

 Overridable native event for when job rendering for the viewport viewer-mode ends. RenderGrid/RenderGrid.h  

void GenerateNewGuid()

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

FString GenerateNextJobId()

 Generates a unique job ID by finding the currently highest job ID and increasing it by one. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

FString GenerateUniqueRandomJobId()

 Generates a unique job ID by grabbing the current time, as well as 16 random bytes, and converting that to a base64 string. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

ULevelSequence * GetDefaultLevelSequence()

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

FString GetDefaultOutputDirectory()

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

FString GetDefaultOutputDirectoryForDisplay()

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

FString GetDefaultOutputDirectoryRaw()

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

UMoviePipelinePrimaryConfig * GetDefaultRenderPreset()

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

UMoviePipelineOutputSetting * GetDefaultRenderPresetOutputSettings()

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

URenderGridDefaults * GetDefaultsObject()

   RenderGrid/RenderGrid.h  

TArray< URenderGridJob * > GetDisabledRenderGridJobs()

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

TArray< URenderGridJob * > GetEnabledRenderGridJobs()

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

FGuid GetGuid()

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

int32 GetIndexOfRenderGridJob ( URenderGridJob* Job
) const

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

TSoftObjectPtr< UWorld > GetLevel()

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

Type * GetPropsSource ()

   RenderGrid/RenderGrid.h  

UObject * GetPropsSourceOrigin()

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

ERenderGridPropsSourceType GetPropsSourceType()

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

TArray< URenderGridJob * > GetRenderGridJobs()

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

TArray< TObjectPtr< URenderGridJob > > & GetRenderGridJobsRef()

   RenderGrid/RenderGrid.h  

URenderGridSettings * GetSettingsObject()

   RenderGrid/RenderGrid.h  

virtual UWorld * GetWorld()

   RenderGrid/RenderGrid.h  

bool HasAnyRenderGridJobs()

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

bool HasRenderGridJob ( URenderGridJob* Job
) const

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

void InsertRenderGridJob ( URenderGridJob* Job,
int32 Index
)

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

void InsertRenderGridJobAfter ( URenderGridJob* Job,
URenderGridJob* AfterJob
)

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

void InsertRenderGridJobBefore ( URenderGridJob* Job,
URenderGridJob* BeforeJob
)

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

bool IsCurrentlyExecutingUserCode()

 Returns true when it's currently executing a blueprint implementable event, returns false otherwise. RenderGrid/RenderGrid.h  

void RemoveRenderGridJob ( URenderGridJob* Job
)

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

URenderGridQueue * Render()

 Renders all the enabled jobs of this render grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderJob ( URenderGridJob* Job
)

 Renders the given job of this render grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderJobs ( const TArray< URenderGridJob* >& Jobs
)

 Renders all the given jobs of this render grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderJobSingleFrame ( URenderGridJob* Job,
const int32 Frame
)

 Renders the given job of this render grid. Only renders a single frame. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderJobSingleFramePosition ( URenderGridJob* Job,
const double FramePosition
)

 Renders the given job of this render grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderJobsSingleFrame ( const TArray< URenderGridJob* >& Jobs,
const int32 Frame
)

 Renders all the given jobs of this render grid. Only renders a single frame of each job. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderJobsSingleFramePosition ( const TArray< URenderGridJob* >& Jobs,
const double FramePosition
)

 Renders all the given jobs of this render grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderSingleFrame ( const int32 Frame
)

 Renders all the enabled jobs of this render grid. Only renders a single frame of each job. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

URenderGridQueue * RenderSingleFramePosition ( const double FramePosition
)

 Renders all the enabled jobs of this render grid. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

bool ReorderRenderGridJob ( URenderGridJob* Job,
URenderGridJob* DroppedOnJob,
const bool bAfter
)

 Relocates the given job in this grid to the position of the given dropped-on job. RenderGrid/RenderGrid.h
  • BlueprintCallable
  • Category="Render Grid"

void SetDefaultLevelSequence ( ULevelSequence* NewSequence
)

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

void SetDefaultOutputDirectory ( const FString& NewOutputDirectory
)

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

void SetDefaultOutputDirectoryRaw ( const FString& NewOutputDirectory
)

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

void SetDefaultRenderPreset ( UMoviePipelinePrimaryConfig* NewRenderPreset
)

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

void SetPropsSource ( ERenderGridPropsSourceType InPropsSourceType,
UObject* InPropsSourceOrigin
)

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

void SetRenderGridJobs ( const TArray< URenderGridJob* >& Jobs
)

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

virtual void Tick ( float DeltaTime
)

 Overridable native event for when this asset is ticked by the editor. RenderGrid/RenderGrid.h  
Obtains a JSON representation of this object. RenderGrid/RenderGrid.h  

FString ToDebugString ()

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostLoad()

   RenderGrid/RenderGrid.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   RenderGrid/RenderGrid.h  

Protected

Name Remarks Include Path Unreal Specifiers
Event for when batch rendering begins. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="BeginBatchRender")
Event for when this asset is opened in the editor. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="BeginEditor")
Event for when job rendering begins. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="BeginJobRender")
Event for when job rendering for the viewport viewer-mode begins. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="BeginViewportRender")
Event for when batch rendering ends. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="EndBatchRender")
Event for when this asset is closed in the editor. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="EndEditor")
Event for when job rendering ends. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="EndJobRender")
Event for when job rendering for the viewport viewer-mode ends. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="EndViewportRender")

void ReceiveTick ( float DeltaTime
)

 The tick event, will only execute when the asset is open in the editor. RenderGrid/RenderGrid.h
  • BlueprintImplementableEvent
  • Meta=(DisplayName="Tick")

Static

Name Remarks Include Path Unreal Specifiers

static TArray< FString > GetBlueprintImplementableEvents()

   RenderGrid/RenderGrid.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page