IAssetViewport

Public interface to [SLevelViewport](API\Editor\LevelEditor\SLevelViewport)

Windows
MacOS
Linux

Inheritance Hierarchy

IAssetViewport

SLevelViewport

References

Module

UnrealEd

Header

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

Include

#include "IAssetViewport.h"

Syntax

class IAssetViewport

Remarks

Public interface to SLevelViewport

Functions

Name Description

Public function

void

 

AddOverlayWidget

(
    TSharedRef < SWidget > OverlaidWidge...
)

Adds a widget overlaid over the viewport

Public function Const

TSharedRef < ...

 

AsWidget()

Returns the SLevelViewport widget (const).

Public function

TSharedRef < ...

 

AsWidget()

Returns the SLevelViewport widget.

Public function

void

 

EndPlayInEditorSession()

Ends a currently active play in editor session in this viewport

Public function

FViewport &#...

 

GetActiveViewport()

Gets the active viewport.

Public function

FEditorViewp ...

 

GetAssetViewportClient()

Public function Const

TSharedPtr < ...

 

GetSharedActiveViewport()

Public function

TWeakPtr < cl...

 

GetViewportWidget()

Returns the SViewport widget contained within the SLevelViewport .

Public function Const

bool

 

HasPlayInEditorViewport()

Public function Const

bool

 

IsImmersive()

Public function Const

bool

 

IsInGameView()

Public function

void

 

MakeImmersive

(
    const bool bWantImmersive,
    const bool bAllowAnimation
)

Attempts to switch this viewport into immersive mode

Public function

void

 

OnSimulateSessionFinished()

Called by the editor when simulate mode with this viewport finishes

Public function

void

 

OnSimulateSessionStarted()

Called by the editor when simulate mode is started with this viewport

Public function

void

 

RegisterGameViewportIfPIE()

Registers a game viewport with the Slate application so that specific messages can be routed directly to this level viewport if it is an active PIE viewport

Public function

void

 

RemoveOverlayWidget

(
    TSharedRef < SWidget > OverlaidWidge...
)

Removes a widget that was previously overlaid on to this viewport

Public function

void

 

StartPlayInEditorSession

(
    UGameViewportClient * PlayClien...,
    const bool bInSimulateInEditor
)

Begins a play in editor session in this viewport.

Public function

void

 

SwapViewportsForPlayInEditor()

Swaps the active SIE viewport client with the inactive PIE viewport (Swaps back to the game) It is not valid to call this unless we have an active simulate in editor session

Public function

void

 

SwapViewportsForSimulateInEditor()

Swaps the active PIE viewport client with the level editor viewport client for simulate in editor It is not valid to call this unless we have an active play in editor session

Public function

void

 

ToggleGameView()

Called when game view should be toggled

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