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 > MeshModelingTools > UDrawPolygonTool

Light Theme

Dark Theme

UDrawPolygonTool

This tool allows the user to draw and extrude 2D polygons

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

UDrawPolygonTool

References

Module	MeshModelingTools
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/MeshModelingTools/Public/DrawPolygonTool.h
Include	#include "DrawPolygonTool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UDrawPolygonTool :
public UInteractiveTool,
public IClickSequenceBehaviorTarget

Remarks

This tool allows the user to draw and extrude 2D polygons

Variables

	Name	Description
IToolsContextAs...	AssetAPI
bool	bAbortActivePolygonDraw
bool	bHaveSelfIntersection
bool	bHaveSurfaceHit	Only used when SnapSettings.bHitSceneObjects = true
bool	bIgnoreSnappingToggle
bool	bInFixedPolygonMode
bool	bInInteractiveExtrude
bool	bPreviewUpdatePending
FViewCameraStat...	CameraState
int32	CurrentCurveTimestamp
FQuaterniond	DrawPlaneOrientation	Orientation of plane we will draw polygon on
FVector3d	DrawPlaneOrigin	Origin of plane we will draw polygon on
TArray< FVector...	FixedPolygonClickPoints
UPlaneDistanceF...	HeightMechanic
FFrame3f	HitPosFrameWorld
FVector3d	LastGridSnapPoint
ToolSceneQuerie...	LastSnapGeometry
UNewMeshMateria...	MaterialProperties
UTransformGizmo...	PlaneTransformGizmo
UTransformProxy...	PlaneTransformProxy
TArray< TArray<...	PolygonHolesVertices	Vertices of holes in current preview polygon
UDrawPolygonToo...	PolygonProperties	Properties that control polygon generation exposed to user via detailsview
TArray< FVector...	PolygonVertices	Vertices of current preview polygon
UPreviewMesh &#...	PreviewMesh
FVector3d	PreviewVertex	Last vertex of polygon that is actively being updated as input device is moved
FVector3d	SelfIntersectionPoint
int	SelfIntersectSegmentIdx
IClickBehaviorT...	SetPointInWorldConnector	Calls SetDrawPlaneFromWorldPos when user ctrl+clicks on scene
TValueWatcher< ...	ShowGizmoWatcher
FPointPlanarSna...	SnapEngine
UDrawPolygonToo...	SnapProperties
FVector3d	SurfaceHitPoint
FVector3d	SurfaceOffsetPoint
UWorld *	TargetWorld

Constructors

	Name	Description
	UDrawPolygonTool()

Functions

	Name	Description
void	AppendVertex ( const FVector3d& Vertex )
void	BeginInteractiveExtrude()
bool	CheckInCurve ( int32 Timestamp )
void	EmitCurrentPolygon()
void	EndInteractiveExtrude()
bool	FindDrawPlaneHitPoint ( const FInputDeviceRay& ClickPos, FVector3d& HitPosOut )
void	GenerateFixedPolygon ( const TArray< FVector3d >& FixedPo..., TArray< FVector3d >& VerticesOut, TArray< TArray< FVector3d >>& Hole... )
bool	GeneratePolygonMesh ( const TArray< FVector3d >& Polygon, const TArray< TArray< FVector3d >> ..., FDynamicMesh3* ResultMeshOut, FFrame3d& WorldFrameOut, bool bIncludePreviewVtx, double ExtrudeDistance, bool bExtrudeSymmetric )	Generate extruded meshes. Returns true on success.
void	GetPolygonParametersFromFixedPoints ( const TArray< FVector3d >& FixedPo..., FVector2d& FirstReferencePt, FVector2d& BoxSize, double& YSign, double& AngleRad )
void	PlaneTransformChanged ( UTransformProxy* Proxy, FTransform Transform )	Called on PlaneTransformProxy.OnTransformChanged
void	PopLastVertexAction()
void	ResetPolygon()	Polygon drawing functions
void	SetAssetAPI ( IToolsContextAssetAPI* AssetAP... )
void	SetDrawPlaneFromWorldPos ( const FVector3d& Position, const FVector3d& Normal )	Updates plane and gizmo position
void	SetWorld ( UWorld* World )
void	ShowExtrudeMessage()
void	ShowStartupMessage()	User feedback messages
void	UndoCurrentOperation()
void	UpdateLivePreview()
void	UpdatePreviewVertex ( const FVector3d& PreviewVertex )
bool	UpdateSelfIntersection()	Can close poly if current segment intersects existing segment
void	UpdateShowGizmoState ( bool bNewVisibility )

Overridden from UInteractiveTool

	Name	Description
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	RegisterActions ( FInteractiveToolActionSet& ActionS... )	Override this function to register the set of Actions this Tool supports, using FInteractiveToolActionSet::RegisterAction.
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
void	Tick ( float DeltaTime )	Allow the Tool to do any necessary processing on Tick

Overridden from IClickSequenceBehaviorTarget

	Name	Description
bool	CanBeginClickSequence ( const FInputDeviceRay& ClickPos )	Test if target would like to begin sequence based on this click
void	OnBeginClickSequence ( const FInputDeviceRay& ClickPos )	Notify Target that click sequence can begin at click point
void	OnBeginSequencePreview ( const FInputDeviceRay& ClickPos )	Notify Target device position has changed but a click sequence hasn't begun yet (eg for interactive previews)
bool	OnNextSequenceClick ( const FInputDeviceRay& ClickPos )	Notify Target about next click in sqeuence
void	OnNextSequencePreview ( const FInputDeviceRay& ClickPos )	Notify Target device position has changed but a click hasn't ocurred yet (eg for interactive previews)
void	OnTerminateClickSequence()	Notify Target that click sequence has been explicitly terminated (eg by escape key, cancel tool, etc)
bool	RequestAbortClickSequence()	Target overrides this and returns true if it wants to abort click sequence.

Overridden from IModifierToggleBehaviorTarget

		Name	Description
	void	OnUpdateModifierState ( int ModifierID, bool bIsOn )	Notify target of current modifier state

Constants

Name	Description
AngleSnapModifier
IgnoreSnappingModifier	Flags used to identify modifier keys/buttons

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

Take our survey

Dismiss