1. Epic GamesDeveloper
  3. FViewportClient

FViewportClient

An abstract interface to a viewport's client.

API > API/Runtime > API/Runtime/Engine

An abstract interface to a viewport's client. The viewport's client processes input received by the viewport, and draws the viewport.

   
Name FViewportClient
Type class
Header File /Engine/Source/Runtime/Engine/Public/ViewportClient.h
Include Path #include "ViewportClient.h"

Syntax

class FViewportClient

Derived Classes

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FViewportClient()

   ViewportClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void Activated ( FViewport* Viewport,
const FWindowActivateEvent& InActivateEvent
)

   ViewportClient.h  

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

 Called when the mouse is moved while a window input capture is in effect ViewportClient.h  

virtual bool CaptureMouseOnLaunch()

 Gets whether or not the viewport captures the Mouse on launch of the application Technically this controls capture on the first window activate, so in situations where the application is launched but isn't activated the effect is delayed until activation. ViewportClient.h  

virtual void CloseRequested ( FViewport* Viewport
)

   ViewportClient.h  

virtual void ConditionalRestoreWorld ( UWorld* InWorld
)

 Restores GWorld to InWorld ViewportClient.h  

virtual UWorld * ConditionalSetWorld()

 Sets GWorld to the appropriate world for this client ViewportClient.h  

virtual void Deactivated ( FViewport* Viewport,
const FWindowActivateEvent& InActivateEvent
)

   ViewportClient.h  

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

   ViewportClient.h  

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

 Retrieves the cursor that should be displayed by the OS ViewportClient.h  

virtual float GetDPIScale()

   ViewportClient.h  

virtual const TArray< FString > * GetEnabledStats()

 Get a ptr to the enabled stats list ViewportClient.h  

virtual FEngineShowFlags * GetEngineShowFlags()

   ViewportClient.h  

virtual EMouseCaptureMode GetMouseCaptureMode()

 Gets the mouse capture behavior when the viewport is clicked ViewportClient.h  

virtual FStatHitchesData * GetStatHitchesData()

 Get a ptr to the stat unit data for this viewport ViewportClient.h  

virtual FStatUnitData * GetStatUnitData()

 Get a ptr to the stat unit data for this viewport ViewportClient.h  

virtual UWorld * GetWorld()

   ViewportClient.h  

virtual bool HandleNavigation ( const uint32 InUserIndex,
TSharedPtr< SWidget > InDestination
)

 Optionally do custom handling of a navigation. ViewportClient.h  

virtual bool HideCursorDuringCapture()

 Gets whether or not the cursor is hidden when the viewport captures the mouse ViewportClient.h  

virtual bool IgnoreInput()

 Check whether we should ignore input. ViewportClient.h  

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

 Check an axis movement received by the viewport. ViewportClient.h  

virtual bool InputAxis ( const FInputKeyEventArgs& Args
)

 Check an axis movement received by the viewport. ViewportClient.h  

virtual bool InputChar ( FViewport* Viewport,
int32 ControllerId,
TCHAR Character
)

 Check a character input received by the viewport. ViewportClient.h  

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

 Check a gesture event received by the viewport. ViewportClient.h  

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

 Check a gesture event received by the viewport. ViewportClient.h  

virtual bool InputKey ( const FInputKeyEventArgs& EventArgs
)

 Check a key event received by the viewport. ViewportClient.h  

virtual bool InputMotion ( FViewport* Viewport,
const FInputDeviceId DeviceId,
const FVector& Tilt,
const FVector& RotationRate,
const FVector& Gravity,
const FVector& Acceleration,
const uint64 Timestamp
)

 Each frame, the input system will update the motion data. ViewportClient.h  

virtual bool InputMotion ( FViewport* Viewport,
int32 ControllerId,
const FVector& Tilt,
const FVector& RotationRate,
const FVector& Gravity,
const FVector& Acceleration
)

 Each frame, the input system will update the motion data. ViewportClient.h  

virtual bool InputTouch ( FViewport* Viewport,
int32 ControllerId,
uint32 Handle,
ETouchType::Type Type,
const FVector2D& TouchLocation,
float Force,
FDateTime DeviceTimestamp,
uint32 TouchpadIndex
)

 Check a key event received by the viewport. ViewportClient.h  

virtual bool InputTouch ( FViewport* Viewport,
const FInputDeviceId DeviceId,
uint32 Handle,
ETouchType::Type Type,
const FVector2D& TouchLocation,
float Force,
uint32 TouchpadIndex,
const uint64 Timestamp
)

 Check a key event received by the viewport. ViewportClient.h  

virtual bool IsFocused ( FViewport* Viewport
)

   ViewportClient.h  

virtual bool IsInGameView()

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

virtual bool IsInPermanentCapture()

   ViewportClient.h  

virtual bool IsOrtho ()

 Returns true if this viewport is orthogonal. ViewportClient.h  

virtual bool IsStatEnabled ( const FString& InName
) const

 Check whether a specific stat is enabled for this viewport ViewportClient.h  

virtual bool LockDuringCapture()

 Gets whether or not the cursor is locked to the viewport when the viewport captures the mouse ViewportClient.h  

virtual void LostFocus ( FViewport* Viewport
)

   ViewportClient.h  

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

 Called to map a cursor reply to an actual widget to render. ViewportClient.h  

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

   ViewportClient.h  

virtual void MouseLeave ( FViewport* Viewport
)

   ViewportClient.h  

virtual void MouseMove ( FViewport* Viewport,
int32 X,
int32 Y
)

   ViewportClient.h  

virtual FPopupMethodReply OnQueryPopupMethod()

 Should we make new windows for popups or create an overlay in the current window. ViewportClient.h  

virtual bool OverrideHighResScreenshotCaptureRegion ( FIntRect& OutCaptureRegion
)

 Allow viewport client to override the current capture region ViewportClient.h  

virtual void Precache()

   ViewportClient.h  

virtual void ProcessAccumulatedPointerInput ( FViewport* InViewport
)

 Called from slate when input is finished for this frame, and we should process any queued mouse moves. ViewportClient.h  

virtual bool ProcessScreenShots ( FViewport* Viewport
)

   ViewportClient.h  

virtual TOptional< bool > QueryShowFocus ( const EFocusCause InFocusCause
) const

 Called to determine if we should render the focus brush. ViewportClient.h  

virtual void ReceivedFocus ( FViewport* Viewport
)

   ViewportClient.h  

virtual void RedrawRequested ( FViewport* Viewport
)

   ViewportClient.h  

virtual void RequestInvalidateHitProxy ( FViewport* Viewport
)

   ViewportClient.h  

virtual bool RequiresHitProxyStorage()

   ViewportClient.h  

virtual bool RequiresKeyboardInput()

 Determine if the viewport client is going to need any keyboard input ViewportClient.h  

virtual bool RequiresUncapturedAxisInput ()

 Determines whether this viewport client should receive calls to InputAxis() if the game's window is not currently capturing the mouse. ViewportClient.h  

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

 Sets all the stats that should be enabled for the viewport ViewportClient.h  

virtual void SetIsSimulateInEditorViewport ( bool bInIsSimulateInEditorViewport
)

   ViewportClient.h  

virtual void SetShowStats ( bool bWantStats
)

 Sets whether stats should be visible for the viewport ViewportClient.h  

virtual bool ShouldAlwaysLockMouse()

 Gets whether or not the cursor should always be locked to the viewport. ViewportClient.h  

virtual bool ShouldDPIScaleSceneCanvas()

   ViewportClient.h  

virtual bool WantsPollingMouseMovement()

   ViewportClient.h  

virtual bool WindowCloseRequested ()

 Called when the top level window associated with the viewport has been requested to close. ViewportClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page