Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
Provides click-on-up interactions with binding-complexity-based priority compatible with FViewportClick.
| Name | UViewportClickInteraction |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ViewportInteractions/ViewportClickInteraction.h |
| Include Path | #include "ViewportInteractions/ViewportClickInteraction.h" |
Syntax
UCLASS (MinimalAPI, Abstract)
class UViewportClickInteraction :
public UViewportInteraction ,
public IViewportClickBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UViewportInteraction → UViewportClickInteraction
Implements Interfaces
Derived Classes
Functions
Public Virtual
Overridden from UViewportInteraction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Initialize
(
UViewportInteractionsBehaviorSource*const InViewportInteractionsBehaviorSource |
Initialization code which can be expanded by derived classes | ViewportInteractions/ViewportClickInteraction.h |
Overridden from IViewportClickBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FInputRayHit IsHitByClick
(
const FInputDeviceRay& InClickPos |
~Begin IViewportClickBehaviorTarget | ViewportInteractions/ViewportClickInteraction.h | |
virtual void OnClickDown
(
const FInputDeviceRay& InClickPos |
Notify the target that the click has started | ViewportInteractions/ViewportClickInteraction.h | |
virtual void OnClickUp
(
const FInputDeviceRay& InClickPos |
Notify the target that the click has completed | ViewportInteractions/ViewportClickInteraction.h | |
virtual void OnForceEndCapture() |
Notify Target that capture is ending | ViewportInteractions/ViewportClickInteraction.h | |
virtual void OnStateUpdated
(
const FInputDeviceState& InInputDeviceState |
Notify Target button state has changed | ViewportInteractions/ViewportClickInteraction.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
HHitProxy * GetHitProxy
(
const FInputDeviceRay& InClickPos |
ViewportInteractions/ViewportClickInteraction.h |
Protected Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BuildBehaviors() |
ViewportInteractions/ViewportClickInteraction.h | ||
virtual void ProcessClick_Internal
(
const FViewportClick& InViewportClick, |
Override this function to provide custom functionality | ViewportInteractions/ViewportClickInteraction.h |