1. Epic GamesDeveloper
  3. FDragAlignmentBase

FDragAlignmentBase

[FDragAlignmentBase](API\Plugins\ModelingComponents\Mechanics\FDragAlignmentBase) is a base class for shared functionality of [UDragAlignmentMechanic](API\Plugins\ModelingComponents\Mechanics\UDragAlignmentMechanic) and [UDragAlignmentInteraction](API\Plugins\ModelingComponents\Mechanics\UDragAlignmentInteraction).

API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/Mechanics

Inheritance Hierarchy

References

   
Module ModelingComponents
Header /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/Mechanics/DragAlignmentMechanic.h
Include #include "Mechanics/DragAlignmentMechanic.h"

Syntax

class FDragAlignmentBase

Remarks

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.

Variables

  Type Name Description
Protected variable bool bPreviewEndpointsValid We keep track of the last position we gave the user and the last position that they moved their gizmo.
Protected variable bool bWaitingOnProjectedResult  
Protected variable FViewCameraState CachedCameraState Used for snapping to verts.
Protected variable FHitResult LastHitResult  
Protected variable FVector3d LastProjectedResult  
Protected variable TUniqueFunction< bool(const FRay &, FHitResult &, bool bUseFilter)> MeshRayCast  
Protected variable TUniqueFunction< bool(int32 Tid)> MeshRayCastTriangleFilter  
Protected variable float VisualAngleSnapThreshold  
Protected variable TUniqueFunction< bool(const FRay &InputRay, FHitResult &OutputHit, const TArray< const UPrimitiveCom... WorldRayCast These are modifiable in case we someday want to make it easier to customize them further.

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function void

AddToGizmo ( UCombinedTransformGizmo* TransformGizmo,
const TArray< const UPrimitiveComponent* >* ComponentsToIgnore,
const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude
)

 Adds this mechanic to the given gizmo.
Public function void

AddToGizmo ( UIntervalGizmo* IntervalGizmo,
const TArray< const UPrimitiveComponent* >* ComponentsToIgnoreInAlignment,
const TArray< const UPrimitiveComponent* >* InvisibleComponentsToInclude
)

 Like the other AddToGizmo, but acts on interval gizmos.
Protected function 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.
Public function Const bool  
Public function FViewCameraState  
Public function USceneSnappingManager * Subclasses must implement these various API functions for the interaction to function
Public function UObject *  
Public function 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.
Protected function void

OnGizmoTransformChanged ( FTransform NewTransform
)

  
Protected function Virtual void This will draw a line from the last input position to the last output position.
Protected function Virtual void Subclasses must call this to initialize the internal functions/states/etc

Constants

Name Description
EDGE_HIT_TYPE_ID  
TRIANGLE_HIT_TYPE_ID Used to identify the type of object we hit, so we can choose different renderings.
VERT_HIT_TYPE_ID  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page