Navigation
API > API/Editor > API/Editor/EditorInteractiveToolsFramework
A viewport interaction that handles temporary and permanent snapping toggles
Hold: toggles the relevant snap setting while the key is held, restoring on release. Quick-press: permanently toggles the snap setting
| Name | UViewportSnapToggleInteraction |
| Type | class |
| Header File | /Engine/Source/Editor/Experimental/EditorInteractiveToolsFramework/Public/ViewportInteractions/ViewportSnapToggleInteraction.h |
| Include Path | #include "ViewportInteractions/ViewportSnapToggleInteraction.h" |
Syntax
UCLASS (MinimalAPI, Transient)
class UViewportSnapToggleInteraction :
public UViewportInteraction ,
public IQuickToggleBehaviorTarget
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UViewportInteraction → UViewportSnapToggleInteraction
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UViewportSnapToggleInteraction() |
ViewportInteractions/ViewportSnapToggleInteraction.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCachedSurfaceSnapping | bool | ViewportInteractions/ViewportSnapToggleInteraction.h | ||
| bCachedTRSSnapping | bool | ViewportInteractions/ViewportSnapToggleInteraction.h | ||
| bSurfaceKeyHeld | bool | ViewportInteractions/ViewportSnapToggleInteraction.h | ||
| bTRSKeyHeld | bool | ViewportInteractions/ViewportSnapToggleInteraction.h | ||
| QuickToggleBehaviorWeak | TWeakObjectPtr< UViewportQuickToggleInputBehavior > | ViewportInteractions/ViewportSnapToggleInteraction.h |
Functions
Public
Public Virtual
Overridden from UViewportInteraction
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Shutdown () |
Called when the interaction is removed from its behavior source. | ViewportInteractions/ViewportSnapToggleInteraction.h |
Overridden from IQuickToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnQuickToggle
(
const FKey& InKey |
ViewportInteractions/ViewportSnapToggleInteraction.h |
Overridden from IKeyInputBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnKeyPressed
(
const FKey& InKeyID |
ViewportInteractions/ViewportSnapToggleInteraction.h | ||
virtual void OnKeyReleased
(
const FKey& InKeyID |
ViewportInteractions/ViewportSnapToggleInteraction.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnForceEndCapture() |
ViewportInteractions/ViewportSnapToggleInteraction.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| ViewportInteractions/ViewportSnapToggleInteraction.h |
Protected Virtual
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/ViewportSnapToggleInteraction.h | |
virtual void OnCommandChordChanged() |
Define what should happen to UInputBehavior(s) when an "observed" command chord changes | ViewportInteractions/ViewportSnapToggleInteraction.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static bool CanTemporaryDisableSnapping() |
ViewportInteractions/ViewportSnapToggleInteraction.h | ||
static void SetSurfaceSnapping
(
bool bEnable |
ViewportInteractions/ViewportSnapToggleInteraction.h |