Navigation
API > API/Plugins > API/Plugins/ModelingComponents
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
| Name | UBaseCreateFromSelectedTool |
| Type | class |
| Header File | /Engine/Plugins/Runtime/MeshModelingToolset/Source/ModelingComponents/Public/BaseTools/BaseCreateFromSelectedTool.h |
| Include Path | #include "BaseTools/BaseCreateFromSelectedTool.h" |
Syntax
UCLASS (MinimalAPI)
class UBaseCreateFromSelectedTool :
public UMultiSelectionMeshEditingTool ,
public UE::Geometry::IDynamicMeshOperatorFactory
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UInteractiveTool → UMultiSelectionTool → UMultiSelectionMeshEditingTool → UBaseCreateFromSelectedTool
Implements Interfaces
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UBaseCreateFromSelectedTool() |
BaseTools/BaseCreateFromSelectedTool.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FFrame3d | UE::Geometry::FFrame3d | BaseTools/BaseCreateFromSelectedTool.h |
Functions
Public
Overridden from UMultiSelectionMeshEditingTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void OnShutdown
(
EToolShutdownType ShutdownType |
BaseTools/BaseCreateFromSelectedTool.h |
Overridden from UInteractiveTool
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CanAccept() |
BaseTools/BaseCreateFromSelectedTool.h | ||
virtual bool HasAccept() |
BaseTools/BaseCreateFromSelectedTool.h | ||
virtual bool HasCancel() |
BaseTools/BaseCreateFromSelectedTool.h | ||
| BaseTools/BaseCreateFromSelectedTool.h | |||
virtual void OnTick
(
float DeltaTime |
BaseTools/BaseCreateFromSelectedTool.h | ||
virtual void Setup() |
InteractiveTool API - generally does not need to be modified by subclasses | BaseTools/BaseCreateFromSelectedTool.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual 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. | BaseTools/BaseCreateFromSelectedTool.h | |
virtual void GenerateAsset
(
const FDynamicMeshOpResult& Result |
Helper to generate assets when a result is accepted; typically does not need to be overloaded. | BaseTools/BaseCreateFromSelectedTool.h | |
virtual FText GetActionName() |
Return the name of the action to be used in the Undo stack | BaseTools/BaseCreateFromSelectedTool.h | |
virtual FString GetCreatedAssetName () |
Return the name to be used for generated assets. | BaseTools/BaseCreateFromSelectedTool.h | |
virtual int32 GetHiddenGizmoIndex() |
Which of the transform gizmos to hide, or -1 if all gizmos can be shown. | BaseTools/BaseCreateFromSelectedTool.h | |
virtual TArray< UMaterialInterface * > GetOutputMaterials() |
Return the materials to be used on the output mesh on tool accept; defaults to the materials set on the preview | BaseTools/BaseCreateFromSelectedTool.h | |
virtual bool KeepCollisionFrom
(
int32 TargetIndex |
Override this to control which inputs should transfer collision to the output (if collision transfer is enabled) | BaseTools/BaseCreateFromSelectedTool.h | |
| Helper to build asset names | BaseTools/BaseCreateFromSelectedTool.h | ||
virtual void SaveProperties() |
Overload to save any added properties in the subclasses; called on shutdown | BaseTools/BaseCreateFromSelectedTool.h | |
virtual void SetPreviewCallbacks() |
Optional overload to set callbacks on preview, e.g. to visualize results; called after preview is created. | BaseTools/BaseCreateFromSelectedTool.h | |
virtual void SetTransformGizmos() |
BaseTools/BaseCreateFromSelectedTool.h | ||
virtual void SetupProperties() |
Overload to initialize any added properties in subclasses; called during setup | BaseTools/BaseCreateFromSelectedTool.h | |
virtual bool SupportsCollisionTransfer() |
Override this to control whether the Transfer Collision setting is available. | BaseTools/BaseCreateFromSelectedTool.h | |
virtual void TransformChanged
(
UTransformProxy* Proxy, |
BaseTools/BaseCreateFromSelectedTool.h | ||
virtual void UpdateAsset
(
const FDynamicMeshOpResult& Result, |
Helper to generate assets when a result is accepted; typically does not need to be overloaded. | BaseTools/BaseCreateFromSelectedTool.h | |
virtual void UpdateGizmoVisibility() |
Helpers for managing transform gizoms; typically do not need to be overloaded. | BaseTools/BaseCreateFromSelectedTool.h |
Overridden from IDynamicMeshOperatorFactory
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TUniquePtr< UE::Geometry::FDynamicMeshOperator > MakeNewOperator() |
IDynamicMeshOperatorFactory implementation that subclass must override and implement | BaseTools/BaseCreateFromSelectedTool.h |