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

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

   
Name FLevelViewportLayout
Type class
Header File /Engine/Source/Editor/LevelEditor/Public/LevelViewportLayout.h
Include Path #include "LevelViewportLayout.h"

Syntax

class FLevelViewportLayout : public FAssetEditorViewportLayout

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FLevelViewportLayout()

 Constructor LevelViewportLayout.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FLevelViewportLayout()

 Destructor LevelViewportLayout.h  

Structs

Name Remarks
FMaximizeViewportCommand Maximize/immersive commands can be queued up at startup to be executed on the first tick.

Functions

Public

Name Remarks Include Path Unreal Specifiers

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

 Builds a viewport layout and returns the widget containing the layout LevelViewportLayout.h  

virtual TSharedRef< SWidget > FactoryViewport ( FName InTypeName,
const FAssetEditorViewportConstructionArgs& ConstructionArgs
)

   LevelViewportLayout.h  

virtual TStatId GetStatId()

   LevelViewportLayout.h  

bool IsLevelViewportVisible ( FName InViewport
) const

 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 LevelViewportLayout.h  

bool IsMaximized()

   LevelViewportLayout.h  

bool IsMaximizeSupported()

 Checks to see if the specified level viewport supports maximizing one pane LevelViewportLayout.h  

virtual bool IsTickable()

   LevelViewportLayout.h  

bool IsTransitioning()

 Returns whether a viewport animation is currently taking place LevelViewportLayout.h  

bool IsViewportImmersive ( FName InViewport
) const

 Checks to see if the specified level viewport is in immersive mode LevelViewportLayout.h  

bool IsViewportMaximized ( FName InViewport
) const

 Checks to see if the specified level viewport is maximized LevelViewportLayout.h  

virtual bool IsVisible()

   LevelViewportLayout.h  

virtual void LoadConfig ( const FString& LayoutString
)

   LevelViewportLayout.h  

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 LevelViewportLayout.h  

virtual void SaveConfig ( const FString& LayoutString
) const

   LevelViewportLayout.h  

void SetIsReplacement ( bool bInIsReplacement
)

 Tells this layout whether it was the intial layout or replaced an existing one when the user switched layouts LevelViewportLayout.h  

virtual void Tick ( float DeltaTime
)

 FTickableEditorObject interface LevelViewportLayout.h  

Protected

Name Remarks Include Path Unreal Specifiers

void BeginThrottleForAnimatedResize()

 Begins a draw throttle for responsiveness when animating a viewports size LevelViewportLayout.h  

void EndThrottleForAnimatedResize()

 Ends a draw throttle for responsiveness when animating a viewports size LevelViewportLayout.h  

void FinishMaximizeTransition()

 If a viewport animation is in progress, finishes that transition immediately LevelViewportLayout.h  

FVector2D GetMaximizedViewportPositionOnCanvas()

 Returns the widget position for viewport transition animations LevelViewportLayout.h  

FVector2D GetMaximizedViewportSizeOnCanvas()

 Returns the widget size for viewport transition animations LevelViewportLayout.h  

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 LevelViewportLayout.h  

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

 Maximizes a specific viewport and hides the others in this layout LevelViewportLayout.h  

virtual EVisibility OnGetNonMaximizedVisibility()

 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 LevelViewportLayout.h  

void SaveCommonLayoutString ( const FString& SpecificLayoutString
) const

 Called in SaveConfig() functions for derived types of layout to save values common to all types LevelViewportLayout.h  

void TakeHighResScreenShot()

 Method for taking high res screen shots of viewports LevelViewportLayout.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page