1. Epic GamesDeveloper
  3. SEditorViewport

SEditorViewport

API > API/Editor > API/Editor/UnrealEd

Inheritance Hierarchy

References

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

Syntax

class SEditorViewport : public SCompoundWidget

Variables

  Type Name Description
Protected variable TSharedPtr< FEditorViewportClient > Client The client responsible for setting up the scene
Protected variable TSharedPtr< FUICommandList > CommandList Commandlist used in the viewport (Maps commands to viewport specific actions)
Protected variable FVector2D InViewportContextMenuLocation  
Protected variable double LastTickTime The last time the viewport was ticked (for visibility determination)
Protected variable TSharedPtr< FSceneViewport > SceneViewport Viewport that renders the scene provided by the viewport client
Protected variable TSharedPtr< SOverlay > ViewportOverlay  
Protected variable TSharedPtr< SViewport > ViewportWidget Widget where the scene viewport is drawn in

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Protected function Virtual void  
Protected function Const TSharedRef< SWidget > Call this function to build a 'text' widget that can display the present feature level
Public function Const TSharedRef< SWidget > Build the exposure menu using EV100 settings
Public function Virtual bool  
Protected function Const bool  
Protected function void Changes the auto exposure setting for this viewport
Public function void

Construct ( const FArguments& InArgs
)

  
Protected function Virtual bool  
Public function void

EnableStereoRendering ( const bool bInEnableStereoRendering
)

 Sets whether stereo rendering is allowed for this viewport. Advanced use only
Public function Const const TSharedPtr< FUICommandList >  
Protected function Const EVisibility  
Public function TSharedPtr< FSceneViewport >  
Public function Virtual Const EVisibility Controls the visibility of the widget transform toolbar, if there is an associated toolbar
Public function Const TSharedPtr< FEditorViewportClient >  
Protected function Virtual Const UWorld * Gets the world this viewport is for
Public function Virtual void  
Public function void Invalidates the viewport to ensure it is redrawn during the next tick.
Protected function Virtual Const bool  
Public function Virtual Const bool

IsCoordSystemActive ( ECoordSystem CoordSystem
)

  
Protected function Const bool Checks if auto exposure setting is selected
Protected function Const bool Called to know whether the fixed EV100 slider is enabled.
Public function Const bool  
Public function Const bool  
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  
Public function Virtual Const bool  
Protected function Virtual Const bool  
Protected function TSharedRef< FEditorViewportClient >  
Protected function Virtual TSharedPtr< SWidget > Implement this to add a viewport toolbar to the inside top of the viewport.
Public function Virtual void Cycles between world and local coordinate systems
Protected function Virtual void Moves between widget modes
Protected function Virtual void  
Protected function Virtual void  
Protected function void

OnFixedEV100ValueChanged ( float NewValue
)

 Called when fixed EV100 slider is adjusted
Protected function Virtual void Called when the user wants to focus the viewport to the current selection
Protected function Const float End feature level control functions block
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  
Protected function Static bool Called to test whether surface snapping is enabled or not
Public function void  
Public function void  
Protected function Virtual void  
Protected function Virtual void  
Public function void Toggles realtime on/off for the viewport. Slate tick/paint is ensured when realtime is on.
Protected function void UI Command delegate bindings
Protected function Static void Called when surface snapping has been enabled/disabled
Protected function Virtual void Implement this to add an arbitrary set of toolbars or other overlays to the inside of the viewport.
Public function void

SetRenderDirectlyToWindow ( const bool bInRenderDirectlyToWindow
)

 Sets whether this viewport can render directly to the back buffer. Advanced use only
Public function Virtual void Called when the user wants to show the in-viewport context menu
Public function void  
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
Public function Virtual void

UpdateInViewportMenuLocation ( const FVector2D InLocation
)

  

Overridden from SWidget

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

  Type Name Description
Public struct FArguments    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page