1. Epic GamesDeveloper
  3. UVREditorUISystem

UVREditorUISystem

VR Editor user interface manager

API > API/Editor > API/Editor/VREditor

VR Editor user interface manager

   
Name UVREditorUISystem
Type class
Header File /Engine/Source/Editor/VREditor/Public/UI/VREditorUISystem.h
Include Path #include "UI/VREditorUISystem.h"

Syntax

UCLASS ()  
class UVREditorUISystem : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UVREditorUISystem()

 Default constructor UI/VREditorUISystem.h  

Constants

Name Type Remarks Include Path
ColorPickerPanelID const VREditorPanelID   UI/VREditorUISystem.h
ContentBrowserPanelID const VREditorPanelID   UI/VREditorUISystem.h
DetailsPanelID const VREditorPanelID   UI/VREditorUISystem.h
InfoDisplayPanelID const VREditorPanelID   UI/VREditorUISystem.h
ModesPanelID const VREditorPanelID   UI/VREditorUISystem.h
RadialMenuPanelID const VREditorPanelID   UI/VREditorUISystem.h
SequencerPanelID const VREditorPanelID   UI/VREditorUISystem.h
TabManagerPanelID const VREditorPanelID   UI/VREditorUISystem.h
TutorialPanelID const VREditorPanelID   UI/VREditorUISystem.h
WorldOutlinerPanelID const VREditorPanelID   UI/VREditorUISystem.h
WorldSettingsPanelID const VREditorPanelID   UI/VREditorUISystem.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool CanScalePanel()

 If a dockable window can be scaled UI/VREditorUISystem.h  

AVREditorDockableWindow * GetDraggingDockUI()

 Returns the current dragged dock window, nullptr if none UI/VREditorUISystem.h  

float GetMaxDockWindowSize()

 Get the maximum dock window size UI/VREditorUISystem.h  

float GetMinDockWindowSize()

 Get the minimum dock window size UI/VREditorUISystem.h  

const UVREditorMode & GetOwner ()

 Gets the owner of this system (const) UI/VREditorUISystem.h  
Gets the owner of this system UI/VREditorUISystem.h  

AVREditorFloatingUI * GetPanel ( const VREditorPanelID& InPanelID
) const

 Get UI panel Actor from the passed ID UI/VREditorUISystem.h  

AVREditorRadialFloatingUI * GetRadialMenuFloatingUI()

 Returns the radial widget so other classes, like the interactors, can access its functionality UI/VREditorUISystem.h  

UVRRadialMenuHandler * GetRadialMenuHandler()

   UI/VREditorUISystem.h  

UVREditorInteractor * GetUIInteractor()

 Get the interactor that holds the radial menu UI/VREditorUISystem.h  

void HideRadialMenu ( const bool bPlaySound,
const bool bAllowFading
)

 Hides the radial menu if the specified hand is showing it UI/VREditorUISystem.h  

void Init ( UVREditorMode* InVRMode
)

 Initializes default values for the UISystem and creates the UI panels UI/VREditorUISystem.h  

bool IsDraggingDockUI()

 Are we currently dragging a dock window UI/VREditorUISystem.h  

bool IsDraggingPanelFromOpen()

 If a panel was opened and dragged with the UI interactor UI/VREditorUISystem.h  

bool IsInteractorDraggingDockUI ( const UVREditorInteractor* Interactor
) const

   UI/VREditorUISystem.h  

bool IsShowingEditorUIPanel ( const VREditorPanelID& InPanelID
) const

 Returns true if the specified editor UI panel is currently visible UI/VREditorUISystem.h  

bool IsShowingRadialMenu ( const UVREditorInteractor* Interactor
) const

 Returns true if the radial menu is visible on this hand UI/VREditorUISystem.h  

FTransform MakeDockableUITransform ( AVREditorDockableWindow* InitDraggingDockUI,
UVREditorInteractor* Interactor,
const float DockSelectDistance
)

 Makes up a transform for a dockable UI when dragging it that includes the original offset from the laser's impact point UI/VREditorUISystem.h  

FTransform MakeDockableUITransformOnLaser ( AVREditorDockableWindow* InitDraggingDockUI,
UVREditorInteractor* Interactor,
const float DockSelectDistance
) const

 Makes up a transform for a dockable UI when dragging it with a laser at the specified distance from the laser origin UI/VREditorUISystem.h  

void OnHoverBeginEffect ( UVREditorWidgetComponent* Button
)

 Called when a laser or simulated mouse hover enters a button UI/VREditorUISystem.h  

void OnHoverEndEffect ( UVREditorWidgetComponent* Button
)

 Called when a laser or simulated mouse hover leaves a button UI/VREditorUISystem.h  

void Render ( const FSceneView* SceneView,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI
)

 Called by VREditorMode to draw debug graphics every frame UI/VREditorUISystem.h  

void SequencerOpenendFromRadialMenu ( const bool bInOpenedFromRadialMenu
)

 Set if sequencer was opened from the radial menu UI/VREditorUISystem.h  

void ShowEditorUIPanel ( const UWidgetComponent* WidgetComponent,
UVREditorInteractor* Interactor,
const bool bShouldShow,
const bool bSpawnInFront,
const bool bDragFromOpen,
const bool bPlaySound
)

 Sets whether the specified editor UI panel should be visible. UI/VREditorUISystem.h  

void ShowEditorUIPanel ( const VREditorPanelID& InPanelID,
UVREditorInteractor* Interactor,
const bool bShouldShow,
const bool bSpawnInFront,
const bool bDragFromOpen,
const bool bPlaySound
)

   UI/VREditorUISystem.h  

void ShowEditorUIPanel ( AVREditorFloatingUI* Panel,
UVREditorInteractor* Interactor,
const bool bShouldShow,
const bool bSpawnInFront,
const bool bDragFromOpen,
const bool bPlaySound
)

   UI/VREditorUISystem.h  

void Shutdown()

 Shuts down the UISystem whenever the mode is exited UI/VREditorUISystem.h  

void StartDraggingDockUI ( AVREditorDockableWindow* InitDraggingDockUI,
UVREditorInteractor* Interactor,
const float DockSelectDistance,
const bool bPlaySound
)

 Start dragging a dock window on the hand UI/VREditorUISystem.h  

void StopDraggingDockUI ( UVREditorInteractor* VREditorInteractor,
const bool bPlaySound
)

 Resets all values to stop dragging the current dock window UI/VREditorUISystem.h  

void Tick ( FEditorViewportClient* ViewportClient,
const float DeltaTime
)

 Called by VREditorMode to update us every frame UI/VREditorUISystem.h  

void TogglePanelsVisibility()

 Hides and unhides all the editor UI panels UI/VREditorUISystem.h  

void TogglePanelVisibility ( const VREditorPanelID& InPanelID
)

 Toggles the visibility of the panel, if the panel is in room space it will be hidden and docked to nothing UI/VREditorUISystem.h  

void TransitionWorld ( UWorld* NewWorld,
EEditorWorldExtensionTransitionState TransitionState
)

 Transition the user widgets to a new world UI/VREditorUISystem.h  

void TryToSpawnRadialMenu ( UVREditorInteractor* Interactor,
const bool bForceRefresh,
const bool bPlaySound
)

 Tries to spawn the radial menu (if the specified hand isn't doing anything else) UI/VREditorUISystem.h  

void UpdateActorPreviewUI ( TSharedRef< SWidget > InWidget,
int32 Index,
AActor* InActor
)

 Function to force an update of the Actor Preview UI based on a change UI/VREditorUISystem.h  

void UpdateDetachedActorPreviewUI ( TSharedRef< SWidget > InWidget,
int32 Index
)

 Function to force an update of the Actor Preview UI based on a change when the preview is detached from the actor UI/VREditorUISystem.h  

void UpdateExternalSlateUI ( TSharedRef< SWidget > InWidget,
FName Name,
FVector2D InSize
)

   UI/VREditorUISystem.h  

void UpdateExternalUMGUI ( const FVREditorFloatingUICreationContext& CreationContext
)

   UI/VREditorUISystem.h  

void UpdateInteractors()

   UI/VREditorUISystem.h  

void UpdateSequencerUI()

 Function to force an update of the Sequencer UI based on a change UI/VREditorUISystem.h  

Protected

Name Remarks Include Path Unreal Specifiers

TSharedRef< SWidget > AddHoverableButton ( TSharedRef< SWidget >& BlockWidget,
FName ButtonType,
TSharedRef< SOverlay >& TestOverlay
)

 Adds a hoverable button of a given type to an overlay, using menu data from a BlockWidget UI/VREditorUISystem.h  

void BuildNumPadWidget()

 Builds the numpad Slate widget UI/VREditorUISystem.h  

void BuildRadialMenuWidget()

 Builds the radial menu Slate widget UI/VREditorUISystem.h  

bool CheckForVRDragDrop()

 The VR Editor UI System's rules for when drag drop should be checked for UI/VREditorUISystem.h  

void CreateUIs()

 Testing SlateUI UI/VREditorUISystem.h  

void CreateVRColorPicker ( const TSharedRef< SColorPicker >& ColorPicker
)

 Creates a VR-specific color picker. Gets bound to SColorPicker's creation override delegate UI/VREditorUISystem.h  

void DestroyVRColorPicker()

 Hides the VR-specific color picker. Gets bound to SColorPicker's destruction override delegate UI/VREditorUISystem.h  

void DockableAreaRestored()

 Can be used when the tab manager is restoring a dockable tab area UI/VREditorUISystem.h  

void HandleEditorModeChanged ( const FEditorModeID& EditorModeID,
bool IsEnabled
)

 Handles being notified when any editor mode changes to see if any VR Editor UI needs to change. UI/VREditorUISystem.h  

void IsProxyTabSupported ( FTabId TabId,
bool& bOutIsTabSupported
)

 Called by proxy tab manager to ask us whether we support the specified tab ID. UI/VREditorUISystem.h  

void MakeRadialBoxMenu ( const TSharedRef< FMultiBox >& MultiBox,
const TSharedRef< SMultiBoxWidget >& MultiBoxWidget,
float RadiusRatioOverride,
FName ButtonTypeOverride
)

 Makes a radial box widget from the menu information contained in a MultiBox and MultiBoxWidget UI/VREditorUISystem.h  

void MakeUniformGridMenu ( const TSharedRef< FMultiBox >& MultiBox,
const TSharedRef< SMultiBoxWidget >& MultiBoxWidget,
int32 Columns
)

 Makes a uniform grid widget from the menu information contained in a MultiBox and MultiBoxWidget UI/VREditorUISystem.h  

void OnAssetEditorOpened ( UObject* Asset
)

 Called when an asset editor opens an asset while in VR Editor Mode. UI/VREditorUISystem.h  

void OnAttentionDrawnToTab ( TSharedPtr< SDockTab > NewTab
)

 Called when the injected proxy tab manager reports needing to draw attention to a tab. UI/VREditorUISystem.h  

void OnCloseAssetEditor ( UObject* Asset,
EAssetEditorCloseReason CloseReason
)

   UI/VREditorUISystem.h  

void OnPreviewInputAction ( FEditorViewportClient& ViewportClient,
UViewportInteractor* Interactor,
const FViewportActionKeyInput& Action,
bool& bOutIsInputCaptured,
bool& bWasHandled
)

 Called to "preview" an input event to get a first chance at it. UI/VREditorUISystem.h  

void OnProxyTabLaunched ( TSharedPtr< SDockTab > NewTab
)

 Called when the injected proxy tab manager reports a new tab has been launched, signaling an asset editor has been launched, but really it could be any major global tab. UI/VREditorUISystem.h  

void OnVRAction ( FEditorViewportClient& ViewportClient,
UViewportInteractor* Interactor,
const FViewportActionKeyInput& Action,
bool& bOutIsInputCaptured,
bool& bWasHandled
)

 Called when the user presses a button on their motion controller device UI/VREditorUISystem.h  

void OnVRHoverUpdate ( UViewportInteractor* Interactor,
FVector& HoverImpactPoint,
bool& bWasHandled
)

 Called every frame to update hover state UI/VREditorUISystem.h  

void ResetAll()

 Reset function that puts you back in placement mode, closes all UIs, etc. UI/VREditorUISystem.h  

TSharedRef< SWidget > SetButtonFormatting ( TSharedRef< SWidget >& BlockWidget,
float WrapSize
)

 Sets the text wrap size of the text block element nested in a BlockWidget UI/VREditorUISystem.h  

bool ShouldPreviewPanel()

 Preview the UI panel's location if spawning with the UI interactor, else spawn immediately UI/VREditorUISystem.h  

void ShowAssetEditor()

 Show the asset editor if it's not currently visible. UI/VREditorUISystem.h  

void SwapRadialMenu()

 Swaps the content of the radial menu between the radial menu and the numpad UI/VREditorUISystem.h  

void ToggledDebugMode ( bool bDebugModeEnabled
)

 When VR Mode debug was toggled. UI/VREditorUISystem.h  

Static

Name Remarks Include Path Unreal Specifiers

static const bool FindAllWidgetsOfType ( TArray< TSharedRef< SWidget > >& FoundWidgets,
const TSharedRef< SWidget >& Content,
FName WidgetType
)

 Finds a widget with a given name inside the Content argument UI/VREditorUISystem.h  

static const TSharedRef< SWidget > & FindWidgetOfType ( const TSharedRef< SWidget >& Content,
FName WidgetType
)

 Finds a widget with a given name inside the Content argument UI/VREditorUISystem.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page