1. Epic GamesDeveloper
  3. UInteractiveToolPropertySet

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.

API > API/Runtime > API/Runtime/InteractiveToolsFramework

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

   
Name UInteractiveToolPropertySet
Type class
Header File /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveTool.h
Include Path #include "InteractiveTool.h"

Syntax

UCLASS (Transient, MinimalAPI)  
class UInteractiveToolPropertySet :  
    public UObject ,  
    public FWatchablePropertySet

Inheritance Hierarchy

Derived Classes

UInteractiveToolPropertySet derived class hierarchy

Functions

Public

Name Remarks Include Path Unreal Specifiers

FInteractiveToolPropertySetModifiedSignature & GetOnModified()

   InteractiveTool.h  
Return true if this property set is enabled. InteractiveTool.h  

virtual void RestoreProperties ( UInteractiveTool* RestoreToTool,
const FString& CacheIdentifier
)

 Restore the values of the Property Set with the given CacheIdentifier. InteractiveTool.h  

virtual void SaveProperties ( UInteractiveTool* SaveFromTool,
const FString& CacheIdentifier
)

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

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Posts a message to the OnModified delegate with the modified FProperty InteractiveTool.h  

Protected

Name Remarks Include Path Unreal Specifiers

TObjectPtr< UInteractiveToolPropertySet > GetDynamicPropertyCache ( const FString& CacheIdentifier,
bool& bWasCreatedOut
)

 GetDynamicPropertyCache return class-internal objects that subclasses can use to save/restore properties. InteractiveTool.h  

virtual void SaveRestoreProperties ( UInteractiveTool* RestoreToTool,
const FString& CacheIdentifier,
bool bSaving
)

 Utility func used to implement the default Save/RestoreProperties funcs. InteractiveTool.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page