1. Epic GamesDeveloper
  3. AVREditorFloatingUI

AVREditorFloatingUI

Represents an interactive floating UI panel in the VR Editor

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

Inheritance Hierarchy

References

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

Syntax

class AVREditorFloatingUI : public AVREditorBaseActor

Remarks

Represents an interactive floating UI panel in the VR Editor

Variables

  Type Name Description
Public variable FVREditorFloatingUICreationContext CreationContext All params used to create this panel if this panel has a UMG widget and was created via BP.
Protected variable FIntPoint Resolution Resolution we should draw this UI at, regardless of scale
Protected variable TSharedPtr< SWidget > SlateWidget Slate widget we're drawing, or null if we're drawing a UMG user widget
Protected variable TObjectPtr< UUserWidget > UserWidget UMG user widget we're drawing, or nullptr if we're drawing a Slate widget
Protected variable TObjectPtr< class UVREditorWidgetComponent > WidgetComponent When in a spawned state, this is the widget component to represent the widget
Protected variable TObjectPtr< class UStaticMeshComponent > WindowMeshComponent The floating window mesh
Protected variable float WorldPlacedScaleFactor  

Constructors

  Type Name Description
Public function  

AVREditorFloatingUI ( const FObjectInitializer& ObjectInitializer
)

 Default constructor which sets up safe defaults

Functions

  Type Name Description
Protected function Const FVector Returns a scale to use for this widget that takes into account animation
Public function void  
Public function Const VREditorPanelID

GetID ()

 Gets the ID of this panel.
Public function Const float Gets the initial size of this UI
Public function UStaticMeshComponent * Returns the mesh component for this UI, or nullptr if not spawned right now
Public function UVREditorUISystem & Returns the owner of this object
Public function Const const UVREditorUISystem & Returns the owner of this object (const)
Public function Const float Gets the scale
Public function Const FVector2D

GetSize ()

 Returns the actual size of the UI in either axis, after scaling has been applied.
Public function Const TSharedPtr< SWidget > Gets the current slate widget.
Public function UUserWidget * Gets the current user widget of this floating UI, return nullptr if using slate widget
Public function Const T * Returns casted userwidget
Public function UVREditorWidgetComponent * Returns the widget component for this UI, or nullptr if not spawned right now
Public function Const bool  
Protected function Virtual void

SetCollision ( const ECollisionEnabled::Type InCollisionType,
const ECollisionResponse InCollisionResponse,
const ECollisionChannel InCollisionChannel
)

 Set collision on components
Public function void

SetResolution ( const FIntPoint& InResolution
)

 Sets the resolution of this floating UI panel and resets the window mesh accordingly.
Public function void

SetScale ( const float NewSize,
const bool bScaleWidget
)

 Sets a new size for the UI
Public function void

SetSlateWidget ( const TSharedRef< SWidget >& InitSlateWidget
)

 Creates a FVREditorFloatingUI using a Slate widget, and sets up safe defaults
Public function void

SetSlateWidget ( UVREditorUISystem& InitOwner,
const VREditorPanelID& InID,
const TSharedRef< SWidget >& InitSlateWidget,
const FIntPoint InitResolution,
const float InitScale,
const EDockedTo InitDockedTo
)

 Creates a FVREditorFloatingUI using a Slate widget, and sets up safe defaults
Public function void

SetUMGWidget ( UVREditorUISystem& InitOwner,
const VREditorPanelID& InID,
TSubclassOf< class UUserWidget > InitUserWidgetClass,
const FIntPoint InitResolution,
const float InitScale,
const EDockedTo InitDockedTo
)

 Creates a FVREditorFloatingUI using a UMG user widget, and sets up safe defaults
Public function Virtual void Called to finish setting everything up, after a widget has been assigned
Public function void

SetWidgetComponentScale ( const FVector& InScale
)

 Set the widget scale
Public function void

SetWindowMesh ( UStaticMesh* InWindowMesh
)

 Set mesh on window mesh component.
Public function void

ShowUI ( const bool bShow,
const bool bAllowFading,
const float InitFadeDelay,
const bool bInClearWidgetOnHide
)

 Shows or hides the UI (also enables collision, and performs a transition effect)

Overridden from AVREditorBaseActor

  Type Name Description
Public function Virtual void

SetTransform ( const FTransform& Transform
)

 Sets the UI transform
Public function Virtual void

TickManually ( float DeltaTime
)

 Called by the UI system to tick this UI every frame.

Overridden from AActor

  Type Name Description
Public function Virtual void Called when this actor is explicitly being destroyed during gameplay or in the editor, not called during level streaming or gameplay ending

Overridden from UObject

  Type Name Description
Public function Virtual void AActor overrides
Public function Virtual Const bool Called during saving to determine if the object is forced to be editor only or not

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page