1. Epic GamesDeveloper
  3. UVREditorUISystem

UVREditorUISystem

VR Editor user interface manager

API > API/Editor > API/Editor/VREditor > API/Editor/VREditor/UI

Inheritance Hierarchy

References

   
Module VREditor
Header /Engine/Source/Editor/VREditor/Public/UI/VREditorUISystem.h
Include #include "UI/VREditorUISystem.h"

Syntax

class UVREditorUISystem : public UObject

Remarks

VR Editor user interface manager

Variables

  Type Name Description
Protected variable FDelegateHandle AssetEditorCloseDelegate  
Protected variable bool bDragPanelFromOpen If started dragging from opening a UI panel
Protected variable bool bPanelCanScale When started dragging from the radial menu we want the analog stick to be reset before the user is allowed to scale the panel.
Protected variable bool bRadialMenuIsNumpad True if the radial menu is currently displaying the numpad
Protected variable bool bRadialMenuVisibleAtSwap True if the radial menu was visible when the content was swapped
Protected variable bool bRefocusViewport Set to true when we need to refocus the viewport.
Protected variable bool bSequencerOpenedFromRadialMenu If sequenced was opened from the radial menu or somewhere else such as the content browser.
Protected variable TObjectPtr< class AVREditorDockableWindow > ColorPickerUI The color picker dockable window
Protected variable TWeakPtr< SWidget > CurrentWidgetOnInfoDisplay The current widget used on the info display.
Protected variable TObjectPtr< class AVREditorDockableWindow > DraggingUI The current UI that is being dragged
Protected variable FTransform DraggingUIOffsetTransform Offset transform from room-relative transform to the object where we picked it up at
Protected variable float DragPanelFromOpenTime The time dragging a panel that was opened resulting in an instant drag
Protected variable FOnRadialMenuGenerated ExistingActionsMenu When replacing the actions menu, store off any existing actions
Protected variable FText ExistingActionsMenuLabel When replacing the actions menu, store off the name of the existing actions menu
Protected variable TMap< FName, TObjectPtr< class AVREditorFloatingUI > > FloatingUIs All of the floating UIs. These may or may not be visible (spawned)
Protected variable TObjectPtr< class AVREditorFloatingUI > InfoDisplayPanel Our Quick Menu UI
Protected variable UVREditorInteractor * InteractorDraggingUI Dragging UIInteractor that is dragging the UI
Protected variable TObjectPtr< class UVREditorInteractor > LaserInteractor AsymmetryInteractor that has a laser and is generally interacting with the scene
Protected variable FVector LastDraggingHoverLocation The last dragged hover location by the laser
Protected variable TMap< FName, TObjectPtr< class AActor > > PreviewWindowInfo All of the preview window info.
Protected variable TSharedPtr< FProxyTabmanager > ProxyTabManager Tab Manager UIAllows us to steal the global tabs and show them in the world.
Protected variable TObjectPtr< class AVREditorRadialFloatingUI > QuickRadialMenu The Radial Menu UI
Protected variable TObjectPtr< UVRRadialMenuHandler > RadialMenuHandler The add-on that handles radial menu switching
Protected variable float RadialMenuHideDelayTime The time since the radial menu was updated
Protected variable FTimespan RadialMenuModifierSpawnTime The time the modifier was pressed at to spawn the menu
Protected variable TObjectPtr< class UVREditorInteractor > UIInteractor Interactor that usually accesses UI and other helper functionality
Protected variable TArray< FVRButton > VRButtons All buttons created for the radial and quick menus
Protected variable TObjectPtr< class UVREditorMode > VRMode Owning object

Constructors

  Type Name Description
Public function   Default constructor

Functions

  Type Name Description
Protected function 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
Protected function void Builds the numpad Slate widget
Protected function void Builds the radial menu Slate widget
Public function Const bool If a dockable window can be scaled
Protected function bool The VR Editor UI System's rules for when drag drop should be checked for
Protected function void Testing SlateUI
Protected function void

CreateVRColorPicker ( const TSharedRef< SColorPicker >& ColorPicker
)

 Creates a VR-specific color picker.
Protected function void Hides the VR-specific color picker.
Protected function void Can be used when the tab manager is restoring a dockable tab area
Public function 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
Public function Static const TSharedRef< SWidget > &

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

 Finds a widget with a given name inside the Content argument
Public function Const AVREditorDockableWindow * Returns the current dragged dock window, nullptr if none
Public function Const float Get the maximum dock window size
Public function Const float Get the minimum dock window size
Public function Const const UVREditorMode & Gets the owner of this system (const)
Public function UVREditorMode & Gets the owner of this system
Public function Const AVREditorFloatingUI *

GetPanel ( const VREditorPanelID& InPanelID
)

 Get UI panel Actor from the passed ID
Public function Const AVREditorRadialFloatingUI * Returns the radial widget so other classes, like the interactors, can access its functionality
Public function UVRRadialMenuHandler *  
Public function UVREditorInteractor * Get the interactor that holds the radial menu
Protected function 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.
Public function void

HideRadialMenu ( const bool bPlaySound,
const bool bAllowFading
)

 Hides the radial menu if the specified hand is showing it
Public function void

Init ( UVREditorMode* InVRMode
)

 Initializes default values for the UISystem and creates the UI panels
Public function bool Are we currently dragging a dock window
Public function Const bool If a panel was opened and dragged with the UI interactor
Public function Const bool  
Protected function void

IsProxyTabSupported ( FTabId TabId,
bool& bOutIsTabSupported
)

 Called by proxy tab manager to ask us whether we support the specified tab ID.
Public function Const bool

IsShowingEditorUIPanel ( const VREditorPanelID& InPanelID
)

 Returns true if the specified editor UI panel is currently visible
Public function Const bool Returns true if the radial menu is visible on this hand
Public function 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
Public function Const FTransform

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

 Makes up a transform for a dockable UI when dragging it with a laser at the specified distance from the laser origin
Protected function 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
Protected function 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
Protected function void Called when an asset editor opens an asset while in VR Editor Mode.
Protected function void Called when the injected proxy tab manager reports needing to draw attention to a tab.
Protected function void

OnCloseAssetEditor ( UObject* Asset,
EAssetEditorCloseReason CloseReason
)

  
Public function void

OnHoverBeginEffect ( UVREditorWidgetComponent* Button
)

 Called when a laser or simulated mouse hover enters a button
Public function void

OnHoverEndEffect ( UVREditorWidgetComponent* Button
)

 Called when a laser or simulated mouse hover leaves a button
Protected function 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.
Protected function void 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.
Protected function 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
Protected function void

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

 Called every frame to update hover state
Public function void

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

 Called by VREditorMode to draw debug graphics every frame
Protected function void Reset function that puts you back in placement mode, closes all UIs, etc.
Public function void

SequencerOpenendFromRadialMenu ( const bool bInOpenedFromRadialMenu
)

 Set if sequencer was opened from the radial menu
Protected function TSharedRef< SWidget >

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

 Sets the text wrap size of the text block element nested in a BlockWidget
Protected function bool Preview the UI panel's location if spawning with the UI interactor, else spawn immediately
Protected function void Show the asset editor if it's not currently visible.
Public function 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.
Public function void

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

 Sets whether the specified editor UI panel should be visible.
Public function void

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

 Sets whether the specified editor UI panel should be visible.
Public function void Shuts down the UISystem whenever the mode is exited
Public function void

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

 Start dragging a dock window on the hand
Public function void

StopDraggingDockUI ( UVREditorInteractor* VREditorInteractor,
const bool bPlaySound
)

 Resets all values to stop dragging the current dock window
Protected function void Swaps the content of the radial menu between the radial menu and the numpad
Public function void

Tick ( FEditorViewportClient* ViewportClient,
const float DeltaTime
)

 Called by VREditorMode to update us every frame
Protected function void

ToggledDebugMode ( bool bDebugModeEnabled
)

 When VR Mode debug was toggled.
Public function void Hides and unhides all the editor UI panels
Public function 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
Public function void

TransitionWorld ( UWorld* NewWorld,
EEditorWorldExtensionTransitionState TransitionState
)

 Transition the user widgets to a new world
Public function 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)
Public function void

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

 Function to force an update of the Actor Preview UI based on a change
Public function 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
Public function void

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

  
Public function void  
Public function void  
Public function void Function to force an update of the SequencerUI based on a change

Constants

Name Description
ColorPickerPanelID  
ContentBrowserPanelID  
DetailsPanelID  
InfoDisplayPanelID  
ModesPanelID  
RadialMenuPanelID  
SequencerPanelID  
TabManagerPanelID  
TutorialPanelID  
WorldOutlinerPanelID  
WorldSettingsPanelID  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page