Class WidgetInteractionComponent

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

Inheritance
System.Object
UObject
ActorComponent
SceneComponent
WidgetInteractionComponent
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: UE4.UMG
Assembly: UE4DotNet.dll
Syntax
public class WidgetInteractionComponent : SceneComponent
Remarks

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.

Properties

| Improve this Doc View Source

ArrowComponent

The arrow component we show at editor time.

Declaration
public ArrowComponent ArrowComponent { get; set; }
Property Value
Type Description
ArrowComponent
| Improve this Doc View Source

bEnableHitTesting

Declaration
public bool bEnableHitTesting { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsHoveredWidgetFocusable

Declaration
public bool bIsHoveredWidgetFocusable { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsHoveredWidgetHitTestVisible

Declaration
public bool bIsHoveredWidgetHitTestVisible { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bIsHoveredWidgetInteractable

Declaration
public bool bIsHoveredWidgetInteractable { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

bShowDebug

Declaration
public bool bShowDebug { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

CustomHitResult

Stores the custom hit result set by the player.

Declaration
public HitResult CustomHitResult { get; set; }
Property Value
Type Description
HitResult
| Improve this Doc View Source

DebugColor

Determines the color of the debug lines.

Declaration
public LinearColor DebugColor { get; set; }
Property Value
Type Description
LinearColor
| Improve this Doc View Source

DefaultObject

Get UE4 Default Object for this Class

Declaration
public static WidgetInteractionComponent DefaultObject { get; }
Property Value
Type Description
WidgetInteractionComponent
| Improve this Doc View Source

HoveredWidgetComponent

The widget component we're currently hovering over.

Declaration
public WidgetComponent HoveredWidgetComponent { get; set; }
Property Value
Type Description
WidgetComponent
| Improve this Doc View Source

InteractionDistance

The distance in game units the component should be able to interact with a widget component.

Declaration
public float InteractionDistance { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

LastHitResult

The last hit result we used.

Declaration
public HitResult LastHitResult { get; set; }
Property Value
Type Description
HitResult
| Improve this Doc View Source

LastLocalHitLocation

The last 2D location on the widget component that was hit.

Declaration
public Vector2D LastLocalHitLocation { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

LocalHitLocation

The 2D location on the widget component that was hit.

Declaration
public Vector2D LocalHitLocation { get; set; }
Property Value
Type Description
Vector2D
| Improve this Doc View Source

PointerIndex

Each user virtual controller or virtual finger tips being simulated should use a different pointer index.

Declaration
public float PointerIndex { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

StaticClass

Get UE4 Class

Declaration
public static Class StaticClass { get; }
Property Value
Type Description
Class
| Improve this Doc View Source

TraceChannel

The trace channel to use when tracing for widget components in the world.

Declaration
public byte TraceChannel { get; set; }
Property Value
Type Description
System.Byte
| Improve this Doc View Source

VirtualUserIndex

Represents the Virtual User Index.

Declaration
public int VirtualUserIndex { get; set; }
Property Value
Type Description
System.Int32
Remarks

Each virtual user should be represented by a different index number, this will maintain separate capture and focus states for them. Each controller or finger-tip should get a unique PointerIndex.

Methods

| Improve this Doc View Source

Get2DHitLocation()

Gets the last hit location on the widget in 2D, local pixel units of the render target.

Declaration
public Vector2D Get2DHitLocation()
Returns
Type Description
Vector2D
| Improve this Doc View Source

GetHoveredWidgetComponent()

Get the currently hovered widget component.

Declaration
public WidgetComponent GetHoveredWidgetComponent()
Returns
Type Description
WidgetComponent
| Improve this Doc View Source

GetLastHitResult(HitResult)

Gets the last hit result generated by the component. Returns the custom hit result if that was set.

Declaration
public void GetLastHitResult(HitResult ReturnValue)
Parameters
Type Name Description
HitResult ReturnValue
| Improve this Doc View Source

IsOverFocusableWidget()

Returns true if a widget under the hit result is focusable.

Declaration
public bool IsOverFocusableWidget()
Returns
Type Description
System.Boolean
Remarks

e.g. Slate widgets that return true for SupportsKeyboardFocus().

| Improve this Doc View Source

IsOverHitTestVisibleWidget()

Returns true if a widget under the hit result is has a visibility that makes it hit test visible.

Declaration
public bool IsOverHitTestVisibleWidget()
Returns
Type Description
System.Boolean
Remarks

e.g. Slate widgets that return true for GetVisibility().IsHitTestVisible().

| Improve this Doc View Source

IsOverInteractableWidget()

Returns true if a widget under the hit result is interactive.

Declaration
public bool IsOverInteractableWidget()
Returns
Type Description
System.Boolean
Remarks

e.g. Slate widgets that return true for IsInteractable().

| Improve this Doc View Source

New(UObject, Name)

Spawn an object of this class

Declaration
public static WidgetInteractionComponent New(UObject obj = null, Name name = default(Name))
Parameters
Type Name Description
UObject obj
Name name
Returns
Type Description
WidgetInteractionComponent
| Improve this Doc View Source

PressAndReleaseKey(Key)

Does both the press and release of a simulated keyboard key.

Declaration
public bool PressAndReleaseKey(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

PressKey(Key, Boolean)

Press a key as if it had come from the keyboard.

Declaration
public bool PressKey(Key Key, bool bRepeat)
Parameters
Type Name Description
Key Key
System.Boolean bRepeat
Returns
Type Description
System.Boolean
Remarks

Avoid using this for 'a-z|A-Z', things like the Editable Textbox in Slate expect OnKeyChar to be called to signal a specific character being send to the widget. So for those cases you should use SendKeyChar.

| Improve this Doc View Source

PressPointerKey(Key)

Presses a key as if the mouse/pointer were the source of it.

Declaration
public void PressPointerKey(Key Key)
Parameters
Type Name Description
Key Key
Remarks

Normally you would just use Left/Right mouse button for the Key. However - advanced uses could also be imagined where you send other keys to signal widgets to take special actions if they're under the cursor.

| Improve this Doc View Source

ReleaseKey(Key)

Releases a key as if it had been released by the keyboard.

Declaration
public bool ReleaseKey(Key Key)
Parameters
Type Name Description
Key Key
Returns
Type Description
System.Boolean
| Improve this Doc View Source

ReleasePointerKey(Key)

Releases a key as if the mouse/pointer were the source of it.

Declaration
public void ReleasePointerKey(Key Key)
Parameters
Type Name Description
Key Key
Remarks

Normally you would just use Left/Right mouse button for the Key. However - advanced uses could also be imagined where you send other keys to signal widgets to take special actions if they're under the cursor.

| Improve this Doc View Source

ScrollWheel(Single)

Sends a scroll wheel event to the widget under the last hit result.

Declaration
public void ScrollWheel(float ScrollDelta)
Parameters
Type Name Description
System.Single ScrollDelta
| Improve this Doc View Source

SendKeyChar(String, Boolean)

Transmits a list of characters to a widget by simulating a OnKeyChar event for each key listed in the string.

Declaration
public bool SendKeyChar(string Characters, bool bRepeat)
Parameters
Type Name Description
System.String Characters
System.Boolean bRepeat
Returns
Type Description
System.Boolean
| Improve this Doc View Source

SetCustomHitResult(HitResult)

Set custom hit result. This is only taken into account if InteractionSource is set to EWidgetInteractionSource::Custom.

Declaration
public void SetCustomHitResult(HitResult HitResult)
Parameters
Type Name Description
HitResult HitResult

Operators

| Improve this Doc View Source

Implicit(IntPtr to WidgetInteractionComponent)

Convert from IntPtr to UObject

Declaration
public static implicit operator WidgetInteractionComponent(IntPtr p)
Parameters
Type Name Description
System.IntPtr p
Returns
Type Description
WidgetInteractionComponent