SEditorViewport

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

UnrealEd

Header

/Engine/Source/Editor/UnrealEd/Public/SEditorViewport.h

Include

#include "SEditorViewport.h"

Syntax

class SEditorViewport : public SCompoundWidget

Variables

Name Description

Protected variable

TSharedPtr< FEd...

 

Client

The client responsible for setting up the scene

Protected variable

TSharedPtr< FUI...

 

CommandList

Commandlist used in the viewport (Maps commands to viewport specific actions)

Protected variable

double

 

LastTickTime

The last time the viewport was ticked (for visibility determination)

Protected variable

TSharedPtr< FSc...

 

SceneViewport

Viewport that renders the scene provided by the viewport client

Protected variable

TSharedPtr< SOv...

 

ViewportOverlay

Protected variable

TSharedPtr< SVi...

 

ViewportWidget

Widget where the scene viewport is drawn in

Constructors

Name Description

Public function

SEditorViewport()

Destructors

Name Description

Public function Virtual

~SEditorViewport()

Functions

Name Description

Protected function Virtual

void

 

BindCommands()

Protected function Const

TSharedRef< ...

 

BuildFeatureLevelWidget()

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

Public function Const

TSharedRef< ...

 

BuildFixedEV100Menu()

Build the exposure menu using EV100 settings

Protected function

void

 

ChangeExposureSetting()

Changes the auto exposure setting for this viewport

Public function

void

 

Construct

(
    const FArguments& InArgs
)

Protected function Virtual

bool

 

DoesAllowScreenCapture()

Public function

void

 

EnableStereoRendering

(
    const bool bInEnableStereoRendering
)

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

Public function Const

const TShare...

 

GetCommandList()

Public function Virtual Const

EVisibility

 

GetTransformToolbarVisibility()

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

Public function Const

TSharedPtr< ...

 

GetViewportClient()

Protected function Virtual Const

UWorld *

 

GetWorld()

Gets the world this viewport is for

Public function

void

 

Invalidate()

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

Protected function Virtual Const

bool

 

Is2DModeVisible()

Public function Virtual Const

bool

 

IsCoordSystemActive

(
    ECoordSystem CoordSystem
)

Protected function Const

bool

 

IsExposureSettingSelected()

Checks if auto exposure setting is selected

Protected function Const

bool

 

IsFixedEV100Enabled()

Called to know whether the fixed EV100 slider is enabled.

Public function Const

bool

 

IsRealtime()

Protected function Const

bool

 

IsShowFlagEnabled

(
    uint32 EngineShowFlagIndex
)

Checks if a show flag is enabled in this viewport

Protected function Virtual Const

bool

 

IsStatCommandVisible

(
    FString CommandName
)

Checks if Stat command is visible in this viewport

Protected function Virtual Const

bool

 

IsTranslateRotateModeVisible()

Public function Virtual Const

bool

 

IsVisible()

Protected function Virtual Const

bool

 

IsWidgetModeActive

(
    FWidget::EWidgetMode Mode
)

Protected function

TSharedRef< ...

 

MakeEditorViewportClient()

Protected function Virtual

TSharedPtr< ...

 

MakeViewportToolbar()

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

Protected function Virtual

void

 

OnCycleCoordinateSystem()

Cycles between world and local coordinate systems

Protected function Virtual

void

 

OnCycleWidgetMode()

Moves between widget modes

Protected function Virtual

void

 

OnDecrementPositionGridSize()

Protected function Virtual

void

 

OnDecrementRotationGridSize()

Protected function

void

 

OnFixedEV100ValueChanged

(
    float NewValue
)

Called when fixed EV100 slider is adjusted

Protected function Virtual

void

 

OnFocusViewportToSelection()

Called when the user wants to focus the viewport to the current selection

Protected function Const

float

 

OnGetFixedEV100Value()

End feature level control functions block

Protected function Virtual Const

const FSlate...

 

OnGetViewportBorderBrush()

Protected function Virtual Const

FSlateColor

 

OnGetViewportBorderColorAndOpacity()

Protected function Virtual Const

EVisibility

 

OnGetViewportContentVisibility()

Protected function Virtual

void

 

OnIncrementPositionGridSize()

Changes the snapping grid size

Protected function Virtual

void

 

OnIncrementRotationGridSize()

Protected function Static

bool

 

OnIsSurfaceSnapEnabled()

Called to test whether surface snapping is enabled or not

Protected function Virtual

void

 

OnScreenCapture()

Protected function Virtual

void

 

OnScreenCaptureForProjectThumbnail()

Public function

void

 

OnToggleRealtime()

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

Protected function

void

 

OnToggleStats()

UI Command delegate bindings

Protected function Static

void

 

OnToggleSurfaceSnap()

Called when surface snapping has been enabled/disabled

Protected function Virtual

void

 

PopulateViewportOverlays

(
    TSharedRef< SOverlay > Overlay
)

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

Public function

void

 

SetRenderDirectlyToWindow

(
    const bool bInRenderDirectlyToWindo...
)

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

Protected function

void

 

ToggleShowFlag

(
    uint32 EngineShowFlagIndex
)

Toggles a show flag in this viewport

Protected function Virtual

void

 

ToggleStatCommand

(
    FString CommandName
)

Toggles Stat command visibility in this viewport

Overridden from SWidget

Name Description

Public function Virtual

FReply

 

OnFocusReceived

(
    const FGeometry& MyGeometry,
    const FFocusEvent& InFocusEvent
)

KEY INPUT Called when focus is given to this widget. This event does not bubble.

Public function Virtual

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)

Public function Virtual Const

bool

 

SupportsKeyboardFocus()

Checks to see if this widget supports keyboard focus. Override this in derived classes.

Public function Virtual

void

 

Tick

(
    const FGeometry& AllottedGeometry,
    const double InCurrentTime,
    const float InDeltaTime
)

Ticks this widget with Geometry.

Classes

Name

Description

Public struct

FArguments

Select Skin
Light
Dark

Welcome to the new Unreal Engine 4 Documentation site!

We're working on lots of new features including a feedback system so you can tell us how we are doing. It's not quite ready for use in the wild yet, so head over to the Documentation Feedback forum to tell us about this page or call out any issues you are encountering in the meantime.

We'll be sure to let you know when the new system is up and running.

Post Feedback