UInteractiveToolPropertySet

A [UInteractiveTool](API\Runtime\InteractiveToolsFramework\UInteractiveTool) contains a set of UObjects that contain "properties" of the Tool, ie the configuration flags, parameters, etc that control the Tool.

Windows
MacOS
Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

UInteractiveToolPropertySet

UAcceptOutputProperties

UAddPatchToolProperties

UAlignObjectsToolProperties

UAttributeEditorToolProperties

UBakeTransformToolProperties

UBrushBaseProperties

UMeshTexturePaintingToolProperties

UMeshVertexPaintingToolProperties

UMeshColorPaintingToolProperties

UMeshWeightPaintingToolProperties

USculptBrushProperties

UBrushSculptProperties

UCombineMeshesToolProperties

UConvertToPolygonsToolProperties

UDeformMeshPolygonsTransformProperties

UDrawPolygonToolSnapProperties

UDrawPolygonToolStandardProperties

UDrawPolyPathExtrudeProperties

UDrawPolyPathProperties

UEditMeshMaterialsToolProperties

UEditMeshPolygonsToolActionPropertySet

UEditMeshPolygonsToolActions

UEditMeshPolygonsToolActions_Triangles

UEditMeshPolygonsToolEdgeActions

UEditMeshPolygonsToolEdgeActions_Triangles

UEditMeshPolygonsToolUVActions

UEditNormalsAdvancedProperties

UEditNormalsToolProperties

UEditPivotToolActionPropertySet

UEditPivotToolProperties

UExistingMeshMaterialProperties

UFixedPlaneBrushProperties

UMergeMeshesToolProperties

UMeshAnalysisProperties

UMeshConstraintProperties

URemeshProperties

UBrushRemeshProperties

URemeshMeshToolProperties

USimplifyMeshToolProperties

UMeshEditingViewProperties

UMeshInspectorProperties

UMeshSelectionToolActionPropertySet

UEditMeshMaterialsEditActions

UMeshSelectionEditActions

UMeshSelectionMeshEditActions

UMeshSelectionToolProperties

UMeshStatisticsProperties

UNewMeshMaterialProperties

UParameterizeMeshToolProperties

UPlaneBrushProperties

UPlaneCutToolProperties

UPolyEditCutProperties

UPolyEditExtrudeProperties

UPolyEditSetUVProperties

UPolyEditTransformProperties

UPolygonOnMeshToolActionPropertySet

UPolygonOnMeshToolProperties

UPolygonSelectionMechanicProperties

UProceduralShapeToolProperties

URemoveOccludedTrianglesAdvancedProperties

URemoveOccludedTrianglesToolProperties

USculptMaxBrushProperties

UShapeSprayToolProperties

UTransformMeshesToolProperties

UUVLayoutAdvancedProperties

UUVLayoutToolProperties

UUVProjectionAdvancedProperties

UUVProjectionToolProperties

UVoxelCSGMeshesToolProperties

References

Module

InteractiveToolsFramework

Header

/Engine/Source/Runtime/Experimental/InteractiveToolsFramework/Public/InteractiveTool.h

Include

#include "InteractiveTool.h"

Syntax

class UInteractiveToolPropertySet : public UObject

Remarks

A UInteractiveTool contains a set of UObjects that contain "properties" of the Tool, ie the configuration flags, parameters, etc that control the Tool. Currently any UObject can be added as a property set, however there is no automatic mechanism for those child UObjects to notify the Tool when a property changes.

If you make your property set UObjects subclasses of UInteractiveToolPropertySet, then when the Tool Properties are changed in the Editor, the parent Tool will be automatically notified. You can override UInteractiveTool::OnPropertyModified() to act on these notifications

Variables

Name Description

Protected variable

FInteractiveToo...

 

OnModified

Functions

Name Description

Public function

FInteractive...

 

GetOnModified()

Protected function

ObjType *...

 

GetPropertyCache()

GetPropertyCache returns a class-internal object that subclasses can use to save/restore properties.

Public function Const

bool

 

IsPropertySetEnabled()

Return true if this property set is enabled.

Public function Virtual

void

 

RestoreProperties

(
    UInteractiveTool* RestoreToToo...
)

Restore saved property values

Public function Virtual

void

 

SaveProperties

(
    UInteractiveTool* SaveFromTool
)

Setting saving/serialization Save values of current Tool Properties.

Protected function Virtual

void

 

SaveRestoreProperties

(
    UInteractiveTool* RestoreToToo...,
    bool bSaving
)

Subclass this to save and restore in a single function.

Protected function

void

 

SaveRestoreProperty

(
    T& CacheValue,
    T& PropsValue,
    bool bSaving
)

Call this from SaveRestoreProperties to either save or restore a given property value

Overridden from UObject

Name Description

Public function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Posts a message to the OnModified delegate with the modified FProperty

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss