1. Epic GamesDeveloper
  3. FUVEditorModeToolkit

FUVEditorModeToolkit

The UV editor mode toolkit is responsible for the panel on the side in the UV editor that shows mode and tool properties.

API > API/Plugins > API/Plugins/UVEditor

Inheritance Hierarchy

References

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

Syntax

class FUVEditorModeToolkit : public FModeToolkit

Remarks

The UV editor mode toolkit is responsible for the panel on the side in the UV editor that shows mode and tool properties. Tool buttons would go in Init().

Variables

  Type Name Description
Protected variable const FSlateBrush * ActiveToolIcon  
Protected variable FStatusBarMessageHandle ActiveToolMessageHandle  
Protected variable FText ActiveToolName  
Protected variable bool bFirstInitializeAfterModeSetup  
Protected variable bool bShowPIEWarning  
Protected variable TSharedPtr< SBorder > EditorDetailsContainer A container for the editor settings.
Protected variable TSharedPtr< STransformGizmoNumericalUIOverlay > GizmoNumericalUIOverlayWidget  
Protected variable TSharedPtr< STextBlock > ModeWarningArea A place for the mode to write out any warnings.
Protected variable TSharedPtr< SBorder > ToolButtonsContainer The portion of the toolbox composed of buttons that activate tools.
Protected variable TSharedPtr< SBorder > ToolDetailsContainer A container for the tool settings that is populated by the DetailsView managed in FModeToolkit
Protected variable TSharedPtr< SWidget > ToolkitWidget The mode's entire toolbox, which gets returned by GetInlineContent()
Protected variable TSharedPtr< STextBlock > ToolWarningArea A place for tools to write out any warnings.
Protected variable TSharedPtr< SWidget > ViewportOverlayWidget Contains the widget container for the Accept/Cancel buttons for tools.

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual TSharedRef< SWidget > Creates a widget where the background visualization can be changed.
Public function Virtual TSharedRef< SWidget > Creates a menu where the displayed UV Channel can be changed for each asset
Protected function Const TSharedRef< SWidget >

CreateDisplaySettingsWidget ( UObject* SettingsObject
)

  
Public function Virtual TSharedRef< SWidget > Creates a widget where the distortion visualization settings can be changed.
Public function Virtual TSharedRef< SWidget > Creates a widget where the grid display can be changed.
Public function Virtual TSharedRef< SWidget > Creates a widget where the visible UDIMs can be changed.
Public function Virtual void

EnableShowPIEWarning ( bool bEnable
)

 Enables or diables the Play in Editor mode warning for the editor
Public function Virtual TSharedRef< SWidget > Creates a widget where the active tool's display settings can be changed.
Public function Virtual void  
Protected function void  
Public function Virtual void Creates submenu for manipulating the gizmo numerical UI
Public function Virtual void

PostModeWarning ( const FText& Message
)

 Set/clear mode-level warning message area. These messages don't get cleared on tool shutdown.
Public function Virtual void

PostNotification ( const FText& Message
)

 Set/clear notification message area
Public function Virtual void

PostWarning ( const FText& Message
)

 Set/clear warning message area
Protected function void  
Protected function void  

Overridden from FModeToolkit

  Type Name Description
Public function Virtual void

BuildToolPalette ( FName PaletteName,
FToolBarBuilder& ToolbarBuilder
)

 For a specific tool palette category, construct and fill ToolbarBuilder with the category's tools
Public function Virtual Const FText  
Public function Virtual Const FText Returns human readable name for the specific palette tool category
Public function Virtual Const void

GetToolPaletteNames ( TArray< FName >& InPaletteName
)

 Returns the Mode specific tabs in the mode toolbar
Public function Virtual Const bool Exclusive Tool Palettes only allow users to use tools from one palette at a time
Public function Virtual Const bool Informs the built in FModeToolkit palette building routines about how we want the toolbars to be setup
Public function Virtual void

Init ( const TSharedPtr< IToolkitHost >& InitToolkitHost,
TWeakObjectPtr< UEdMode > InOwningMode
)

 FModeToolkit.
Protected function Virtual void  
Protected function Virtual void FModeToolkit.

Overridden from IToolkit

  Type Name Description
Public function Virtual Const FText Returns the localized name of this toolkit type (typically just " editor")
Public function Virtual Const TSharedPtr< class SWidget >  
Public function Virtual Const FName IToolkit.

Constants

Name Description
PaletteNames_Standard  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page