FDragAlignmentBase | Unreal Engine 5.7 Documentation

FDragAlignmentBase is a base class for shared functionality of UDragAlignmentMechanic and UDragAlignmentInteraction. This interaction can be attached to (potentially multiple) UCombinedTransformGizmo object to allow them to snap to scene geometry in rotation and translation when a modifier key is pressed.


Name	FDragAlignmentBase
Type	class
Header File	/Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Mechanics/DragAlignmentMechanic.h
Include Path	#include "Mechanics/DragAlignmentMechanic.h"

Syntax

class FDragAlignmentBase

Name	Remarks	Include Path	Unreal Specifiers
virtual ~FDragAlignmentBase()		Mechanics/DragAlignmentMechanic.h

Name	Type	Remarks	Include Path
EDGE_HIT_TYPE_ID	const int32		Mechanics/DragAlignmentMechanic.h
TRIANGLE_HIT_TYPE_ID	const int32	Used to identify the type of object we hit, so we can choose different renderings.	Mechanics/DragAlignmentMechanic.h
VERT_HIT_TYPE_ID	const int32		Mechanics/DragAlignmentMechanic.h

Name	Remarks	Include Path
void AddToGizmo ( UCombinedTransformGizmo* TransformGizmo, const TArray< const UPrimitiveComponent* >* ComponentsToIgnore, const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude )	Adds this mechanic to the given gizmo.	Mechanics/DragAlignmentMechanic.h
void AddToGizmo ( UIntervalGizmo* IntervalGizmo, const TArray< const UPrimitiveComponent* >* ComponentsToIgnoreInAlignment, const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude )	Like the other AddToGizmo, but acts on interval gizmos.	Mechanics/DragAlignmentMechanic.h
bool GetAlignmentModeEnabled()		Mechanics/DragAlignmentMechanic.h
FViewCameraState GetCameraState()		Mechanics/DragAlignmentMechanic.h
USceneSnappingManager * GetSnappingManager()	Subclasses must implement these various API functions for the interaction to function	Mechanics/DragAlignmentMechanic.h
UObject * GetUObjectContainer()		Mechanics/DragAlignmentMechanic.h
void InitializeDeformedMeshRayCast ( TFunction< UE::Geometry::FDynamicMeshAABBTree3()> GetSpatialIn, const FTransform3d& TargetTransform, const UE::Geometry::FGroupTopologyDeformer LinearDeformer )	Optional- allows the use of the mechanic in mesh deformation.	Mechanics/DragAlignmentMechanic.h

Name	Remarks	Include Path
virtual bool CastRay ( const FRay& WorldRay, FVector& OutputPoint, const TArray< const UPrimitiveComponent* >* ComponentsToIgnore, const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude, bool bUseFilter )	Casts a ray into the scene to find an alignment point. Used in the functions bound to gizmos.	Mechanics/DragAlignmentMechanic.h
void OnGizmoTransformChanged ( FTransform NewTransform )		Mechanics/DragAlignmentMechanic.h
virtual void RenderInternal ( IToolsContextRenderAPI* RenderAPI )	This will draw a line from the last input position to the last output position.	Mechanics/DragAlignmentMechanic.h
virtual void SetupInternal()	Subclasses must call this to initialize the internal functions/states/etc	Mechanics/DragAlignmentMechanic.h