Navigation
API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/Mechanics
Inheritance Hierarchy
- 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
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bShowGrid | |
 |
TUniqueFunction< bool()> | CanUpdatePlaneFunc | Replace this to externally control if plane can be updated |
  |
TObjectPtr< USingleClickInputBehavior > | ClickToSetPlaneBehavior | |
  |
TObjectPtr< ULocalSingleClickInputBehavior > | MiddleClickToSetGizmoBehavior | This is the behavior and behavior target used for the Shift+click behavior that sets the gizmo's position in the world. |
 |
OnConstructionPlaneChangedEvent | OnPlaneChanged | |
 |
UE::Geometry::FFrame3d | Plane | |
  |
TObjectPtr< UCombinedTransformGizmo > | PlaneTransformGizmo | |
  |
TObjectPtr< UTransformProxy > | PlaneTransformProxy | |
 |
TUniquePtr< FSelectClickedAction > | 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
| Type | Name | Description | |
|---|---|---|---|
 |
void | Initialize
(
UWorld* TargetWorld, |
|
 |
void | SetDrawPlaneFromWorldPos
(
const FVector3d& Position, |
|
 |
void | SetPlaneWithoutBroadcast
(
const UE::Geometry::FFrame3d& Plane |
Sets the plane without broadcasting OnPlaneChanged. |
 |
void | TransformChanged
(
UTransformProxy* Proxy, |
|
 |
void | UpdateClickPriority
(
FInputCapturePriority NewPriority |
Overridden from UInteractionMechanic
| Type | Name | Description | |
|---|---|---|---|
  |
void | Render
(
IToolsContextRenderAPI* RenderAPI |
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 |