Navigation
API > API/Plugins > API/Plugins/FractureEditor
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&40;Abstract&41;
class UFractureModalTool : public UFractureActionTool
Remarks
Tools derived from this class provide parameter details and operate modally.
Variables
| Type | Name | Description | |
|---|---|---|---|
| OnToolPropertyInternallyModified | OnPropertyModifiedDirectlyByTool | ||
| TArray< TObjectPtr< UGeometryCollectionComponent > > | VisualizedCollections | Geometry collection components referenced by visualizations. |
Constructors
| Type | Name | Description | |
|---|---|---|---|
UFractureModalTool
(
const FObjectInitializer& ObjInit |
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | |||
| void | DrawHUD
(
FEditorViewportClient* ViewportClient, |
||
| void | EnumerateVisualizationMapping
(
const FVisualizationMappings& Mappings, |
||
| int32 | ExecuteFracture
(
const FFractureToolContext& FractureContext |
Executes function that generates new geometry. Returns the first new geometry index. | |
| bool | |||
| void | |||
| FText | GetApplyText () |
This is the Text that will appear on the button to execute the fracture | |
| TArray< UObject * > | |||
| void | NotifyOfPropertyChangeByTool
(
UFractureToolSettings* PropertySet |
Call after changing properties internally in the tool to allow external views of the property to update properly. | |
| void | OnComponentTransformChanged
(
UGeometryCollectionComponent* Component |
Called when a selected geometry collection component is moved in the scene. | |
| void | OnComponentTransformChangedInternal
(
USceneComponent* InRootComponent, |
||
| void | OnTick
(
float DeltaTime |
||
| void | Call to override editor view flags to disable temporal AA and motion blur, which make the lines look bad. | ||
| void | PostFractureProcess
(
const FFractureToolContext& FractureContext, |
Optional processing after a successful fracture (i.e., will not be called if ExecuteFracture returns INDEX_NONE) | |
| void | Render
(
const FSceneView* View, |
Draw callback from edmode | |
| void | Restore editor view flags. | ||
| void | Called when the selection changes, and when the modal tool is entered. | ||
| void | Setup
(
TWeakPtr< FFractureEditorModeToolkit > InToolkit |
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
| Type | Name | Description | |
|---|---|---|---|
| bool | CanExecute () |
||
| void | Execute
(
TWeakPtr< FFractureEditorModeToolkit > InToolkit |
Executes the command. Derived types need to be implemented in a thread safe way |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | PostEditChangeChainProperty
(
FPropertyChangedChainEvent& PropertyChangedEvent |
This alternate version of PostEditChange is called when properties inside structs are modified. | |
| void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
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. |