1. Epic GamesDeveloper
  3. FEditorViewportClient

FEditorViewportClient

Viewport client for editor viewports.

API > API/Editor > API/Editor/UnrealEd

Viewport client for editor viewports. Contains common functionality for camera movement, rendering debug information, etc.

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

Syntax

class FEditorViewportClient :  
    public FCommonViewportClient ,  
    public FViewElementDrawer ,  
    public FGCObject

Inheritance Hierarchy

Derived Classes

FEditorViewportClient derived class hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FEditorViewportClient ( FEditorModeTools* InModeTools,
FPreviewScene* InPreviewScene,
const TWeakPtr< SEditorViewport >& InEditorViewportWidget
)

   EditorViewportClient.h  
Non-copyable EditorViewportClient.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FEditorViewportClient()

   EditorViewportClient.h  

Structs

Name Remarks
FDropObjectOptions  
FRealtimeOverride Temporary realtime overrides and user messages that are not saved between editor sessions.
FRequiredCursorState Used to store the required cursor visibility states and override cursor appearance

Interfaces

Name Remarks
ICustomTemporalUpscalerData Used by the custom temporal upscaler plugin.

Constants

Name Type Remarks Include Path
DefaultOrthoViewMode const EViewModeIndex Default view mode for orthographic viewports EditorViewportClient.h
DefaultPerspectiveViewMode const EViewModeIndex Default view mode for perspective viewports EditorViewportClient.h
MaxCameraSpeeds const uint32 The Maximum Mouse/Camera Speeds Setting supported EditorViewportClient.h
SafePadding float const Constant for how much the camera safe zone rectangle is inset when being displayed in the editor EditorViewportClient.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AspectRatio float   EditorViewportClient.h  
bDisableInput bool True if all input is rejected from this viewport EditorViewportClient.h  
bDrawAxes bool If true, draw the axis indicators when the viewport is perspective. EditorViewportClient.h  
bDrawAxesGame bool If true, draw the axis indicators when EngineShowFlags.Game is set. EditorViewportClient.h  
bDrawVertices bool If true, draw vertices for selected BSP brushes and static meshes if the large vertices show flag is set. EditorViewportClient.h  
bForcingUnlitForNewMap bool True if we've forced the SHOW_Lighting show flag off because there are no lights in the scene EditorViewportClient.h  
bLockFlightCamera bool Flag to lock the viewport fly camera EditorViewportClient.h  
bNeedsInvalidateHitProxy bool If, following the next redraw, we should invalidate hit proxies on the viewport EditorViewportClient.h  
bNeedsLinkedRedraw bool   EditorViewportClient.h  
bNeedsRedraw bool The number of pending viewport redraws. EditorViewportClient.h  
bSetListenerPosition bool If true, the listener position will be set EditorViewportClient.h  
bShouldApplyViewModifiers bool Whether view modifiers should be called and applied. EditorViewportClient.h  
bUseNumpadCameraControl bool If true, numpad keys will be used to move camera in perspective viewport EditorViewportClient.h  
bUsingOrbitCamera bool True if the orbit camera is currently being used EditorViewportClient.h  
bWidgetAxisControlledByDrag bool True if the widget's axis is being controlled by an active mouse drag. EditorViewportClient.h  
CurrentBufferVisualizationMode FName   EditorViewportClient.h  
CurrentGPUSkinCacheVisualizationMode FName   EditorViewportClient.h  
CurrentGroomVisualizationMode FName   EditorViewportClient.h  
CurrentLumenVisualizationMode FName   EditorViewportClient.h  
CurrentNaniteVisualizationMode FName   EditorViewportClient.h  
CurrentRayTracingDebugVisualizationMode FName   EditorViewportClient.h  
CurrentSubstrateVisualizationMode FName   EditorViewportClient.h  
CurrentVirtualShadowMapVisualizationMode FName   EditorViewportClient.h  
CurrentVirtualTextureVisualizationMode FName   EditorViewportClient.h  
EngineShowFlags FEngineShowFlags A set of flags that determines visibility for various scene elements. EditorViewportClient.h  
ExposureSettings FExposureSettings Editor setting to allow designers to override the automatic expose EditorViewportClient.h  
FOVAngle float Viewport's stored horizontal field of view (saved in ini files). EditorViewportClient.h  
FramesSinceLastDraw int32 The number of frames since this viewport was last drawn. EditorViewportClient.h  
ImmersiveDelegate FViewportStateGetter Delegate used to get whether or not this client is in an immersive viewport EditorViewportClient.h  
LandscapeLODOverride int8 Override the LOD of landscape in this viewport. EditorViewportClient.h  
LastEngineShowFlags FEngineShowFlags Previous value for engine show flags, used for toggling. EditorViewportClient.h  
RenderViewportFeedback TSharedPtr< UE::RenderViewportFeedback::FReceiver, ESPMode::ThreadSafe >   EditorViewportClient.h  
StereoViewStates TArray< FSceneViewStateReference > Viewport view state when stereo rendering is enabled EditorViewportClient.h  
ViewFOV float Viewport's current horizontal field of view (can be modified by locked cameras etc.) EditorViewportClient.h  
ViewIndex int32 Index of this view in the editor's list of views EditorViewportClient.h  
ViewModifiers FEditorViewportViewModifierDelegate List of view modifiers to apply on view parameters. EditorViewportClient.h  
Viewport FViewport *   EditorViewportClient.h  
ViewportType ELevelViewportType The viewport type. EditorViewportClient.h  
ViewState FSceneViewStateReference The viewport's scene view state. EditorViewportClient.h  
ViewTransformOrthographic FViewportCameraTransform Viewport camera transform data for orthographic viewports EditorViewportClient.h  
ViewTransformPerspective FViewportCameraTransform Viewport camera transform data for perspective viewports EditorViewportClient.h  
VisibilityDelegate FViewportStateGetter Delegate used to get the visibility of this client from a slate viewport layout and tab configuration EditorViewportClient.h  
WireframeOpacity float Editor setting to adjust wireframe opacity EditorViewportClient.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
bClipToSelectionOnFocus bool Whether focusing on a box should clip the near plane to that selection. EditorViewportClient.h  
bInGameViewMode bool If true, we are in Game View mode EditorViewportClient.h  
bInVREditViewMode bool If true, we are in VR Edit View mode EditorViewportClient.h  
bIsCurrentLevelEditingFocus bool True if this is the current viewport client in editing EditorViewportClient.h  
bIsPreviewingResolutionFraction bool Controles resolution fraction for previewing in editor viewport at different screen percentage. EditorViewportClient.h  
bIsTrackingBeingStopped bool True during FEditorViewportClient::StopTracking. Used to guard against reentry. EditorViewportClient.h  
bShouldInvalidateViewportWidget bool If true, the viewport widget should be invalidated on the next tick (needed to ensure thread safety) EditorViewportClient.h  
CachedWorldBounds FBox The cached bounds of the world. EditorViewportClient.h  
CapturedMouseMoves TArray< FIntPoint >   EditorViewportClient.h  
CustomTemporalUpscalerData TSharedPtr< ICustomTemporalUpscalerData >   EditorViewportClient.h  
DragStartView FSceneView * When we drag the manipulator(no camera movement involve) in absolute we need a view to compute the delta We want to use the view when the user start dragging and use the same view until the displacement is done. EditorViewportClient.h  
DragStartViewFamily FSceneViewFamily *   EditorViewportClient.h  
FarPlane float If > 0, overrides the view's far clipping plane with a plane at the specified distance. EditorViewportClient.h  
NearPlane float Near plane adjustable for each editor view, if < 0 GNearClippingPlane should be used. EditorViewportClient.h  
OrthographicFarPlane TOptional< double > The location of the far clipping plane in orthographic view. EditorViewportClient.h  
OrthographicNearPlane TOptional< double > The location of the near clipping plane in orthographic view. EditorViewportClient.h  
OrthoViewModeIndex EViewModeIndex View mode to set when this viewport is not of type LVT_Perspective EditorViewportClient.h  
PerspViewModeIndex EViewModeIndex View mode to set when this viewport is of type LVT_Perspective EditorViewportClient.h  
PreviewResolutionFraction TOptional< float >   EditorViewportClient.h  
PrioritizedInputChords TArray< FPrioritizedInputChord > A list of input key combinations, sorted by priority. EditorViewportClient.h  
SceneDPIMode ESceneDPIMode   EditorViewportClient.h  
ViewModeParam int32 View mode param EditorViewportClient.h  
ViewModeParamName FName   EditorViewportClient.h  
ViewModeParamNameMap TMap< int32, FName > A map converting the viewmode param into an asset name. EditorViewportClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddRealtimeOverride ( bool bShouldBeRealtime,
FText SystemDisplayName
)

 Overrides the realtime state of this viewport until RemoveViewportsRealtimeOverride is called. EditorViewportClient.h  

void AdjustTransformWidgetSize ( const int32 SizeDelta
)

 Adjusts the current transform widget size by the provided delta value EditorViewportClient.h  

bool AllowsCinematicControl()

 Returns true if the viewport is allowed to be possessed for previewing cinematic sequences or keyframe animations EditorViewportClient.h  

virtual bool BeginTransform ( const FGizmoState& InState
)

   EditorViewportClient.h  

virtual FSceneView * CalcSceneView ( FSceneViewFamily* ViewFamily,
const int32 StereoViewIndex
)

 Configures the specified FSceneView object with the view and projection matrices for this viewport. EditorViewportClient.h  

virtual FMatrix CalcViewRotationMatrix ( const FRotator& InViewRotation
) const

 Computes a matrix to use for viewport location and rotation EditorViewportClient.h  

virtual FMatrix CalcViewRotationMatrixForControllingActorView ( const FRotator& InViewRotation
) const

   EditorViewportClient.h  

virtual bool CanCycleWidgetMode()

 Whether or not the widget mode can be cycled EditorViewportClient.h  

virtual FDropQuery CanDropObjectsAtCoordinates ( int32 MouseX,
int32 MouseY,
const FAssetData& AssetInfo
)

 Checks the viewport to see if the given object can be dropped using the given mouse coordinates local to this viewport EditorViewportClient.h  

virtual bool CanSetWidgetMode ( UE::Widget::EWidgetMode NewMode
) const

 Whether or not the new widget mode can be set in this viewport EditorViewportClient.h  

virtual bool CanUseDragTool()

   EditorViewportClient.h  

void CenterViewportAtPoint ( const FVector& NewLookAt,
bool bInstant
)

 Translates the viewport so that the given LookAt point is at the center of viewport, while maintaining current Location/LookAt distance EditorViewportClient.h  

void ChangeActorColorationVisualizationMode ( FName InName
)

 Changes the actor coloration visualization mode for this viewport. EditorViewportClient.h  

void ChangeBufferVisualizationMode ( FName InName
)

 Changes the buffer visualization mode for this viewport. EditorViewportClient.h  

void ChangeGPUSkinCacheVisualizationMode ( FName InName
)

 Changes the GPU Skin Cache visualization mode for this viewport EditorViewportClient.h  

void ChangeGroomVisualizationMode ( FName InName
)

 Changes the Groom visualization mode for this viewport. EditorViewportClient.h  

void ChangeLumenVisualizationMode ( FName InName
)

 Changes the Lumen visualization mode for this viewport. EditorViewportClient.h  

void ChangeNaniteVisualizationMode ( FName InName
)

 Changes the Nanite visualization mode for this viewport. EditorViewportClient.h  

void ChangeRayTracingDebugVisualizationMode ( FName InName
)

 Changes the ray tracing debug visualization mode for this viewport EditorViewportClient.h  

void ChangeSubstrateVisualizationMode ( FName InName
)

 Changes the Substrate visualization mode for this viewport. EditorViewportClient.h  

void ChangeVirtualShadowMapVisualizationMode ( FName InName
)

 Changes the virtual shadow map visualization mode for this viewport. EditorViewportClient.h  

void ChangeVirtualTextureVisualizationMode ( FName InName
)

 Changes the virtual texture visualization mode for this viewport. EditorViewportClient.h  

virtual void CheckHoveredHitProxy ( HHitProxy* HoveredHitProxy
)

 Called when the mouse cursor is hovered over a hit proxy EditorViewportClient.h  

void ClearAudioFocus()

   EditorViewportClient.h  

void ConvertMovementToDragRot ( const FVector& InDelta,
FVector& InDragDelta,
FRotator& InRotDelta
) const

 Converts a generic movement delta into drag/rotation deltas based on the viewport and keys held down. EditorViewportClient.h  

void ConvertMovementToOrbitDragRot ( const FVector& InDelta,
FVector& InDragDelta,
FRotator& InRotDelta
) const

   EditorViewportClient.h  

virtual void DestroyDropPreviewActors()

 If dragging an actor for placement, this function destroys the actor. EditorViewportClient.h  

virtual void DestroyDropPreviewElements()

 If dragging items for placement, this function destroys the items. EditorViewportClient.h  

void DisableOverrideEngineShowFlags()

 Disable EngineShowFlags override if enabled EditorViewportClient.h  

bool DoRealtimeAndOverridesMatch ( bool bInValue
) const

   EditorViewportClient.h  

void DrawActorScreenSpaceBoundingBox ( FCanvas* InCanvas,
const FSceneView* InView,
FViewport* InViewport,
AActor* InActor,
const FLinearColor& InColor,
const bool bInDrawBracket,
const FString& InLabelText
)

 Draws a screen space bounding box around the specified actor EditorViewportClient.h  

void DrawBoundingBox ( FBox& Box,
FCanvas* InCanvas,
const FSceneView* InView,
const FViewport* InViewport,
const FLinearColor& InColor,
const bool bInDrawBracket,
const FString& InLabelText
)

   EditorViewportClient.h  

virtual void DrawCanvas ( FViewport& InViewport,
FSceneView& View,
FCanvas& Canvas
)

 Called to draw onto the viewports 2D canvas EditorViewportClient.h  

virtual void DrawPreviewLightVisualization ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

 Draws a visualization of the preview light if it was recently moved. EditorViewportClient.h  

virtual bool DropObjectsAtCoordinates ( int32 MouseX,
int32 MouseY,
const TArray< UObject* >& DroppedObjects,
TArray< FTypedElementHandle >& OutNewObjects,
const FDropObjectOptions& Options
)

 Attempts to intelligently drop the given objects in the viewport, using the given mouse coordinates local to this viewport EditorViewportClient.h  

virtual bool DropObjectsAtCoordinates ( int32 MouseX,
int32 MouseY,
const TArray< UObject* >& DroppedObjects,
TArray< AActor* >& OutNewActors,
bool bOnlyDropOnTarget,
bool bCreateDropPreview,
bool bSelectActors,
UActorFactory* FactoryToUse
)

   EditorViewportClient.h  
Enable customization of the EngineShowFlags for rendering. EditorViewportClient.h  

virtual bool EndTransform ( const FGizmoState& InState
)

   EditorViewportClient.h  

void FocusViewportOnBox ( const FBox& BoundingBox,
bool bInstant
)

 Focuses the viewport to the center of the bounding box ensuring that the entire box is in view EditorViewportClient.h  

virtual FLinearColor GetBackgroundColor()

   EditorViewportClient.h  

virtual uint32 GetCachedMouseX()

   EditorViewportClient.h  

virtual uint32 GetCachedMouseY()

   EditorViewportClient.h  

FEditorCameraController * GetCameraController()

   EditorViewportClient.h  

float GetCameraSpeed ()

 Get the camera speed for this viewport EditorViewportClient.h  

float GetCameraSpeed ( int32 SpeedSetting
) const

 Get the camera speed for this viewport based on the specified speed setting EditorViewportClient.h  

virtual float GetCameraSpeedScalar()

 Get the camera speed scalar for this viewport EditorViewportClient.h  

virtual int32 GetCameraSpeedSetting()

 Get the camera speed setting for this viewport EditorViewportClient.h  

virtual const FEditorViewportCameraSpeedSettings & GetCameraSpeedSettings()

 Gets the settings that control camera speed for this viewport EditorViewportClient.h  

bool GetClipToSelectionOnFocus()

 Gets whether focusing on a box should clip to selection. EditorViewportClient.h  

FText GetCurrentActorColorationVisualizationModeDisplayName()

 Returns the FText display name associated with current actor coloration visualization mode. EditorViewportClient.h  

FText GetCurrentBufferVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentBufferVisualizationMode. EditorViewportClient.h  

FText GetCurrentGPUSkinCacheVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentGPUSkinCacheVisualizationMode. EditorViewportClient.h  

FText GetCurrentGroomVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentGroomVisualizationMode. EditorViewportClient.h  

FText GetCurrentLumenVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentLumenVisualizationMode. EditorViewportClient.h  

FText GetCurrentNaniteVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentNaniteVisualizationMode. EditorViewportClient.h  

FText GetCurrentSubstrateVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentSubstrateVisualizationMode. EditorViewportClient.h  

FText GetCurrentVirtualShadowMapVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentVirtualShadowMapVisualizationMode. EditorViewportClient.h  

FText GetCurrentVirtualTextureVisualizationModeDisplayName()

 Returns the FText display name associated with CurrentVirtualTextureVisualizationMode. EditorViewportClient.h  

EAxisList::Type GetCurrentWidgetAxis()

   EditorViewportClient.h  

FViewportCursorLocation GetCursorWorldLocationFromMousePos()

 Gets the world space cursor info from the current mouse position EditorViewportClient.h  

TSharedPtr< ICustomTemporalUpscalerData > GetCustomTemporalUpscalerData()

   EditorViewportClient.h  

float GetDefaultPrimaryResolutionFractionTarget()

   EditorViewportClient.h  

TSharedPtr< SEditorViewport > GetEditorViewportWidget()

 Get the editor viewport widget EditorViewportClient.h  

float GetFarClipPlaneOverride()

 Get the far clipping plane override for this viewport. EditorViewportClient.h  

FVector GetForwardVector()

   EditorViewportClient.h  

FVector GetHitProxyObjectLocation ( int32 X,
int32 Y
)

 Returns the location of the object at the given viewport X,Y EditorViewportClient.h  

bool GetIsCurrentLevelEditingFocus()

   EditorViewportClient.h  

virtual FMatrix GetLocalCoordinateSystem()

   EditorViewportClient.h  

const FVector & GetLookAtLocation()

   EditorViewportClient.h  

FEditorModeTools * GetModeTools()

 Editor mode tool manager being used for this viewport client EditorViewportClient.h  

FMouseDeltaTracker * GetMouseDeltaTracker()

 Mouse info is usually transformed to gizmo space before FEdMode handles it, this allows raw delta X and Y access EditorViewportClient.h  

float GetNearClipPlane()

 Get the near clipping plane for this viewport. EditorViewportClient.h  

TOptional< double > GetOrthographicFarPlaneOverride()

 Get the orthographic far plane override for this viewport. EditorViewportClient.h  

TOptional< double > GetOrthographicNearPlaneOverride()

 Get the orthographic near plane override for this viewport. EditorViewportClient.h  

float GetOrthoUnitsPerPixel ( const FViewport* Viewport
) const

   EditorViewportClient.h  

EViewModeIndex GetOrthoViewMode()

   EditorViewportClient.h  

float GetOrthoZoom()

   EditorViewportClient.h  

EViewModeIndex GetPerspViewMode()

   EditorViewportClient.h  

virtual bool GetPivotForOrbit ( FVector& OutPivot
) const

 Get the custom pivot point around which the camera should orbit for this viewport EditorViewportClient.h  

FPreviewScene * GetPreviewScene()

 Retrieves the FPreviewScene used by this instance of FEditorViewportClient. EditorViewportClient.h  

int32 GetPreviewScreenPercentage()

   EditorViewportClient.h  

FText GetRealtimeOverrideMessage()

   EditorViewportClient.h  

virtual FSceneInterface * GetScene()

   EditorViewportClient.h  

float GetSceneDepthAtLocation ( int32 X,
int32 Y
)

 Returns the scene depth at the given viewport X,Y EditorViewportClient.h  

bool GetShowWidget()

   EditorViewportClient.h  

const FVector & GetViewLocation()

   EditorViewportClient.h  

EViewModeIndex GetViewMode()

   EditorViewportClient.h  

TMap< int32, FName > & GetViewModeParamNameMap()

 Returns the map allowing to convert from the viewmode param to a name. EditorViewportClient.h  

void GetViewportDimensions ( FIntPoint& OutOrigin,
FIntPoint& OutSize
)

 Gets the dimensions of the viewport EditorViewportClient.h  

FViewportClientNavigationHelper * GetViewportNavigationHelper()

   EditorViewportClient.h  

virtual ELevelViewportType GetViewportType()

 Returns the effective viewport type (taking into account any actor locking or camera possession) EditorViewportClient.h  

const FRotator & GetViewRotation()

   EditorViewportClient.h  

EViewStatusForScreenPercentage GetViewStatusForScreenPercentage()

   EditorViewportClient.h  
Gets ViewportCameraTransform object for the current viewport type EditorViewportClient.h  
  EditorViewportClient.h  

virtual FMatrix GetWidgetCoordSystem()

   EditorViewportClient.h  

virtual ECoordSystem GetWidgetCoordSystemSpace()

   EditorViewportClient.h  

virtual FVector GetWidgetLocation()

   EditorViewportClient.h  

virtual UE::Widget::EWidgetMode GetWidgetMode()

   EditorViewportClient.h  

FBox GetWorldBounds()

 Gets the bounds of the world being represented. EditorViewportClient.h  

virtual bool HandleIsShowFlagEnabled ( FEngineShowFlags::EShowFlag EngineShowFlagIndex
) const

 Delegate handler fired to determine the state of a show flag EditorViewportClient.h  

virtual void HandleToggleShowFlag ( FEngineShowFlags::EShowFlag EngineShowFlagIndex
)

 Delegate handler fired when a show flag is toggled EditorViewportClient.h  

virtual bool HasDropPreviewActors()

 Returns true if a placement dragging actor exists EditorViewportClient.h  

virtual bool HasDropPreviewElements()

 Returns true if a placement drag preview elements exists EditorViewportClient.h  

bool HasRealtimeOverride ( FText SystemDisplayName
) const

 Returns whether there's a realtime override registered with the given system name. EditorViewportClient.h  

void InputAxisForOrbit ( FViewport* Viewport,
const FVector& DragDelta,
FVector& Drag,
FRotator& Rot
)

   EditorViewportClient.h  

bool InputTakeScreenshot ( FViewport* Viewport,
FKey Key,
EInputEvent Event
)

 Implements screenshot capture for editor viewports. EditorViewportClient.h  

virtual bool InputWidgetDelta ( FViewport* InViewport,
EAxisList::Type CurrentAxis,
FVector& Drag,
FRotator& Rot,
FVector& Scale
)

 Called to give the viewport client a chance to handle widgets being moved EditorViewportClient.h  

void Invalidate ( bool bInvalidateChildViews,
bool bInvalidateHitProxies
)

 Invalidates this viewport and optionally child views. EditorViewportClient.h  

bool IsActiveViewportType ( ELevelViewportType InViewportType
) const

   EditorViewportClient.h  

bool IsActiveViewportTypeInRotation()

   EditorViewportClient.h  

bool IsActorColorationVisualizationModeSelected ( FName InName
) const

 Checks if an actor coloration visualization mode is selected. EditorViewportClient.h  

bool IsAltPressed()

 Utility functions to return the modifier key states. EditorViewportClient.h  

virtual bool IsAspectRatioConstrained()

 Is the aspect ratio currently constrained? EditorViewportClient.h  

bool IsBufferVisualizationModeSelected ( FName InName
) const

 Checks if a buffer visualization mode is selected. EditorViewportClient.h  

bool IsCameraLocked()

 Callback for checking the camera lock flag. EditorViewportClient.h  

bool IsCmdPressed()

   EditorViewportClient.h  

bool IsCommandChordPressed ( const TSharedPtr< FUICommandInfo > InCommand,
FKey InOptionalKey
) const

 Utility function to return whether the command accepts the key states EditorViewportClient.h  

bool IsCtrlPressed()

   EditorViewportClient.h  

bool IsEngineShowFlagsOverrideEnabled()

   EditorViewportClient.h  

bool IsFlightCameraActive()

 Returns whether or not the flight camera is active EditorViewportClient.h  

bool IsForcedRealtimeAudio()

   EditorViewportClient.h  

bool IsGPUSkinCacheVisualizationModeSelected ( FName InName
) const

 Checks if a GPU Skin Cache visualization mode is selected EditorViewportClient.h  

bool IsGroomVisualizationModeSelected ( FName InName
) const

 Checks if a Groom visualization mode is selected. EditorViewportClient.h  

bool IsInImmersiveViewport()

   EditorViewportClient.h  

virtual bool IsLevelEditorClient()

 If true, this is a level editor viewport EditorViewportClient.h  

bool IsLowDPIPreview()

   EditorViewportClient.h  

bool IsLumenVisualizationModeSelected ( FName InName
) const

 Checks if a Lumen visualization mode is selected. EditorViewportClient.h  

bool IsMovingCamera()

   EditorViewportClient.h  

bool IsNaniteVisualizationModeSelected ( FName InName
) const

 Checks if a Nanite visualization mode is selected. EditorViewportClient.h  

bool IsPerspective()

 Returns true if this viewport is perspective. EditorViewportClient.h  

bool IsPreviewingScreenPercentage()

   EditorViewportClient.h  

bool IsPrioritizedInputChordPressed ( const FName InInputCordName
) const

   EditorViewportClient.h  

bool IsRayTracingDebugVisualizationModeSelected ( FName InName
) const

 Checks if a ray tracing debug visualization mode is selected EditorViewportClient.h  

bool IsRealtime()

   EditorViewportClient.h  

bool IsRealtimeOverrideSet()

   EditorViewportClient.h  

bool IsSetShowBoundsChecked()

 Callback for checking the bounds show flag. EditorViewportClient.h  

bool IsSetShowCollisionChecked()

 Callback for checking the collision geometry show flag. EditorViewportClient.h  

bool IsSetShowGridChecked()

 Callback for checking the grid show flag. EditorViewportClient.h  

bool IsShiftPressed()

   EditorViewportClient.h  

bool IsShowingAspectRatioBarDisplay()

   EditorViewportClient.h  

bool IsShowingSafeFrameBoxDisplay()

   EditorViewportClient.h  

bool IsSimulateInEditorViewport()

   EditorViewportClient.h  

bool IsSubstrateVisualizationModeSelected ( FName InName
) const

 Checks if a Substrate visualization mode is selected. EditorViewportClient.h  

bool IsTracking()

   EditorViewportClient.h  

bool IsUsingAbsoluteTranslation ( bool bAlsoCheckAbsoluteRotation
) const

 Determines whether this viewport is currently allowed to use Absolute Movement EditorViewportClient.h  

bool IsViewModeEnabled ( EViewModeIndex InViewModeIndex
) const

   EditorViewportClient.h  

bool IsViewModeParam ( int32 InViewModeParam
) const

   EditorViewportClient.h  

bool IsVirtualShadowMapVisualizationModeSelected ( FName InName
) const

 Checks if a virtual shadow map visualization mode is selected. EditorViewportClient.h  

bool IsVirtualTextureVisualizationModeSelected ( FName InName
) const

 Checks if a virtual texture visualization mode is selected. EditorViewportClient.h  

bool IsVisible()

 True if the window is maximized or floating EditorViewportClient.h  

bool IsVisualizeCalibrationMaterialEnabled()

 Returns whether visualize debug material is enabled. EditorViewportClient.h  

bool IsZebraViewModeEnabled ( bool bHorizontal
) const

   EditorViewportClient.h  

virtual TSharedPtr< FDragTool > MakeDragTool ( EDragTool::Type DragToolType
)

 Called to make a drag tool when the user starts dragging in the viewport EditorViewportClient.h  

void MarkMouseMovedSinceClick()

 Forces a cursor update and marks the window as a move has occurred EditorViewportClient.h  

void MoveViewportCamera ( const FVector& InDrag,
const FRotator& InRot,
bool bDollyCamera
)

 Moves the viewport Scamera according to the specified drag and rotation. EditorViewportClient.h  

void OnEditorModeIDChanged ( const FEditorModeID& EditorModeID,
bool bIsEntering
)

 Called when an editor mode has been (de)activated EditorViewportClient.h  

void OpenScreenshot ( FString SourceFilePath
)

 Opens the screenshot in the uses default bitmap viewer (determined by OS) EditorViewportClient.h  

void OverrideFarClipPlane ( const float InFarPlane
)

 Override the far clipping plane. Set to a negative value to disable the override. EditorViewportClient.h  

void OverrideNearClipPlane ( float InNearPlane
)

 Override the near clipping plane. Set to a negative value to disable the override. EditorViewportClient.h  

virtual void OverridePostProcessSettings ( FSceneView& View
)

 Called to override any post process settings for the view EditorViewportClient.h  

void PeformDefaultCameraMovement ( FVector& Drag,
FRotator& Rot,
FVector& Scale
)

 Perform default camera movement that would normally happen* This can be used by systems to override how the camera is triggered EditorViewportClient.h  
Removes the last added realtime override. EditorViewportClient.h  

virtual void ProcessClick ( FSceneView& View,
HHitProxy* HitProxy,
FKey Key,
EInputEvent Event,
uint32 HitX,
uint32 HitY
)

 Called when the user clicks in the viewport EditorViewportClient.h  
Functions for registering and evaluating prioritized input chords. EditorViewportClient.h  

void RemoveCameraRoll()

   EditorViewportClient.h  

bool RemoveRealtimeOverride ( FText SystemDisplayName,
bool bCheckMissingOverride
)

 Removes the most recent realtime override registered with the given system name. EditorViewportClient.h  

void RenderDragTool ( const FSceneView* View,
FCanvas* Canvas
)

 Render the drag tool in the viewport EditorViewportClient.h  

virtual void RequestRealTimeFrames ( uint64 NumRealTimeFrames
)

 Get the number of real-time frames to draw (overrides bRealtime) EditorViewportClient.h  

void RestoreRealtime ( const bool bAllowDisable
)

 Restores realtime setting to stored value. EditorViewportClient.h  

virtual void RotateViewportType()

 Rotate through viewport view options EditorViewportClient.h  

void SaveRealtimeStateToConfig ( bool& ConfigVar
) const

 Saves the realtime state to a config location. Does not save any temp overrides EditorViewportClient.h  

void SetAllowCinematicControl ( bool bInAllowCinematicControl
)

 Sets whether or not this viewport is allowed to be possessed by cinematic/scrubbing tools EditorViewportClient.h  

void SetAudioFocus()

   EditorViewportClient.h  

virtual void SetCameraLock()

 Callback for toggling the camera lock flag. EditorViewportClient.h  

void SetCameraSetup ( const FVector& LocationForOrbiting,
const FRotator& InOrbitRotation,
const FVector& InOrbitZoom,
const FVector& InOrbitLookAt,
const FVector& InViewLocation,
const FRotator& InViewRotation
)

 This set ups camera for both orbit and non orbit control EditorViewportClient.h  

virtual void SetCameraSpeedScalar ( float SpeedScalar
)

 Set the camera speed scalar for this viewport EditorViewportClient.h  

virtual void SetCameraSpeedSetting ( int32 SpeedSetting
)

 Set the speed setting for the camera in this viewport EditorViewportClient.h  

virtual void SetCameraSpeedSettings ( const FEditorViewportCameraSpeedSettings& InCameraSpeedSettings
)

 Sets the camera speed settings for this viewport EditorViewportClient.h  

void SetClipToSelectionOnFocus ( bool bInClipToSelection
)

 Sets whether focusing on a box should clip to selection. EditorViewportClient.h  

virtual void SetCurrentWidgetAxis ( EAxisList::Type InAxis
)

 Sets the current axis being manipulated by the transform widget EditorViewportClient.h  

void SetCustomTemporalUpscalerData ( TSharedPtr< ICustomTemporalUpscalerData > InCustomTemporalUpscalerData
)

   EditorViewportClient.h  

void SetForcedAudioRealtime ( bool bShouldForceAudioRealtime
)

 True to force realtime audio to be true, false to stop forcing it EditorViewportClient.h  

void SetGameView ( bool bGameViewEnable
)

   EditorViewportClient.h  

void SetInitialViewTransform ( ELevelViewportType ViewportType,
const FVector& ViewLocation,
const FRotator& ViewRotation,
float InOrthoZoom
)

   EditorViewportClient.h  

void SetIsCurrentLevelEditingFocus ( bool bInIsCurrentLevelEditingFocus
)

   EditorViewportClient.h  

void SetLookAtLocation ( const FVector& LookAt,
bool bRecalculateView
)

 Sets the look at location of the viewports camera for orbit * EditorViewportClient.h  

void SetLowDPIPreview ( bool LowDPIPreview
)

 Set whether previewing for low DPI. EditorViewportClient.h  

void SetOrthographicFarPlaneOverride ( const TOptional< double >& InValue
)

 Set the orthographic far plane override for this viewport. EditorViewportClient.h  

void SetOrthographicNearPlaneOverride ( const TOptional< double >& InValue
)

 Set the orthographic near plane override for this viewport. EditorViewportClient.h  

void SetOrthoZoom ( float InOrthoZoom
)

 Sets ortho zoom amount EditorViewportClient.h  

void SetPreviewingScreenPercentage ( bool bIsPreviewing
)

 Sets whether preview screen percentage for UI. EditorViewportClient.h  

void SetPreviewScreenPercentage ( int32 PreviewScreenPercentage
)

 Set preview screen percentage on UI behalf. EditorViewportClient.h  

void SetRealtime ( bool bInRealtime,
bool bStoreCurrentValue
)

   EditorViewportClient.h  

void SetRealtime ( bool bInRealtime
)

 Sets whether or not the viewport updates in realtime. EditorViewportClient.h  

void SetRequiredCursorOverride ( bool WantOverride,
EMouseCursor::Type RequiredCursor
)

 Overrides current cursor. EditorViewportClient.h  

void SetShowAspectRatioBarDisplay ( bool bEnable
)

 Aspect ratio bar display settings EditorViewportClient.h  

void SetShowBounds ( bool bShow
)

 Sets the show bounds flag EditorViewportClient.h  

void SetShowCollision()

 Callback for toggling the collision geometry show flag. EditorViewportClient.h  

void SetShowGrid()

 Callback for toggling the grid show flag. EditorViewportClient.h  

void SetShowSafeFrameBoxDisplay ( bool bEnable
)

   EditorViewportClient.h  

virtual void SetupViewForRendering ( FSceneViewFamily& ViewFamily,
FSceneView& View
)

 Called to do any additional set up of the view for rendering EditorViewportClient.h  

void SetViewLocation ( const FVector& NewLocation
)

 Sets the location of the viewport's camera EditorViewportClient.h  

void SetViewLocationForOrbiting ( const FVector& LookAtPoint,
float DistanceToCamera
)

 Sets the camera view location such that the LookAtPoint point is at the specified location. EditorViewportClient.h  

virtual void SetViewMode ( EViewModeIndex InViewModeIndex
)

 Sets how the viewport is displayed (lit, wireframe, etc) for the current viewport type EditorViewportClient.h  

void SetViewModeParam ( int32 InViewModeParam
)

 Set the viewmode param. EditorViewportClient.h  

void SetViewModes ( const EViewModeIndex InPerspViewModeIndex,
const EViewModeIndex InOrthoViewModeIndex
)

 Sets how the viewport is displayed (lit, wireframe, etc) EditorViewportClient.h  

virtual void SetViewportType ( ELevelViewportType InViewportType
)

 Set the viewport type of the client EditorViewportClient.h  

void SetViewRotation ( const FRotator& NewRotation
)

 Sets the location of the viewport's camera EditorViewportClient.h  

virtual void SetVREditView ( bool bGameViewEnable
)

   EditorViewportClient.h  

virtual void SetWidgetCoordSystemSpace ( ECoordSystem NewCoordSystem
)

 Sets the coordinate system space to use EditorViewportClient.h  

virtual void SetWidgetMode ( UE::Widget::EWidgetMode NewMode
)

 Sets the current widget mode EditorViewportClient.h  

void SetWidgetModeOverride ( UE::Widget::EWidgetMode InWidgetMode
)

 Overrides current widget mode EditorViewportClient.h  

virtual void SetZebraViewMode ( bool bHorizontalZebraMode
)

 Sets the viewport type to Geometry Inspection Zebra mode, horizontal or vertical type EditorViewportClient.h  

virtual void SetZebraViewModeStripeCount ( uint8 InStripeCount
)

 Sets Geometry Inspection Zebra mode stripe count EditorViewportClient.h  

virtual bool ShouldLockPitch()

   EditorViewportClient.h  

virtual bool ShouldOrbitCamera()

   EditorViewportClient.h  

virtual bool ShouldScaleCameraSpeedByDistance()

   EditorViewportClient.h  

bool ShouldShowStats()

 Returns true if status information should be displayed over the viewport EditorViewportClient.h  

void ShowWidget ( const bool bShow
)

 Show or hide the widget. EditorViewportClient.h  

virtual void SummonContextMenu ( const FTypedElementHandle& HitProxyElement
)

 Override to specify what should happen when a context menu is requested EditorViewportClient.h  

bool SupportsLowDPIPreview()

   EditorViewportClient.h  

bool SupportsManualOrthographicDepthControl()

 Accessor for whether orthographic control should be enabled. EditorViewportClient.h  

bool SupportsPreviewResolutionFraction()

   EditorViewportClient.h  

void TakeHighResScreenShot()

   EditorViewportClient.h  

void TakeOwnershipOfModeManager ( TSharedPtr< FEditorModeTools >& ModeManagerPtr
)

 Legacy adapter for a toolkit to take ownership of a mode manager that may have been created by this viewport client EditorViewportClient.h  

void TakeScreenshot ( FViewport* Viewport,
bool bInvalidateViewport
)

 Takes the screenshot capture, this is called by keybinded events as well InputTakeScreenshot EditorViewportClient.h  

virtual void Tick ( float DeltaSeconds
)

 Ticks this viewport client EditorViewportClient.h  

void ToggleOrbitCamera ( bool bEnableOrbitCamera
)

 Toggle between orbit camera and fly camera EditorViewportClient.h  

bool ToggleRealtime ()

 Toggles whether or not the viewport updates in realtime and returns the updated state. EditorViewportClient.h  

void ToggleShowBounds()

 Callback for toggling the bounds show flag. EditorViewportClient.h  

virtual void TrackingStarted ( const FInputEventState& InInputState,
bool bIsDraggingWidget,
bool bNudge
)

 Called when mouse movement tracking begins EditorViewportClient.h  

virtual void TrackingStopped()

 Called when mouse movement tracking stops EditorViewportClient.h  

FVector TranslateDelta ( FKey InKey,
float InDelta,
bool InNudge
)

 Determines which axis InKey and InDelta most refer to and returns a corresponding FVector. EditorViewportClient.h  

void UnregisterPrioritizedInputChord ( const FName InInputCordName
)

   EditorViewportClient.h  

virtual bool UpdateDropPreviewActors ( int32 MouseX,
int32 MouseY,
const TArray< UObject* >& DroppedObjects,
bool& out_bDroppedObjectsVisible,
UActorFactory* FactoryToUse
)

 If dragging an actor for placement, this function updates its position. EditorViewportClient.h  

virtual bool UpdateDropPreviewElements ( int32 MouseX,
int32 MouseY,
const TArray< UObject* >& DroppedObjects,
bool& out_bDroppedObjectsVisible,
TScriptInterface< IAssetFactoryInterface > Factory
)

 If dragging items for placement, this function updates their position. EditorViewportClient.h  

virtual void UpdateGestureDelta()

 Called each frame to update the viewport based on delta trackpad gestures EditorViewportClient.h  

void UpdateHiddenCollisionDrawing()

 When collision draw mode changes, this function allows hidden objects to be drawn, so hidden colliding objects can be seen EditorViewportClient.h  

virtual void UpdateLinkedOrthoViewports ( bool bInvalidate
)

   EditorViewportClient.h  

virtual void UpdateMouseDelta()

 Called each frame to update the viewport based on delta mouse movements EditorViewportClient.h  

virtual bool UseAppTime()

 Should this viewport use app time instead of world time. EditorViewportClient.h  

virtual bool WantsDrawWhenAppIsHidden ()

 Normally we disable all viewport rendering when the editor is minimized, but the render commands may need to be processed regardless (like if we were outputting to a monitor via capture card). EditorViewportClient.h  

Overridden from FViewportClient

Name Remarks Include Path Unreal Specifiers

virtual void CapturedMouseMove ( FViewport* InViewport,
int32 InMouseX,
int32 InMouseY
)

   EditorViewportClient.h  

virtual void Draw ( FViewport* Viewport,
FCanvas* Canvas
)

   EditorViewportClient.h  

virtual EMouseCursor::Type GetCursor ( FViewport* Viewport,
int32 X,
int32 Y
)

   EditorViewportClient.h  

virtual const TArray< FString > * GetEnabledStats()

   EditorViewportClient.h  

virtual FStatHitchesData * GetStatHitchesData()

   EditorViewportClient.h  

virtual FStatUnitData * GetStatUnitData()

   EditorViewportClient.h  

virtual UWorld * GetWorld ()

 Use the viewports Scene to get a world. EditorViewportClient.h  

virtual bool InputAxis ( const FInputKeyEventArgs& Args
)

   EditorViewportClient.h  

virtual bool InputGesture ( FViewport* Viewport,
const FInputDeviceId DeviceId,
EGestureEvent GestureType,
const FVector2D& GestureDelta,
bool bIsDirectionInvertedFromDevice,
const uint64 Timestamp
)

   EditorViewportClient.h  

virtual bool InputKey ( const FInputKeyEventArgs& EventArgs
)

   EditorViewportClient.h  

virtual bool IsInGameView()

 Returns true if this viewport is excluding non-game elements from its display EditorViewportClient.h  

virtual bool IsOrtho()

   EditorViewportClient.h  

virtual bool IsStatEnabled ( const FString& InName
) const

   EditorViewportClient.h  

virtual void LostFocus ( FViewport* Viewport
)

   EditorViewportClient.h  

virtual TOptional< TSharedRef< SWidget > > MapCursor ( FViewport* Viewport,
const FCursorReply& CursorReply
)

   EditorViewportClient.h  

virtual void MouseEnter ( FViewport* Viewport,
int32 x,
int32 y
)

   EditorViewportClient.h  

virtual void MouseLeave ( FViewport* Viewport
)

   EditorViewportClient.h  

virtual void MouseMove ( FViewport* Viewport,
int32 x,
int32 y
)

   EditorViewportClient.h  

virtual void ProcessAccumulatedPointerInput ( FViewport* InViewport
)

   EditorViewportClient.h  

virtual bool ProcessScreenShots ( FViewport* Viewport
)

 FViewportClient interface EditorViewportClient.h  

virtual void ReceivedFocus ( FViewport* Viewport
)

   EditorViewportClient.h  

virtual void RedrawRequested ( FViewport* Viewport
)

   EditorViewportClient.h  

virtual void RequestInvalidateHitProxy ( FViewport* Viewport
)

   EditorViewportClient.h  

virtual void SetEnabledStats ( const TArray< FString >& InEnabledStats
)

   EditorViewportClient.h  

virtual void SetShowStats ( bool bWantStats
)

 Sets whether or not stats info is displayed over the viewport EditorViewportClient.h  

Overridden from FViewElementDrawer

Name Remarks Include Path Unreal Specifiers

virtual void Draw ( const FSceneView* View,
FPrimitiveDrawInterface* PDI
)

 FViewElementDrawer interface EditorViewportClient.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

 FGCObject interface EditorViewportClient.h  

virtual FString GetReferencerName()

   EditorViewportClient.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void AbortTracking()

 Aborts mouse tracking (stop and cancel) EditorViewportClient.h  

void ApplyDeltaToRotateWidget ( const FRotator& InRot
)

 Updates the rotate widget with the passed in delta rotation. EditorViewportClient.h  

void ApplyRequiredCursorVisibility ( bool bUpdateSoftwareCursorPostion
)

 Apply the required cursor visibility states from the RequiredCursorVisibiltyAndAppearance struct EditorViewportClient.h  

bool CalculateEditorConstrainedViewRect ( FSlateRect& OutSafeFrameRect,
FViewport* InViewport,
const float DPIScale
)

 Helper function to calculate the safe frame rectangle on the current viewport EditorViewportClient.h  

void DrawAxes ( FViewport* Viewport,
FCanvas* Canvas,
const FRotator* InRotation,
EAxisList::Type InAxis
)

 Draws viewport axes EditorViewportClient.h  

void DrawScaleUnits ( FViewport* Viewport,
FCanvas* Canvas,
const FSceneView& InView
)

 Draws viewport scale units EditorViewportClient.h  

void EnableCameraLock ( bool bEnable
)

 Enables or disables camera lock EditorViewportClient.h  

virtual bool GetActiveSafeFrame ( float& OutAspectRatio
) const

 Helper used by DrawSafeFrames to get the current safe frame aspect ratio. EditorViewportClient.h  

FCachedJoystickState * GetJoystickState ( const uint32 InControllerID
)

 Gets a joystick state cache for the specified controller ID EditorViewportClient.h  

virtual bool Internal_InputAxis ( FViewport* Viewport,
FInputDeviceId DeviceID,
FKey Key,
float Delta,
float DeltaTime,
int32 NumSamples,
bool bGamepad
)

   EditorViewportClient.h  

virtual bool Internal_InputKey ( const FInputKeyEventArgs& EventArgs
)

   EditorViewportClient.h  

void InvalidateViewportWidget()

 Invalidates the viewport widget (if valid) to register its active timer EditorViewportClient.h  

virtual void NudgeSelectedObjects ( const FInputEventState& InputState
)

   EditorViewportClient.h  

void OnChangeCameraSpeed ( const FInputEventState& InputState
)

 Called when a user changes the camera speed EditorViewportClient.h  

void OnDollyPerspectiveCamera ( const FInputEventState& InputState
)

 Called when a user dollys the perspective camera EditorViewportClient.h  

void OnOrthoZoom ( const FInputEventState& InputState,
float Scale
)

 Called when a user zooms the ortho viewport EditorViewportClient.h  

virtual void PerspectiveCameraMoved()

 Called when the perspective viewport camera moves EditorViewportClient.h  

void ProcessClickInViewport ( const FInputEventState& InputState,
FSceneView& View
)

 Handles clicking in the viewport EditorViewportClient.h  

void ProcessDoubleClickInViewport ( const FInputEventState& InputState,
FSceneView& View
)

 Handles double clicking in the viewport EditorViewportClient.h  

virtual void RedrawAllViewportsIntoThisScene()

 Invalidates this and other linked viewports (anything viewing the same scene) EditorViewportClient.h  

void SetRequiredCursor ( const bool bHardwareCursorVisible,
const bool bSoftwareCursorVisible
)

 Sets the required hardware and software cursor. EditorViewportClient.h  

bool ShouldUseMoveCanvasMovement()

 Determines if the new MoveCanvas movement should be used EditorViewportClient.h  

void StartTrackingDueToInput ( const FInputEventState& InputState,
FSceneView& View
)

 Starts tracking the mouse due to mouse input EditorViewportClient.h  

void StopTracking()

 Stops any mouse tracking EditorViewportClient.h  

void UpdateAndApplyCursorVisibility()

 Updates the visibility of the hardware and software cursors according to the viewport's state. EditorViewportClient.h  

void UpdateRequiredCursorVisibility()

 Setup the cursor visibility state we require and store in RequiredCursorVisibiltyAndAppearance struct EditorViewportClient.h  

Overridden from FCommonViewportClient

Name Remarks Include Path Unreal Specifiers

virtual float UpdateViewportClientWindowDPIScale()

 FCommonViewportClient interface EditorViewportClient.h  

Static

Name Remarks Include Path Unreal Specifiers

static uint8 GetZebraViewModeStripeCount()

   EditorViewportClient.h  

static FString UnrealUnitsToSiUnits ( float UnrealUnits
)

 Get a prettified string representation of the specified unreal units EditorViewportClient.h  

Operators

Name Remarks Include Path Unreal Specifiers
  EditorViewportClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page