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