UAnyButtonInputBehavior

[UAnyButtonInputBehavior](API\Runtime\InteractiveToolsFramework\BaseBehaviors\UAnyButtonInputBehavior) is a base behavior that provides a generic interface to a TargetButton on a physical Input Device.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/BaseBehaviors/AnyButtonInputBehavior.h

Include

#include "BaseBehaviors/AnyButtonInputBehavior.h"

Syntax

class UAnyButtonInputBehavior : public UInputBehavior

Remarks

UAnyButtonInputBehavior is a base behavior that provides a generic interface to a TargetButton on a physical Input Device. You can subclass UAnyButtonInputBehavior to write InputBehaviors that can work independent of a particular device type or button, by using the UAnyButtonInputBehavior functions below.

The target device button is selected using the .ButtonNumber property, or you can override the relevant GetXButtonState() function if you need more control.

Variables

Name Description

Protected variable

EInputDevices

 

ActiveDevice

Which device is currently active

Protected variable

TUniqueFunction...

 

GetMouseButtonStateFunc

Returns FDeviceButtonState for target mouse button

Constructors

Name Description

Public function

UAnyButtonInputBehavior()

Functions

Name Description

Public function Const

EInputDevice...

 

GetActiveDevice()

Protected function

FDeviceButto...

 

GetButtonStateFunc

(
    const FInputDeviceState& Input
)

Returns FDeviceButtonState for target active device button

Public function Virtual

FVector2D

 

GetClickPoint

(
    const FInputDeviceState& input
)

Public function Virtual

FInputDevice...

 

GetDeviceRay

(
    const FInputDeviceState& input
)

Public function Virtual

FRay

 

GetWorldRay

(
    const FInputDeviceState& input
)

Public function Virtual

bool

 

IsDown

(
    const FInputDeviceState& input
)

Public function Virtual

bool

 

IsPressed

(
    const FInputDeviceState& input
)

Public function Virtual

bool

 

IsReleased

(
    const FInputDeviceState& input
)

Public function Virtual

void

 

SetUseCustomMouseButton

Configure a custom target mouse button

Public function Virtual

void

 

SetUseLeftMouseButton()

Configure the target Mouse button to be the left button

Public function Virtual

void

 

SetUseMiddleMouseButton()

Configure the target Mouse button to be the middle button

Public function Virtual

void

 

SetUseRightMouseButton()

Configure the target Mouse button to be the right button

Overridden from UInputBehavior

Name Description

Public function Virtual

EInputDevice...

 

GetSupportedDevices()

Return set of devices supported by this behavior

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss