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 > LevelEditor > SLevelViewport

Light Theme

Dark Theme

SLevelViewport

Encapsulates an [SViewport](API\Runtime\Slate\Widgets\SViewport) and an SLevelViewportToolBar

Windows

MacOS

Linux

Inheritance Hierarchy

SEditorViewport

IAssetViewport

SLevelViewport

References

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

Syntax

class SLevelViewport :
public SEditorViewport,
public IAssetViewport

Remarks

Encapsulates an SViewport and an SLevelViewportToolBar

Constructors

	Name	Description
	SLevelViewport()

Destructors

	Name	Description
	~SLevelViewport()

Functions

	Name	Description
bool	CanGetCameraInformationFromActor ( AActor* Actor )
bool	CanToggleGameView()
void	Construct ( const FArguments& InArgs )	Constructs the viewport widget
void	ConstructLevelEditorViewportClient ( const FArguments& InArgs )	Constructs the level editor viewport client
void	ConstructViewportOverlayContent()	Constructs the widgets for the viewport overlay
TSharedRef< ...	CreateActorLockSceneOutlinerColumn ( ISceneOutliner& SceneOutliner )
TSharedRef< ...	GenerateLevelMenu()
float	GetActorLockSceneOutlinerColumnWidth()
bool	GetCameraInformationFromActor ( AActor* Actor, FMinimalViewInfo& out_CameraInfo )
EVisibility	GetCloseImmersiveButtonVisibility()	Called to get the visibility of the viewport's 'Restore from Immersive' button.
const TShare...	GetCommandList()
FName	GetConfigKey()	Returns the config key associated with this viewport.
EVisibility	GetCurrentLevelButtonVisibility()
FText	GetCurrentLevelText ( bool bDrawOnlyLabel )	Called to get the level text
EVisibility	GetCurrentLevelTextVisibility()
FText	GetCurrentScreenPercentageText ( bool bDrawOnlyLabel )	Called to get the screen percentage preview text
EVisibility	GetCurrentScreenPercentageVisibility()
FString	GetDeviceProfileString()
EVisibility	GetFullToolbarVisibility()	Get the visibility for items considered to be part of the 'full' viewport toolbar
const FLevel...	GetLevelViewportClient()
FLevelEditor...	GetLevelViewportClient()
EVisibility	GetMaximizeToggleVisibility()	Called to get the visibility of the viewport's maximize/minimize toggle button.
TWeakPtr< IL...	GetParentLevelEditor()	Get the parent level editor for this viewport
FText	GetSelectedActorsCurrentLevelText ( bool bDrawOnlyLabel )	Called to get the text for the level the currently selected actor or actors are in.
EVisibility	GetSelectedActorsCurrentLevelTextVisibility()
EVisibility	GetToolbarVisibility()	Get the visibility for viewport toolbar
EVisibility	GetToolBarVisibility()	Called to get the visibility of the level viewport toolbar
EVisibility	GetViewportControlsVisibility()
FName	GetViewportTypeWithinLayout()	Get this level viewport widget's type within its parent layout
bool	IsActorAlwaysPreview ( TWeakObjectPtr< AActor > Actor )	For the specified actor, See if we're forcing a preview
bool	IsActorLocked ( const TWeakObjectPtr< AActor > Acto... )
bool	IsActorPreviewDetached ( TWeakObjectPtr< AActor > PreviewAct... )	See if the specified actor's ActorPreview is detached from actor
bool	IsActorPreviewPinned ( TWeakObjectPtr< AActor > PreviewAct... )	See if the specified actor's ActorPreview is pinned or not
bool	IsAnyActorLocked()
bool	IsDeviceProfileStringSet ( FString ProfileName )
bool	IsFoliageTypeVisible ( TWeakObjectPtr< class UFoliageType ... )	Checks if a foliage type is visible in this viewport
bool	IsInForegroundTab()
bool	IsLayerVisible ( FName LayerName )	Checks if a layer is visible in this viewport Called to determine if a layer is visible.
bool	IsLockedCameraViewEnabled()	Check whether locked camera view is enabled
bool	IsMaximized()
bool	IsPlayInEditorViewportActive()
bool	IsSelectedActorLocked()
bool	IsViewportConfigurationSet ( FName ConfigurationName )	Returns whether the named layout is currently selected on the parent tab that this viewport belongs to.
bool	IsViewportTypeWithinLayoutEqual ( FName InLayoutType )	Checks if the specified layout type matches our current viewport type.
void	LockActorInternal ( AActor* NewActorToLock )
void	OnActorLockToggleFromMenu ( AActor* Actor )	Called to lock/unlock the actor from the viewport's context menu
void	OnActorSelectionChanged ( const TArray< UObject* >& New..., bool bForceRefresh )	Called on all viewports, when actor selection changes.
void	OnClearAllBookmarks()	Called to clear all bookmarks
void	OnClearBookmark ( int32 BookmarkIndex )	Called to clear a bookmark
void	OnCompactBookmarks()	Called to Compact Bookmarks.
void	OnFloatingButtonClicked()	Actions to perform whenever the viewports floating buttons are pressed
void	OnJumpToBookmark ( int32 BookmarkIndex )	Called to jump to a bookmark
FReply	OnMenuClicked()
void	OnPreviewSelectedCamerasChange()	Called when Preview Selected Cameras preference is changed.
void	OnSetBookmark ( int32 BookmarkIndex )	Called to set a bookmark
void	OnSetViewportConfiguration ( FName ConfigurationName )	Sets the current layout on the parent tab that this viewport belongs to.
FReply	OnToggleMaximize()	Called when the maximize command is executed
void	RemoveAllPreviews ( const bool bRemoveFromDesktopViewpo... )	Unpin and close all actor preview windows
void	SaveConfig ( const FString& ConfigName )	Saves this viewport's config to ULevelEditorViewportSettings
void	SetActorAlwaysPreview ( TWeakObjectPtr< AActor > PreviewAct..., bool bAlwaysPreview )	For the specified actor, toggle Pinned/Unpinned of it's ActorPreview
void	SetDeviceProfileString ( const FString& ProfileName )	Set the device profile name
void	SetKeyboardFocusToThisViewport()	Sets Slate keyboard focus to this viewport
void	SetViewportTypeWithinLayout ( FName InLayoutType )	Set this level viewport widget's type within its parent layout
void	ToggleActorPilotCameraView()	Toggles enabling the exact camera view when locking a viewport to a camera
void	ToggleActorPreviewIsPanelDetached ( TWeakObjectPtr< AActor > PreviewAct... )	For the specified actor, toggle whether the panel is detached from it
void	ToggleActorPreviewIsPinned ( TWeakObjectPtr< AActor > PreviewAct... )	For the specified actor, toggle Pinned/Unpinned of it's ActorPreview
void	ToggleAllFoliageTypes ( bool bVisible )	Toggles all foliage types visibility
void	ToggleShowFoliageType ( TWeakObjectPtr< class UFoliageType ... )	Toggles foliage type visibility in this viewport
void	ToggleShowLayer ( FName LayerName )	Toggles layer visibility in this viewport
void	ToggleViewportTypeActivationWithinLayout ( FName InLayoutType )	Activates the specified viewport type in the layout, if it's not already, or reverts to default if it is.

Overridden from SEditorViewport

	Name	Description
void	BindCommands()
EVisibility	GetTransformToolbarVisibility()	Controls the visibility of the widget transform toolbar, if there is an associated toolbar
UWorld *	GetWorld()	Gets the world this viewport is for
bool	IsVisible()
TSharedRef< ...	MakeEditorViewportClient()	SEditorViewport interface
TSharedPtr< ...	MakeViewportToolbar()	Implement this to add a viewport toolbar to the inside top of the viewport.
void	OnDecrementPositionGridSize()
void	OnDecrementRotationGridSize()
void	OnFocusViewportToSelection()	SEditorViewport Interface
const FSlate...	OnGetViewportBorderBrush()
FSlateColor	OnGetViewportBorderColorAndOpacity()
EVisibility	OnGetViewportContentVisibility()	This is not the visibility of the scene rendered in the viewport
void	OnIncrementPositionGridSize()	Changes the snapping grid size
void	OnIncrementRotationGridSize()

Overridden from IAssetViewport

	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< SV...	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 )	IAssetViewport Interface
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

Classes

	Name	Description
	FArguments

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

Take our survey

Dismiss