1. Epic GamesDeveloper
  3. UCommonGameViewportClient

UCommonGameViewportClient

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

API > API/Plugins > API/Plugins/CommonUI

Inheritance Hierarchy

References

   
Module CommonUI
Header /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonGameViewportClient.h
Include #include "CommonGameViewportClient.h"

Syntax

UCLASS&40;Within&61;Engine, Transient, Config&61;Engine&41;  
class UCommonGameViewportClient : public UGameViewportClient

Remarks

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

Variables

  Type Name Description
Protected variable FOnRerouteAxisDelegate RerouteAxis  
Protected variable FOnRerouteInputDelegate RerouteBlockedInput  
Protected variable FOnRerouteInputDelegate RerouteInput  
Protected variable FOnRerouteTouchDelegate RerouteTouch  

Constructors

  Type Name Description
Public function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

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

 Default Handler for Axis input.
Public function Virtual void

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

 Default Handler for Key input.
Public function Virtual void

HandleRerouteTouch ( int32 ControllerId,
uint32 TouchId,
ETouchType::Type TouchType,
const FVector2D& TouchLocation,
FReply& Reply
)

 Default Handler for Touch input.
Protected function Virtual bool Console window & fullscreen shortcut have higher priority than UI
Public function FOnRerouteAxisDelegate &  
Public function FOnRerouteInputDelegate &  
Public function FOnRerouteInputDelegate &  
Public function FOnRerouteTouchDelegate &  

Overridden from FViewportClient

  Type Name Description
Public function 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.
Public function Virtual bool

InputKey ( const FInputKeyEventArgs& EventArgs
)

 Check a key event received by the viewport.
Public function 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.

Deprecated Functions

  Type Name Description
Public function Virtual void

HandleRerouteAxis ( int32 ControllerId,
FKey Key,
float Delta,
FReply& Reply
)

 This version of HandleRerouteAxis has been deprecated. Please use the version that takes an FInputDeviceId instead
Public function Virtual void

HandleRerouteInput ( int32 ControllerId,
FKey Key,
EInputEvent EventType,
FReply& Reply
)

 This version of HandleRerouteInput has been deprecated. Please use the version that takes an FInputDeviceId instead

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page