Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
Base class used to implement viewport interactions. Has some helper functions to check if Shift, Alt, Ctrl modifier keys and Mouse Button keys are down. Tick can be used for code which needs to affect things like camera movements in Editor Viewport Client
| Name | UViewportInteraction |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ViewportInteractions/ViewportInteraction.h |
| Include Path | #include "ViewportInteractions/ViewportInteraction.h" |
Syntax
UCLASS (MinimalAPI, Transient, Abstract)
class UViewportInteraction : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UViewportInteraction
Derived Classes
UViewportInteraction derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UViewportInteraction() |
ViewportInteractions/ViewportInteraction.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| InputBehaviors | TArray< TObjectPtr< UInputBehavior > > | ViewportInteractions/ViewportInteraction.h | ||
| OnChordChangedDelegateHandle | FDelegateHandle | ViewportInteractions/ViewportInteraction.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TArray< TObjectPtr< UInputBehavior > > GetInputBehaviors() |
ViewportInteractions/ViewportInteraction.h | ||
FName GetInteractionName() |
ViewportInteractions/ViewportInteraction.h | ||
UViewportInteractionsBehaviorSource * GetViewportInteractionsBehaviorSource() |
ViewportInteractions/ViewportInteraction.h | ||
virtual void Initialize
(
UViewportInteractionsBehaviorSource*const InViewportInteractionsBehaviorSource |
Initialization code which can be expanded by derived classes | ViewportInteractions/ViewportInteraction.h | |
bool IsAltDown() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsAnyMouseButtonDown() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsCtrlDown() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsEnabled() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsLeftMouseButtonDown() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsMiddleMouseButtonDown() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsMouseLooking() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsRightMouseButtonDown() |
ViewportInteractions/ViewportInteraction.h | ||
bool IsShiftDown() |
ViewportInteractions/ViewportInteraction.h | ||
void SetEnabled
(
bool bInEnabled |
ViewportInteractions/ViewportInteraction.h | ||
virtual void Tick
(
float InDeltaTime |
ViewportInteractions/ViewportInteraction.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void BeginDestroy() |
ViewportInteractions/ViewportInteraction.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< TSharedPtr< FUICommandInfo > > GetCommands () |
Return a list of commands used by a key-based UInputBehavior. | ViewportInteractions/ViewportInteraction.h | |
FEditorViewportClient * GetEditorViewportClient() |
ViewportInteractions/ViewportInteraction.h | ||
virtual void OnCommandChordChanged() |
Define what should happen to UInputBehavior(s) when an "observed" command chord changes | ViewportInteractions/ViewportInteraction.h | |
void RegisterInputBehavior
(
UInputBehavior* InBehavior |
ViewportInteractions/ViewportInteraction.h | ||
void RegisterInputBehaviors
(
TArray< UInputBehavior* > InBehaviors |
ViewportInteractions/ViewportInteraction.h |