1. Epic GamesDeveloper
  3. FLevelViewportLayout

FLevelViewportLayout

Base class for level viewport layout configurations Handles maximizing and restoring well as visibility of specific viewports.

API > API/Editor > API/Editor/LevelEditor

Inheritance Hierarchy

  • FAssetEditorViewportLayout
  • FLevelViewportLayout

References

   
Module LevelEditor
Header /Engine/Source/Editor/LevelEditor/Public/LevelViewportLayout.h
Include #include "LevelViewportLayout.h"

Syntax

class FLevelViewportLayout : public FAssetEditorViewportLayout

Remarks

Base class for level viewport layout configurations Handles maximizing and restoring well as visibility of specific viewports.

Variables

  Type Name Description
Protected variable bool bIsImmersive True if we're currently in immersive mode
Protected variable bool bIsMaximized True if we're currently maximized
Protected variable bool bIsMaximizeSupported True if the layout supports maximizing one viewport, false if the feature is disabled
Protected variable bool bIsQueryingLayoutMetrics Temporarily set to true while we are querying layout metrics and want all widgets to be visible
Protected variable bool bIsReplacement True if the user selected this layout, false if it's the initial layout loaded
Protected variable bool bIsTransitioning True if we've started an animation and are waiting for it to finish
Protected variable bool bWasImmersive True when transitioning from an immersive state
Protected variable bool bWasMaximized True when transitioning from a maximized state
Protected variable TWeakPtr< SWindow > CachedOwnerWindow Caches the window that our widgets are contained within
Protected variable TArray< FMaximizeViewportCommand > DeferredMaximizeCommands  
Protected variable FCurveSequence MaximizeAnimation Curve for animating from a "restored" state to a maximized state
Protected variable FName MaximizedViewport The current maximized viewport if any
Protected variable FVector2D MaximizedViewportStartPosition Window-space start position of the viewport that's currently being maximized
Protected variable FVector2D MaximizedViewportStartSize Window-space start size of the viewport that's currently being maximized
Protected variable TWeakPtr< ILevelEditor > ParentLevelEditor The optional parent level editor for this layout
Protected variable TSharedPtr< SWidget > ViewportReplacementWidget Dummy widget that we'll inline-replace viewport widgets with while a view is maximized (or made immersive)
Protected variable FThrottleRequest ViewportResizeThrottleRequest Viewport resize draw throttle request
Protected variable TSharedPtr< SWidget > ViewportsOverlayWidget When maximizing viewports (or making them immersive), this stores the widget we create to wrap the viewport

Constructors

  Type Name Description
Public function   Constructor

Destructors

  Type Name Description
Public function Virtual   Destructor

Functions

  Type Name Description
Protected function void Begins a draw throttle for responsiveness when animating a viewports size
Public function Virtual TSharedRef< SWidget >

BuildViewportLayout ( TSharedPtr< SDockTab > InParentDockTab,
TSharedPtr< FEditorViewportTabContent > InParentTab,
const FString& LayoutString
)

 Builds a viewport layout and returns the widget containing the layout
Protected function void Ends a draw throttle for responsiveness when animating a viewports size
Public function Virtual TSharedRef< SWidget >

FactoryViewport ( FName InTypeName,
const FAssetEditorViewportConstructionArgs& ConstructionArgs
)

  
Protected function void If a viewport animation is in progress, finishes that transition immediately
Protected function Const FVector2D Returns the widget position for viewport transition animations
Protected function Const FVector2D Returns the widget size for viewport transition animations
Public function Virtual Const TStatId  
Protected function void

InitCommonLayoutFromString ( const FString& LayoutString,
const FName PerspectiveViewportKey
)

 Called in after factory of a new layout functions for derived types of layout to init values common to all types
Public function Const bool

IsLevelViewportVisible ( FName InViewport
)

 Checks to see the specified level viewport is visible in this layout A viewport is visible in a layout if the layout is visible and the viewport is the maximized viewport or there is no maximized viewport
Public function Const bool Checks to see if the specified level viewport supports maximizing one pane
Public function Virtual Const bool  
Public function Const bool Returns whether a viewport animation is currently taking place
Public function Const bool

IsViewportImmersive ( FName InViewport
)

 Checks to see if the specified level viewport is in immersive mode
Public function Const bool

IsViewportMaximized ( FName InViewport
)

 Checks to see if the specified level viewport is maximized
Public function Virtual Const bool  
Public function Virtual void

LoadConfig ( const FString& LayoutString
)

  
Protected function void

MaximizeViewport ( FName ViewportToMaximize,
const bool bWantMaximize,
const bool bWantImmersive,
const bool bAllowAnimation
)

 Maximizes a specific viewport and hides the others in this layout
Protected function Virtual Const EVisibility Delegate called to get the visibility of the non-maximized viewports The non-maximized viewports are not visible if there is a maximized viewport on top of them
Public function void

RequestMaximizeViewport ( FName ViewportToMaximize,
const bool bWantMaximize,
const bool bWantImmersive,
const bool bAllowAnimation
)

 Makes a request to maximize a specific viewport and hide the others in this layout
Protected function Const void

SaveCommonLayoutString ( const FString& SpecificLayoutString
)

 Called in SaveConfig() functions for derived types of layout to save values common to all types
Public function Virtual Const void

SaveConfig ( const FString& LayoutString
)

  
Public function void

SetIsReplacement ( bool bInIsReplacement
)

 Tells this layout whether it was the intial layout or replaced an existing one when the user switched layouts
Protected function void Method for taking high res screen shots of viewports
Public function Virtual void

Tick ( float DeltaTime
)

 FTickableEditorObject interface

Classes

  Type Name Description
Protected struct FMaximizeViewportCommand Maximize/immersive commands can be queued up at startup to be executed on the first tick.  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page