Navigation
API > API/Runtime > API/Runtime/InteractiveToolsFramework > API/Runtime/InteractiveToolsFramework/BaseGizmos
Inheritance Hierarchy
- UObject
- IInputBehaviorSource
- UInteractiveGizmo
- USimpleSingleClickGizmo
References
| Module | InteractiveToolsFramework |
| Header | /Engine/Source/Runtime/InteractiveToolsFramework/Public/BaseGizmos/SimpleSingleClickGizmo.h |
| Include | #include "BaseGizmos/SimpleSingleClickGizmo.h" |
Syntax
UCLASS (MinimalAPI)
class USimpleSingleClickGizmo :
public UInteractiveGizmo ,
public IClickBehaviorTarget ,
public IHoverBehaviorTarget
Remarks
Simple gizmo that triggers an OnClicked callback when it is clicked.
Variables
| Type | Name | Description | |
|---|---|---|---|
  |
TObjectPtr< USingleClickInputBehavior > | ClickBehavior | The mouse click behavior of the gizmo is accessible so that it can be modified to use different mouse keys. |
  |
TScriptInterface< IGizmoClickTarget > | HitTarget | The HitTarget provides a hit-test against some 3D element (presumably a visual widget) that controls when interaction can start |
 |
FOnClick | OnClick |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
bool | InitializeWithComponent
(
UPrimitiveComponent* ComponentIn |
Overridden from UInteractiveGizmo
| Type | Name | Description | |
|---|---|---|---|
  |
void | Setup () |
UInteractiveGizmo. |
Overridden from IClickBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
FInputRayHit | IsHitByClick
(
const FInputDeviceRay& ClickPos |
IClickBehaviorTarget. |
  |
void | OnClicked
(
const FInputDeviceRay& ClickPos |
Notify Target that click ocurred |
Overridden from IHoverBehaviorTarget
| Type | Name | Description | |
|---|---|---|---|
  |
FInputRayHit | BeginHoverSequenceHitTest
(
const FInputDeviceRay& PressPos |
IHoverBehaviorTarget. |
  |
void | OnBeginHover
(
const FInputDeviceRay& DevicePos |
Initialize hover sequence at given position |
  |
void | OnEndHover () |
Terminate active hover sequence |
  |
bool | OnUpdateHover
(
const FInputDeviceRay& DevicePos |
Update active hover sequence with new input position |
Typedefs
| Name | Description |
|---|---|
| FOnClick |