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

> Unreal Engine API Reference > Plugins > ModelingComponents > BaseTools > UBaseMeshProcessingTool

Light Theme

Dark Theme

UBaseMeshProcessingTool

[UBaseMeshProcessingTool](API\Plugins\ModelingComponents\BaseTools\UBaseMeshProcessingTool) is a base Tool (ie has no functionality of it's own and must be subclassed) that provides the following structure:

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

USingleSelectionTool

UBaseMeshProcessingTool

	UOffsetMeshTool
	USmoothMeshTool

References

Module	ModelingComponents
Header	/Engine/Plugins/Experimental/MeshModelingToolset/Source/ModelingComponents/Public/BaseTools/BaseMeshProcessingTool.h
Include	#include "BaseTools/BaseMeshProcessingTool.h"

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)()
class UBaseMeshProcessingTool :
public USingleSelectionTool,
public IDynamicMeshOperatorFactory

Remarks

UBaseMeshProcessingTool is a base Tool (ie has no functionality of it's own and must be subclassed) that provides the following structure:

a Background-Compute-With-Preview Temp Actor/Component is created based on the input mesh
The Subclass provides FDynamicMeshOperator instances (via IDynamicMeshOperatorFactory) that process/modify and update this Preview
PropertySets with custom visibility can be registered, and on change will invalidate the current computation

Optional support for a WeightMap property set and tracking of active weight map can be enabled by calling AddWeightMapPropertySet(), GetActiveWeightMap() will then return the active WeightMap, and changes to the WeightMap selection will invalidate the computation.

Most subclasses will only need to define their PropertySets and implement MakeNewOperator(), see eg SmoothMeshTool for a minimal example

Other functions:

GetInitialMesh() : return reference to copy of initial mesh, used to initialize FDynamicMeshOperator
GetUPreviewMesh() : return the UPreviewMesh inside the background compute (for configuration/etc - should not directly touch the mesh!)
GetPreviewTransform() : return active FTransform on the Preview mesh, should be passed to FDynamicMeshOperator unless it is outputting world position
InvalidateResult() : subclasses call this to notify the base class that current result/computation has been invalidated

The Base tool will do various optional precomputations or changes to the input mesh, which can be configured by overriding various functions below.

RequiresInitialVtxNormals() : return true (default=false) to calculate per-vertex normals on the input mesh, returned by GetInitialVtxNormals()

RequiresInitialBoundaryLoops() : return true (default=false) to calculate boundary loops on the input mesh, returned by GetInitialBoundaryLoops()

RequiresScaleNormalization() : return true (default=true) to apply an initial scale to the input mesh so that it has consistent size before being sent into the computation. Scaling factor (eg for scaling UI constants) can be accessed via GetScaleNormalizationFactor()

Variables

	Name	Description
IToolsContextAs...	AssetAPI
TArray< FOption...	OptionalProperties
UMeshOpPreviewW...	Preview	Preview object holds temporary Actor with preview mesh component.
UWorld *	TargetWorld

Constructors

	Name	Description
	UBaseMeshProcessingTool()

Functions

	Name	Description
void	AddOptionalPropertySet ( UInteractiveToolPropertySet* P..., TUniqueFunction< bool()> Visibility..., TUniqueFunction< void()> OnModified..., bool bChangeInvalidatesResult )
PropSetType ...	AddOptionalPropertySet ( TUniqueFunction< bool()> Visibility..., TUniqueFunction< void()> OnModified..., bool bChangeInvalidatesResult )	Register an optional property set with the given VisibilityFunc, and call OnModifiedFunc if any of the properties change
PropSetType ...	AddOptionalPropertySet ( TUniqueFunction< bool()> Visibility..., bool bChangeInvalidatesResult )	Optional Property Set API - subclasses can use this to manage property sets with configurable visibility that invalidate the precompute Register an optional property set with the given VisibilityFunc
PropSetType ...	AddWeightMapPropertySet ( TUniqueFunction< bool()> Visibility... )	Optional weight map support Weight map will only be enabled if base class registers a weight map property set
FText	GetAcceptTransactionName()
TSharedPtr< ...	GetActiveWeightMap()
TSharedPtr< ...	GetInitialBoundaryLoops()
const FDynam...	GetInitialMesh()
FDynamicMesh...	GetInitialMesh()
TSharedPtr< ...	GetInitialVtxNormals()
const FTrans...	GetPreviewTransform()
double	GetScaleNormalizationFactor()
FText	GetToolMessageString()	UBaseMeshProcessingTool OPTIONAL API - subclasses may implement these functions
UPreviewMesh...	GetUPreviewMesh()
bool	HasActiveWeightMap()
bool	HasMeshTopologyChanged()	Called when Tool is Accepted to determine whether it is safe to only update vertex positions, or if entire target mesh must be replaced.
void	InitializeProperties()	This function is called during Setup() to allow subclass to register property sets, before kicking off initial computation
void	InvalidateResult()
void	OnOptionalPropSetModified ( int32 Index )
void	OnShutdown ( EToolShutdownType ShutdownType )	This function is called during ::Shutdown so that subclass may perform final processing and save property sets
bool	RequiresInitialBoundaryLoops()	Optional base mesh boundary loops.
bool	RequiresInitialVtxNormals()	Optional base mesh per-vertex normals.
bool	RequiresScaleNormalization()	Optional uniform scale applied to mesh.
void	SavePropertySets()
void	SetupWeightMapPropertySet ( UWeightMapSetProperties* Prope... )
void	SetWorld ( UWorld* World )
void	UpdateOptionalPropertyVisibility()	Call this function to update optional property sets visibility. Should call base implementation
void	UpdateResult()

Overridden from UInteractiveTool

	Name	Description
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	OnTick ( float DeltaTime )	Action support/system
void	Render ( IToolsContextRenderAPI* Render... )	Allow the Tool to do any custom drawing (ie via PDI/RHI)
void	Setup()	InteractiveTool API - generally does not need to be modified by subclasses
void	Shutdown ( EToolShutdownType ShutdownType )	Called by ToolManager to shut down the Tool

Overridden from IDynamicMeshOperatorFactory

		Name	Description
	TUniquePtr< ...	MakeNewOperator()	UBaseMeshProcessingTool REQUIRED API - subclasses must implement these functions IDynamicMeshOperatorFactory implementation that subclass must override and implement

Classes

	Name	Description
	FOptionalPropertySet

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss