UFractureModalTool

Tools derived from this class provide parameter details and operate modally.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

FractureEditor

Header

/Engine/Plugins/Experimental/ChaosEditor/Source/FractureEditor/Public/FractureTool.h

Include

#include "FractureTool.h"

Syntax

UCLASS(Abstract)
class UFractureModalTool : public UFractureActionTool

Remarks

Tools derived from this class provide parameter details and operate modally.

Variables

Name Description

Public variable

OnToolPropertyI...

 

OnPropertyModifiedDirectlyByTool

Protected variable UProperty

TArray< TObject...

 

VisualizedCollections

Geometry collection components referenced by visualizations.

Constructors

Name Description

Public function

UFractureModalTool

(
    const FObjectInitializer& ObjInit
)

Functions

Name Description

Protected function Virtual

void

 

ClearVisualizations()

Public function Virtual

void

 

DrawHUD

(
    FEditorViewportClient* Viewpor...,
    FViewport* Viewport,
    const FSceneView* View,
    FCanvas* Canvas
)

Protected function Const

void

 

EnumerateVisualizationMapping

(
    const FVisualizationMappings& Mapp...,
    int32 ArrayNum,
    TFunctionRef< void Idx, FVect...
)

Public function Virtual

int32

 

ExecuteFracture

(
    const FFractureToolContext& Fractu...
)

Executes function that generates new geometry. Returns the first new geometry index.

Public function Virtual

void

 

FractureContextChanged()

Public function Virtual Const

FText

 

GetApplyText()

This is the Text that will appear on the button to execute the fracture

Public function Virtual Const

TArray< UObj...

 

GetSettingsObjects()

Public function Virtual Const

void

 

NotifyOfPropertyChangeByTool

(
    UFractureToolSettings* Propert...
)

Call after changing properties internally in the tool to allow external views of the property to update properly.

Public function Virtual

void

 

OnComponentTransformChanged

Called when a selected geometry collection component is moved in the scene.

Protected function

void

 

OnComponentTransformChangedInternal

(
    USceneComponent* InRootCompone...,
    ETeleportType Teleport
)

Protected function

void

 

OverrideEditorViewFlagsForLineRendering()

Call to override editor view flags to disable temporal AA and motion blur, which make the lines look bad.

Public function Virtual

void

 

Render

(
    const FSceneView* View,
    FViewport* Viewport,
    FPrimitiveDrawInterface* PDI
)

Draw callback from edmode

Protected function

void

 

RestoreEditorViewFlags()

Restore editor view flags.

Public function Virtual

void

 

SelectedBonesChanged()

Called when the selection changes, and when the modal tool is entered.

Public function Virtual

void

 

Setup()

Called when the modal tool is entered.

Public function Virtual

void

 

Shutdown()

Called when the modal tool is exited (on switching to a new modal tool or exiting the fracture editor mode)

Overridden from UFractureActionTool

Name Description

Public function Virtual Const

bool

 

CanExecute()

Public function Virtual

void

 

Execute

Executes the command. Derived types need to be implemented in a thread safe way

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeChainProperty

(
    FPropertyChangedChainEvent& Proper...
)

This alternate version of PostEditChange is called when properties inside structs are modified.

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally

Typedefs

Name

Description

OnToolPropertyInternallyModified

OnPropertyModifiedDirectlyByTool is broadcast when a property is changed internally by the tool.