1. Epic GamesDeveloper
  3. UWidgetInteractionComponent

UWidgetInteractionComponent

This is a component to allow interaction with the Widget Component.

Unreal Engine C++ API Reference > Runtime > UMG > Components

Inheritance Hierarchy

  • USceneComponent
  • UWidgetInteractionComponent

References

   
Module UMG
Header /Engine/Source/Runtime/UMG/Public/Components/WidgetInteractionComponent.h
Include #include "Components/WidgetInteractionComponent.h"

Syntax

UCLASS (ClassGroup="UserInterface", Meta=(BlueprintSpawnableComponent), MinimalAPI)  
class UWidgetInteractionComponent : public USceneComponent

Remarks

This is a component to allow interaction with the Widget Component. This class allows you to simulate a sort of laser pointer device, when it hovers over widgets it will send the basic signals to show as if the mouse were moving on top of it. You'll then tell the component to simulate key presses, like Left Mouse, down and up, to simulate a mouse click.

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bEnableHitTesting Should the interaction component perform hit testing (Automatic or Custom) and attempt to simulate hover - if you were going to emulate a keyboard you would want to turn this option off if the virtual keyboard was separate from the virtual pointer device and used a second interaction component.
Protected variable UProperty Transient bool bIsHoveredWidgetFocusable Are we hovering over any focusable widget?
Protected variable UProperty Transient bool bIsHoveredWidgetHitTestVisible Are we hovered over a widget that is hit test visible?
Protected variable UProperty Transient bool bIsHoveredWidgetInteractable Are we hovering over any interactive widgets.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bShowDebug Shows some debugging lines and a hit sphere to help you debug interactions.
Protected variable UProperty Transient FHitResult CustomHitResult Stores the custom hit result set by the player.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay BlueprintReadWrite FLinearColor DebugColor Determines the color of the debug lines.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float DebugLineThickness Determines the thickness of the debug lines.
Public variable UProperty Category, EditAnywhere, AdvancedDisplay, Meta BlueprintReadWrite float DebugSphereLineThickness Determines the line thickness of the debug sphere.
Protected variable UProperty Transient TObjectPtr< UWidgetComponent > HoveredWidgetComponent The widget component we're currently hovering over.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite float InteractionDistance The distance in game units the component should be able to interact with a widget component.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite EWidgetInteractionSource InteractionSource Should we project from the world location of the component? If you set this to false, you'll need to call SetCustomHitResult(), and provide the result of a custom hit test form whatever location you wish.
Protected variable UProperty Transient FHitResult LastHitResult The last hit result we used.
Protected variable UProperty Transient FVector2D LastLocalHitLocation The last 2D location on the widget component that was hit.
Protected variable FWeakWidgetPath LastWidgetPath The last widget path under the hit result.
Protected variable UProperty Transient FVector2D LocalHitLocation The 2D location on the widget component that was hit.
Protected variable FModifierKeysState ModifierKeys The modifier keys to simulate during key presses.
Public variable UProperty Category BlueprintAssignable FOnHoveredWidgetChanged OnHoveredWidgetChanged Called when the hovered Widget Component changes.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 PointerIndex Each user virtual controller or virtual finger tips being simulated should use a different pointer index.
Protected variable TSet< FKey > PressedKeys The current set of pressed keys we maintain the state of.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TEnumAsByte< ECollisionChannel > TraceChannel The trace channel to use when tracing for widget components in the world.
Protected variable TSharedPtr< FSlateVirtualUserHandle > VirtualUser Represents the virtual user in slate.
Public variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite int32 VirtualUserIndex Represents the Virtual User Index.

Constructors

  Type Name Description
Public function  

UWidgetInteractionComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Virtual void

Activate ( bool bReset
)

  
Protected function Const bool Returns true if the inteaction component can interact with the supplied widget component
Protected function bool Is it safe for this interaction component to run? Might not be in a server situation with no slate application.
Public function Virtual void  
Protected function Virtual Const FWidgetPath

FindHoveredWidgetPath ( const FWidgetTraceResult& TraceResult
)

 Gets the WidgetPath for the widget being hovered over based on the hit result.
Public function Const UFunction BlueprintCallable, Category FVector2D Gets the last hit location on the widget in 2D, local pixel units of the render target.
Public function Const UFunction BlueprintCallable, Category UWidgetComponent * Get the currently hovered widget component.
Public function Const const FWeakWidgetPath & Gets the widget path for the slate widgets under the last hit result.
Protected function void

GetKeyAndCharCodes ( const FKey& Key,
bool& bHasKeyCode,
uint32& KeyCode,
bool& bHasCharCode,
uint32& CharCode
)

 Gets the key and char codes for sending keys for the platform.
Public function Const UFunction BlueprintCallable, Category const FHitResult & Gets the last hit result generated by the component. Returns the custom hit result if that was set.
Protected function Const void

GetRelatedComponentsToIgnoreInAutomaticHitTesting ( TArray< UPrimitiveComponent* >& IgnorePrimitives
)

 Gets the list of components to ignore during hit testing.
Public function Const UFunction BlueprintCallable, Category bool Returns true if a widget under the hit result is focusable.
Public function Const UFunction BlueprintCallable, Category bool Returns true if a widget under the hit result is has a visibility that makes it hit test visible.
Public function Const UFunction BlueprintCallable, Category bool Returns true if a widget under the hit result is interactive.
Public function Virtual void  
Protected function Virtual Const FWidgetTraceResult Performs the trace and gets the hit result under the specified InteractionSource
Public function Virtual UFunction BlueprintCallable, Category bool

PressAndReleaseKey ( FKey Key
)

 Does both the press and release of a simulated keyboard key.
Public function Virtual UFunction BlueprintCallable, Category bool

PressKey ( FKey Key,
bool bRepeat
)

 Press a key as if it had come from the keyboard.
Public function Virtual UFunction BlueprintCallable, Category void

PressPointerKey ( FKey Key
)

 Presses a key as if the mouse/pointer were the source of it.
Public function Virtual UFunction BlueprintCallable, Category bool

ReleaseKey ( FKey Key
)

 Releases a key as if it had been released by the keyboard.
Public function Virtual UFunction BlueprintCallable, Category void

ReleasePointerKey ( FKey Key
)

 Releases a key as if the mouse/pointer were the source of it.
Public function Virtual UFunction BlueprintCallable, Category void

ScrollWheel ( float ScrollDelta
)

 Sends a scroll wheel event to the widget under the last hit result.
Public function Virtual UFunction BlueprintCallable, Category bool

SendKeyChar ( FString Characters,
bool bRepeat
)

 Transmits a list of characters to a widget by simulating a OnKeyChar event for each key listed in the string.
Public function UFunction BlueprintCallable, Category void

SetCustomHitResult ( const FHitResult& HitResult
)

 Set custom hit result.
Public function UFunction BlueprintCallable, Category void

SetFocus ( UWidget* FocusWidget
)

 Set the focus target of the virtual user managed by this component
Protected function void Performs the simulation of pointer movement. Does not run if bEnableHitTesting is set to false.
Public function Virtual void

TickComponent ( float DeltaTime,
enum ELevelTick TickType,
FActorComponentTickFunction* ThisTickFunction
)

  

Classes

  Type Name Description
Protected struct FWidgetTraceResult    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page