UCSGMeshesTool

Simple Mesh Plane Cutting Tool

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

MeshModelingTools

Header

/Engine/Plugins/Runtime/MeshModelingToolset/Source/MeshModelingTools/Public/CSGMeshesTool.h

Include

#include "CSGMeshesTool.h"

Syntax

UCLASS()
class UCSGMeshesTool : public UBaseCreateFromSelectedTool

Remarks

Simple Mesh Plane Cutting Tool

Variables

Name Description

Protected variable

bool

 

bTrimMode

Protected variable

TArray< int >

 

CreatedBoundaryEdges

For visualization of any errors in the currently-previewed CSG operation

Protected variable UProperty

TObjectPtr< UCS...

 

CSGProperties

Protected variable UProperty

TObjectPtr< ULi...

 

DrawnLineSet

Protected variable

TArray< TShared...

 

OriginalDynamicMeshes

Protected variable UProperty

TArray< TObject...

 

OriginalMeshPreviews

Protected variable UProperty

TObjectPtr< UMa...

 

PreviewsGhostMaterial

Material used to show the otherwise-invisible cutting/trimming mesh.

Protected variable UProperty

TObjectPtr< UTr...

 

TrimProperties

Constructors

Name Description

Public function

UCSGMeshesTool()

Functions

Name Description

Public function

void

 

EnableTrimMode()

Protected function

void

 

UpdatePreviewsMaterial()

Update the material of ghostly preview meshes (used to show trimming or subtracting surface)

Protected function

void

 

UpdatePreviewsVisibility()

Update visibility of ghostly preview meshes (used to show trimming or subtracting surface)

Protected function

void

 

UpdateVisualization()

Overridden from UBaseCreateFromSelectedTool

Name Description

Protected function 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.

Protected function Virtual Const

FText

 

GetActionName()

Return the name of the action to be used in the Undo stack

Protected function Virtual Const

FString

 

GetCreatedAssetName()

Return the name to be used for generated assets.

Protected function Virtual Const

int32

 

GetHiddenGizmoIndex()

Which of the transform gizmos to hide, or -1 if all gizmos can be shown.

Protected function Virtual

void

 

SaveProperties()

Overload to save any added properties in the subclasses; called on shutdown

Protected function Virtual

void

 

SetPreviewCallbacks()

Optional overload to set callbacks on preview, e.g. to visualize results; called after preview is created.

Protected function Virtual

void

 

SetupProperties()

Overload to initialize any added properties in subclasses; called during setup

Overridden from UInteractiveTool

Name Description

Protected function Virtual

void

 

OnPropertyModified

(
    UObject* PropertySet,
    FProperty* Property
)

Automatically called by UInteractiveToolPropertySet.OnModified delegate to notify Tool of child property set changes

Protected function Virtual

void

 

Shutdown

(
    EToolShutdownType ShutdownType
)

Called by ToolManager to shut down the Tool

Overridden from IDynamicMeshOperatorFactory

Name Description

Protected function Virtual

TUniquePtr< ...

 

MakeNewOperator()

IDynamicMeshOperatorFactory API.