UPolygonOnMeshTool

Simple Mesh Plane Cutting Tool

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MeshModelingToolsEditorOnly

Header

/Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsEditorOnly/Public/PolygonOnMeshTool.h

Include

#include "PolygonOnMeshTool.h"

Syntax

UCLASS()
class UPolygonOnMeshTool :
    public USingleSelectionMeshEditingTool,
    public UE::Geometry::IDynamicMeshOperatorFactory,
    public IClickBehaviorTarget,
    public IHoverBehaviorTarget

Remarks

Simple Mesh Plane Cutting Tool

Variables

Constructors

Name Description

Public function

UPolygonOnMeshTool()

Functions

Name Description

Protected function

void

 

BeginDrawPolygon()

Protected function

void

 

CompleteDrawPolygon()

Protected function

void

 

GenerateAsset

(
    const TArray< FDynamicMeshOpResult ...
)

Public function Virtual

bool

 

HitTest

(
    const FRay& Ray,
    FHitResult& OutHit
)

Support for hover and click, for drawing polygon.

Public function Virtual

void

 

RequestAction

(
    EPolygonOnMeshToolActions ActionTyp...
)

Protected function

void

 

SetupPreview()

Protected function

void

 

UpdateDrawPlane()

Protected function

void

 

UpdatePolygonType()

Protected function

void

 

UpdateVisualization()

Overridden from USingleSelectionMeshEditingTool

Name Description

Public function Virtual

void

 

SetWorld

(
    UWorld* World
)

Overridden from UInteractiveTool

Name Description

Public function Virtual Const

bool

 

CanAccept()

Public function Virtual Const

bool

 

HasAccept()

Public function Virtual Const

bool

 

HasCancel()

Public function Virtual

void

 

OnPropertyModified

(
    UObject* PropertySet,
    FProperty* Property
)

Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes

Public function Virtual

void

 

OnTick

(
    float DeltaTime
)

Action support/system

Public function Virtual

void

 

Render

(
    IToolsContextRenderAPI* Render...
)

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 IDynamicMeshOperatorFactory

Name Description

Public function Virtual

TUniquePtr< ...

 

MakeNewOperator()

IDynamicMeshOperatorFactory API.

Overridden from IClickBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

IsHitByClick

(
    const FInputDeviceRay& ClickPos
)

IClickBehaviorTarget API.

Public function Virtual

void

 

OnClicked

(
    const FInputDeviceRay& ClickPos
)

Notify Target that click ocurred

Overridden from IHoverBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

BeginHoverSequenceHitTest

(
    const FInputDeviceRay& PressPos
)

IHoverBehaviorTarget API.

Public function Virtual

void

 

OnBeginHover

(
    const FInputDeviceRay& DevicePos
)

Initialize hover sequence at given position

Public function Virtual

void

 

OnEndHover()

Terminate active hover sequence

Public function Virtual

bool

 

OnUpdateHover

(
    const FInputDeviceRay& DevicePos
)

Update active hover sequence with new input position