1. Epic GamesDeveloper
  3. USpaceCurveDeformationMechanic

USpaceCurveDeformationMechanic

API > API/Plugins > API/Plugins/ModelingComponents

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

Syntax

UCLASS (MinimalAPI)  
class USpaceCurveDeformationMechanic :  
    public UInteractionMechanic ,  
    public IClickBehaviorTarget ,  
    public IHoverBehaviorTarget

Inheritance Hierarchy

Implements Interfaces

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~USpaceCurveDeformationMechanic()

 Some other standard functions. Mechanics/SpaceCurveDeformationMechanic.h  

Typedefs

Name Type Remarks Include Path
OnPointsChangedEvent TMulticastDelegate_NoParams< void > This delegate is called every time the control point sequence is altered. Mechanics/SpaceCurveDeformationMechanic.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
ClickBehavior TObjectPtr< USingleClickInputBehavior > Behaviors used for moving points around and hovering them. Mechanics/SpaceCurveDeformationMechanic.h  
HoverBehavior TObjectPtr< UMouseHoverBehavior >   Mechanics/SpaceCurveDeformationMechanic.h  
OnPointsChanged OnPointsChangedEvent   Mechanics/SpaceCurveDeformationMechanic.h  
TransformProperties TObjectPtr< USpaceCurveDeformationMechanicPropertySet >   Mechanics/SpaceCurveDeformationMechanic.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearCurveSource()

   Mechanics/SpaceCurveDeformationMechanic.h  

void ClearSelection()

   Mechanics/SpaceCurveDeformationMechanic.h  

void GetCurrentCurvePoints ( TArray< UE::Geometry::FFrame3d >& PointsOut
)

   Mechanics/SpaceCurveDeformationMechanic.h  

void SelectionClear()

   Mechanics/SpaceCurveDeformationMechanic.h  

void SelectionFill()

   Mechanics/SpaceCurveDeformationMechanic.h  

void SelectionGrowToEnd()

   Mechanics/SpaceCurveDeformationMechanic.h  

void SelectionGrowToNext()

   Mechanics/SpaceCurveDeformationMechanic.h  

void SelectionGrowToPrev()

   Mechanics/SpaceCurveDeformationMechanic.h  

void SelectionGrowToStart()

   Mechanics/SpaceCurveDeformationMechanic.h  

void SetCurveSource ( TSharedPtr< FSpaceCurveSource > CurveSource
)

   Mechanics/SpaceCurveDeformationMechanic.h  

void SetWorld ( UWorld* World
)

   Mechanics/SpaceCurveDeformationMechanic.h  

Overridden from UInteractionMechanic

Name Remarks Include Path Unreal Specifiers

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   Mechanics/SpaceCurveDeformationMechanic.h  

virtual void Setup ( UInteractiveTool* ParentTool
)

   Mechanics/SpaceCurveDeformationMechanic.h  

virtual void Shutdown()

   Mechanics/SpaceCurveDeformationMechanic.h  

virtual void Tick ( float DeltaTime
)

   Mechanics/SpaceCurveDeformationMechanic.h  

Overridden from IClickBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit IsHitByClick ( const FInputDeviceRay& ClickPos
)

 IClickBehaviorTarget implementation. Mechanics/SpaceCurveDeformationMechanic.h  

virtual void OnClicked ( const FInputDeviceRay& ClickPos
)

   Mechanics/SpaceCurveDeformationMechanic.h  

Overridden from IModifierToggleBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual void OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 IModifierToggleBehaviorTarget implementation, inherited through IClickBehaviorTarget. Mechanics/SpaceCurveDeformationMechanic.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos
)

 IHoverBehaviorTarget implementation. Mechanics/SpaceCurveDeformationMechanic.h  

virtual void OnBeginHover ( const FInputDeviceRay& DevicePos
)

   Mechanics/SpaceCurveDeformationMechanic.h  

virtual void OnEndHover()

   Mechanics/SpaceCurveDeformationMechanic.h  

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   Mechanics/SpaceCurveDeformationMechanic.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ChangeSelection ( int32 NewPointID,
bool AddToSelection
)

 These issue undo/redo change objects, and must therefore not be called in undo/redo code. Mechanics/SpaceCurveDeformationMechanic.h  

void ClearHover()

   Mechanics/SpaceCurveDeformationMechanic.h  

bool DeselectPoint ( int32 PointID
)

   Mechanics/SpaceCurveDeformationMechanic.h  

void GizmoTransformChanged ( UTransformProxy* Proxy,
FTransform Transform
)

 Callbacks we'll receive from the gizmo proxy. Mechanics/SpaceCurveDeformationMechanic.h  

void GizmoTransformEnded ( UTransformProxy* Proxy
)

   Mechanics/SpaceCurveDeformationMechanic.h  

void GizmoTransformStarted ( UTransformProxy* Proxy
)

   Mechanics/SpaceCurveDeformationMechanic.h  

bool HitTest ( const FInputDeviceRay& ClickPos,
FInputRayHit& ResultOut
)

 All of the following do not issue undo/redo change objects. Mechanics/SpaceCurveDeformationMechanic.h  

void SelectPoint ( int32 PointID
)

   Mechanics/SpaceCurveDeformationMechanic.h  

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

   Mechanics/SpaceCurveDeformationMechanic.h  

void UpdateGizmoLocation()

   Mechanics/SpaceCurveDeformationMechanic.h  

void UpdateRenderGeometry()

   Mechanics/SpaceCurveDeformationMechanic.h  

void UpdateSelection ( const TArray< int32 >& NewSelection
)

   Mechanics/SpaceCurveDeformationMechanic.h  

void UpdateSpatial()

   Mechanics/SpaceCurveDeformationMechanic.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page