1. Epic GamesDeveloper
  3. SLevelViewport

SLevelViewport

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

Unreal Engine C++ API Reference > Editor > LevelEditor

Inheritance Hierarchy

References

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

Syntax

class SLevelViewport :  
    public SAssetEditorViewport,  
    public IAssetViewport

Remarks

Encapsulates an SViewport and an SLevelViewportToolBar

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Static bool  
Public function Const bool  
Public function void

Construct ( const FArguments& InArgs,
const FAssetEditorViewportConstructionArgs& InConstructionArgs
)

 Constructs the viewport widget
Public function void Constructs the level editor viewport client
Public function void Constructs the widgets for the viewport overlay
Public function Const TSharedRef< class ISceneOutlinerColumn >  
Public function Static void  
Public function Static float  
Public function Const bool  
Public function Static bool  
Public function Const EVisibility Called to get the visibility of the viewport's 'Restore from Immersive' button.
Public function Const const TSharedPtr< FUICommandList > &  
Public function Const FName Returns the config key associated with this viewport.
Public function Const FMargin  
Public function Const FText Called to get the screen percentage preview text
Public function Const EVisibility  
Public function Const FString  
Public function Const EVisibility Get the visibility for items considered to be part of the 'full' viewport toolbar
Public function Const const FLevelEditorViewportClient &  
Public function FLevelEditorViewportClient &  
Public function Const EVisibility Called to get the visibility of the viewport's maximize/minimize toggle button.
Public function Const TWeakPtr< ILevelEditor > Get the parent level editor for this viewport
Public function Const FText

GetSelectedActorsCurrentLevelText ( bool bDrawOnlyLabel
)

 Called to get the text for the level the currently selected actor or actors are in.
Public function Virtual Const EVisibility  
Public function Const EVisibility Get the visibility for viewport toolbar
Public function Virtual Const EVisibility Called to get the visibility of the level viewport toolbar
Public function Virtual Const EVisibility  
Public function Const bool For the specified actor, See if we're forcing a preview
Public function Virtual Const bool  
Public function Const bool

IsActorLocked ( const TWeakObjectPtr< AActor > Actor
)

  
Public function bool See if the specified actor's ActorPreview is detached from actor
Public function bool See if the specified actor's ActorPreview is pinned or not
Public function Const bool  
Public function Const bool  
Public function Const bool Checks if a foliage type is visible in this viewport
Public function Const bool  
Public function Const bool

IsLayerVisible ( FName LayerName
)

 Checks if a layer is visible in this viewportCalled to determine if a layer is visible.
Public function Const bool Check whether locked camera view is enabled
Public function Const bool  
Public function Const bool  
Public function Const bool  
Protected function void

LockActorInternal ( AActor* NewActorToLock
)

  
Public function void Called to lock/unlock the actor from the viewport's context menu
Public function void

OnActorSelectionChanged ( const TArray< UObject* >& NewSelection,
bool bForceRefresh
)

 Called on all viewports, when actor selection changes.
Public function void Called to clear all bookmarks
Public function void

OnClearBookmark ( int32 BookmarkIndex
)

 Called to clear a bookmark
Public function void Called to Compact Bookmarks.
Public function void

OnElementSelectionChanged ( const UTypedElementSelectionSet* SelectionSet,
bool bForceRefresh
)

 Called on all viewports, when element selection changes.
Public function void Actions to perform whenever the viewports floating buttons are pressed
Public function void

OnJumpToBookmark ( int32 BookmarkIndex
)

 Called to jump to a bookmark
Public function void Called when Preview Selected Cameras preference is changed.
Public function void

OnSetBookmark ( int32 BookmarkIndex
)

 Called to set a bookmark
Public function FReply Called when the maximize command is executed
Public function void

RemoveAllPreviews ( const bool bRemoveFromDesktopViewport
)

 Unpin and close all actor preview windows
Public function Const void

SaveConfig ( const FString& ConfigName
)

 Saves this viewport's config to ULevelEditorViewportSettings
Public function void

SetActorAlwaysPreview ( TWeakObjectPtr< AActor > PreviewActor,
bool bAlwaysPreview
)

 For the specified actor, toggle Pinned/Unpinned of it's ActorPreview
Public function void

SetAllowsCinematicControl ( bool bAllow
)

 Sets whether the viewport should allow cinematic control
Public function void

SetDeviceProfileString ( const FString& ProfileName
)

 Set the device profile name
Public function void Sets Slate keyboard focus to this viewport
Public function void Toggles enabling the exact camera view when locking a viewport to a camera
Public function void For the specified actor, toggle whether the panel is detached from it
Public function void For the specified actor, toggle Pinned/Unpinned of it's ActorPreview
Public function void

ToggleAllFoliageTypes ( bool bVisible
)

 Toggles all foliage types visibility
Public function void Toggles foliage type visibility in this viewport
Public function void

ToggleShowLayer ( FName LayerName
)

 Toggles layer visibility in this viewport

Overridden from SEditorViewport

  Type Name Description
Protected function Virtual void  
Public function Virtual bool  
Public function Virtual Const EVisibility Controls the visibility of the widget transform toolbar, if there is an associated toolbar
Public function Virtual Const UWorld * Gets the world this viewport is for
Public function Virtual void  
Public function Virtual Const bool  
Protected function Virtual TSharedRef< FEditorViewportClient > SEditorViewport interface
Protected function Virtual TSharedPtr< SWidget > Implement this to add a viewport toolbar to the inside top of the viewport.
Protected function Virtual void  
Protected function Virtual void  
Public function Virtual void SEditorViewport Interface
Protected function Virtual Const EVisibility  
Protected function Virtual Const const FSlateBrush *  
Protected function Virtual Const FSlateColor  
Protected function Virtual Const EVisibility  
Protected function Virtual void Changes the snapping grid size
Protected function Virtual void  
Public function Virtual void Called when the user wants to show the in-viewport context menu

Overridden from IAssetViewport

  Type Name Description
Public function Virtual void

AddOverlayWidget ( TSharedRef< SWidget > OverlaidWidget
)

 Adds a widget overlaid over the viewport
Public function Virtual Const TSharedRef< const SWidget > Returns the SLevelViewport widget (const).
Public function Virtual TSharedRef< SWidget > Returns the SLevelViewport widget.
Public function Virtual void Ends a currently active play in editor session in this viewport
Public function Virtual FViewport * Gets the active viewport.
Public function Virtual FEditorViewportClient &  
Public function Virtual Const TSharedPtr< FSceneViewport >  
Public function Virtual TWeakPtr< SViewport > Returns the SViewport widget contained within the SLevelViewport.
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

MakeImmersive ( const bool bWantImmersive,
const bool bAllowAnimation
)

 Attempts to switch this viewport into immersive mode
Public function Virtual void Called by the editor when simulate mode with this viewport finishes
Public function Virtual void Called by the editor when simulate mode is started with this viewport
Public function Virtual void 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 Virtual void

RemoveOverlayWidget ( TSharedRef< SWidget > OverlaidWidget
)

 Removes a widget that was previously overlaid on to this viewport
Public function Virtual void

StartPlayInEditorSession ( UGameViewportClient* PlayClient,
const bool bInSimulateInEditor
)

 IAssetViewport Interface
Public function Virtual void 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 Virtual void 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 Virtual void Called when game view should be toggled

Classes

  Type Name Description
Public struct FArguments    

Constants

Name Description
bInViewportMenuEnabled  

Deprecated Functions

  Type Name Description
Public function Virtual Const EVisibility GetCurrentLevelButtonVisibility not used anymore.
Public function Virtual Const EVisibility GetCurrentLevelTextVisibility not used anymore.
Public function Const FName Moved to internal handling by FViewportTabContent. See FViewportTabContent::BindCommonViewportCommands
Public function Const bool

IsViewportConfigurationSet ( FName ConfigurationName
)

 Moved to internal handling by FViewportTabContent. See FViewportTabContent::BindCommonViewportCommands
Public function bool Moved to internal handling by FViewportTabContent. See FViewportTabContent::BindCommonViewportCommands
Public function void

OnSetViewportConfiguration ( FName ConfigurationName
)

 Moved to internal handling by FViewportTabContent. See FViewportTabContent::BindCommonViewportCommands
Public function void Moved to internal handling by FViewportTabContent. See FViewportTabContent::BindCommonViewportCommands
Public function void Moved to internal handling by FViewportTabContent. See FViewportTabContent::BindCommonViewportCommands

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page