1. Epic GamesDeveloper
  3. UDrawPolygonTool

UDrawPolygonTool

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

Unreal Engine C++ API Reference > Plugins > MeshModelingTools

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;&41;  
class UDrawPolygonTool :  
    public UInteractiveTool,  
    public IClickSequenceBehaviorTarget

Remarks

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

Variables

  Type Name Description
Protected variable bool bAbortActivePolygonDraw  
Protected variable bool bHasSavedExtrudeHeight  
Protected variable bool bHaveSelfIntersection  
Protected variable bool bHaveSurfaceHit Only used when SnapSettings.bSnapToSurfaces = true
Protected variable bool bIgnoreSnappingToggle  
Protected variable bool bInFixedPolygonMode  
Protected variable bool bInInteractiveExtrude  
Protected variable bool bPreviewUpdatePending  
Protected variable FViewCameraState CameraState  
Protected variable int32 CurrentCurveTimestamp  
Protected variable UProperty TObjectPtr< UDragAlignmentMechanic > DragAlignmentMechanic  
Protected variable TArray< FVector3d > FixedPolygonClickPoints  
Protected variable UProperty TObjectPtr< UPlaneDistanceFromHitMechanic > HeightMechanic  
Protected variable FVector3d LastGridSnapPoint  
Protected variable ToolSceneQueriesUtil::FSnapGeometry LastSnapGeometry  
Protected variable UProperty TObjectPtr< UNewMeshMaterialProperties > MaterialProperties  
Protected variable UProperty TObjectPtr< UCreateMeshObjectTypeProperties > OutputTypeProperties Property set for type of output object (StaticMesh, Volume, etc)
Protected variable UProperty TObjectPtr< UConstructionPlaneMechanic > PlaneMechanic  
Protected variable TArray< TArray< FVector3d > > PolygonHolesVertices Vertices of holes in current preview polygon
Protected variable UProperty TObjectPtr< UDrawPolygonToolStandardProperties > PolygonProperties Properties that control polygon generation exposed to user via details view
Protected variable TArray< FVector3d > PolygonVertices Vertices of current preview polygon
Protected variable UProperty TObjectPtr< UPreviewMesh > PreviewMesh  
Protected variable FVector3d PreviewVertex Last vertex of polygon that is actively being updated as input device is moved
Protected variable float SavedExtrudeHeight  
Protected variable FVector3d SelfIntersectionPoint  
Protected variable int SelfIntersectSegmentIdx  
Protected variable UE::Geometry::FPointPlanarSnapSolver SnapEngine  
Protected variable UProperty TObjectPtr< UDrawPolygonToolSnapProperties > SnapProperties  
Protected variable FVector3d SurfaceHitPoint  
Protected variable FVector3d SurfaceOffsetPoint  
Protected variable UWorld * TargetWorld  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function bool Whether to allow the draw plane to be updated in the UI returns false if there is an in-progress shape relying on the current draw plane
Public function Virtual void

AppendVertex ( const FVector3d& Vertex
)

  
Public function Virtual void

ApplyUndoPoints ( const TArray< FVector3d >& ClickPointsIn,
const TArray< FVector3d >& PolygonVerticesIn
)

  
Public function Virtual void  
Protected function Const bool

CheckInCurve ( int32 Timestamp
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual bool

FindDrawPlaneHitPoint ( const FInputDeviceRay& ClickPos,
FVector3d& HitPosOut
)

  
Protected function void

GenerateFixedPolygon ( const TArray< FVector3d >& FixedPoints,
TArray< FVector3d >& VerticesOut,
TArray< TArray< FVector3d >>& HolesVerticesOut
)

  
Protected function bool

GeneratePolygonMesh ( const TArray< FVector3d >& Polygon,
const TArray< TArray< FVector3d >>& PolygonHoles,
FDynamicMesh3* ResultMeshOut,
UE::Geometry::FFrame3d& WorldFrameOut,
bool bIncludePreviewVtx,
double ExtrudeDistance,
bool bExtrudeSymmetric
)

 Generate extruded meshes. Returns true on success.
Protected function void

GetPolygonParametersFromFixedPoints ( const TArray< FVector3d >& FixedPoints,
FVector2d& FirstReferencePt,
FVector2d& BoxSize,
double& YSign,
double& AngleRad
)

  
Protected function void Called on PlaneMechanic.OnPlaneChanged
Public function Virtual void Polygon drawing functions
Public function Virtual void

SetWorld ( UWorld* World
)

  
Protected function void  
Protected function void User feedback messages
Protected function void

UndoCurrentOperation ( const TArray< FVector3d >& ClickPointsIn,
const TArray< FVector3d >& PolygonVerticesIn
)

  
Protected function void  
Public function Virtual void

UpdatePreviewVertex ( const FVector3d& PreviewVertex
)

  
Protected function bool Can close poly if current segment intersects existing segment

Overridden from UInteractiveTool

  Type Name Description
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual void

OnTick ( float DeltaTime
)

 Allow the Tool to do any necessary processing on Tick
Public function Virtual void Override this function to register the set of Actions this Tool supports, using FInteractiveToolActionSet::RegisterAction.
Public function Virtual void Allow the Tool to do any custom drawing (ie via PDI/RHI)
Public function Virtual void

Setup ()

 Called by ToolManager to initialize the Tool after ToolBuilder::BuildTool() has been called
Public function Virtual void

Shutdown ( EToolShutdownType ShutdownType
)

 Called by ToolManager to shut down the Tool

Overridden from IClickSequenceBehaviorTarget

  Type Name Description
Public function Virtual bool Test if target would like to begin sequence based on this click.
Public function Virtual void Notify Target about the first click in the sequence.
Public function Virtual void Notify Target device position has changed but a click sequence hasn't begun yet (eg for interactive previews)
Public function Virtual bool

OnNextSequenceClick ( const FInputDeviceRay& ClickPos
)

 Notify Target about next click in sqeuence
Public function Virtual void Notify Target device position has changed but a click hasn't ocurred yet (eg for interactive previews)
Public function Virtual void Notify Target that click sequence has been explicitly terminated (eg by escape key, cancel tool, etc).
Public function Virtual bool Target overrides this and returns true if it wants to abort click sequence.

Overridden from IModifierToggleBehaviorTarget

  Type Name Description
Public function Virtual void

OnUpdateModifierState ( int ModifierID,
bool bIsOn
)

 Notify target of current modifier state

Constants

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page