Navigation
API > API/Plugins > API/Plugins/ModelingComponents > API/Plugins/ModelingComponents/BaseTools
Inheritance Hierarchy
- UMultiSelectionMeshEditingTool
- IDynamicMeshOperatorFactory
- UBaseCreateFromSelectedTool
- UBaseVoxelTool
- UMergeMeshesTool
- UVoxelBlendMeshesTool
- UVoxelCSGMeshesTool
- UVoxelMorphologyMeshesTool
- UVoxelSolidifyMeshesTool
- UCSGMeshesTool
- UCutMeshWithMeshTool
- USelfUnionMeshesTool
References
| Module | ModelingComponents |
| Header | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/BaseTools/BaseCreateFromSelectedTool.h |
| Include | #include "BaseTools/BaseCreateFromSelectedTool.h" |
Syntax
UCLASS&40;&41;
class UBaseCreateFromSelectedTool :
public UMultiSelectionMeshEditingTool,
public UE::Geometry::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
| Type | Name | Description | |
|---|---|---|---|
  |
TObjectPtr< UBaseCreateFromSelectedHandleSourceProperties > | HandleSourcesProperties | |
  |
TObjectPtr< UCreateMeshObjectTypeProperties > | OutputTypeProperties | |
  |
TObjectPtr< UMeshOpPreviewWithBackgroundCompute > | Preview | |
  |
TArray< TObjectPtr< UCombinedTransformGizmo > > | TransformGizmos | |
  |
TObjectPtr< UTransformInputsToolProperties > | TransformProperties | |
  |
TArray< TObjectPtr< UTransformProxy > > | TransformProxies |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | 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 | Return the name of the action to be used in the Undo stack | |
   |
FString | Return the name to be used for generated assets. | |
   |
int32 | Which of the transform gizmos to hide, or -1 if all gizmos can be shown. | |
   |
TArray< UMaterialInterface * > | 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 | Overload to save any added properties in the subclasses; called on shutdown | |
  |
void | Optional overload to set callbacks on preview, e.g. to visualize results; called after preview is created. | |
  |
void | ||
  |
void | Overload to initialize any added properties in subclasses; called during setup | |
  |
void | TransformChanged
(
UTransformProxy* Proxy, |
|
  |
void | UpdateAsset
(
const FDynamicMeshOpResult& Result, |
Helper to generate assets when a result is accepted; typically does not need to be overloaded. |
  |
void | Helpers for managing transform gizoms; typically do not need to be overloaded. |
Overridden from UMultiSelectionMeshEditingTool
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnShutdown
(
EToolShutdownType ShutdownType |
Overridden from UInteractiveTool
| Type | Name | Description | |
|---|---|---|---|
   |
bool | CanAccept () |
|
   |
bool | HasAccept () |
|
   |
bool | HasCancel () |
|
  |
void | OnPropertyModified
(
UObject* PropertySet, |
Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes |
  |
void | OnTick
(
float DeltaTime |
Allow the Tool to do any necessary processing on Tick |
  |
void | Setup () |
InteractiveTool API - generally does not need to be modified by subclasses |
Overridden from IDynamicMeshOperatorFactory
| Type | Name | Description | |
|---|---|---|---|
  |
TUniquePtr< UE::Geometry::FDynamicMeshOperator > | IDynamicMeshOperatorFactory implementation that subclass must override and implement |
Typedefs
| Name | Description |
|---|---|
| FFrame3d |