Language:
Discover
By Skill Level
By Category

SEditorViewport

Choose your OS:

Inheritance Hierarchy

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()

Public function

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 TShare ...

 

GetCommandList()

The viewport command list

Public function Virtual

EVisibility

 

GetTransformToolbarVisibility()

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

Public function

TSharedPtr < ...

 

GetViewportClient()

Protected function Virtual

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

bool

 

Is2DModeVisible()

True if the 2d mode widget is visible

Public function Virtual

bool

 

IsCoordSystemActive

(
    ECoordSystem CoordSystem
)

True if the specified coordinate system the active one active

Protected function

bool

 

IsExposureSettingSelected()

Checks if auto exposure setting is selected

Protected function

bool

 

IsFixedEV100Enabled()

Called to know whether the fixed EV100 slider is enabled.

Public function

bool

 

IsRealtime()

True if the viewport is being updated in realtime

Protected function

bool

 

IsShowFlagEnabled

(
    uint32 EngineShowFlagIndex
)

Checks if a show flag is enabled in this viewport

Protected function Virtual

bool

 

IsStatCommandVisible

(
    FString CommandName
)

Checks if Stat command is visible in this viewport

Protected function Virtual

bool

 

IsTranslateRotateModeVisible()

True if the translate/rotate mode widget is visible

Public function Virtual

bool

 

IsVisible()

True if the viewport is currently visible

Protected function Virtual

bool

 

IsWidgetModeActive

(
    FWidget::EWidgetMode Mode
)

True if the specified widget mode is active

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

float

 

OnGetFixedEV100Value()

Called by the fixed EV100 slider to get the fixed EV100 value

Protected function Virtual

const FSlate ...

 

OnGetViewportBorderBrush()

Protected function Virtual

FSlateColor

 

OnGetViewportBorderColorAndOpacity()

Protected function Virtual

EVisibility

 

OnGetViewportContentVisibility()

The visibility of widgets in the viewport (e.g, menus).

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.

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

bool

 

SupportsKeyboardFocus()

Checks to see if this widget supports keyboard focus.

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

References

Module

UnrealEd

Header

Editor/UnrealEd/Public/SEditorViewport.h