1. Epic GamesDeveloper
  3. ULatticeControlPointsMechanic

ULatticeControlPointsMechanic

API > API/Plugins > API/Plugins/ModelingComponents

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

Syntax

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

Inheritance Hierarchy

Implements Interfaces

Typedefs

Name Type Remarks Include Path
FShouldHideGizmo TBaseDelegate_NoParams< bool >   Mechanics/LatticeControlPointsMechanic.h
FVector2i UE::Geometry::FVector2i   Mechanics/LatticeControlPointsMechanic.h
OnPointsChangedEvent TMulticastDelegate_NoParams< void > This delegate is called every time the control points are moved. Mechanics/LatticeControlPointsMechanic.h
OnSelectionChangedEvent TMulticastDelegate_NoParams< void > This delegate is called every time the control point selection changes. Mechanics/LatticeControlPointsMechanic.h

Constants

Name Type Remarks Include Path
CtrlModifierID const int32   Mechanics/LatticeControlPointsMechanic.h
ShiftModifierID const int32   Mechanics/LatticeControlPointsMechanic.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bHasChanged bool   Mechanics/LatticeControlPointsMechanic.h  
OnPointsChanged OnPointsChangedEvent   Mechanics/LatticeControlPointsMechanic.h  
OnSelectionChanged OnSelectionChangedEvent   Mechanics/LatticeControlPointsMechanic.h  
ShouldHideGizmo FShouldHideGizmo   Mechanics/LatticeControlPointsMechanic.h  

Protected

Name Type Remarks Include Path Unreal Specifiers
LongTransactions UE::TransactionUtil::FLongTransactionTracker   Mechanics/LatticeControlPointsMechanic.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void ClearAllPointColorOverrides()

   Mechanics/LatticeControlPointsMechanic.h  

void ClearPointColorOverride ( int32 Index
)

   Mechanics/LatticeControlPointsMechanic.h  

bool ControlPointIsSelected ( int32 Index
)

   Mechanics/LatticeControlPointsMechanic.h  

virtual void DrawHUD ( FCanvas* Canvas,
IToolsContextRenderAPI* RenderAPI
)

   Mechanics/LatticeControlPointsMechanic.h  

const TArray< FVector3d > & GetControlPoints()

   Mechanics/LatticeControlPointsMechanic.h  

EToolContextCoordinateSystem GetCoordinateSystem()

   Mechanics/LatticeControlPointsMechanic.h  

const TSet< int32 > & GetSelectedPointIDs()

   Mechanics/LatticeControlPointsMechanic.h  

virtual void Initialize ( const TArray< FVector3d >& Points,
const TArray< FVector2i >& Edges,
const FTransform3d& LocalToWorldTransform
)

   Mechanics/LatticeControlPointsMechanic.h  

bool IsGizmoBeingDragged()

   Mechanics/LatticeControlPointsMechanic.h  

void SetCoordinateSystem ( EToolContextCoordinateSystem InCoordinateSystem
)

   Mechanics/LatticeControlPointsMechanic.h  

void SetPointColorOverride ( int32 Index,
const FColor& NewColor
)

   Mechanics/LatticeControlPointsMechanic.h  

void SetWorld ( UWorld* World
)

   Mechanics/LatticeControlPointsMechanic.h  

void UpdateControlPointPositions ( const TArray< FVector3d >& NewPoints
)

   Mechanics/LatticeControlPointsMechanic.h  

void UpdateDrawables()

   Mechanics/LatticeControlPointsMechanic.h  

void UpdatePointLocations ( const TMap< int32, FVector3d >& NewLocations
)

   Mechanics/LatticeControlPointsMechanic.h  

void UpdatePointLocations ( const TArray< FVector3d >& NewLocations
)

 Set all lattice control points. Mechanics/LatticeControlPointsMechanic.h  

void UpdateSetPivotMode ( bool bInSetPivotMode
)

   Mechanics/LatticeControlPointsMechanic.h  

Overridden from UInteractionMechanic

Name Remarks Include Path Unreal Specifiers

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   Mechanics/LatticeControlPointsMechanic.h  

virtual void Setup ( UInteractiveTool* ParentTool
)

 UInteractionMechanic. Mechanics/LatticeControlPointsMechanic.h  

virtual void Shutdown()

   Mechanics/LatticeControlPointsMechanic.h  

Overridden from IClickBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit IsHitByClick ( const FInputDeviceRay& ClickPos
)

 IClickBehaviorTarget implementation. Mechanics/LatticeControlPointsMechanic.h  

virtual void OnClicked ( const FInputDeviceRay& ClickPos
)

   Mechanics/LatticeControlPointsMechanic.h  

Overridden from IModifierToggleBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual void OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

   Mechanics/LatticeControlPointsMechanic.h  

Overridden from IHoverBehaviorTarget

Name Remarks Include Path Unreal Specifiers

virtual FInputRayHit BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos
)

 IHoverBehaviorTarget implementation. Mechanics/LatticeControlPointsMechanic.h  

virtual void OnBeginHover ( const FInputDeviceRay& DevicePos
)

   Mechanics/LatticeControlPointsMechanic.h  

virtual void OnEndHover()

   Mechanics/LatticeControlPointsMechanic.h  

virtual bool OnUpdateHover ( const FInputDeviceRay& DevicePos
)

   Mechanics/LatticeControlPointsMechanic.h  

Protected

Name Remarks Include Path Unreal Specifiers

void ClearHover()

   Mechanics/LatticeControlPointsMechanic.h  

bool DeselectPoint ( int32 PointID
)

   Mechanics/LatticeControlPointsMechanic.h  

void GizmoTransformChanged ( UTransformProxy* Proxy,
FTransform Transform
)

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

void GizmoTransformEnded ( UTransformProxy* Proxy
)

   Mechanics/LatticeControlPointsMechanic.h  

void GizmoTransformStarted ( UTransformProxy* Proxy
)

   Mechanics/LatticeControlPointsMechanic.h  

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

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

void OnDragRectangleChanged ( const FCameraRectangle& Rectangle
)

   Mechanics/LatticeControlPointsMechanic.h  

void OnDragRectangleFinished ( const FCameraRectangle& Rectangle,
bool bCancelled
)

   Mechanics/LatticeControlPointsMechanic.h  

void OnDragRectangleStarted()

   Mechanics/LatticeControlPointsMechanic.h  

void RebuildDrawables()

   Mechanics/LatticeControlPointsMechanic.h  

void SelectPoint ( int32 PointID
)

   Mechanics/LatticeControlPointsMechanic.h  

void UpdateGizmoLocation()

   Mechanics/LatticeControlPointsMechanic.h  

void UpdateGizmoVisibility()

   Mechanics/LatticeControlPointsMechanic.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page