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

  • UGameViewportClient
  • UCommonGameViewportClient

References

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

Syntax

UCLASS (Within=Engine, Transient, Config=Engine)  
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  

UCommonGameViewportClient ( FVTableHelper& Helper
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual void

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

  
Public function Virtual void

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

 Default Handler for Axis input.
Public function Virtual void

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

 Default Handler for Axis input.
Public function Virtual void

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

 Default Handler for Key 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.
Public function Virtual bool

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

  
Public function Virtual bool

InputKey ( const FInputKeyEventArgs& EventArgs
)

  
Public function Virtual bool

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

  
Protected function Virtual bool

IsKeyPriorityAboveUI ( const FInputKeyEventArgs& EventArgs
)

 Console window & fullscreen shortcut have higher priority than UI
Public function Virtual void

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

  
Public function FOnRerouteAxisDelegate &  
Public function FOnRerouteInputDelegate &  
Public function FOnRerouteInputDelegate &  
Public function FOnRerouteTouchDelegate &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page