UDynamicMeshBrushTool

[UDynamicMeshBrushTool](API\Plugins\MeshModelingToolsExp\UDynamicMeshBrushTool) is a base class that specializes [UBaseBrushTool](API\Runtime\InteractiveToolsFramework\BaseTools\UBaseBrushTool) for brushing on an FDynamicMesh3.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MeshModelingToolsExp

Header

/Engine/Plugins/Experimental/MeshModelingToolsetExp/Source/MeshModelingToolsExp/Public/DynamicMeshBrushTool.h

Include

#include "DynamicMeshBrushTool.h"

Syntax

UCLASS(Transient)
class UDynamicMeshBrushTool : public UBaseBrushTool

Remarks

UDynamicMeshBrushTool is a base class that specializes UBaseBrushTool for brushing on an FDynamicMesh3. The input FPrimitiveComponentTarget is hidden and a UPreviewMesh is created and shown in its place. This UPreviewMesh is used for hit-testing and dynamic rendering.

Variables

Name Description

Protected variable

UE::Geometry::F...

 

InputMeshBoundsLocal

Protected variable

FDelegateHandle

 

OnBaseMeshComponentChangedHandle

Protected variable UProperty

TObjectPtr< UPr...

 

PreviewMesh

Constructors

Name Description

Public function

UDynamicMeshBrushTool()

Functions

Name Description

Protected function Virtual

void

 

OnBaseMeshComponentChanged()

This function is called when the component inside the PreviewMesh is modified (eg via an undo/redo event)

Protected function Virtual

void

 

OnShutdown

(
    EToolShutdownType ShutdownType
)

Subclasses can override these to customize behavior

Overridden from UBaseBrushTool

Name Description

Protected function Virtual

double

 

EstimateMaximumTargetDimension()

Subclasses should implement this to give an estimate of target dimension for brush size scaling

Overridden from UMeshSurfacePointTool

Name Description

Public function Virtual

bool

 

HitTest

(
    const FRay& Ray,
    FHitResult& OutHit
)

Overridden from UInteractiveTool

Name Description

Public function Virtual

void

 

Setup()

Register InputBehaviors, etc

Public function Virtual

void

 

Shutdown

(
    EToolShutdownType ShutdownType
)

Called by ToolManager to shut down the Tool