Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseBehaviors
Inheritance Hierarchy
- UObject
- UInputBehavior
- UAnyButtonInputBehavior
- UAvaSingleClickAndDragBehavior
- UBrushAdjusterInputBehavior
- UClickDragInputBehavior
- ULocalClickDragInputBehavior
- UMouseWheelInputBehavior
- UMultiClickSequenceInputBehavior
- UScalableConeGizmoInputBehavior
- UScalableSphereGizmoInputBehavior
- USingleClickInputBehavior
- UAvaInteractiveToolsRightClickBehavior
- UDoubleClickInputBehavior
- ULocalDoubleClickInputBehavior
- ULocalSingleClickInputBehavior
- USingleClickOrDragInputBehavior
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseBehaviors/AnyButtonInputBehavior.h |
| Include | #include "BaseBehaviors/AnyButtonInputBehavior.h" |
Syntax
UCLASS (MinimalAPI)
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
| Type | Name | Description | |
|---|---|---|---|
 |
EInputDevices | ActiveDevice | Which device is currently active |
 |
TUniqueFunction< FDeviceButtonState(const FInputDeviceState &Input)> | GetMouseButtonStateFunc | Returns FDeviceButtonState for target mouse button |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
EInputDevices | ||
 |
FDeviceButtonState | GetButtonStateFunc
(
const FInputDeviceState& Input |
Returns FDeviceButtonState for target active device button |
  |
FVector2D | GetClickPoint
(
const FInputDeviceState& input |
|
  |
FInputDeviceRay | GetDeviceRay
(
const FInputDeviceState& input |
|
  |
FRay | GetWorldRay
(
const FInputDeviceState& input |
|
  |
bool | IsDoubleClicked
(
const FInputDeviceState& input |
|
  |
bool | IsDown
(
const FInputDeviceState& input |
|
  |
bool | IsPressed
(
const FInputDeviceState& input |
|
  |
bool | IsReleased
(
const FInputDeviceState& input |
|
  |
void | SetUseCustomMouseButton
(
TUniqueFunction< FDeviceButtonState(const FInputDeviceState&Input)> |
Configure a custom target mouse button |
  |
void | Configure the target Mouse button to be the left button | |
  |
void | Configure the target Mouse button to be the middle button | |
  |
void | Configure the target Mouse button to be the right button |
Overridden from UInputBehavior
| Type | Name | Description | |
|---|---|---|---|
  |
EInputDevices | Return set of devices supported by this behavior |