Navigation
API > API/Plugins > API/Plugins/ModelingComponents
Interaction that can be added to (potentially multiple) UCombinedTransformGizmo object to allow them to snap to scene geometry in rotation and translation. Generally driven by an externally-provided UKeyAsModifierInputBehavior, or alternately can be directly updated by calling OnUpdateModifierState()
| Name | UDragAlignmentInteraction |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Mechanics/DragAlignmentMechanic.h |
| Include Path | #include "Mechanics/DragAlignmentMechanic.h" |
Syntax
UCLASS (MinimalAPI)
class UDragAlignmentInteraction :
public UObject ,
public FDragAlignmentBase ,
public IModifierToggleBehaviorTarget
Inheritance Hierarchy
- FDragAlignmentBase → UDragAlignmentInteraction
- UObjectBase → UObjectBaseUtility → UObject → UDragAlignmentInteraction
Implements Interfaces
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void RegisterAsBehaviorTarget
(
UKeyAsModifierInputBehavior* KeyModifierBehavior |
Client can call this on setup to connect the interaction to an external Key behavior. | Mechanics/DragAlignmentMechanic.h | |
virtual void Render
(
IToolsContextRenderAPI* RenderAPI |
Client must call this every frame to do alignment visualization rendering. | Mechanics/DragAlignmentMechanic.h | |
virtual void Setup
(
USceneSnappingManager* SnappingManager |
Mechanics/DragAlignmentMechanic.h |
Overridden from FDragAlignmentBase
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool GetAlignmentModeEnabled() |
Mechanics/DragAlignmentMechanic.h | ||
virtual FViewCameraState GetCameraState() |
Mechanics/DragAlignmentMechanic.h | ||
virtual USceneSnappingManager * GetSnappingManager() |
Subclasses must implement these various API functions for the interaction to function | Mechanics/DragAlignmentMechanic.h | |
virtual UObject * GetUObjectContainer() |
Mechanics/DragAlignmentMechanic.h |
Overridden from IModifierToggleBehaviorTarget
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnUpdateModifierState
(
int ModifierID, |
IModifierToggleBehaviorTarget implementation. | Mechanics/DragAlignmentMechanic.h |