UFractureModalTool

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

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UFractureActionTool

UFractureModalTool

UFractureInteractiveTool

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
	OnToolPropertyI...	OnPropertyModifiedDirectlyByTool
	TArray< TObject...	VisualizedCollections	Geometry collection components referenced by visualizations.

Constructors

	Name	Description
	UFractureModalTool ( const FObjectInitializer& ObjInit )

Functions

	Name	Description
void	ClearVisualizations()
void	DrawHUD ( FEditorViewportClient* Viewpor..., FViewport* Viewport, const FSceneView* View, FCanvas* Canvas )
void	EnumerateVisualizationMapping ( const FVisualizationMappings& Mapp..., int32 ArrayNum, TFunctionRef< void Idx, FVect... )
int32	ExecuteFracture ( const FFractureToolContext& Fractu... )	Executes function that generates new geometry. Returns the first new geometry index.
void	FractureContextChanged()
FText	GetApplyText()	This is the Text that will appear on the button to execute the fracture
TArray< UObj...	GetSettingsObjects()
void	NotifyOfPropertyChangeByTool ( UFractureToolSettings* Propert... )	Call after changing properties internally in the tool to allow external views of the property to update properly.
void	OnComponentTransformChanged ( UGeometryCollectionComponent* ... )	Called when a selected geometry collection component is moved in the scene.
void	OnComponentTransformChangedInternal ( USceneComponent* InRootCompone..., ETeleportType Teleport )
void	OverrideEditorViewFlagsForLineRendering()	Call to override editor view flags to disable temporal AA and motion blur, which make the lines look bad.
void	Render ( const FSceneView* View, FViewport* Viewport, FPrimitiveDrawInterface* PDI )	Draw callback from edmode
void	RestoreEditorViewFlags()	Restore editor view flags.
void	SelectedBonesChanged()	Called when the selection changes, and when the modal tool is entered.
void	Setup()	Called when the modal tool is entered.
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
	bool	CanExecute()
	void	Execute ( TWeakPtr< FFractureEditorModeToolki... )	Executes the command. Derived types need to be implemented in a thread safe way

Overridden from UObject

		Name	Description
	void	PostEditChangeChainProperty ( FPropertyChangedChainEvent& Proper... )	This alternate version of PostEditChange is called when properties inside structs are modified.
	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.