Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
A viewport interaction class used to add support for a list of FUICommandInfo Commands to the current viewport
| Name | UViewportCommandsInteraction |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ViewportInteractions/ViewportCommandsInteraction.h |
| Include Path | #include "ViewportInteractions/ViewportCommandsInteraction.h" |
Syntax
UCLASS (MinimalAPI)
class UViewportCommandsInteraction :
public UViewportInteraction ,
public IKeyInputBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UViewportInteraction → UViewportCommandsInteraction
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UViewportCommandsInteraction() |
ViewportInteractions/ViewportCommandsInteraction.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bExecuteOnPress | bool | Set to true to execute commands on Press instead of Release | ViewportInteractions/ViewportCommandsInteraction.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Commands | TArray< TSharedPtr< FUICommandInfo > > | ViewportInteractions/ViewportCommandsInteraction.h | ||
| EditorCommandList | TSharedPtr< FUICommandList > | ViewportInteractions/ViewportCommandsInteraction.h | ||
| KeyInputBehaviorWeak | TWeakObjectPtr< UKeyInputBehavior > | ViewportInteractions/ViewportCommandsInteraction.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void SetCommands
(
const TSharedPtr< FUICommandList >& InEditorCommandList, |
Sets which commands will be handled by this Command Interaction | ViewportInteractions/ViewportCommandsInteraction.h |
Overridden from IKeyInputBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnKeyPressed
(
const FKey& InKeyID |
~ Begin IKeyInputBehaviorTarget | ViewportInteractions/ViewportCommandsInteraction.h | |
virtual void OnKeyReleased
(
const FKey& InKeyID |
ViewportInteractions/ViewportCommandsInteraction.h |
Protected
Overridden from UViewportInteraction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< TSharedPtr< FUICommandInfo > > GetCommands () |
Return a list of commands used by a key-based UInputBehavior. | ViewportInteractions/ViewportCommandsInteraction.h | |
virtual void OnCommandChordChanged() |
~ Begin UViewportInteractionBase | ViewportInteractions/ViewportCommandsInteraction.h |