Navigation
API > API/Plugins > API/Plugins/MeshModelingTools
Inheritance Hierarchy
- UMultiSelectionMeshEditingTool
- IDynamicMeshOperatorFactory
- UBaseCreateFromSelectedTool
- UCSGMeshesTool
References
| Module | MeshModelingTools |
| Header | /Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/CSGMeshesTool.h |
| Include | #include "CSGMeshesTool.h" |
Syntax
UCLASS&40;&41;
class UCSGMeshesTool : public UBaseCreateFromSelectedTool
Remarks
Simple Mesh Plane Cutting Tool
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
bool | bTrimMode | |
 |
TArray< int > | CreatedBoundaryEdges | For visualization of any errors in the currently-previewed CSG operation |
  |
TObjectPtr< UCSGMeshesToolProperties > | CSGProperties | |
  |
TObjectPtr< ULineSetComponent > | DrawnLineSet | |
 |
TArray< TSharedPtr< FDynamicMesh3, ESPMode::ThreadSafe > > | OriginalDynamicMeshes | |
  |
TArray< TObjectPtr< UPreviewMesh > > | OriginalMeshPreviews | |
  |
TObjectPtr< UMaterialInstanceDynamic > | PreviewsGhostMaterial | Material used to show the otherwise-invisible cutting/trimming mesh. |
  |
TObjectPtr< UTrimMeshesToolProperties > | TrimProperties |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
Functions
| Type | Name | Description | |
|---|---|---|---|
 |
void | ||
 |
void | Update the material of ghostly preview meshes (used to show trimming or subtracting surface) | |
 |
void | Update visibility of ghostly preview meshes (used to show trimming or subtracting surface) | |
 |
void |
Overridden from UBaseCreateFromSelectedTool
| 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. |
   |
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. | |
  |
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 | Overload to initialize any added properties in subclasses; called during setup |
Overridden from UMultiSelectionMeshEditingTool
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnShutdown
(
EToolShutdownType ShutdownType |
Overridden from UInteractiveTool
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnPropertyModified
(
UObject* PropertySet, |
Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes |
Overridden from IDynamicMeshOperatorFactory
| Type | Name | Description | |
|---|---|---|---|
  |
TUniquePtr< UE::Geometry::FDynamicMeshOperator > | IDynamicMeshOperatorFactory API. |