1. Epic GamesDeveloper
  3. UInputRouter

UInputRouter

[UInputRouter](API\Runtime\InteractiveToolsFramework\UInputRouter) mediates between a higher-level input event source (eg like an [FEdMode](API\Editor\UnrealEd\FEdMode)) and a set of InputBehaviors that respond to those events.

API > API/Runtime > API/Runtime/InteractiveToolsFramework

Inheritance Hierarchy

References

   
Module InteractiveToolsFramework
Header /Engine/Source/Runtime/InteractiveToolsFramework/Public/InputRouter.h
Include #include "InputRouter.h"

Syntax

class UInputRouter : public UObject

Remarks

UInputRouter mediates between a higher-level input event source (eg like an FEdMode) and a set of InputBehaviors that respond to those events. Sets of InputBehaviors are registered, and then PostInputEvent() is called for each event.

Internally one of the active Behaviors may "capture" the event stream. Separate "Left" and "Right" captures are supported, which means that (eg) an independent capture can be tracked for each VR controller.

If the input device supports "hover", PostHoverInputEvent() will forward hover events to InputBehaviors that also support it.

Variables

  Type Name Description
Protected variable TObjectPtr< UInputBehaviorSet > ActiveInputBehaviors  
Protected variable UInputBehavior * ActiveKeyboardCapture  
Protected variable FInputCaptureData ActiveKeyboardCaptureData  
Protected variable void * ActiveKeyboardCaptureOwner  
Protected variable UInputBehavior * ActiveLeftCapture  
Protected variable FInputCaptureData ActiveLeftCaptureData  
Protected variable void * ActiveLeftCaptureOwner  
Protected variable UInputBehavior * ActiveLeftHoverCapture Hover support
Protected variable void * ActiveLeftHoverCaptureOwner  
Protected variable UInputBehavior * ActiveRightCapture  
Protected variable FInputCaptureData ActiveRightCaptureData  
Protected variable void * ActiveRightCaptureOwner  
Public variable bool bAutoInvalidateOnCapture If true, then we post an Invalidation (ie redraw) request on every captured input event (default false)
Public variable bool bAutoInvalidateOnHover If true, then we post an Invalidation (ie redraw) request if any active InputBehavior responds to Hover events (default false)
Protected variable FInputDeviceState LastMouseInputState  
Protected variable IToolsContextTransactionsAPI * TransactionsAPI  

Constructors

  Type Name Description
Protected function    

Functions

  Type Name Description
Protected function void  
Protected function void  
Public function Virtual void Remove Behaviors from this Source from the active set
Public function Virtual void Terminate any active captures and end all hovers
Public function Virtual void If this Behavior is capturing, call ForceEndCapture() to notify that we are taking capture away
Protected function void  
Protected function void  
Public function Virtual Const bool Returns true if there is an active mouse capture
Protected function Virtual void Initialize the InputRouter with the necessary Context-level state.
Public function Virtual void Insert a new hover input event which is forwarded to all hover-enabled Behaviors
Public function Virtual bool Insert a new input event which is used to check for new captures, or forwarded to active capture
Protected function Virtual void  
Protected function Virtual void  
Protected function bool  
Public function Virtual void Add a new behavior Source. Behaviors from this source will be added to the active behavior set.
Protected function Virtual void Shutdown the InputRouter.
Protected function void

TerminateHover ( EInputCaptureSide Side
)

  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page