1. Epic GamesDeveloper
  3. UUVEditorMode

UUVEditorMode

The UV editor mode is the mode used in the UV asset editor.

API > API/Plugins > API/Plugins/UVEditor

Inheritance Hierarchy

References

   
Module UVEditor
Header /Engine/Plugins/Editor/UVEditor/Source/UVEditor/Public/UVEditorMode.h
Include #include "UVEditorMode.h"

Syntax

UCLASS&40;Transient&41;  
class UUVEditorMode : public UEdMode

Remarks

The UV editor mode is the mode used in the UV asset editor. It holds most of the inter-tool state. We put things in a mode instead of directly into the asset editor in case we want to someday use the mode in multiple asset editors.

Variables

  Type Name Description
Protected variable TArray< TSharedPtr< UE::Geometry::FDynamicMesh3 > > AppliedCanonicalMeshes 1:1 with the asset arrays.
Protected variable TArray< TObjectPtr< UMeshOpPreviewWithBackgroundCompute > > AppliedPreviews 1:1 with AppliedCanonicalMeshes, the actual displayed 3d meshes that can be used by tools for background computations.
Protected variable TArray< FString > AssetNames 1:1 with ToolTargets, indexed by AssetID
Public variable UProperty TObjectPtr< UUVEditorBackgroundPreview > BackgroundVisualization We don't actually override MouseEnter, etc, because things get forwarded to the input router via FEditorModeTools, and we don't have any additional input handling to do at the mode level.
Protected variable FDelegateHandle BeginPIEDelegateHandle  
Protected variable bool bIsActive  
Protected variable bool bPIEModeActive Holds references to PIE callbacks to handle logic when the PIE session starts & shuts down.
Protected variable FDelegateHandle CancelPIEDelegateHandle  
Protected variable TArray< TWeakObjectPtr< UUVToolContextObject > > ContextsToShutdown  
Protected variable TArray< TWeakObjectPtr< UUVToolContextObject > > ContextsToUpdateOnToolEnd  
Protected variable FString DefaultToolIdentifier  
Public variable UProperty TObjectPtr< UUVEditorDistortionVisualization > DistortionVisualization  
Protected variable FDelegateHandle EndPIEDelegateHandle  
Protected variable TWeakObjectPtr< UEditorInteractiveToolsContext > LivePreviewITC Used to forward Render/DrawHUD calls in the live preview to the api object.
Protected variable UProperty TObjectPtr< UWorld > LivePreviewWorld Here largely for convenience to avoid having to pass it around functions.
Protected variable TSet< int32 > ModifiedAssetIDs Authoritative list of targets that have changes that have not been baked back yet.
Protected variable UProperty TArray< TObjectPtr< UObject > > OriginalObjectsToEdit Stores original input objects, for instance UStaticMesh pointers.
Protected variable TArray< int32 > PendingUVLayerIndex  
Protected variable FDelegateHandle PostSaveWorldDelegateHandle Holds references to Save callbacks to handle logic when the autosave triggers and shuts down active tools.
Protected variable UProperty TArray< TObjectPtr< UInteractiveToolPropertySet > > PropertyObjectsToTick Mode-level property objects (visible or not) that get ticked.
Protected variable UProperty TArray< TObjectPtr< UUVToolAction > > RegisteredActions  
Protected variable UProperty TObjectPtr< UUVToolSelectionAPI > SelectionAPI  
Protected variable UProperty TArray< TObjectPtr< UUVEditorToolMeshInput > > ToolInputObjects Input objects we give to the tools, one per displayed UV layer.
Protected variable UProperty TArray< TObjectPtr< UToolTarget > > ToolTargets Tool targets created from OriginalObjectsToEdit (and 1:1 with that array) that provide us with dynamic meshes whose UV layers we unwrap.
Protected variable TArray< FTransform > Transforms Transforms that should be used for the 3d previews, 1:1 with OriginalObjectsToEdit and ToolTargets.
Protected variable int32 UDIMsChangedWatcherId  
Public variable UProperty TObjectPtr< UUVEditorGridProperties > UVEditorGridProperties Hold a settings object to configure the grid.
Public variable UProperty TObjectPtr< UUVEditorUDIMProperties > UVEditorUDIMProperties Hold a settings object to configure the UDIMs.
Protected variable TArray< TWeakObjectPtr< UMeshElementsVisualizer > > WireframesToTick Wireframes have to get ticked to be able to respond to setting changes.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function void  
Public function Const bool  
Public function void

ChangeInputObjectLayer ( int32 AssetID,
int32 NewLayerIndex
)

 Public for use by undo/redo. Otherwise should use RequestUVChannelChange.
Public function Virtual void

DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

  
Public function void

EmitToolIndependentObjectChange ( UObject* TargetObject,
TUniquePtr< FToolCommandChange > Change,
const FText& Description
)

 TODO: We'll probably eventually want a function like this so we can figure out how big our 3d preview scene is and how we should position the camera intially...
Public function void  
Public function Const const TArray< FString > &  
Public function void  
Public function UObject *  
Public function Const int32

GetDisplayedChannel ( int32 AssetID
)

  
Public function UObject *  
Public function UObject *  
Public function Const int32

GetNumUVChannels ( int32 AssetID
)

  
Public function UObject *  
Public function Static const FToolTargetTypeRequirements & Gets the tool target requirements for the mode.
Public function UObject *  
Public function Static double Gets the factor by which UV layer unwraps get scaled (scaling makes certain things easier, like zooming in, etc).
Public function Const bool Asset management.
Public function Static void

InitializeAssetEditorContexts ( UContextObjectStore& ContextStore,
const TArray< TObjectPtr< UObject >>& AssetsIn,
const TArray< FTransform >& TransformsIn,
FEditorViewportClient& LivePreviewViewportClient,
FAssetEditorModeManager& LivePreviewModeManager,
UUVToolViewportButtonsAPI& ViewportButtonsAPI,
UUVTool2DViewportAPI& UVTool2DViewportAPI
)

 Called by an asset editor so that a created instance of the mode has all the data it needs on Enter() to initialize itself.
Protected function void  
Protected function void  
Public function bool  
Public function Virtual bool This is currently not part of the base class at all... Should it be?
Public function Const void

PopulateUDIMsByAsset ( int32 AssetId,
TArray< FUDIMSpecifier >& UDIMsOut
)

  
Protected function void  
Protected function void  
Public function Virtual void  
Public function void

RequestUVChannelChange ( int32 AssetID,
int32 Channel
)

 Request a change of the displayed UV channel/layer.
Protected function void

SetDisplayedUVChannels ( const TArray< int32 >& LayerPerAsset,
bool bEmitUndoTransaction
)

 Used with the ToolAssetAndLayerAPI to process tool layer change requests.
Protected function void

SetSimulationWarning ( bool bEnabled
)

  
Protected function void  
Protected function void  
Protected function void  

Overridden from UEdMode

  Type Name Description
Public function Virtual void We're changing visibility of this one to public here so that we can call it from the toolkit when clicking accept/cancel buttons.
Protected function Virtual void Not sure whether we need these yet.
Protected function Virtual void  
Public function Virtual void

Enter ()

  
Public function Virtual void

Exit ()

  
Public function Virtual void

ModeTick ( float DeltaTime
)

  
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual Const bool

ShouldToolStartBeAllowed ( const FString& ToolIdentifier
)

 Subclasses can override this to add additional checks on whether a tool should be allowed to start.

Constants

Name Description
AnalyticsLastStartTimestamp  
EM_UVEditorModeId  

Deprecated Functions

  Type Name Description
Protected function void

UpdateTriangleMaterialBasedOnBackground ( bool IsBackgroundVisible
)

 UpdateTriangleMaterialBasedOnBackground is deprecated, replaced by the more generic UpdateTriangleMaterialBasedOnDisplaySettings.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page