Navigation
API > API/Plugins > API/Plugins/RenderGridEditor
The render grid editor interface.
| Name | IRenderGridEditor |
| Type | class |
| Header File | /Engine/Plugins/Experimental/RenderGrid/Source/RenderGridEditor/Public/IRenderGridEditor.h |
| Include Path | #include "IRenderGridEditor.h" |
Syntax
class IRenderGridEditor : public FBlueprintEditor
Inheritance Hierarchy
- FGCObject → FBlueprintEditor → IRenderGridEditor
- FNotifyHook → FBlueprintEditor → IRenderGridEditor
- FTickableObjectBase → FTickableEditorObject → FBlueprintEditor → IRenderGridEditor
- FEditorUndoClient → FBlueprintEditor → IRenderGridEditor
- FNoncopyable → FBlueprintEditor → IRenderGridEditor
Implements Interfaces
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnRenderGridChanged | TMulticastDelegate_NoParams< void > | IRenderGridEditor.h | |
| FOnRenderGridJobCreated | TMulticastDelegate_OneParam< void, URenderGridJob * > | IRenderGridEditor.h | |
| FOnRenderGridJobsSelectionChanged | TMulticastDelegate_NoParams< void > | IRenderGridEditor.h | |
| FOnRenderGridPreviewRenderedFirstTimeSinceAppStart | TMulticastDelegate_NoParams< void > | IRenderGridEditor.h | |
| FOnRenderGridShouldHideUIChanged | TMulticastDelegate_NoParams< void > | IRenderGridEditor.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnRenderGridChangedDelegate | FOnRenderGridChanged | The delegate for when data in the render grid changed. | IRenderGridEditor.h | |
| OnRenderGridJobCreatedDelegate | FOnRenderGridJobCreated | The delegate for when a render grid job is created. | IRenderGridEditor.h | |
| OnRenderGridJobsSelectionChangedDelegate | FOnRenderGridJobsSelectionChanged | The delegate for when the selection of render grid jobs changed. | IRenderGridEditor.h | |
| OnRenderGridPreviewRenderedFirstTimeSinceAppStartDelegate | FOnRenderGridPreviewRenderedFirstTimeSinceAppStart | The delegate for the first time (since the start of this application) that the preview is rendered. | IRenderGridEditor.h | |
| OnRenderGridShouldHideUIChangedDelegate | FOnRenderGridShouldHideUIChanged | The delegate for when the the result of ShouldHideUI() has changed. | IRenderGridEditor.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanCurrentlyRender() |
Returns whether it can currently render (like a preview render or a batch render) or not. | IRenderGridEditor.h | |
URenderGridQueue * GetBatchRenderQueue() |
Returns the current batch render queue, or null if it's not currently batch rendering. | IRenderGridEditor.h | |
URenderGrid * GetInstance() |
IRenderGridEditor.h | ||
URenderGridQueue * GetPreviewRenderQueue() |
Returns the current preview render queue, or null if it's not currently rendering a preview. | IRenderGridEditor.h | |
URenderGridBlueprint * GetRenderGridBlueprint() |
IRenderGridEditor.h | ||
TSharedPtr< Private::FRenderGridBlueprintEditorToolbar > GetRenderGridToolbarBuilder() |
IRenderGridEditor.h | ||
TArray< URenderGridJob * > GetSelectedRenderGridJobs() |
Get the currently selected render grid jobs. | IRenderGridEditor.h | |
bool IsBatchRendering() |
Returns whether it is currently batch rendering or not. | IRenderGridEditor.h | |
virtual bool IsCurrentlyRenderingOrPlaying() |
Returns whether it is currently rendering or playing (so changes in the level and such should be ignored). | IRenderGridEditor.h | |
bool IsPreviewRendering() |
Returns whether it is currently preview rendering or not. | IRenderGridEditor.h | |
void MarkAsModified() |
Marks the editing asset as modified. | IRenderGridEditor.h | |
virtual FOnRenderGridChanged & OnRenderGridChanged() |
IRenderGridEditor.h | ||
virtual FOnRenderGridJobCreated & OnRenderGridJobCreated() |
IRenderGridEditor.h | ||
virtual FOnRenderGridJobsSelectionChanged & OnRenderGridJobsSelectionChanged() |
IRenderGridEditor.h | ||
virtual FOnRenderGridPreviewRenderedFirstTimeSinceAppStart & OnRenderGridPreviewRenderedFirstTimeSinceAppStart() |
IRenderGridEditor.h | ||
virtual FOnRenderGridShouldHideUIChanged & OnRenderGridShouldHideUIChanged() |
IRenderGridEditor.h | ||
void SetIsDebugging
(
const bool bInIsDebugging |
Sets whether the blueprint editor is in debugging mode or not. | IRenderGridEditor.h | |
void SetPreviewRenderQueue
(
URenderGridQueue* Queue |
Sets the current preview render queue, set it to null if it's not currently rendering a preview. | IRenderGridEditor.h | |
void SetSelectedRenderGridJobs
(
const TArray< URenderGridJob* >& Jobs |
Set the selected render grid jobs. | IRenderGridEditor.h | |
virtual bool ShouldHideUI() |
Returns whether it is should currently hide the UI for things to not cause any bugs (like during rendering etc). | IRenderGridEditor.h |