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

UAttributeEditorActionPropertySet

UAttributeEditorCopyAttributeActions

UAttributeEditorModifyAttributeActions

UAttributeEditorNewAttributeActions

UAttributeEditorNormalsActions

UAttributeEditorUVActions

UAttributeEditorAttribProperties

UBakedCurvatureMapToolProperties

UBakedNormalMapToolProperties

UBakedOcclusionMapToolProperties

UBakedOcclusionMapVisualizationProperties

UBakedTexture2DImageProperties

UBakeMeshAttributeMapsToolProperties

UBakeTransformToolProperties

UBrushBaseProperties

UMeshTexturePaintingToolProperties

UMeshVertexPaintingToolProperties

UMeshColorPaintingToolProperties

UMeshWeightPaintingToolProperties

USculptBrushProperties

UBrushSculptProperties

UBspConversionToolActionPropertySet

UBspConversionToolProperties

UCollisionGeometryVisualizationProperties

UCombineMeshesToolProperties

UConvertToPolygonsToolProperties

UCSGMeshesToolProperties

UDeformMeshPolygonsTransformProperties

UDiffusionSmoothProperties

UDisplaceMeshCommonProperties

UDisplaceMeshDirectionalFilterProperties

UDisplaceMeshPerlinNoiseProperties

UDisplaceMeshSineWaveProperties

UDisplaceMeshTextureMapProperties

UDrawPolygonToolSnapProperties

UDrawPolygonToolStandardProperties

UDrawPolyPathExtrudeProperties

UDrawPolyPathProperties

UDynamicSculptToolActions

UEdgeLoopInsertionProperties

UEditGroomCardsToolActionPropertySet

UEditGroomCardsToolActions

USelectGroomCardsToolActions

UEditMeshMaterialsToolProperties

UEditMeshPolygonsToolActionPropertySet

UEditMeshPolygonsToolActions

UEditMeshPolygonsToolActions_Triangles

UEditMeshPolygonsToolEdgeActions

UEditMeshPolygonsToolEdgeActions_Triangles

UEditMeshPolygonsToolUVActions

UEditNormalsAdvancedProperties

UEditNormalsToolProperties

UEditPivotToolActionPropertySet

UEditPivotToolProperties

UExistingMeshMaterialProperties

UFixedPlaneBrushProperties

UGroomCardsInfoToolProperties

UGroomToMeshToolProperties

UGroupEdgeInsertionProperties

UHoleFillStatisticsProperties

UHoleFillToolActions

UHoleFillToolProperties

UImplicitOffsetProperties

UImplicitSmoothProperties

UIterativeOffsetProperties

UIterativeSmoothProperties

UKelvinBrushProperties

UMergeMeshesToolProperties

UMeshAnalysisProperties

UMeshAttributePaintEditActions

UMeshAttributePaintToolProperties

UMeshConstraintProperties

UGenerateLODMeshesToolProperties

URemeshProperties

UBrushRemeshProperties

URemeshMeshToolProperties

UProjectToTargetToolProperties

USimplifyMeshToolProperties

UMeshEditingViewProperties

UMeshInspectorProperties

UMeshSculptBrushOpProps

UBasePlaneBrushOpProps

UFixedPlaneBrushOpProps

UPlaneBrushOpProps

UViewAlignedPlaneBrushOpProps

UBaseSmoothBrushOpProps

USecondarySmoothBrushOpProps

USmoothBrushOpProps

USmoothFillBrushOpProps

UEraseBrushOpProps

UFlattenBrushOpProps

UInflateBrushOpProps

UMoveBrushOpProps

UPinchBrushOpProps

USculptMaxBrushOpProps

UStandardSculptBrushOpProps

UViewAlignedSculptBrushOpProps

UMeshSelectionToolActionPropertySet

UEditMeshMaterialsEditActions

UMeshSelectionEditActions

UMeshSelectionMeshEditActions

UMeshSelectionToolProperties

UMeshStatisticsProperties

UMeshTangentsToolProperties

UMeshToVolumeToolProperties

UMirrorToolActionPropertySet

UMirrorToolProperties

UNewMeshMaterialProperties

UOffsetMeshToolProperties

UOnAcceptHandleSourcesProperties

UBaseCreateFromSelectedHandleSourceProperties

UParameterizeMeshToolProperties

UPhysicsObjectToolPropertySet

UPlaneCutToolProperties

UPolyEditCommonProperties

UPolyEditCutProperties

UPolyEditExtrudeProperties

UPolyEditInsetProperties

UPolyEditOffsetProperties

UPolyEditOutsetProperties

UPolyEditSetUVProperties

UPolygonOnMeshToolActionPropertySet

UPolygonOnMeshToolProperties

UPolygonSelectionMechanicProperties

UProceduralShapeToolProperties

UProceduralArrowToolProperties

UProceduralConeToolProperties

UProceduralCylinderToolProperties

UProceduralDiscToolProperties

UProceduralPuncturedDiscToolProperties

UProceduralRectangleToolProperties

UProceduralBoxToolProperties

UProceduralRoundedRectangleToolProperties

UProceduralSphereToolProperties

UProceduralSphericalBoxToolProperties

UProceduralTorusToolProperties

URemoveOccludedTrianglesAdvancedProperties

URemoveOccludedTrianglesToolProperties

URevolveProperties

URevolveBoundaryToolProperties

URevolveToolProperties

USculptMaxBrushProperties

USeamSculptToolProperties

USelfUnionMeshesToolProperties

USetCollisionGeometryToolProperties

UShapeSprayToolProperties

USmoothHoleFillProperties

USmoothMeshToolProperties

USpaceCurveDeformationMechanicPropertySet

UTransformInputsToolProperties

UTransformMeshesToolProperties

UUVLayoutPreviewProperties

UUVLayoutToolProperties

UUVProjectionAdvancedProperties

UUVProjectionToolProperties

UVertexBrushSculptProperties

UVolumeToMeshToolProperties

UVoxelBlendMeshesToolProperties

UVoxelCSGMeshesToolProperties

UVoxelMorphologyMeshesToolProperties

UVoxelProperties

UVoxelSolidifyMeshesToolProperties

UWeightMapSetProperties

UOffsetWeightMapSetProperties

USmoothWeightMapSetProperties

UWorkPlaneProperties

References

Module

InteractiveToolsFramework

Header

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

Include

#include "InteractiveTool.h"

Syntax

class UInteractiveToolPropertySet :
    public UObject,
    public FWatchablePropertySet

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

bool

 

bIsPropertySetEnabled

Protected variable

UInteractiveToo...

 

CachedProperties

CachedProperties should only ever be set to an instance of the subclass, ideally via GetPropertyCache().

Protected variable

FInteractiveToo...

 

OnModified

Functions

Name Description

Protected function

UInteractive...

 

GetDynamicPropertyCache()

Public function

FInteractive...

 

GetOnModified()

Protected function Static

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...
)

Public function Virtual

void

 

SaveProperties

(
    UInteractiveTool* SaveFromTool
)

Setting saving/serialization Save and restore values of current Tool Properties between tool invocations

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