UCommonGameViewportClient

[CommonUI](API\Plugins\CommonUI\CommonUI) Viewport to reroute input to UI first.

API > API/Plugins > API/Plugins/CommonUI

CommonUI Viewport to reroute input to UI first. Needed to allow CommonUI to route / handle inputs.

   
Name UCommonGameViewportClient
Type class
Header File /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonGameViewportClient.h
Include Path #include "CommonGameViewportClient.h"

Syntax

UCLASS (MinimalAPI, Within=Engine, Transient, Config=Engine)  
class UCommonGameViewportClient : public UGameViewportClient

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UCommonGameViewportClient ( FVTableHelper& Helper
)

   CommonGameViewportClient.h  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bUseVirtualPointerCursor bool   CommonGameViewportClient.h  
RerouteTouchDelegate FTouchRerouteDelegate   CommonGameViewportClient.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

PRAGMA_ENABLE_DEPRECATION_WARNINGS FTouchRerouteDelegate::RegistrationType & GetRerouteTouchRegistration()

   CommonGameViewportClient.h  

FOnRerouteAxisDelegate & OnRerouteAxis()

   CommonGameViewportClient.h  

FOnRerouteInputDelegate & OnRerouteBlockedInput()

   CommonGameViewportClient.h  

FOnRerouteInputDelegate & OnRerouteInput()

   CommonGameViewportClient.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnRerouteTouchInputDelegate & OnRerouteTouchInput()

   CommonGameViewportClient.h  

void SetUseVirtualPointerCursor ( bool bEnabled
)

 When true, MapCursor redirects any non-None cursor type to Custom so the virtual pointer widget is always displayed. CommonGameViewportClient.h  

Public Virtual

Name Remarks Include Path Unreal Specifiers

virtual void HandleRerouteAxis ( FInputDeviceId DeviceId,
FKey Key,
float Delta,
FReply& Reply
)

 Default Handler for Axis input. CommonGameViewportClient.h  

virtual void HandleRerouteInput ( FInputDeviceId DeviceId,
FKey Key,
EInputEvent EventType,
FReply& Reply
)

 Default Handler for Key input. CommonGameViewportClient.h  

virtual void HandleRerouteTouch ( FTouchId TouchId,
ETouchType::Type TouchType,
const FVector2D& TouchLocation,
FReply& Reply
)

 Default Handler for Touch input. CommonGameViewportClient.h  

virtual void HandleRerouteTouch ( FInputDeviceId DeviceId,
uint32 TouchId,
ETouchType::Type TouchType,
const FVector2D& TouchLocation,
FReply& Reply
)

   CommonGameViewportClient.h  

Overridden from FViewportClient

Name Remarks Include Path Unreal Specifiers

virtual void CapturedMouseMove ( FViewport* InViewport,
int32 X,
int32 Y
)

   CommonGameViewportClient.h  

virtual bool InputAxis ( const FInputKeyEventArgs& Args
)

   CommonGameViewportClient.h  

virtual bool InputKey ( const FInputKeyEventArgs& EventArgs
)

   CommonGameViewportClient.h  

virtual bool InputTouch ( FViewport*const InViewport,
const FTouchId TouchId,
const ETouchType::Type Type,
const FVector2D& TouchLocation,
const float Force,
const uint64 Timestamp
)

   CommonGameViewportClient.h  

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

   CommonGameViewportClient.h  

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

   CommonGameViewportClient.h  

Protected

Name Remarks Include Path Unreal Specifiers

FTouchRerouteDelegate & GetRerouteTouchDelegate()

   CommonGameViewportClient.h  

Protected Virtual

Name Remarks Include Path Unreal Specifiers

virtual bool IsKeyPriorityAboveUI ( const FInputKeyEventArgs& EventArgs
)

 Console window & fullscreen shortcut have higher priority than UI CommonGameViewportClient.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page