FAssetEditorViewportLayout

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

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/AssetEditorViewportLayout.h

Include

#include "AssetEditorViewportLayout.h"

Syntax

class FAssetEditorViewportLayout :
    public TSharedFromThis< FAssetEditorViewportLayout > ,
    public FEditorViewportLayout ,
    public FTickableEditorObject

Remarks

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

Variables

Name Description

Public variable

TWeakPtr < SDock ...

 

ParentTab

The parent tab where this layout resides

Public variable

TWeakPtr < class...

 

ParentTabContent

The parent tab content object where this layout resides

Public variable

TWeakPtr < class...

 

ViewportsOverlayPtr

The overlay widget that handles what viewports should be on top (non-maximized or maximized)

Constructors

Name Description

Public function

FAssetEditorViewportLayout()

Constructor

Destructors

Name Description

Public function Virtual

~FAssetEditorViewportLayout()

Destructor

Functions

Name Description

Public function

TSharedRef < ...

 

BuildViewportLayout

(
    TFunction < TSharedRef < SEditorViewp ...,
    TSharedPtr < SDockTab > InParentDock...,
    TSharedPtr < class FViewportTabConte ...,
    const FString & LayoutString
)

Builds a viewport layout and returns the widget containing the layout

Public function Const

TSharedRef < ...

 

FactoryViewport

(
    TFunction < TSharedRef < SEditorViewp ...,
    FName InTypeName,
    const FAssetEditorViewportConstruct ...
)

Create an instance of a custom viewport from the specified viewport type name

Public function Const

TWeakPtr < cl...

 

GetParentTabContent()

Returns the parent tab content object

Public function Const

FString

 

GetTypeSpecificLayoutString

(
    const FString & LayoutString
)

Generates a layout string for persisting settings for this layout based on the runtime type of layout

Public function

TSharedRef < ...

 

MakeViewportLayout

(
    TFunction < TSharedRef < SEditorViewp ...,
    const FString & LayoutString
)

Overridden in derived classes to set up custom layouts

Overridden from FTickableObjectBase

Name Description

Public function Virtual Const

TStatId

 

GetStatId()

Return the stat id to use for this tickable

Public function Virtual Const

bool

 

IsTickable()

Virtual that can be overloaded by the inheriting class.

Public function Virtual

void

 

Tick

(
    float DeltaTime
)

FTickableEditorObject interface

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback