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 > UBaseCreateFromSelectedTool

Light Theme

Dark Theme

UBaseCreateFromSelectedTool

[UBaseCreateFromSelectedTool](API\Plugins\ModelingComponents\BaseTools\UBaseCreateFromSelectedTool) is a base Tool (must be subclassed) that provides support for common functionality in tools that create a new mesh from a selection of one or more existing meshes

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveTool

UMultiSelectionTool

UBaseCreateFromSelectedTool

UBaseVoxelTool

	UVoxelBlendMeshesTool
	UVoxelMorphologyMeshesTool
	UVoxelSolidifyMeshesTool

UCSGMeshesTool

USelfUnionMeshesTool

References

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

Syntax

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

Remarks

UBaseCreateFromSelectedTool is a base Tool (must be subclassed) that provides support for common functionality in tools that create a new mesh from a selection of one or more existing meshes

Variables

		Name	Description
	IToolsContextAs...	AssetAPI
	UBaseCreateFrom...	HandleSourcesProperties
	UMeshOpPreviewW...	Preview
	UWorld *	TargetWorld
	TArray< UTransf...	TransformGizmos
	TArray< FVector...	TransformInitialScales
	UTransformInput...	TransformProperties
	TArray< UTransf...	TransformProxies

Constructors

	Name	Description
	UBaseCreateFromSelectedTool()

Functions

	Name	Description
void	ConvertInputsAndSetPreviewMaterials ( bool bSetPreviewMesh )	UBaseCreateFromSelectedTool API - subclasses typically implement these functions After preview is created, this is called to convert inputs and set preview materials (grouped together because materials may come from inputs) Subclasses should always implement this.
void	GenerateAsset ( const FDynamicMeshOpResult& Result )	Helper to generate assets when a result is accepted; typically does not need to be overloaded.
FText	GetActionName()	Return the name of the action to be used in the Undo stack
FString	GetCreatedAssetName()	Return the name to be used for generated assets.
TArray< UMat...	GetOutputMaterials()	Return the materials to be used on the output mesh on tool accept; defaults to the materials set on the preview
FString	PrefixWithSourceNameIfSingleSelection ( const FString& AssetName )	Helper to build asset names
void	SaveProperties()	Overload to save any added properties in the subclasses; called on shutdown
void	SetAssetAPI ( IToolsContextAssetAPI* AssetAP... )
void	SetPreviewCallbacks()	Optional overload to set callbacks on preview, e.g. to visualize results; called after preview is created.
void	SetTransformGizmos()
void	SetupProperties()	Overload to initialize any added properties in subclasses; called during setup
void	SetWorld ( UWorld* World )
void	TransformChanged ( UTransformProxy* Proxy, FTransform Transform )
void	UpdateAsset ( const FDynamicMeshOpResult& Result, TUniquePtr< FPrimitiveComponentTarg... )	Helper to generate assets when a result is accepted; typically does not need to be overloaded.
void	UpdateGizmoVisibility()	Helpers for managing transform gizoms; typically do not need to be overloaded.

Overridden from UInteractiveTool

	Name	Description
bool	CanAccept()
bool	HasAccept()
bool	HasCancel()
void	OnPropertyModified ( UObject* PropertySet, FProperty* Property )	Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes
void	OnTick ( float DeltaTime )	Action support/system
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()	IDynamicMeshOperatorFactory implementation that subclass must override and implement

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

Take our survey

Dismiss