UMeshBoundaryToolBase

Base class for tools that do things with a mesh boundary.

Windows
MacOS
Linux

Inheritance Hierarchy

References

Module

MeshModelingTools

Header

/Engine/Plugins/Experimental/MeshModelingToolset/Source/MeshModelingTools/Public/MeshBoundaryToolBase.h

Include

#include "MeshBoundaryToolBase.h"

Syntax

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

Remarks

Base class for tools that do things with a mesh boundary. Provides ability to select mesh boundaries and some other boilerplate code. TODO: We can refactor to make the HoleFiller tool inherit from this.

Variables

Name Description

Protected variable UProperty

USingleClickInp...

 

LoopSelectClickBehavior

Behavior that wraps this class's selection click operation.

Protected variable

FDynamicMeshAAB...

 

MeshSpatial

Used for hit querying.

Protected variable

TSharedPtr< FDy...

 

OriginalMesh

Protected variable UProperty

UPolygonSelecti...

 

SelectionMechanic

Protected variable

UWorld *

 

TargetWorld

Protected variable

TUniquePtr< FBa...

 

Topology

Functions

Name Description

Protected function Virtual

void

 

OnSelectionChanged()

Override in the child to respond to new loop selections.

Public function Virtual

void

 

SetWorld

(
    UWorld* World
)

Protected function Virtual Const

bool

 

ShouldSelectionAppend()

Override in the child to determine whether new selection should attempt to append.

Overridden from UInteractiveTool

Name Description

Public function Virtual Const

bool

 

HasAccept()

Public function Virtual Const

bool

 

HasCancel()

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 IClickBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

IsHitByClick

(
    const FInputDeviceRay& ClickPos
)

IClickBehaviorTarget.

Public function Virtual

void

 

OnClicked

(
    const FInputDeviceRay& ClickPos
)

This may need overriding, depending on the child class, though the child could also just override OnSelectionChanged().

Overridden from IHoverBehaviorTarget

Name Description

Public function Virtual

FInputRayHit

 

BeginHoverSequenceHitTest

(
    const FInputDeviceRay& PressPos
)

IHoverBehaviorTarget.

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

Classes

Name

Description

Protected class

FBasicTopology

A variant of group topology that considers all triangles one group, so that group edges are boundary edges in the mesh.
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss