Navigation
API > API/Plugins > API/Plugins/MeshModelingTools
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.
| Name | UDynamicMeshBrushTool |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/DynamicMeshBrushTool.h |
| Include Path | #include "DynamicMeshBrushTool.h" |
Syntax
UCLASS (MinimalAPI, Transient)
class UDynamicMeshBrushTool : public UBaseBrushTool
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → USingleSelectionTool → UMeshSurfacePointTool → UBaseBrushTool → UDynamicMeshBrushTool
Implements Interfaces
- IClickDragBehaviorTarget
- IModifierToggleBehaviorTarget
- IHoverBehaviorTarget
- IInputBehaviorSource
- IInteractiveToolCameraFocusAPI
Derived Classes
UDynamicMeshBrushTool derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UDynamicMeshBrushTool() |
DynamicMeshBrushTool.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
TObjectPtr< UPreviewMesh > GetPreviewMesh() |
DynamicMeshBrushTool.h |
Overridden from UMeshSurfacePointTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool HitTest
(
const FRay& Ray, |
DynamicMeshBrushTool.h |
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Setup() |
DynamicMeshBrushTool.h | ||
virtual void Shutdown
(
EToolShutdownType ShutdownType |
DynamicMeshBrushTool.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnBaseMeshComponentChanged() |
This function is called when the component inside the PreviewMesh is modified (eg via an undo/redo event) | DynamicMeshBrushTool.h | |
virtual void OnShutdown
(
EToolShutdownType ShutdownType |
Subclasses can override these to customize behavior | DynamicMeshBrushTool.h |
Overridden from UBaseBrushTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual double EstimateMaximumTargetDimension() |
DynamicMeshBrushTool.h |