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

Light Theme

Dark Theme

UPolygonOnMeshTool

Simple Mesh Plane Cutting Tool

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UPolygonOnMeshTool

References

Module	MeshModelingToolsEditorOnly
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/MeshModelingToolsEditorOnly/Public/PolygonOnMeshTool.h
Include	#include "PolygonOnMeshTool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UPolygonOnMeshTool :
    public USingleSelectionTool,
    public IDynamicMeshOperatorFactory,
    public IClickBehaviorTarget,
    public IHoverBehaviorTarget

Remarks

Simple Mesh Plane Cutting Tool

Variables

Constructors

	Name	Description
	UPolygonOnMeshTool()

Functions

	Name	Description
void	BeginDrawPolygon()
void	CompleteDrawPolygon()
void	GenerateAsset ( const TArray< FDynamicMeshOpResult ... )
bool	HitTest ( const FRay& Ray, FHitResult& OutHit )	Support for hover and click, for drawing polygon.
void	RequestAction ( EPolygonOnMeshToolActions ActionTyp... )
void	SetupPreview()
void	SetWorld ( UWorld* World )
void	UpdateDrawPlane()
void	UpdatePolygonType()
void	UpdateVisualization()

Overridden from UInteractiveTool

	Name	Description
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	OnPropertyModified ( UObject* PropertySet, FProperty* Property )	Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
void	OnTick ( float DeltaTime )	Action support/system
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom drawing (ie via PDI/RHI)
void	Setup()	Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

Overridden from IDynamicMeshOperatorFactory

		Name	Description
	TUniquePtr< ...	MakeNewOperator()	IDynamicMeshOperatorFactory API.

Overridden from IClickBehaviorTarget

		Name	Description
	FInputRayHit	IsHitByClick ( const FInputDeviceRay& ClickPos )	IClickBehaviorTarget API.
	void	OnClicked ( const FInputDeviceRay& ClickPos )	Notify Target that click ocurred

Overridden from IHoverBehaviorTarget

	Name	Description
FInputRayHit	BeginHoverSequenceHitTest ( const FInputDeviceRay& PressPos )	IHoverBehaviorTarget API.
void	OnBeginHover ( const FInputDeviceRay& DevicePos )	Initialize hover sequence at given position
void	OnEndHover()	Terminate active hover sequence
bool	OnUpdateHover ( const FInputDeviceRay& DevicePos )	Update active hover sequence with new input position

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

Take our survey

Dismiss