1. Epic GamesDeveloper
  3. UConstructionPlaneMechanic

UConstructionPlaneMechanic

[UConstructionPlaneMechanic](API\Plugins\ModelingComponents\UConstructionPlaneMechanic) implements an interaction in which a 3D plane can be positioned using the standard 3D Gizmo, or placed at hit-locations in the existing scene.

API > API/Plugins > API/Plugins/ModelingComponents

UConstructionPlaneMechanic implements an interaction in which a 3D plane can be positioned using the standard 3D Gizmo, or placed at hit-locations in the existing scene. A grid in the plane can optionally be rendered.

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

Syntax

UCLASS (MinimalAPI)  
class UConstructionPlaneMechanic : public UInteractionMechanic

Inheritance Hierarchy

Typedefs

Name Type Remarks Include Path
OnConstructionPlaneChangedEvent TMulticastDelegate_NoParams< void >   Mechanics/ConstructionPlaneMechanic.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
bShowGrid bool   Mechanics/ConstructionPlaneMechanic.h  
CanUpdatePlaneFunc TUniqueFunction< bool()> Replace this to externally control if plane can be updated Mechanics/ConstructionPlaneMechanic.h  
OnPlaneChanged OnConstructionPlaneChangedEvent   Mechanics/ConstructionPlaneMechanic.h  
Plane UE::Geometry::FFrame3d   Mechanics/ConstructionPlaneMechanic.h  
PlaneTransformGizmo TObjectPtr< UCombinedTransformGizmo >   Mechanics/ConstructionPlaneMechanic.h  
PlaneTransformProxy TObjectPtr< UTransformProxy >   Mechanics/ConstructionPlaneMechanic.h  
SetPlaneCtrlClickBehaviorTarget TUniquePtr< FSelectClickedAction > This is the behavior target used for the Ctrl+click behavior that sets the plane in the world, exposed here so that the user can modify it after Setup() if needed. Mechanics/ConstructionPlaneMechanic.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void Initialize ( UWorld* TargetWorld,
const UE::Geometry::FFrame3d& InitialPlane
)

   Mechanics/ConstructionPlaneMechanic.h  

void SetDrawPlaneFromWorldPos ( const FVector3d& Position,
const FVector3d& Normal,
bool bIgnoreNormal
)

   Mechanics/ConstructionPlaneMechanic.h  

void SetPlaneWithoutBroadcast ( const UE::Geometry::FFrame3d& Plane
)

 Sets the plane without broadcasting OnPlaneChanged. Mechanics/ConstructionPlaneMechanic.h  

void UpdateClickPriority ( FInputCapturePriority NewPriority
)

   Mechanics/ConstructionPlaneMechanic.h  

Overridden from UInteractionMechanic

Name Remarks Include Path Unreal Specifiers

virtual void Render ( IToolsContextRenderAPI* RenderAPI
)

   Mechanics/ConstructionPlaneMechanic.h  

virtual void Setup ( UInteractiveTool* ParentTool
)

   Mechanics/ConstructionPlaneMechanic.h  

virtual void Shutdown()

   Mechanics/ConstructionPlaneMechanic.h  

virtual void Tick ( float DeltaTime
)

   Mechanics/ConstructionPlaneMechanic.h  

Protected

Name Remarks Include Path Unreal Specifiers

void TransformChanged ( UTransformProxy* Proxy,
FTransform Transform
)

   Mechanics/ConstructionPlaneMechanic.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page