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 > UConstructionPlaneMechanic

Light Theme

Dark Theme

UConstructionPlaneMechanic

[UConstructionPlaneMechanic](API\Plugins\ModelingComponents\Mechanics\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.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractionMechanic

UConstructionPlaneMechanic

References

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

Syntax

UCLASS()
class UConstructionPlaneMechanic : public UInteractionMechanic

Remarks

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.

Variables

	Name	Description
bool	bShowGrid
TUniqueFunction...	CanUpdatePlaneFunc	Replace this to externally control if plane can be updated
TObjectPtr< USi...	ClickToSetPlaneBehavior
OnConstructionP...	OnPlaneChanged
UE::Geometry::F...	Plane
TObjectPtr< UCo...	PlaneTransformGizmo
TObjectPtr< UTr...	PlaneTransformProxy
TUniquePtr< FSe...	SetPlaneCtrlClickBehaviorTarget	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.

Functions

	Name	Description
void	Initialize ( UWorld* TargetWorld, const UE::Geometry::FFrame3d& Init... )
void	SetDrawPlaneFromWorldPos ( const FVector3d& Position, const FVector3d& Normal, bool bIgnoreNormal )
void	SetPlaneWithoutBroadcast ( const UE::Geometry::FFrame3d& Plan... )	Sets the plane without broadcasting OnPlaneChanged.
void	TransformChanged ( UTransformProxy* Proxy, FTransform Transform )
void	UpdateClickPriority ( FInputCapturePriority NewPriority )

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

Typedefs

Name	Description
OnConstructionPlaneChangedEvent