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

UDrawPolyPathTool

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

UDrawPolyPathTool

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UDrawPolyPathTool :
    public UInteractiveTool,
    public IClickBehaviorTarget,
    public IHoverBehaviorTarget

Variables

	Name	Description
TArray< double ...	ArcLengths
IToolsContextAs...	AssetAPI
bool	bPathIsClosed
FViewCameraStat...	CameraState
double	CurHeight
double	CurOffsetDistance
double	CurPathLength
TArray< FFrame3...	CurPathPoints
TArray< FVector...	CurPolyLine
int32	CurrentCurveTimestamp
USpatialCurveDi...	CurveDistMechanic
FFrame3d	DrawPlaneWorld
UPolyEditPrevie...	EditPreview
UPlaneDistanceF...	ExtrudeHeightMechanic
UDrawPolyPathEx...	ExtrudeProperties
UNewMeshMateria...	MaterialProperties
TArray< double ...	OffsetScaleFactors
UConstructionPl...	PlaneMechanic
UCollectSurface...	SurfacePathMechanic
UWorld *	TargetWorld
UDrawPolyPathPr...	TransformProps
float	UVScaleFactor	UV Scale factor to apply to texturing on any new geometry (e.g. new faces added by extrude)
FTransform3d	WorldTransform	Camera state at last render

Functions

	Name	Description
void	BeginConstantOffsetDistance()
void	BeginInteractiveExtrudeHeight()
void	BeginInteractiveOffsetDistance()
bool	CanUpdateDrawPlane()
bool	CheckInCurve ( int32 Timestamp )
void	ClearPreview()
void	EmitNewObject ( EDrawPolyPathOutputMode OutputMode )
void	GenerateExtrudeMesh ( FDynamicMesh3& PathMesh )
void	GeneratePathMesh ( FDynamicMesh3& Mesh )
void	GenerateRampMesh ( FDynamicMesh3& PathMesh )
bool	HitTest ( const FRay& Ray, FHitResult& OutHit )
void	InitializeNewSurfacePath()
void	InitializePreviewMesh()
void	OnCompleteExtrudeHeight()
void	OnCompleteOffsetDistance()
void	OnCompleteSurfacePath()
void	SetAssetAPI ( IToolsContextAssetAPI* AssetAP... )
void	SetWorld ( UWorld* World )
void	ShowExtrudeMessage()
void	ShowOffsetMessage()
void	ShowStartupMessage()	User feedback messages
void	UndoCurrentOperation()
void	UpdateExtrudePreview()
void	UpdatePathPreview()
void	UpdateSurfacePathPlane()

Overridden from UInteractiveTool

	Name	Description
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	OnTick ( float DeltaTime )	Action support/system
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

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