Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Plugins > ModelingComponents > Mechanics > USpaceCurveDeformationMechanic

Light Theme

Dark Theme

USpaceCurveDeformationMechanic

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractionMechanic

USpaceCurveDeformationMechanic

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class USpaceCurveDeformationMechanic :
    public UInteractionMechanic,
    public IClickBehaviorTarget,
    public IHoverBehaviorTarget

Variables

	Name	Description
bool	bAddToSelectionToggle	Support for Shift and Ctrl toggles.
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.
bool	bRenderGeometryValid
bool	bSpatialValid
FViewCameraStat...	CameraState	Support for hovering.
USingleClickInp...	ClickBehavior	Behaviors used for moving points around and hovering them.
int32	CtrlModifierId
int32	CurrentChangeStamp	Used for expiring undo/redo changes, which compare this to their stored value and expire themselves if they do not match.
FColor	CurrentPointsColor
FColor	CurrentSegmentsColor
TArray< FFrame3...	CurvePoints
TSharedPtr< FSp...	CurveSource
TArray< FFrame3...	CurveStartPositions	We need the selected point start positions so we can move multiple points appropriately.
float	DepthBias
TSharedPtr< FSp...	EmptyCurveSource
FGeometrySet3	GeometrySet	Used for spatial queries.
TFunction< bool...	GeometrySetToleranceTest
FFrame3d	GizmoStartPosition	The starting point of the gizmo is needed to determine the offset by which to move the points.
UMouseHoverBeha...	HoverBehavior
FColor	HoverColor
int32	HoveredPointID
FColor	NormalCurveColor	Variables for drawing.
OnPointsChanged...	OnPointsChanged
float	PointsSize
UTransformGizmo...	PointTransformGizmo
UTransformProxy...	PointTransformProxy	Support for gizmo.
FColor	PreviewColor
APreviewGeometr...	PreviewGeometryActor	Used for displaying points/segments
UPointSetCompon...	RenderPoints
ULineSetCompone...	RenderSegments
float	SegmentsThickness
FColor	SelectedColor
TArray< int32 >	SelectedPointIDs	Support for selection.
int32	ShiftModifierId
USpaceCurveDefo...	TransformProperties

Destructors

	Name	Description
	~USpaceCurveDeformationMechanic()	Some other standard functions.

Functions

	Name	Description
void	ChangeSelection ( int32 NewPointID, bool AddToSelection )	These issue undo/redo change objects, and must therefore not be called in undo/redo code.
void	ClearCurveSource()
void	ClearHover()
void	ClearSelection()
bool	DeselectPoint ( int32 PointID )
void	GetCurrentCurvePoints ( TArray< FFrame3d >& PointsOut )
void	GizmoTransformChanged ( UTransformProxy* Proxy, FTransform Transform )	Callbacks we'll receive from the gizmo proxy.
void	GizmoTransformEnded ( UTransformProxy* Proxy )
void	GizmoTransformStarted ( UTransformProxy* Proxy )
bool	HitTest ( const FInputDeviceRay& ClickPos, FInputRayHit& ResultOut )	All of the following do not issue undo/redo change objects.
void	SelectionClear()
void	SelectionFill()
void	SelectionGrowToEnd()
void	SelectionGrowToNext()
void	SelectionGrowToPrev()
void	SelectionGrowToStart()
void	SelectPoint ( int32 PointID )
void	SetCurveSource ( TSharedPtr< FSpaceCurveSource > Cur... )
void	SetWorld ( UWorld* World )
void	UpdateCurve ( const TArray< FFrame3d >& NewPosit... )
void	UpdateGizmoLocation()
void	UpdateRenderGeometry()
void	UpdateSelection ( const TArray< int32 >& NewSelectio... )
void	UpdateSpatial()

Overridden from UInteractionMechanic

	Name	Description
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Mechanic to do any custom drawing (ie via PDI/RHI)
void	Setup ( UInteractiveTool* ParentTool )	Called to initialize the InteractionMechanic
void	Shutdown()	Called to clean up the InteractionMechanic
void	Tick ( float DeltaTime )	ALlow the Mechanic to Tick

Overridden from IClickBehaviorTarget

		Name	Description
	FInputRayHit	IsHitByClick ( const FInputDeviceRay& ClickPos )	IClickBehaviorTarget implementation.
	void	OnClicked ( const FInputDeviceRay& ClickPos )	Notify Target that click ocurred

Overridden from IModifierToggleBehaviorTarget

		Name	Description
	void	OnUpdateModifierState ( int ModifierID, bool bIsOn )	IModifierToggleBehaviorTarget implementation, inherited through IClickBehaviorTarget.

Overridden from IHoverBehaviorTarget

	Name	Description
FInputRayHit	BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos )	IHoverBehaviorTarget implementation.
void	OnBeginHover ( const FInputDeviceRay& DevicePos )	Initialize hover sequence at given position
void	OnEndHover()	Terminate active hover sequence
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.

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss