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.

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractionMechanic

UConstructionPlaneMechanic

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
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	bEnableSnapToWorldGrid
bool	bShowGrid
TUniqueFunction...	CanUpdatePlaneFunc	Replace this to externally control if plane can be updated
USingleClickInp...	ClickToSetPlaneBehavior
OnConstructionP...	OnPlaneChanged
FFrame3d	Plane
UTransformGizmo...	PlaneTransformGizmo
UTransformProxy...	PlaneTransformProxy
TUniquePtr< ICl...	SetPointInWorldConnector

Functions

		Name	Description
	void	Initialize ( UWorld* TargetWorld, const FFrame3d& InitialPlane )
	void	SetDrawPlaneFromWorldPos ( const FVector3d& Position, const FVector3d& Normal, bool bIgnoreNormal )
	void	SetEnableGridSnaping ( bool bEnable )
	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

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

Take our survey

Dismiss