Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Editor > UnrealEd > IAssetViewport

Light Theme

Dark Theme

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
void	AddOverlayWidget ( TSharedRef< SWidget > OverlaidWidge... )	Adds a widget overlaid over the viewport
TSharedRef< ...	AsWidget()	Returns the SLevelViewport widget (const).
TSharedRef< ...	AsWidget()	Returns the SLevelViewport widget.
void	EndPlayInEditorSession()	Ends a currently active play in editor session in this viewport
FViewport &#...	GetActiveViewport()	Gets the active viewport.
FEditorViewp...	GetAssetViewportClient()
TSharedPtr< ...	GetSharedActiveViewport()
TWeakPtr< cl...	GetViewportWidget()	Returns the SViewport widget contained within the SLevelViewport.
bool	HasPlayInEditorViewport()
bool	IsImmersive()
bool	IsInGameView()
void	MakeImmersive ( const bool bWantImmersive, const bool bAllowAnimation )	Attempts to switch this viewport into immersive mode
void	OnSimulateSessionFinished()	Called by the editor when simulate mode with this viewport finishes
void	OnSimulateSessionStarted()	Called by the editor when simulate mode is started with this viewport
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
void	RemoveOverlayWidget ( TSharedRef< SWidget > OverlaidWidge... )	Removes a widget that was previously overlaid on to this viewport
void	StartPlayInEditorSession ( UGameViewportClient* PlayClien..., const bool bInSimulateInEditor )	Begins a play in editor session in this viewport.
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
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
void	ToggleGameView()	Called when game view should be toggled

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss