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

Inheritance Hierarchy

References

   
Module InteractiveToolsFramework
Header /Engine/Source/Runtime/InteractiveToolsFramework/Public/InteractiveTool.h
Include #include "InteractiveTool.h"

Syntax

UCLASS (Transient, MinimalAPI)  
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

  Type Name Description
Protected variable UProperty Meta Transient duplicatetransient, skipserialization bool bIsPropertySetEnabled Controls whether a property set is shown in the UI. Transient so that disabling a PropertySet in one tool doesn't disable it in others.
Protected variable UProperty Transient duplicatetransient, nontransactional, skipserialization TMap< FString, TObjectPtr< UInteractiveToolPropertySet > > CachedPropertiesMap  
Protected variable FInteractiveToolPropertySetModifiedSignature OnModified  

Functions

  Type Name Description
Protected function TObjectPtr< UInteractiveToolPropertySet >

GetDynamicPropertyCache ( const FString& CacheIdentifier,
bool& bWasCreatedOut
)

 GetDynamicPropertyCache return class-internal objects that subclasses can use to save/restore properties.
Public function FInteractiveToolPropertySetModifiedSignature &  
Public function Const bool Return true if this property set is enabled.
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Posts a message to the OnModified delegate with the modified FProperty
Public function Virtual void

RestoreProperties ( UInteractiveTool* RestoreToTool,
const FString& CacheIdentifier
)

 Restore the values of the Property Set with the given CacheIdentifier.
Public function Virtual void

SaveProperties ( UInteractiveTool* SaveFromTool,
const FString& CacheIdentifier
)

 Setting saving/serialization Save and restore values of current Tool Properties between tool invocations.
Protected function Virtual void

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

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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page