Navigation
API > API/Plugins > API/Plugins/ModelingComponents
UUVLayoutPreview is a utility object that creates and manages a 3D plane on which a UV layout for a 3D mesh is rendered. The UV layout
| Name | UUVLayoutPreview |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Drawing/UVLayoutPreview.h |
| Include Path | #include "Drawing/UVLayoutPreview.h" |
Syntax
UCLASS (MinimalAPI, Transient)
class UUVLayoutPreview : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UUVLayoutPreview
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UUVLayoutPreview() |
Drawing/UVLayoutPreview.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BackingRectangleMaterial | TObjectPtr< UMaterialInterface > | Configure the backing rectangle material | Drawing/UVLayoutPreview.h | |
| bShowBackingRectangle | bool | Configure whether the backing rectangle should be shown | Drawing/UVLayoutPreview.h | |
| MeshElementsVisualizer | TObjectPtr< UMeshElementsVisualizer > | MeshElementsVisualizer references the PreviewMesh to handle drawing the wireframes for UVs | Drawing/UVLayoutPreview.h | |
| PreviewMesh | TObjectPtr< UPreviewMesh > | PreviewMesh is initialized with a copy of an input mesh with UVs mapped to position, ie such that (X,Y,Z) = (U,V,0) | Drawing/UVLayoutPreview.h | |
| Settings | TObjectPtr< UUVLayoutPreviewProperties > | Visualization settings | Drawing/UVLayoutPreview.h | |
| TriangleComponent | TObjectPtr< UTriangleSetComponent > | Set of additional triangles to draw, eg for backing rectangle, etc | Drawing/UVLayoutPreview.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void CreateInWorld
(
UWorld* World |
Create preview mesh in the World with the given transform | Drawing/UVLayoutPreview.h | |
void Disconnect() |
Remove and destroy preview mesh | Drawing/UVLayoutPreview.h | |
void OnTick
(
float DeltaTime |
Tick the UV Layout Preview, allowing it to update various settings | Drawing/UVLayoutPreview.h | |
void Render
(
IToolsContextRenderAPI* RenderAPI |
Render the UV Layout Preview, allowing it to update various settings | Drawing/UVLayoutPreview.h | |
void SetCurrentCameraState
(
const FViewCameraState& CameraState |
Update the current camera state, used to auto-position the UV layout preview | Drawing/UVLayoutPreview.h | |
void SetSourceMaterials
(
const FComponentMaterialSet& MaterialSet |
Configure material set for UV-space preview mesh | Drawing/UVLayoutPreview.h | |
void SetSourceWorldPosition
(
FTransform WorldTransform, |
Specify the current world transform/bounds for the target object. | Drawing/UVLayoutPreview.h | |
void SetTransform
(
const FTransform& UseTransform |
Set the transform on the UV Layout preview mesh | Drawing/UVLayoutPreview.h | |
void SetVisible
(
bool bVisible |
Set the visibility of the UV Layout preview mesh | Drawing/UVLayoutPreview.h | |
void UpdateUVMesh
(
const FDynamicMesh3* SourceMesh, |
Notify the UV Layout Preview that the source UVs have been modified | Drawing/UVLayoutPreview.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetCurrentScale() |
Drawing/UVLayoutPreview.h | ||
void RecalculatePosition() |
Drawing/UVLayoutPreview.h |