1. Epic GamesDeveloper
  3. SEditorViewport

SEditorViewport

API > API/Editor > API/Editor/UnrealEd

   
Name SEditorViewport
Type class
Header File /Engine/Source/Editor/UnrealEd/Public/SEditorViewport.h
Include Path #include "SEditorViewport.h"

Syntax

class SEditorViewport : public SCompoundWidget

Inheritance Hierarchy

Derived Classes

SEditorViewport derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

SEditorViewport()

   SEditorViewport.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~SEditorViewport()

   SEditorViewport.h  

Structs

Name Remarks
FArguments  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
ActiveTimerHandle TWeakPtr< FActiveTimerHandle > The handle to the active timer SEditorViewport.h  
AutoUpgradeWidgetChild TWeakPtr< SWidget > For automatic legacy toolbar upgrades. SEditorViewport.h  
bInvalidated bool Whether the viewport needs to update, even without input or realtime (e.g. inertial camera movement) SEditorViewport.h  
bLegacyToolbarIsAutomaticallyUpgradable bool A flag indicating that the automatic toolbar upgrade has been approved SEditorViewport.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TSharedRef< SWidget > BuildFixedEV100Menu()

 Build the exposure menu using EV100 settings SEditorViewport.h  

TSharedRef< SWidget > BuildWireframeMenu()

 Build the slider to adjust wireframe opacity SEditorViewport.h  

virtual bool CanToggleInViewportContextMenu()

   SEditorViewport.h  

void Construct ( const FArguments& InArgs
)

   SEditorViewport.h  

void EnableStereoRendering ( const bool bInEnableStereoRendering
)

 Sets whether stereo rendering is allowed for this viewport. Advanced use only SEditorViewport.h  

const TSharedPtr< FUICommandList > GetCommandList()

   SEditorViewport.h  

TSharedPtr< IPreviewProfileController > GetPreviewProfileController()

   SEditorViewport.h  

TSharedPtr< FSceneViewport > GetSceneViewport()

   SEditorViewport.h  

virtual EVisibility GetTransformToolbarVisibility()

 Controls the visibility of the widget transform toolbar, if there is an associated toolbar SEditorViewport.h  

TSharedPtr< FEditorViewportClient > GetViewportClient()

   SEditorViewport.h  

virtual void HideInViewportContextMenu()

   SEditorViewport.h  

void Invalidate ()

 Invalidates the viewport to ensure it is redrawn during the next tick. SEditorViewport.h  

virtual bool IsCoordSystemActive ( ECoordSystem CoordSystem
) const

   SEditorViewport.h  

bool IsPreviewingScreenPercentage()

   SEditorViewport.h  

bool IsRealtime()

   SEditorViewport.h  

virtual bool IsVisible()

   SEditorViewport.h  
A legacy patch built to allow SCommonEditorViewportToolbarBase to automatically switch to the new viewport style. SEditorViewport.h  

virtual void OnCycleCoordinateSystem()

 Cycles between world and local coordinate systems SEditorViewport.h  

void OnOpenViewportPerformanceEditorPreferences()

   SEditorViewport.h  

void OnOpenViewportPerformanceProjectSettings()

   SEditorViewport.h  

void OnToggleRealtime()

 Toggles realtime on/off for the viewport. Slate tick/paint is ensured when realtime is on. SEditorViewport.h  

void SetRenderDirectlyToWindow ( const bool bInRenderDirectlyToWindow
)

 Sets whether this viewport can render directly to the back buffer. Advanced use only SEditorViewport.h  

virtual void ToggleInViewportContextMenu()

 Called when the user wants to show the in-viewport context menu SEditorViewport.h  

void TogglePreviewingScreenPercentage()

   SEditorViewport.h  

virtual void UpdateInViewportMenuLocation ( const FVector2D InLocation
)

   SEditorViewport.h  

Overridden from SWidget

Name Remarks Include Path Unreal Specifiers

virtual FReply OnFocusReceived ( const FGeometry& MyGeometry,
const FFocusEvent& InFocusEvent
)

   SEditorViewport.h  

virtual FReply OnKeyDown ( const FGeometry& MyGeometry,
const FKeyEvent& InKeyEvent
)

   SEditorViewport.h  

virtual bool SupportsKeyboardFocus()

   SEditorViewport.h  

virtual void Tick ( const FGeometry& AllottedGeometry,
const double InCurrentTime,
const float InDeltaTime
)

   SEditorViewport.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void BindCommands()

   SEditorViewport.h  

virtual void BindShowCommands ( FUICommandList& OutCommandList
)

   SEditorViewport.h  

TSharedRef< SWidget > BuildFeatureLevelWidget()

 Call this function to build a 'text' widget that can display the present feature level SEditorViewport.h  

virtual TSharedPtr< SWidget > BuildViewportToolbar()

 Implement this to add a viewport toolbar above the viewport that does not cover the viewport. SEditorViewport.h  

bool CanToggleRealtime()

   SEditorViewport.h  

void ChangeExposureSetting()

 Changes the auto exposure setting for this viewport SEditorViewport.h  

virtual TSharedPtr< IPreviewProfileController > CreatePreviewProfileController()

   SEditorViewport.h  

virtual bool DoesAllowScreenCapture()

   SEditorViewport.h  

EVisibility GetCurrentFeatureLevelPreviewTextVisibility()

   SEditorViewport.h  

virtual UWorld * GetWorld()

 Gets the world this viewport is for SEditorViewport.h  

virtual bool Is2DModeVisible()

   SEditorViewport.h  

bool IsExposureSettingSelected()

 Checks if auto exposure setting is selected SEditorViewport.h  

bool IsFixedEV100Enabled()

 Called to know whether the fixed EV100 slider is enabled. SEditorViewport.h  

bool IsShowFlagEnabled ( uint32 EngineShowFlagIndex
) const

 Checks if a show flag is enabled in this viewport SEditorViewport.h  

virtual bool IsStatCommandVisible ( FString CommandName
) const

 Checks if Stat command is visible in this viewport SEditorViewport.h  

virtual bool IsTranslateRotateModeVisible()

   SEditorViewport.h  

virtual bool IsWidgetModeActive ( UE::Widget::EWidgetMode Mode
) const

   SEditorViewport.h  

TSharedRef< FEditorViewportClient > MakeEditorViewportClient()

   SEditorViewport.h  

virtual TSharedPtr< SWidget > MakeViewportToolbar()

 Implement this to add a viewport toolbar to the inside top of the viewport. SEditorViewport.h  

virtual void OnCycleWidgetMode()

 Moves between widget modes SEditorViewport.h  

virtual void OnDecrementPositionGridSize()

   SEditorViewport.h  

virtual void OnDecrementRotationGridSize()

   SEditorViewport.h  

void OnFixedEV100ValueChanged ( float NewValue
)

 Called when fixed EV100 slider is adjusted SEditorViewport.h  

virtual void OnFocusViewportToSelection()

 Called when the user wants to focus the viewport to the current selection SEditorViewport.h  
End feature level control functions block SEditorViewport.h  

virtual EVisibility OnGetFocusedViewportIndicatorVisibility()

   SEditorViewport.h  

virtual const FSlateBrush * OnGetViewportBorderBrush()

   SEditorViewport.h  

virtual FSlateColor OnGetViewportBorderColorAndOpacity()

   SEditorViewport.h  

virtual EVisibility OnGetViewportContentVisibility()

   SEditorViewport.h  

float OnGetWireframeOpacity()

   SEditorViewport.h  

virtual void OnIncrementPositionGridSize()

 Changes the snapping grid size SEditorViewport.h  

virtual void OnIncrementRotationGridSize()

   SEditorViewport.h  

virtual void OnScreenCapture()

   SEditorViewport.h  

virtual void OnScreenCaptureForProjectThumbnail()

   SEditorViewport.h  

void OnToggleStats()

 UI Command delegate bindings SEditorViewport.h  

void OnWireframeOpacityChanged ( float Opacity
)

 Adjustable wireframe opacity SEditorViewport.h  

virtual void PopulateViewportOverlays ( TSharedRef< SOverlay > Overlay
)

 Implement this to add an arbitrary set of toolbars or other overlays to the inside of the viewport. SEditorViewport.h  

void ToggleShowFlag ( uint32 EngineShowFlagIndex
)

 Toggles a show flag in this viewport SEditorViewport.h  

virtual void ToggleStatCommand ( FString CommandName
)

 Toggles Stat command visibility in this viewport SEditorViewport.h  

Static

Name Remarks Include Path Unreal Specifiers

static TSharedPtr< SWidget > CreateViewportIndicatorWidget ( const TAttribute< EVisibility >& InVisibility
)

 Creates a widget showing whether the viewport is active or not SEditorViewport.h  

static bool IsDistanceBasedCameraSpeedEnabled()

 Called to test whether distance-based perspective camera speed scaling is enabled SEditorViewport.h  

static bool IsRotateToSurfaceNormalEnabled()

 Called to test whether rotation matching surface normal is enabled or not SEditorViewport.h  

static bool OnIsSurfaceSnapEnabled()

 Called to test whether surface snapping is enabled or not SEditorViewport.h  

static void OnToggleDistanceBasedCameraSpeed()

 Called to enable/disable distance-based perspective camera speed scaling SEditorViewport.h  

static void OnToggleRotateToSurfaceNormal()

 Called when rotation matching surface normal has been enabled/disabled SEditorViewport.h  

static void OnToggleSurfaceSnap()

 Called when surface snapping has been enabled/disabled SEditorViewport.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page