1. Epic GamesDeveloper
  3. USpaceCurveDeformationMechanic

USpaceCurveDeformationMechanic

Unreal Engine C++ API Reference > Plugins > ModelingComponents > Mechanics

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class USpaceCurveDeformationMechanic :  
    public UInteractionMechanic,  
    public IClickBehaviorTarget,  
    public IHoverBehaviorTarget

Variables

  Type Name Description
Protected variable bool bAddToSelectionToggle Support for Shift and Ctrl toggles.
Protected variable bool bGizmoBeingDragged Used to make it easy to tell whether the gizmo was moved by the user or by undo/redo or some other change that we shoulnd't respond to.
Protected variable bool bRenderGeometryValid  
Protected variable bool bSpatialValid  
Protected variable FViewCameraState CameraState Support for hovering.
Public variable UProperty TObjectPtr< USingleClickInputBehavior > ClickBehavior Behaviors used for moving points around and hovering them.
Protected variable int32 CtrlModifierId  
Protected variable int32 CurrentChangeStamp Used for expiring undo/redo changes, which compare this to their stored value and expire themselves if they do not match.
Protected variable FColor CurrentPointsColor  
Protected variable FColor CurrentSegmentsColor  
Protected variable TArray< UE::Geometry::FFrame3d > CurvePoints  
Protected variable TSharedPtr< FSpaceCurveSource > CurveSource  
Protected variable TArray< UE::Geometry::FFrame3d > CurveStartPositions We need the selected point start positions so we can move multiple points appropriately.
Protected variable float DepthBias  
Protected variable TSharedPtr< FSpaceCurveSource > EmptyCurveSource  
Protected variable UE::Geometry::FGeometrySet3 GeometrySet Used for spatial queries.
Protected variable TFunction< bool(const FVector3d &, const FVector3d &)> GeometrySetToleranceTest  
Protected variable UE::Geometry::FFrame3d GizmoStartPosition The starting point of the gizmo is needed to determine the offset by which to move the points.
Public variable UProperty TObjectPtr< UMouseHoverBehavior > HoverBehavior  
Protected variable FColor HoverColor  
Protected variable int32 HoveredPointID  
Protected variable FColor NormalCurveColor Variables for drawing.
Public variable OnPointsChangedEvent OnPointsChanged  
Protected variable float PointsSize  
Protected variable UProperty TObjectPtr< UCombinedTransformGizmo > PointTransformGizmo  
Protected variable UProperty TObjectPtr< UTransformProxy > PointTransformProxy Support for gizmo.
Protected variable FColor PreviewColor  
Protected variable UProperty TObjectPtr< APreviewGeometryActor > PreviewGeometryActor Used for displaying points/segments
Protected variable UProperty TObjectPtr< UPointSetComponent > RenderPoints  
Protected variable UProperty TObjectPtr< ULineSetComponent > RenderSegments  
Protected variable float SegmentsThickness  
Protected variable FColor SelectedColor  
Protected variable TArray< int32 > SelectedPointIDs Support for selection.
Protected variable int32 ShiftModifierId  
Public variable UProperty TObjectPtr< USpaceCurveDeformationMechanicPropertySet > TransformProperties  

Destructors

  Type Name Description
Public function Virtual   Some other standard functions.

Functions

  Type Name Description
Protected function void

ChangeSelection ( int32 NewPointID,
bool AddToSelection
)

 These issue undo/redo change objects, and must therefore not be called in undo/redo code.
Public function void  
Protected function void  
Public function void  
Protected function bool

DeselectPoint ( int32 PointID
)

  
Public function void  
Protected function void

GizmoTransformChanged ( UTransformProxy* Proxy,
FTransform Transform
)

 Callbacks we'll receive from the gizmo proxy.
Protected function void  
Protected function void  
Protected function bool

HitTest ( const FInputDeviceRay& ClickPos,
FInputRayHit& ResultOut
)

 All of the following do not issue undo/redo change objects.
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Public function void  
Protected function void

SelectPoint ( int32 PointID
)

  
Public function void  
Public function void

SetWorld ( UWorld* World
)

  
Protected function void

UpdateCurve ( const TArray< UE::Geometry::FFrame3d >& NewPositions
)

  
Protected function void  
Protected function void  
Protected function void

UpdateSelection ( const TArray< int32 >& NewSelection
)

  
Protected function void  

Overridden from UInteractionMechanic

  Type Name Description
Public function Virtual void Allow the Mechanic to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ( UInteractiveTool* ParentTool
)

 Called to initialize the InteractionMechanic
Public function Virtual void Called to clean up the InteractionMechanic
Public function Virtual void

Tick ( float DeltaTime
)

 ALlow the Mechanic to Tick

Overridden from IClickBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit

IsHitByClick ( const FInputDeviceRay& ClickPos
)

 IClickBehaviorTarget implementation.
Public function Virtual void

OnClicked ( const FInputDeviceRay& ClickPos
)

 Notify Target that click ocurred

Overridden from IModifierToggleBehaviorTarget

  Type Name Description
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 IModifierToggleBehaviorTarget implementation, inherited through IClickBehaviorTarget.

Overridden from IHoverBehaviorTarget

  Type Name Description
Public function Virtual FInputRayHit IHoverBehaviorTarget implementation.
Public function Virtual void

OnBeginHover ( const FInputDeviceRay& DevicePos
)

 Initialize hover sequence at given position
Public function Virtual void Terminate active hover sequence
Public function Virtual bool

OnUpdateHover ( const FInputDeviceRay& DevicePos
)

 Update active hover sequence with new input position

Typedefs

Name Description
OnPointsChangedEvent This delegate is called every time the control point sequence is altered.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page
Back to top
Games
Marketplaces
Tools
Online Services
Resources
Company

© 2004-2025, Epic Games, Inc. All rights reserved. Unreal and its logo are Epic’s trademarks or registered trademarks in the US and elsewhere.