Navigation
API > API/Plugins > API/Plugins/UVEditor
Serves as a container for the background texture/material display in the UVEditor. This class is responsible for managing the quad drawn behind the grid, as well as maintaining the texture and material choices from the user to display.
| Name | UUVEditorBackgroundPreview |
| Type | class |
| Header File | /Engine/Plugins/Editor/UVEditor/Source/UVEditor/Public/UVEditorBackgroundPreview.h |
| Include Path | #include "UVEditorBackgroundPreview.h" |
Syntax
UCLASS (MinimalAPI, Transient)
class UUVEditorBackgroundPreview : public UPreviewGeometry
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UPreviewGeometry → UUVEditorBackgroundPreview
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FOnBackgroundMaterialChange | TMulticastDelegate_OneParam< void, TObjectPtr< UMaterialInstanceDynamic > MaterialInstance > | UVEditorBackgroundPreview.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackgroundComponent | TObjectPtr< UTriangleSetComponent > | The component containing the quad visualization | UVEditorBackgroundPreview.h | |
| BackgroundMaterial | TObjectPtr< UMaterialInstanceDynamic > | The active material being displayed for the background | UVEditorBackgroundPreview.h | |
| OnBackgroundMaterialChange | FOnBackgroundMaterialChange | UVEditorBackgroundPreview.h | ||
| Settings | TObjectPtr< UUVEditorBackgroundPreviewProperties > | Visualization settings | UVEditorBackgroundPreview.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void OnTick
(
float DeltaTime |
Client must call this every frame for changes to .Settings to be reflected in rendered result. | UVEditorBackgroundPreview.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void UpdateBackground() |
UVEditorBackgroundPreview.h | ||
void UpdateVisibility() |
UVEditorBackgroundPreview.h |
Overridden from UPreviewGeometry
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnCreated() |
UVEditorBackgroundPreview.h |