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 > SEditorViewport

Light Theme

Dark Theme

SEditorViewport

Windows

MacOS

Linux

Inheritance Hierarchy

FSlateControlledConstruction

TSharedFromThis

SWidget

SCompoundWidget

SEditorViewport

	SAssetEditorViewport
	SBasePoseViewport
	SLevelViewport

References

Module	UnrealEd
Header	/Engine/Source/Editor/UnrealEd/Public/SEditorViewport.h
Include	#include "SEditorViewport.h"

Syntax

class SEditorViewport : public SCompoundWidget

Variables

	Name	Description
TSharedPtr< FEd...	Client	The client responsible for setting up the scene
TSharedPtr< FUI...	CommandList	Commandlist used in the viewport (Maps commands to viewport specific actions)
double	LastTickTime	The last time the viewport was ticked (for visibility determination)
TSharedPtr< FSc...	SceneViewport	Viewport that renders the scene provided by the viewport client
TSharedPtr< SOv...	ViewportOverlay
TSharedPtr< SVi...	ViewportWidget	Widget where the scene viewport is drawn in

Constructors

	Name	Description
	SEditorViewport()

Destructors

	Name	Description
	~SEditorViewport()

Functions

	Name	Description
void	BindCommands()
TSharedRef< ...	BuildFeatureLevelWidget()	Call this function to build a 'text' widget that can display the present feature level
TSharedRef< ...	BuildFixedEV100Menu()	Build the exposure menu using EV100 settings
bool	CanToggleRealtime()
void	ChangeExposureSetting()	Changes the auto exposure setting for this viewport
void	Construct ( const FArguments& InArgs )
bool	DoesAllowScreenCapture()
void	EnableStereoRendering ( const bool bInEnableStereoRendering )	Sets whether stereo rendering is allowed for this viewport. Advanced use only
const TShare...	GetCommandList()
EVisibility	GetTransformToolbarVisibility()	Controls the visibility of the widget transform toolbar, if there is an associated toolbar
TSharedPtr< ...	GetViewportClient()
UWorld *	GetWorld()	Gets the world this viewport is for
void	Invalidate()	Invalidates the viewport to ensure it is redrawn during the next tick.
bool	Is2DModeVisible()
bool	IsCoordSystemActive ( ECoordSystem CoordSystem )
bool	IsExposureSettingSelected()	Checks if auto exposure setting is selected
bool	IsFixedEV100Enabled()	Called to know whether the fixed EV100 slider is enabled.
bool	IsRealtime()
bool	IsShowFlagEnabled ( uint32 EngineShowFlagIndex )	Checks if a show flag is enabled in this viewport
bool	IsStatCommandVisible ( FString CommandName )	Checks if Stat command is visible in this viewport
bool	IsTranslateRotateModeVisible()
bool	IsVisible()
bool	IsWidgetModeActive ( FWidget::EWidgetMode Mode )
TSharedRef< ...	MakeEditorViewportClient()
TSharedPtr< ...	MakeViewportToolbar()	Implement this to add a viewport toolbar to the inside top of the viewport.
void	OnCycleCoordinateSystem()	Cycles between world and local coordinate systems
void	OnCycleWidgetMode()	Moves between widget modes
void	OnDecrementPositionGridSize()
void	OnDecrementRotationGridSize()
void	OnFixedEV100ValueChanged ( float NewValue )	Called when fixed EV100 slider is adjusted
void	OnFocusViewportToSelection()	Called when the user wants to focus the viewport to the current selection
float	OnGetFixedEV100Value()	End feature level control functions block
const FSlate...	OnGetViewportBorderBrush()
FSlateColor	OnGetViewportBorderColorAndOpacity()
EVisibility	OnGetViewportContentVisibility()
void	OnIncrementPositionGridSize()	Changes the snapping grid size
void	OnIncrementRotationGridSize()
bool	OnIsSurfaceSnapEnabled()	Called to test whether surface snapping is enabled or not
void	OnScreenCapture()
void	OnScreenCaptureForProjectThumbnail()
void	OnToggleRealtime()	Toggles realtime on/off for the viewport. Slate tick/paint is ensured when realtime is on.
void	OnToggleStats()	UI Command delegate bindings
void	OnToggleSurfaceSnap()	Called when surface snapping has been enabled/disabled
void	PopulateViewportOverlays ( TSharedRef< SOverlay > Overlay )	Implement this to add an arbitrary set of toolbars or other overlays to the inside of the viewport.
void	SetRenderDirectlyToWindow ( const bool bInRenderDirectlyToWindo... )	Sets whether this viewport can render directly to the back buffer. Advanced use only
void	ToggleShowFlag ( uint32 EngineShowFlagIndex )	Toggles a show flag in this viewport
void	ToggleStatCommand ( FString CommandName )	Toggles Stat command visibility in this viewport

Overridden from SWidget

	Name	Description
FReply	OnFocusReceived ( const FGeometry& MyGeometry, const FFocusEvent& InFocusEvent )	KEY INPUT Called when focus is given to this widget. This event does not bubble.
FReply	OnKeyDown ( const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent )	Called after a key is pressed when this widget has focus (this event bubbles if not handled)
bool	SupportsKeyboardFocus()	Checks to see if this widget supports keyboard focus. Override this in derived classes.
void	Tick ( const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime )	Ticks this widget with Geometry.

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