1. Epic GamesDeveloper
  3. UFractureModalTool

UFractureModalTool

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

API > API/Plugins > API/Plugins/FractureEditor

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

   
Name UFractureModalTool
Type class
Header File /Engine/Plugins/Experimental/ChaosEditor/Source/FractureEditor/Public/FractureTool.h
Include Path #include "FractureTool.h"

Syntax

UCLASS (Abstract)  
class UFractureModalTool : public UFractureActionTool

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UFractureModalTool ( const FObjectInitializer& ObjInit
)

   FractureTool.h  

Typedefs

Name Type Remarks Include Path
OnToolPropertyInternallyModified TMulticastDelegate_OneParam< void, UObject * > OnPropertyModifiedDirectlyByTool is broadcast when a property is changed internally by the tool. FractureTool.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnPropertyModifiedDirectlyByTool OnToolPropertyInternallyModified   FractureTool.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void DrawHUD ( FEditorViewportClient* ViewportClient,
FViewport* Viewport,
const FSceneView* View,
FCanvas* Canvas
)

   FractureTool.h  

virtual int32 ExecuteFracture ( const FFractureToolContext& FractureContext
)

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

virtual bool ExecuteUpdatesShape()

   FractureTool.h  

virtual void FractureContextChanged()

   FractureTool.h  

virtual FText GetApplyText()

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

virtual TArray< UObject * > GetSettingsObjects()

   FractureTool.h  

virtual void NotifyOfPropertyChangeByTool ( UFractureToolSettings* PropertySet
) const

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

virtual void OnComponentTransformChanged ( UGeometryCollectionComponent* Component
)

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

virtual void OnTick ( float DeltaTime
)

   FractureTool.h  

virtual void PostFractureProcess ( const FFractureToolContext& FractureContext,
int32 FirstNewGeometryIndex
)

 Optional processing after a successful fracture (i.e., will not be called if ExecuteFracture returns INDEX_NONE) FractureTool.h  

virtual void Render ( const FSceneView* View,
FViewport* Viewport,
FPrimitiveDrawInterface* PDI
)

 Draw callback from edmode FractureTool.h  

virtual void SelectedBonesChanged()

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

virtual void Setup ( TWeakPtr< FFractureEditorModeToolkit > InToolkit
)

 Called when the modal tool is entered. FractureTool.h  

virtual void Shutdown()

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

Overridden from UFractureActionTool

Name Remarks Include Path Unreal Specifiers

virtual bool CanExecute()

   FractureTool.h  

virtual void Execute ( TWeakPtr< FFractureEditorModeToolkit > InToolkit
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   FractureTool.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   FractureTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual void ClearVisualizations()

   FractureTool.h  

void EnumerateVisualizationMapping ( const FVisualizationMappings& Mappings,
int32 ArrayNum,
TFunctionRef< void(int32 Idx, FVector ExplodedVector)> Func
) const

   FractureTool.h  

void OnComponentTransformChangedInternal ( USceneComponent* InRootComponent,
ETeleportType Teleport
)

   FractureTool.h  

void OverrideEditorViewFlagsForLineRendering()

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

void RestoreEditorViewFlags()

 Restore editor view flags. FractureTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page