Files
UnrealEngineUWP/Engine/Source/Editor/PropertyEditor/Private/PropertyNode.cpp

3521 lines
110 KiB
C++
Raw Normal View History

// Copyright Epic Games, Inc. All Rights Reserved.
#include "PropertyNode.h"
#include "Misc/ConfigCacheIni.h"
#include "Serialization/ArchiveReplaceObjectRef.h"
#include "Components/ActorComponent.h"
#include "Containers/Deque.h"
#include "Editor/UnrealEdEngine.h"
#include "Engine/UserDefinedStruct.h"
#include "EditConditionContext.h"
#include "UnrealEdGlobals.h"
#include "ScopedTransaction.h"
#include "PropertyRestriction.h"
#include "Kismet2/StructureEditorUtils.h"
#include "Kismet2/BlueprintEditorUtils.h"
#include "Misc/ScopeExit.h"
#include "Editor.h"
#include "ObjectPropertyNode.h"
#include "PropertyHandleImpl.h"
#include "PropertyTextUtilities.h"
#include "EditorSupportDelegates.h"
#include "UObject/ConstructorHelpers.h"
#include "InstancedReferenceSubobjectHelper.h"
#include "Framework/Notifications/NotificationManager.h"
#include "Widgets/Notifications/SNotificationList.h"
#include "UObject/MetaData.h"
#include "UObject/TextProperty.h"
#include "UObject/EnumProperty.h"
#include "UObject/UnrealType.h"
#define LOCTEXT_NAMESPACE "PropertyNode"
FEditConditionParser FPropertyNode::EditConditionParser;
FPropertySettings& FPropertySettings::Get()
{
static FPropertySettings Settings;
return Settings;
}
FPropertySettings::FPropertySettings()
: bShowFriendlyPropertyNames( true )
, bExpandDistributions( false )
, bShowHiddenProperties(false)
{
GConfig->GetBool(TEXT("PropertySettings"), TEXT("ShowHiddenProperties"), bShowHiddenProperties, GEditorPerProjectIni);
GConfig->GetBool(TEXT("PropertySettings"), TEXT("ShowFriendlyPropertyNames"), bShowFriendlyPropertyNames, GEditorPerProjectIni);
GConfig->GetBool(TEXT("PropertySettings"), TEXT("ExpandDistributions"), bExpandDistributions, GEditorPerProjectIni);
}
DEFINE_LOG_CATEGORY(LogPropertyNode);
static FObjectPropertyNode* NotifyFindObjectItemParent(FPropertyNode* InNode)
{
FObjectPropertyNode* Result = NULL;
check(InNode);
FPropertyNode* ParentNode = InNode->GetParentNode();
if (ParentNode)
{
Result = ParentNode->FindObjectItemParent();
}
return Result;
}
FPropertyNode::FPropertyNode(void)
: ParentNode(NULL)
, Property(NULL)
, ArrayOffset(0)
, ArrayIndex(-1)
, MaxChildDepthAllowed(FPropertyNodeConstants::NoDepthRestrictions)
, PropertyNodeFlags (EPropertyNodeFlags::NoFlags)
, bRebuildChildrenRequested( false )
, bChildrenRebuilt(false)
, PropertyPath(TEXT(""))
, bIsEditConst(false)
, bUpdateEditConstState(true)
, bDiffersFromDefault(false)
, bUpdateDiffersFromDefault(true)
{
}
FPropertyNode::~FPropertyNode(void)
{
DestroyTree();
}
void FPropertyNode::InitNode(const FPropertyNodeInitParams& InitParams)
{
//Dismantle the previous tree
DestroyTree();
//tree hierarchy
check(InitParams.ParentNode.Get() != this);
ParentNode = InitParams.ParentNode.Get();
ParentNodeWeakPtr = InitParams.ParentNode;
//Property Data
Property = InitParams.Property;
ArrayOffset = InitParams.ArrayOffset;
ArrayIndex = InitParams.ArrayIndex;
bool bIsSparse = InitParams.IsSparseProperty == FPropertyNodeInitParams::EIsSparseDataProperty::True;
if (ParentNode && InitParams.IsSparseProperty == FPropertyNodeInitParams::EIsSparseDataProperty::Inherit)
{
//default to parents max child depth
MaxChildDepthAllowed = ParentNode->MaxChildDepthAllowed;
//if limitless or has hit the full limit
if (MaxChildDepthAllowed > 0)
{
--MaxChildDepthAllowed;
}
// if the parent node's property is sparse data, our property must be too
bIsSparse = bIsSparse || ParentNode->HasNodeFlags(EPropertyNodeFlags::IsSparseClassData);
}
// Property is advanced if it is marked advanced or the entire class is advanced and the property not marked as simple
static const FName Name_AdvancedClassDisplay("AdvancedClassDisplay");
bool bAdvanced = Property.IsValid() ? ( Property->HasAnyPropertyFlags(CPF_AdvancedDisplay) || ( !Property->HasAnyPropertyFlags( CPF_SimpleDisplay ) && Property->GetOwnerClass() && Property->GetOwnerClass()->GetBoolMetaData(Name_AdvancedClassDisplay) ) ) : false;
PropertyNodeFlags = EPropertyNodeFlags::NoFlags;
SetNodeFlags(EPropertyNodeFlags::IsSparseClassData, bIsSparse);
static const FName Name_ShouldShowInViewport("ShouldShowInViewport");
bool bShouldShowInViewport = Property.IsValid() ? Property->GetBoolMetaData(Name_ShouldShowInViewport) : false;
SetNodeFlags(EPropertyNodeFlags::ShouldShowInViewport, bShouldShowInViewport);
//default to copying from the parent
if (ParentNode)
{
if (ParentNode->HasNodeFlags(EPropertyNodeFlags::ShowCategories))
{
SetNodeFlags(EPropertyNodeFlags::ShowCategories, true);
}
else
{
SetNodeFlags(EPropertyNodeFlags::ShowCategories, false);
}
// We are advanced if our parent is advanced or our property is marked as advanced
SetNodeFlags(EPropertyNodeFlags::IsAdvanced, ParentNode->HasNodeFlags(EPropertyNodeFlags::IsAdvanced) || bAdvanced );
}
else
{
SetNodeFlags(EPropertyNodeFlags::ShowCategories, InitParams.bCreateCategoryNodes );
}
SetNodeFlags(EPropertyNodeFlags::ShouldShowHiddenProperties, InitParams.bForceHiddenPropertyVisibility);
SetNodeFlags(EPropertyNodeFlags::ShouldShowDisableEditOnInstance, InitParams.bCreateDisableEditOnInstanceNodes);
//Custom code run prior to setting property flags
//needs to happen after the above SetNodeFlags calls so that ObjectPropertyNode can properly respond to CollapseCategories
InitBeforeNodeFlags();
bool bIsEditInlineNew = false;
bool bShowInnerObjectProperties = false;
const FProperty* MyProperty = Property.Get();
if (MyProperty == nullptr)
{
// Disable all flags if no property is bound.
SetNodeFlags(EPropertyNodeFlags::SingleSelectOnly | EPropertyNodeFlags::EditInlineNew | EPropertyNodeFlags::ShowInnerObjectProperties, false);
}
else
{
const bool GotReadAddresses = GetReadAddressUncached( *this, false, nullptr, false );
const bool bSingleSelectOnly = GetReadAddressUncached( *this, true, nullptr);
SetNodeFlags(EPropertyNodeFlags::SingleSelectOnly, bSingleSelectOnly);
const FProperty* OwnerProperty = MyProperty->GetOwnerProperty();
const bool bIsObjectOrInterface = CastField<FObjectPropertyBase>(MyProperty) || CastField<FInterfaceProperty>(MyProperty);
bool bIsInsideContainer = CastField<FArrayProperty>(OwnerProperty) || CastField<FSetProperty>(OwnerProperty) || CastField<FMapProperty>(OwnerProperty);
// Don't consider the container's inline status if the key is a class property that is not inline
if (const FMapProperty* MapProperty = CastField<FMapProperty>(OwnerProperty))
{
const FObjectPropertyBase* KeyObjectProperty = CastField<FObjectPropertyBase>(MapProperty->GetKeyProperty());
if (KeyObjectProperty && KeyObjectProperty->PropertyClass && !KeyObjectProperty->PropertyClass->HasAnyClassFlags(EClassFlags::CLASS_EditInlineNew))
{
bIsInsideContainer = false;
}
}
// true if the property can be expanded into the property window; that is, instead of seeing
// a pointer to the object, you see the object's properties.
static const FName Name_EditInline("EditInline");
static const FName Name_ShowInnerProperties("ShowInnerProperties");
// we are EditInlineNew if this property has the flag, or if inside a container that has the flag.
bIsEditInlineNew = GotReadAddresses && bIsObjectOrInterface &&
(MyProperty->HasMetaData(Name_EditInline) || (bIsInsideContainer && OwnerProperty->HasMetaData(Name_EditInline)));
bShowInnerObjectProperties = bIsObjectOrInterface && MyProperty->HasMetaData(Name_ShowInnerProperties);
if (bIsEditInlineNew)
{
SetNodeFlags(EPropertyNodeFlags::EditInlineNew, true);
}
else if (bShowInnerObjectProperties)
{
SetNodeFlags(EPropertyNodeFlags::ShowInnerObjectProperties, true);
}
//Get the property max child depth
static const FName Name_MaxPropertyDepth("MaxPropertyDepth");
if (Property->HasMetaData(Name_MaxPropertyDepth))
{
int32 NewMaxChildDepthAllowed = Property->GetIntMetaData(Name_MaxPropertyDepth);
//Ensure new depth is valid. Otherwise just let the parent specified value stand
if (NewMaxChildDepthAllowed > 0)
{
//if there is already a limit on the depth allowed, take the minimum of the allowable depths
if (MaxChildDepthAllowed >= 0)
{
MaxChildDepthAllowed = FMath::Min(MaxChildDepthAllowed, NewMaxChildDepthAllowed);
}
else
{
//no current limit, go ahead and take the new limit
MaxChildDepthAllowed = NewMaxChildDepthAllowed;
}
}
}
const FString& EditConditionString = MyProperty->GetMetaData(TEXT("EditCondition"));
// see if the property supports some kind of edit condition and this isn't the "parent" property of a static array
const bool bIsStaticArrayParent = MyProperty->ArrayDim > 1 && GetArrayIndex() != -1;
if (!EditConditionString.IsEmpty() && !bIsStaticArrayParent)
{
EditConditionExpression = EditConditionParser.Parse(EditConditionString);
if (EditConditionExpression.IsValid())
{
EditConditionContext = MakeShareable(new FEditConditionContext(*this));
}
}
bool bRequiresValidation = bIsEditInlineNew || bShowInnerObjectProperties;
// We require validation if we are in a container.
bRequiresValidation |= MyProperty->IsA<FArrayProperty>() || MyProperty->IsA<FSetProperty>() || MyProperty->IsA<FMapProperty>();
// We require validation if our parent also needs validation (if an array parent was resized all the addresses of children are invalid)
bRequiresValidation |= (GetParentNode() && GetParentNode()->HasNodeFlags(EPropertyNodeFlags::RequiresValidation));
SetNodeFlags( EPropertyNodeFlags::RequiresValidation, bRequiresValidation );
}
InitExpansionFlags();
if (InitParams.bAllowChildren)
{
RebuildChildren();
}
PropertyPath = FPropertyNode::CreatePropertyPath(this->AsShared())->ToString();
}
/**
* Used for rebuilding a sub portion of the tree
*/
void FPropertyNode::RebuildChildren()
{
CachedReadAddresses.Reset();
bool bDestroySelf = false;
DestroyTree(bDestroySelf);
if (MaxChildDepthAllowed != 0)
{
//the case where we don't want init child nodes is when an Item has children that we don't want to display
//the other option would be to make each node "Read only" under that item.
//The example is a material assigned to a static mesh.
if (HasNodeFlags(EPropertyNodeFlags::CanBeExpanded) && (ChildNodes.Num() == 0))
{
InitChildNodes();
}
}
//see if they support some kind of edit condition
if (Property.IsValid() && Property->GetBoolMetaData(TEXT("FullyExpand")))
{
bool bExpand = true;
bool bRecurse = true;
}
// Children have been rebuilt, clear any pending rebuild requests
bRebuildChildrenRequested = false;
bChildrenRebuilt = true;
// Notify any listener that children have been rebuilt
OnRebuildChildren.ExecuteIfBound();
}
void FPropertyNode::AddChildNode(TSharedPtr<FPropertyNode> InNode)
{
ChildNodes.Add(InNode);
}
void FPropertyNode::ClearCachedReadAddresses( bool bRecursive )
{
CachedReadAddresses.Reset();
if( bRecursive )
{
for( int32 ChildIndex = 0; ChildIndex < ChildNodes.Num(); ++ChildIndex )
{
ChildNodes[ChildIndex]->ClearCachedReadAddresses( bRecursive );
}
}
}
// Follows the chain of items upwards until it finds the object window that houses this item.
FComplexPropertyNode* FPropertyNode::FindComplexParent()
{
FPropertyNode* Cur = this;
FComplexPropertyNode* Found = NULL;
while( true )
{
Found = Cur->AsComplexNode();
if( Found )
{
break;
}
Cur = Cur->GetParentNode();
if( !Cur )
{
// There is a break in the parent chain
break;
}
}
return Found;
}
// Follows the chain of items upwards until it finds the object window that houses this item.
const FComplexPropertyNode* FPropertyNode::FindComplexParent() const
{
const FPropertyNode* Cur = this;
const FComplexPropertyNode* Found = NULL;
while( true )
{
Found = Cur->AsComplexNode();
if( Found )
{
break;
}
Cur = Cur->GetParentNode();
if( !Cur )
{
// There is a break in the parent chain
break;
}
}
return Found;
}
class FObjectPropertyNode* FPropertyNode::FindObjectItemParent()
{
FComplexPropertyNode* ComplexParent = FindComplexParent();
if (!ComplexParent)
{
return nullptr;
}
if (FObjectPropertyNode* ObjectNode = ComplexParent->AsObjectNode())
{
return ObjectNode;
}
else if (FPropertyNode* ParentNodePtr = ComplexParent->GetParentNode())
{
return ParentNodePtr->FindObjectItemParent();
}
return nullptr;
}
const class FObjectPropertyNode* FPropertyNode::FindObjectItemParent() const
{
const FComplexPropertyNode* ComplexParent = FindComplexParent();
if (!ComplexParent)
{
return nullptr;
}
if (const FObjectPropertyNode* ObjectNode = ComplexParent->AsObjectNode())
{
return ObjectNode;
}
else if (const FPropertyNode* ParentNodePtr = ComplexParent->GetParentNode())
{
return ParentNodePtr->FindObjectItemParent();
}
return nullptr;
}
/**
* Follows the top-most object window that contains this property window item.
*/
FObjectPropertyNode* FPropertyNode::FindRootObjectItemParent()
{
// not every type of change to property values triggers a proper refresh of the hierarchy, so find the topmost container window and trigger a refresh manually.
FObjectPropertyNode* TopmostObjectItem=NULL;
FObjectPropertyNode* NextObjectItem = FindObjectItemParent();
while ( NextObjectItem != NULL )
{
TopmostObjectItem = NextObjectItem;
FPropertyNode* NextObjectParent = NextObjectItem->GetParentNode();
if ( NextObjectParent != NULL )
{
NextObjectItem = NextObjectParent->FindObjectItemParent();
}
else
{
break;
}
}
return TopmostObjectItem;
}
bool FPropertyNode::DoesChildPropertyRequireValidation(FProperty* InChildProp)
{
return InChildProp != nullptr && (CastField<FObjectProperty>(InChildProp) != nullptr || CastField<FStructProperty>(InChildProp) != nullptr);
}
/**
* Used to see if any data has been destroyed from under the property tree.
*/
EPropertyDataValidationResult FPropertyNode::EnsureDataIsValid()
{
bool bValidateChildren = !HasNodeFlags(EPropertyNodeFlags::SkipChildValidation);
bool bValidateChildrenKeyNodes = false; // by default, we don't check this, since it's just for Map properties
// If we have rebuilt children since last EnsureDataIsValid call let the caller know
if (bChildrenRebuilt)
{
bChildrenRebuilt = false;
return EPropertyDataValidationResult::ChildrenRebuilt;
}
// The root must always be validated
if (GetParentNode() == nullptr || HasNodeFlags(EPropertyNodeFlags::RequiresValidation))
{
CachedReadAddresses.Reset();
//Figure out if an array mismatch can be ignored
bool bIgnoreAllMismatch = false;
//make sure that force depth-limited trees don't cause a refresh
bIgnoreAllMismatch |= (MaxChildDepthAllowed==0);
//check my property
if (Property.IsValid())
{
FProperty* MyProperty = Property.Get();
UStruct* OwnerStruct = MyProperty->GetOwnerStruct();
if (!OwnerStruct || OwnerStruct->IsStructTrashed())
{
//verify that the property is not part of an invalid trash class, treat it as an invalid object if it is which will cause a refresh
return EPropertyDataValidationResult::ObjectInvalid;
}
//verify that the number of container children is correct
FArrayProperty* ArrayProperty = CastField<FArrayProperty>(MyProperty);
FSetProperty* SetProperty = CastField<FSetProperty>(MyProperty);
FMapProperty* MapProperty = CastField<FMapProperty>(MyProperty);
FStructProperty* StructProperty = CastField<FStructProperty>(MyProperty);
//default to unknown array length
int32 NumArrayChildren = -1;
//assume all arrays have the same length
bool bArraysHaveEqualNum = true;
//assume all arrays match the number of property window children
bool bArraysMatchChildNum = true;
bool bArrayHasNewItem = false;
FProperty* ContainerElementProperty = MyProperty;
if (ArrayProperty)
{
ContainerElementProperty = ArrayProperty->Inner;
}
else if (SetProperty)
{
ContainerElementProperty = SetProperty->ElementProp;
}
else if (MapProperty)
{
// Need to attempt to validate both the key and value properties...
bValidateChildrenKeyNodes = DoesChildPropertyRequireValidation(MapProperty->KeyProp);
ContainerElementProperty = MapProperty->ValueProp;
}
bValidateChildren = DoesChildPropertyRequireValidation(ContainerElementProperty);
//verify that the number of object children are the same too
FObjectPropertyBase* ObjectProperty = CastField<FObjectPropertyBase>(MyProperty);
//check to see, if this an object property, whether the contents are NULL or not.
//This is the check to see if an object property was changed from NULL to non-NULL, or vice versa, from non-property window code.
bool bObjectPropertyNull = true;
//Edit inline properties can change underneath the window
bool bIgnoreChangingChildren = !(HasNodeFlags(EPropertyNodeFlags::EditInlineNew) || HasNodeFlags(EPropertyNodeFlags::ShowInnerObjectProperties)) ;
//ignore this node if the consistency check should happen for the children
bool bIgnoreStaticArray = (Property->ArrayDim > 1) && (ArrayIndex == -1);
//if this node can't possibly have children (or causes a circular reference loop) then ignore this as a object property
if (bIgnoreChangingChildren || bIgnoreStaticArray || HasNodeFlags(EPropertyNodeFlags::NoChildrenDueToCircularReference))
{
//this will bypass object property consistency checks
ObjectProperty = NULL;
}
FReadAddressList ReadAddresses;
const bool bSuccess = GetReadAddress( ReadAddresses );
//make sure we got the addresses correctly
if (!bSuccess)
{
UE_LOG( LogPropertyNode, Verbose, TEXT("Object is invalid %s"), *Property->GetName() );
return EPropertyDataValidationResult::ObjectInvalid;
}
// If an object property with ShowInnerProperties changed object values out from under the property
bool bShowInnerObjectPropertiesObjectChanged = false;
//check for null, if we find one, there is a problem.
for (int32 Scan = 0; Scan < ReadAddresses.Num(); ++Scan)
{
uint8* Addr = ReadAddresses.GetAddress(Scan);
//make sure the data still exists
if (Addr==NULL)
{
UE_LOG( LogPropertyNode, Verbose, TEXT("Object is invalid %s"), *Property->GetName() );
return EPropertyDataValidationResult::ObjectInvalid;
}
if( ArrayProperty && !bIgnoreAllMismatch)
{
//ensure that array structures have the proper number of children
FScriptArrayHelper ArrayHelper(ArrayProperty, Addr);
int32 ArrayNum = ArrayHelper.Num();
//if first child
if (NumArrayChildren == -1)
{
NumArrayChildren = ArrayNum;
}
bArrayHasNewItem = GetNumChildNodes() < ArrayNum;
//make sure multiple arrays match
bArraysHaveEqualNum = bArraysHaveEqualNum && (NumArrayChildren == ArrayNum);
//make sure the array matches the number of property node children
bArraysMatchChildNum = bArraysMatchChildNum && (GetNumChildNodes() == ArrayNum);
}
if (SetProperty && !bIgnoreAllMismatch)
{
// like arrays, ensure that set structures have the proper number of children
int32 SetNum = FScriptSetHelper::Num(Addr);
if (NumArrayChildren == -1)
{
NumArrayChildren = SetNum;
}
bArrayHasNewItem = GetNumChildNodes() < SetNum;
bArraysHaveEqualNum = bArraysHaveEqualNum && (NumArrayChildren == SetNum);
bArraysMatchChildNum = bArraysMatchChildNum && (GetNumChildNodes() == SetNum);
}
if (MapProperty && !bIgnoreAllMismatch)
{
FScriptMapHelper MapHelper(MapProperty, Addr);
int32 MapNum = MapHelper.Num();
if (NumArrayChildren == -1)
{
NumArrayChildren = MapNum;
}
bArrayHasNewItem = GetNumChildNodes() < MapNum;
bArraysHaveEqualNum = bArraysHaveEqualNum && (NumArrayChildren == MapNum);
bArraysMatchChildNum = bArraysMatchChildNum && (GetNumChildNodes() == MapNum);
}
if (ObjectProperty && !bIgnoreAllMismatch)
{
UObject* Obj = ObjectProperty->GetObjectPropertyValue(Addr);
if (!bShowInnerObjectPropertiesObjectChanged && HasNodeFlags(EPropertyNodeFlags::ShowInnerObjectProperties|EPropertyNodeFlags::EditInlineNew) && ChildNodes.Num() == 1)
{
bool bChildObjectFound = false;
// should never have more than one node (0 is ok if the object property is null)
check(ChildNodes.Num() == 1);
bool bNeedRebuild = false;
FObjectPropertyNode* ChildObjectNode = ChildNodes[0]->AsObjectNode();
for(int32 ObjectIndex = 0; ObjectIndex < ChildObjectNode->GetNumObjects(); ++ObjectIndex)
{
if(Obj == ChildObjectNode->GetUObject(ObjectIndex))
{
bChildObjectFound = true;
break;
}
}
bShowInnerObjectPropertiesObjectChanged = !bChildObjectFound;
}
if (Obj != NULL)
{
bObjectPropertyNull = false;
break;
}
}
}
//if all arrays match each other but they do NOT match the property structure, cause a rebuild
if (bArraysHaveEqualNum && !bArraysMatchChildNum)
{
RebuildChildren();
if( bArrayHasNewItem && ChildNodes.Num() )
{
TSharedPtr<FPropertyNode> LastChildNode = ChildNodes.Last();
// Don't expand huge children
if( LastChildNode->GetNumChildNodes() > 0 && LastChildNode->GetNumChildNodes() < 10 )
{
// Expand the last item for convenience since generally the user will want to edit the new value they added.
LastChildNode->SetNodeFlags(EPropertyNodeFlags::Expanded, true);
}
}
return EPropertyDataValidationResult::ArraySizeChanged;
}
if(bShowInnerObjectPropertiesObjectChanged)
{
RebuildChildren();
return EPropertyDataValidationResult::EditInlineNewValueChanged;
}
const bool bHasChildren = (GetNumChildNodes() > 0);
// If the object property is not null and has no children, its children need to be rebuilt
// If the object property is null and this node has children, the node needs to be rebuilt
if (!HasNodeFlags(EPropertyNodeFlags::ShowInnerObjectProperties) && ObjectProperty && ((!bObjectPropertyNull && !bHasChildren) || (bObjectPropertyNull && bHasChildren)))
{
RebuildChildren();
return EPropertyDataValidationResult::PropertiesChanged;
}
}
}
if( bRebuildChildrenRequested )
{
RebuildChildren();
// If this property is editinline and not edit const then its editinline new and we can optimize some of the refreshing in some cases. Otherwise we need to refresh all properties in the view
return HasNodeFlags(EPropertyNodeFlags::ShowInnerObjectProperties) || (HasNodeFlags(EPropertyNodeFlags::EditInlineNew) && !IsEditConst()) ? EPropertyDataValidationResult::EditInlineNewValueChanged : EPropertyDataValidationResult::PropertiesChanged;
}
EPropertyDataValidationResult FinalResult = EPropertyDataValidationResult::DataValid;
// Validate children and/or their key nodes.
if (bValidateChildren || bValidateChildrenKeyNodes)
{
for (int32 Scan = 0; Scan < ChildNodes.Num(); ++Scan)
{
TSharedPtr<FPropertyNode>& ChildNode = ChildNodes[Scan];
check(ChildNode.IsValid());
if (bValidateChildren)
{
EPropertyDataValidationResult ChildDataResult = ChildNode->EnsureDataIsValid();
if (FinalResult == EPropertyDataValidationResult::DataValid && ChildDataResult != EPropertyDataValidationResult::DataValid)
{
FinalResult = ChildDataResult;
}
}
// If the child property has a key node that needs validation, validate it here
TSharedPtr<FPropertyNode>& ChildKeyNode = ChildNode->GetPropertyKeyNode();
if (bValidateChildrenKeyNodes && ChildKeyNode.IsValid())
{
EPropertyDataValidationResult ChildDataResult = ChildKeyNode->EnsureDataIsValid();
if (FinalResult == EPropertyDataValidationResult::DataValid && ChildDataResult != EPropertyDataValidationResult::DataValid)
{
FinalResult = ChildDataResult;
}
}
}
}
return FinalResult;
}
FPropertyAccess::Result FPropertyNode::GetPropertyValueString(FString& OutString, const bool bAllowAlternateDisplayValue, EPropertyPortFlags PortFlags) const
{
uint8* ValueAddress = nullptr;
FPropertyAccess::Result Result = GetSingleReadAddress(ValueAddress);
if (ValueAddress != nullptr)
{
const FProperty* PropertyPtr = GetProperty();
// Check for bogus data
if (PropertyPtr != nullptr && GetParentNode() != nullptr)
{
FPropertyTextUtilities::PropertyToTextHelper(OutString, this, PropertyPtr, ValueAddress, nullptr, PortFlags);
UEnum* Enum = nullptr;
int64 EnumValue = 0;
if (const FByteProperty* ByteProperty = CastField<FByteProperty>(PropertyPtr))
{
if (ByteProperty->Enum != nullptr)
{
Enum = ByteProperty->Enum;
EnumValue = ByteProperty->GetPropertyValue(ValueAddress);
}
}
else if (const FEnumProperty* EnumProperty = CastField<FEnumProperty>(PropertyPtr))
{
Enum = EnumProperty->GetEnum();
EnumValue = EnumProperty->GetUnderlyingProperty()->GetSignedIntPropertyValue(ValueAddress);
}
if (Enum != nullptr)
{
if (Enum->IsValidEnumValue(EnumValue))
{
// See if we specified an alternate name for this value using metadata
OutString = Enum->GetDisplayNameTextByValue(EnumValue).ToString();
if (!bAllowAlternateDisplayValue || OutString.Len() == 0)
{
OutString = Enum->GetNameStringByValue(EnumValue);
}
}
else
{
Result = FPropertyAccess::Fail;
}
}
}
else
{
Result = FPropertyAccess::Fail;
}
}
return Result;
}
FPropertyAccess::Result FPropertyNode::GetPropertyValueText(FText& OutText, const bool bAllowAlternateDisplayValue) const
{
uint8* ValueAddress = nullptr;
FPropertyAccess::Result Result = GetSingleReadAddress(ValueAddress);
if (ValueAddress != nullptr)
{
const FProperty* PropertyPtr = GetProperty();
if (PropertyPtr)
{
if (PropertyPtr->IsA(FTextProperty::StaticClass()))
{
OutText = CastField<FTextProperty>(PropertyPtr)->GetPropertyValue(ValueAddress);
}
else
{
FString ExportedTextString;
FPropertyTextUtilities::PropertyToTextHelper(ExportedTextString, this, PropertyPtr, ValueAddress, nullptr, PPF_PropertyWindow);
UEnum* Enum = nullptr;
int64 EnumValue = 0;
if (const FByteProperty* ByteProperty = CastField<FByteProperty>(PropertyPtr))
{
Enum = ByteProperty->Enum;
EnumValue = ByteProperty->GetPropertyValue(ValueAddress);
}
else if (const FEnumProperty* EnumProperty = CastField<FEnumProperty>(PropertyPtr))
{
Enum = EnumProperty->GetEnum();
EnumValue = EnumProperty->GetUnderlyingProperty()->GetSignedIntPropertyValue(ValueAddress);
}
if (Enum)
{
if (Enum->IsValidEnumValue(EnumValue))
{
// Text form is always display name
OutText = Enum->GetDisplayNameTextByValue(EnumValue);
}
else
{
Result = FPropertyAccess::Fail;
}
}
else
{
OutText = FText::FromString(ExportedTextString);
}
}
}
else
{
Result = FPropertyAccess::Fail;
}
}
return Result;
}
/**
* Sets the flags used by the window and the root node
* @param InFlags - flags to turn on or off
* @param InOnOff - whether to toggle the bits on or off
*/
void FPropertyNode::SetNodeFlags(const EPropertyNodeFlags::Type InFlags, const bool InOnOff)
{
if (InOnOff)
{
PropertyNodeFlags |= InFlags;
}
else
{
PropertyNodeFlags &= (~InFlags);
}
}
bool FPropertyNode::GetChildNode(const int32 ChildArrayIndex, TSharedPtr<FPropertyNode>& OutChildNode)
{
OutChildNode = nullptr;
for (auto Child = ChildNodes.CreateIterator(); Child; ++Child)
{
if (Child->IsValid() && (*Child)->ArrayIndex == ChildArrayIndex)
{
OutChildNode = *Child;
return true;
}
}
return false;
}
bool FPropertyNode::GetChildNode(const int32 ChildArrayIndex, TSharedPtr<FPropertyNode>& OutChildNode) const
{
OutChildNode = nullptr;
for (auto Child = ChildNodes.CreateConstIterator(); Child; ++Child)
{
if (Child->IsValid() && (*Child)->ArrayIndex == ChildArrayIndex)
{
OutChildNode = *Child;
return true;
}
}
return false;
}
TSharedPtr<FPropertyNode> FPropertyNode::FindChildPropertyNode( const FName InPropertyName, bool bRecurse )
{
// search children breadth-first, so that identically-named properties are first picked up in top-level classes, eg:
// class UFoo
// {
// struct FBar
// {
// int ID;
// } Bar;
// int ID;
// };
// depth-first search would find FBar::ID before UFoo::ID when searching for "ID", which is rarely what was intended
TDeque<TSharedPtr<FPropertyNode>> NodesToSearch;
auto PushAll = [&NodesToSearch](const TArray<TSharedPtr<FPropertyNode>>& Nodes)
{
NodesToSearch.Reserve(NodesToSearch.Num() + Nodes.Num());
for (const TSharedPtr<FPropertyNode>& Node : Nodes)
{
NodesToSearch.PushLast(Node);
}
};
PushAll(ChildNodes);
while (!NodesToSearch.IsEmpty())
{
TSharedPtr<FPropertyNode> Node = NodesToSearch.First();
NodesToSearch.PopFirst();
if (Node->GetProperty() && Node->GetProperty()->GetFName() == InPropertyName)
{
return Node;
}
if (bRecurse)
{
PushAll(Node->ChildNodes);
}
}
return nullptr;
}
/**
* Returns whether this window's property is read only or has the CPF_EditConst flag.
*/
bool FPropertyNode::IsPropertyConst() const
{
if (HasNodeFlags(EPropertyNodeFlags::IsReadOnly))
{
return true;
}
if (Property != nullptr)
{
return Property->HasAllPropertyFlags(CPF_EditConst);
}
return false;
}
/** @return whether this window's property is constant (can't be edited by the user) */
bool FPropertyNode::IsEditConst() const
{
if (bUpdateEditConstState)
{
// Ask the objects whether this property can be changed
const FObjectPropertyNode* ObjectPropertyNode = FindObjectItemParent();
bIsEditConst = IsPropertyConst();
if (!bIsEditConst && Property.IsValid() && ObjectPropertyNode)
{
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain(Property.Get());
// travel up the chain to see if this property's owner struct is EditConst - if it is, so is this property
FPropertyNode* CurParent = ParentNode;
while (CurParent != nullptr)
{
FStructProperty* StructProperty = CastField<FStructProperty>(CurParent->GetProperty());
if (StructProperty == nullptr)
{
break;
}
if (CurParent->IsEditConst())
{
// An owning struct is edit const, so the child property is too
bIsEditConst = true;
}
else
{
// See if the struct has a problem with this property being editable
UScriptStruct* ScriptStruct = StructProperty->Struct;
if (ScriptStruct && ScriptStruct->StructFlags & STRUCT_CanEditChange)
{
UScriptStruct::ICppStructOps* TheCppStructOps = ScriptStruct->GetCppStructOps();
check(TheCppStructOps);
const int32 NumInstances = ObjectPropertyNode->GetInstancesNum();
TArray<const void*> StructAddresses;
StructAddresses.Reset(NumInstances);
for (int32 Index = 0; Index < NumInstances; ++Index)
{
StructAddresses.Add(CurParent->GetValueAddressFromObject(ObjectPropertyNode->GetUObject(Index)));
}
for (const void* StructAddr : StructAddresses)
{
if (!TheCppStructOps->CanEditChange(*PropertyChain, StructAddr))
{
bIsEditConst = true;
break;
}
}
}
}
if (bIsEditConst)
{
break;
}
CurParent = CurParent->ParentNode;
}
if (!bIsEditConst)
{
for (TPropObjectConstIterator CurObjectIt(ObjectPropertyNode->ObjectConstIterator()); CurObjectIt; ++CurObjectIt)
{
const TWeakObjectPtr<UObject> CurObject = *CurObjectIt;
if (CurObject.IsValid())
{
if (!CurObject->CanEditChange(*PropertyChain))
{
// At least one of the objects didn't like the idea of this property being changed.
bIsEditConst = true;
break;
}
}
}
}
}
// check edit condition
if (!bIsEditConst && HasEditCondition())
{
bIsEditConst = !IsEditConditionMet();
}
bUpdateEditConstState = false;
}
return bIsEditConst;
}
bool FPropertyNode::ShouldSkipSerialization() const
{
return Property != nullptr && Property->HasAnyPropertyFlags(CPF_SkipSerialization);
}
bool FPropertyNode::HasEditCondition() const
{
return EditConditionExpression.IsValid();
}
bool FPropertyNode::IsEditConditionMet() const
{
if (HasEditCondition())
{
TValueOrError<bool, FText> Result = EditConditionParser.Evaluate(*EditConditionExpression.Get(), *EditConditionContext.Get());
if (Result.IsValid())
{
return Result.GetValue();
}
}
return true;
}
bool FPropertyNode::SupportsEditConditionToggle() const
{
if (!Property.IsValid())
{
return false;
}
FProperty* MyProperty = Property.Get();
static const FName Name_HideEditConditionToggle("HideEditConditionToggle");
if (EditConditionExpression.IsValid() && !Property->HasMetaData(Name_HideEditConditionToggle))
{
const FBoolProperty* ConditionalProperty = EditConditionContext->GetSingleBoolProperty(EditConditionExpression);
if (ConditionalProperty != nullptr)
{
// There are 2 valid states for inline edit conditions:
// 1. The property is marked as editable and has InlineEditConditionToggle set.
// 2. The property is not marked as editable and does not have InlineEditConditionToggle set.
// In both cases, the original property will be hidden and only show up as a toggle.
static const FName Name_InlineEditConditionToggle("InlineEditConditionToggle");
const bool bIsInlineEditCondition = ConditionalProperty->HasMetaData(Name_InlineEditConditionToggle);
const bool bIsEditable = ConditionalProperty->HasAllPropertyFlags(CPF_Edit);
if (bIsInlineEditCondition == bIsEditable)
{
return true;
}
if (bIsInlineEditCondition && !bIsEditable)
{
UE_LOG(LogPropertyNode, Warning, TEXT("Property being used as inline edit condition is not editable, but has redundant InlineEditConditionToggle flag. Field \"%s\" in class \"%s\"."), *ConditionalProperty->GetNameCPP(), *Property->GetOwnerStruct()->GetName());
return true;
}
// The property is already shown, and not marked as inline edit condition.
if (!bIsInlineEditCondition && bIsEditable)
{
return false;
}
}
}
return false;
}
void FPropertyNode::ToggleEditConditionState()
{
const FBoolProperty* EditConditionProperty = EditConditionContext->GetSingleBoolProperty(EditConditionExpression);
check(EditConditionProperty != nullptr);
FPropertyNode* MyParentNode = ParentNodeWeakPtr.Pin().Get();
check(MyParentNode != nullptr);
bool OldValue = true;
FComplexPropertyNode* ComplexParentNode = FindComplexParent();
for (int32 Index = 0; Index < ComplexParentNode->GetInstancesNum(); ++Index)
{
uint8* ValuePtr = ComplexParentNode->GetValuePtrOfInstance(Index, EditConditionProperty, MyParentNode);
OldValue &= EditConditionProperty->GetPropertyValue(ValuePtr);
EditConditionProperty->SetPropertyValue(ValuePtr, !OldValue);
}
// Propagate the value change to any instances if we're editing a template object
FObjectPropertyNode* ObjectNode = FindObjectItemParent();
if (ObjectNode != nullptr)
{
for (int32 ObjIndex = 0; ObjIndex < ObjectNode->GetNumObjects(); ++ObjIndex)
{
TWeakObjectPtr<UObject> ObjectWeakPtr = ObjectNode->GetUObject(ObjIndex);
UObject* Object = ObjectWeakPtr.Get();
if (Object != nullptr && Object->IsTemplate())
{
TArray<UObject*> ArchetypeInstances;
Object->GetArchetypeInstances(ArchetypeInstances);
for (int32 InstanceIndex = 0; InstanceIndex < ArchetypeInstances.Num(); ++InstanceIndex)
{
uint8* ArchetypeBaseOffset = MyParentNode->GetValueAddressFromObject(ArchetypeInstances[InstanceIndex]);
uint8* ArchetypeValueAddr = EditConditionProperty->ContainerPtrToValuePtr<uint8>(ArchetypeBaseOffset);
// Only propagate if the current value on the instance matches the previous value on the template.
const bool CurValue = EditConditionProperty->GetPropertyValue(ArchetypeValueAddr);
if (OldValue == CurValue)
{
EditConditionProperty->SetPropertyValue(ArchetypeValueAddr, !OldValue);
}
}
}
}
}
}
bool FPropertyNode::IsOnlyVisibleWhenEditConditionMet() const
{
static const FName Name_EditConditionHides("EditConditionHides");
if (Property.IsValid() && Property->HasMetaData(Name_EditConditionHides))
{
return HasEditCondition();
}
return false;
}
/**
* Appends my path, including an array index (where appropriate)
*/
bool FPropertyNode::GetQualifiedName( FString& PathPlusIndex, const bool bWithArrayIndex, const FPropertyNode* StopParent, bool bIgnoreCategories ) const
{
bool bAddedAnything = false;
if (ParentNodeWeakPtr.IsValid() && StopParent != ParentNode)
{
bAddedAnything = ParentNode->GetQualifiedName(PathPlusIndex, bWithArrayIndex, StopParent, bIgnoreCategories);
}
if (Property.IsValid())
{
if (bAddedAnything)
{
PathPlusIndex += TEXT(".");
}
Property->AppendName(PathPlusIndex);
if (bWithArrayIndex && (ArrayIndex != INDEX_NONE))
{
PathPlusIndex += TEXT("[");
PathPlusIndex.AppendInt(ArrayIndex);
PathPlusIndex += TEXT("]");
}
bAddedAnything = true;
}
return bAddedAnything;
}
bool FPropertyNode::GetReadAddressUncached( const FPropertyNode& InPropertyNode,
bool InRequiresSingleSelection,
FReadAddressListData* OutAddresses,
bool bComparePropertyContents,
bool bObjectForceCompare,
bool bArrayPropertiesCanDifferInSize ) const
{
if (ParentNodeWeakPtr.IsValid())
{
return ParentNode->GetReadAddressUncached( InPropertyNode, InRequiresSingleSelection, OutAddresses, bComparePropertyContents, bObjectForceCompare, bArrayPropertiesCanDifferInSize );
}
return false;
}
bool FPropertyNode::GetReadAddressUncached( const FPropertyNode& InPropertyNode, FReadAddressListData& OutAddresses ) const
{
if (ParentNodeWeakPtr.IsValid())
{
return ParentNode->GetReadAddressUncached( InPropertyNode, OutAddresses );
}
return false;
}
bool FPropertyNode::GetReadAddress(bool InRequiresSingleSelection,
FReadAddressList& OutAddresses,
bool bComparePropertyContents,
bool bObjectForceCompare,
bool bArrayPropertiesCanDifferInSize) const
{
if (!ParentNodeWeakPtr.IsValid())
{
return false;
}
// @todo PropertyEditor Nodes which require validation cannot be cached
if( CachedReadAddresses.Num() && !CachedReadAddresses.bRequiresCache && !HasNodeFlags(EPropertyNodeFlags::RequiresValidation) )
{
OutAddresses.ReadAddressListData = &CachedReadAddresses;
return CachedReadAddresses.bAllValuesTheSame;
}
CachedReadAddresses.Reset();
bool bAllValuesTheSame = GetReadAddressUncached( *this, InRequiresSingleSelection, &CachedReadAddresses, bComparePropertyContents, bObjectForceCompare, bArrayPropertiesCanDifferInSize );
OutAddresses.ReadAddressListData = &CachedReadAddresses;
CachedReadAddresses.bAllValuesTheSame = bAllValuesTheSame;
CachedReadAddresses.bRequiresCache = false;
return bAllValuesTheSame;
}
/**
* fills in the OutAddresses array with the addresses of all of the available objects.
* @param InItem The property to get objects from.
* @param OutAddresses Storage array for all of the objects' addresses.
*/
bool FPropertyNode::GetReadAddress( FReadAddressList& OutAddresses ) const
{
if (!ParentNodeWeakPtr.IsValid())
{
return false;
}
// @todo PropertyEditor Nodes which require validation cannot be cached
if( CachedReadAddresses.Num() && !HasNodeFlags(EPropertyNodeFlags::RequiresValidation) )
{
OutAddresses.ReadAddressListData = &CachedReadAddresses;
return true;
}
CachedReadAddresses.Reset();
bool bSuccess = GetReadAddressUncached( *this, CachedReadAddresses );
if( bSuccess )
{
OutAddresses.ReadAddressListData = &CachedReadAddresses;
}
CachedReadAddresses.bRequiresCache = false;
return bSuccess;
}
FPropertyAccess::Result FPropertyNode::GetSingleReadAddress(uint8*& OutValueAddress) const
{
OutValueAddress = nullptr;
FReadAddressList ReadAddresses;
bool bAllValuesTheSame = GetReadAddress(!!HasNodeFlags(EPropertyNodeFlags::SingleSelectOnly), ReadAddresses, false, true);
if ((ReadAddresses.Num() > 0 && bAllValuesTheSame) || ReadAddresses.Num() == 1)
{
OutValueAddress = ReadAddresses.GetAddress(0);
return FPropertyAccess::Success;
}
return ReadAddresses.Num() > 1 ? FPropertyAccess::MultipleValues : FPropertyAccess::Fail;
}
uint8* FPropertyNode::GetStartAddressFromObject(const UObject* Obj) const
{
if (!Obj)
{
return nullptr;
}
if (HasNodeFlags(EPropertyNodeFlags::IsSparseClassData))
{
return (uint8*)Obj->GetClass()->GetOrCreateSparseClassData();
}
return (uint8*)Obj;
}
uint8* FPropertyNode::GetValueBaseAddressFromObject(const UObject* Obj) const
{
return GetValueBaseAddress(GetStartAddressFromObject(Obj), HasNodeFlags(EPropertyNodeFlags::IsSparseClassData));
}
uint8* FPropertyNode::GetValueAddressFromObject(const UObject* Obj) const
{
return GetValueAddress(GetStartAddressFromObject(Obj), HasNodeFlags(EPropertyNodeFlags::IsSparseClassData));
}
uint8* FPropertyNode::GetValueBaseAddress(uint8* StartAddress, bool bIsSparseData) const
{
uint8* Result = NULL;
if (bIsSparseData)
{
Result = StartAddress;
}
else
{
if (ParentNodeWeakPtr.IsValid())
{
Result = ParentNode->GetValueAddress(StartAddress, bIsSparseData);
}
}
return Result;
}
uint8* FPropertyNode::GetValueAddress(uint8* StartAddress, bool bIsSparseData) const
{
return GetValueBaseAddress(StartAddress, bIsSparseData);
}
/*-----------------------------------------------------------------------------
FPropertyItemValueDataTrackerSlate
-----------------------------------------------------------------------------*/
/**
* Calculates and stores the address for both the current and default value of
* the associated property and the owning object.
*/
class FPropertyItemValueDataTrackerSlate
{
public:
/**
* A union which allows a single address to be represented as a pointer to a uint8
* or a pointer to a UObject.
*/
union FPropertyValueRoot
{
UObject* OwnerObject;
uint8* ValueAddress;
};
void Reset(FPropertyNode* InPropertyNode, UObject* InOwnerObject)
{
OwnerObject = InOwnerObject;
PropertyNode = InPropertyNode;
bHasDefaultValue = false;
InnerInitialize();
}
void InnerInitialize()
{
PropertyValueRoot.OwnerObject = NULL;
PropertyDefaultValueRoot.OwnerObject = NULL;
PropertyValueAddress = NULL;
PropertyValueBaseAddress = NULL;
PropertyDefaultBaseAddress = NULL;
PropertyDefaultAddress = NULL;
PropertyValueRoot.OwnerObject = OwnerObject.Get();
check(PropertyNode);
FProperty* Property = PropertyNode->GetProperty();
check(Property);
check(PropertyValueRoot.OwnerObject);
FPropertyNode* ParentNode = PropertyNode->GetParentNode();
// if the object specified is a class object, transfer to the CDO instead
if ( Cast<UClass>(PropertyValueRoot.OwnerObject) != NULL )
{
PropertyValueRoot.OwnerObject = Cast<UClass>(PropertyValueRoot.OwnerObject)->GetDefaultObject();
}
const bool bIsContainerProperty = CastField<FArrayProperty>(Property) || CastField<FSetProperty>(Property) || CastField<FMapProperty>(Property);
const bool bIsInsideContainerProperty = Property->GetOwner<FArrayProperty>() || Property->GetOwner<FSetProperty>() || Property->GetOwner<FMapProperty>();
FPropertyNode* Node = bIsInsideContainerProperty ? ParentNode : PropertyNode;
PropertyValueBaseAddress = Node->GetValueBaseAddressFromObject(PropertyValueRoot.OwnerObject);
PropertyValueAddress = PropertyNode->GetValueAddressFromObject(PropertyValueRoot.OwnerObject);
if (IsValidTracker())
{
bHasDefaultValue = Private_HasDefaultValue();
// calculate the addresses for the default object if it exists
if (bHasDefaultValue)
{
PropertyDefaultValueRoot.OwnerObject = PropertyValueRoot.OwnerObject ? PropertyValueRoot.OwnerObject->GetArchetype() : nullptr;
PropertyDefaultBaseAddress = Node->GetValueBaseAddressFromObject(PropertyDefaultValueRoot.OwnerObject);
PropertyDefaultAddress = PropertyNode->GetValueAddressFromObject(PropertyDefaultValueRoot.OwnerObject);
//////////////////////////
// If this is a container property, we must take special measures to use the base address of the property's value; for instance,
// the array property's PropertyDefaultBaseAddress points to an FScriptArray*, while PropertyDefaultAddress points to the
// FScriptArray's Data pointer.
if (bIsContainerProperty)
{
PropertyValueAddress = PropertyValueBaseAddress;
PropertyDefaultAddress = PropertyDefaultBaseAddress;
}
}
}
}
/**
* Constructor
*
* @param InPropItem the property window item this struct will hold values for
* @param InOwnerObject the object which contains the property value
*/
FPropertyItemValueDataTrackerSlate(FPropertyNode* InPropertyNode, UObject* InOwnerObject)
: OwnerObject(InOwnerObject)
, PropertyNode(InPropertyNode)
, bHasDefaultValue(false)
{
InnerInitialize();
}
/**
* @return Whether or not this tracker has a valid address to a property and object
*/
bool IsValidTracker() const
{
return PropertyValueBaseAddress != nullptr && OwnerObject.IsValid();
}
/**
* @return a pointer to the subobject root (outer-most non-subobject) of the owning object.
*/
UObject* GetTopLevelObject()
{
check(PropertyNode);
FObjectPropertyNode* RootNode = PropertyNode->FindRootObjectItemParent();
check(RootNode);
TArray<UObject*> RootObjects;
for ( TPropObjectIterator Itor( RootNode->ObjectIterator() ) ; Itor ; ++Itor )
{
TWeakObjectPtr<UObject> Object = *Itor;
if( Object.IsValid() )
{
RootObjects.Add(Object.Get());
}
}
UObject* Result;
for ( Result = PropertyValueRoot.OwnerObject; Result; Result = Result->GetOuter() )
{
if ( RootObjects.Contains(Result) )
{
break;
}
}
if( !Result )
{
// The result is not contained in the root so it is the top level object
Result = PropertyValueRoot.OwnerObject;
}
return Result;
}
/**
* Whether or not we have a default value
*/
bool HasDefaultValue() const { return bHasDefaultValue; }
/**
* @return The property node we are inspecting
*/
FPropertyNode* GetPropertyNode() const { return PropertyNode; }
/**
* @return The address of the property's value.
*/
uint8* GetPropertyValueAddress() const { return PropertyValueAddress; }
/**
* @return The base address of the property's default value.
*/
uint8* GetPropertyDefaultBaseAddress() const { return PropertyDefaultBaseAddress; }
/**
* @return The address of the property's default value.
*/
uint8* GetPropertyDefaultAddress() const { return PropertyDefaultAddress; }
/**
* @return The address of the property's owner object.
*/
uint8* GetPropertyRootAddress() const { return PropertyValueRoot.ValueAddress; }
/**
* @return The address of the default value owner object.
*/
uint8* GetPropertyDefaultRootAddress() const { return PropertyDefaultValueRoot.ValueAddress; }
private:
/**
* Determines whether the property bound to this struct exists in the owning object's archetype.
*
* @return true if this property exists in the owning object's archetype; false if the archetype is e.g. a
* CDO for a base class and this property is declared in the owning object's class.
*/
bool Private_HasDefaultValue() const
{
bool bResult = false;
if (IsValidTracker())
{
UClass* OwnerClass = PropertyValueRoot.OwnerObject->GetClass();
if (GetPropertyNode()->HasNodeFlags(EPropertyNodeFlags::IsSparseClassData))
{
if (OwnerClass)
{
UStruct* SparseClassDataStruct = OwnerClass->GetSparseClassDataStruct();
UStruct* SparseClassDataArchetypeStruct = OwnerClass->GetSparseClassDataArchetypeStruct();
if (SparseClassDataStruct == SparseClassDataArchetypeStruct)
{
bResult = true;
}
else
{
// Find the member property which contains this item's property
FPropertyNode* MemberPropertyNode = PropertyNode;
for (; MemberPropertyNode != nullptr; MemberPropertyNode = MemberPropertyNode->GetParentNode())
{
FProperty* MemberProperty = MemberPropertyNode->GetProperty();
if (MemberProperty != nullptr)
{
if (MemberProperty->GetOwner<UClass>() != nullptr)
{
break;
}
}
}
if (MemberPropertyNode != nullptr && MemberPropertyNode->GetProperty())
{
// we check to see that this property is in the defaults class
bResult = MemberPropertyNode->GetProperty()->IsInContainer(SparseClassDataArchetypeStruct);
}
}
}
return bResult;
}
check(PropertyValueBaseAddress);
check(PropertyValueRoot.OwnerObject);
UObject* ParentDefault = PropertyValueRoot.OwnerObject->GetArchetype();
check(ParentDefault);
if (OwnerClass == ParentDefault->GetClass())
{
// if the archetype is of the same class, then we must have a default
bResult = true;
}
else
{
// Find the member property which contains this item's property
FPropertyNode* MemberPropertyNode = PropertyNode;
for ( ;MemberPropertyNode != NULL; MemberPropertyNode = MemberPropertyNode->GetParentNode() )
{
FProperty* MemberProperty = MemberPropertyNode->GetProperty();
if ( MemberProperty != NULL )
{
if ( MemberProperty->GetOwner<UClass>() != NULL )
{
break;
}
}
}
if ( MemberPropertyNode != NULL && MemberPropertyNode->GetProperty())
{
// we check to see that this property is in the defaults class
bResult = MemberPropertyNode->GetProperty()->IsInContainer(ParentDefault->GetClass());
}
}
}
return bResult;
}
private:
TWeakObjectPtr<UObject> OwnerObject;
/** The property node we are inspecting */
FPropertyNode* PropertyNode;
/** The address of the owning object */
FPropertyValueRoot PropertyValueRoot;
/**
* The address of the owning object's archetype
*/
FPropertyValueRoot PropertyDefaultValueRoot;
/**
* The address of this property's value.
*/
uint8* PropertyValueAddress;
/**
* The base address of this property's value. i.e. for dynamic arrays, the location of the FScriptArray which
* contains the array property's value
*/
uint8* PropertyValueBaseAddress;
/**
* The base address of this property's default value (see other comments for PropertyValueBaseAddress)
*/
uint8* PropertyDefaultBaseAddress;
/**
* The address of this property's default value.
*/
uint8* PropertyDefaultAddress;
/** Whether or not we have a default value */
bool bHasDefaultValue;
};
/* ==========================================================================================================
FPropertyItemComponentCollector
Given a property and the address for that property's data, searches for references to components and
keeps a list of any that are found.
========================================================================================================== */
/**
* Given a property and the address for that property's data, searches for references to components and keeps a list of any that are found.
*/
struct FPropertyItemComponentCollector
{
/** contains the property to search along with the value address to use */
const FPropertyItemValueDataTrackerSlate& ValueTracker;
/** holds the list of instanced objects found */
TArray<UObject*> Components;
/** Whether or not we have an edit inline new */
bool bContainsEditInlineNew;
/** Constructor */
FPropertyItemComponentCollector( const FPropertyItemValueDataTrackerSlate& InValueTracker )
: ValueTracker(InValueTracker)
, bContainsEditInlineNew( false )
{
check(ValueTracker.GetPropertyNode());
FPropertyNode* PropertyNode = ValueTracker.GetPropertyNode();
check(PropertyNode);
FProperty* Prop = PropertyNode->GetProperty();
if ( PropertyNode->GetArrayIndex() == INDEX_NONE )
{
// either the associated property is not an array property, or it's the header for the property (meaning the entire array)
for ( int32 ArrayIndex = 0; ArrayIndex < Prop->ArrayDim; ArrayIndex++ )
{
ProcessProperty(Prop, ValueTracker.GetPropertyValueAddress() + ArrayIndex * Prop->ElementSize);
}
}
else
{
// single element of either a dynamic or static array
ProcessProperty(Prop, ValueTracker.GetPropertyValueAddress());
}
}
/**
* Routes the processing to the appropriate method depending on the type of property.
*
* @param Property the property to process
* @param PropertyValueAddress the address of the property's value
*/
void ProcessProperty( FProperty* Property, uint8* PropertyValueAddress )
{
if ( Property != NULL )
{
bContainsEditInlineNew |= Property->HasMetaData(TEXT("EditInline")) && ((Property->PropertyFlags & CPF_EditConst) == 0);
if ( ProcessObjectProperty(CastField<FObjectPropertyBase>(Property), PropertyValueAddress) )
{
return;
}
if ( ProcessStructProperty(CastField<FStructProperty>(Property), PropertyValueAddress) )
{
return;
}
if ( ProcessInterfaceProperty(CastField<FInterfaceProperty>(Property), PropertyValueAddress) )
{
return;
}
if ( ProcessDelegateProperty(CastField<FDelegateProperty>(Property), PropertyValueAddress) )
{
return;
}
if ( ProcessMulticastDelegateProperty(CastField<FMulticastDelegateProperty>(Property), PropertyValueAddress) )
{
return;
}
if ( ProcessArrayProperty(CastField<FArrayProperty>(Property), PropertyValueAddress) )
{
return;
}
if ( ProcessSetProperty(CastField<FSetProperty>(Property), PropertyValueAddress) )
{
return;
}
if ( ProcessMapProperty(CastField<FMapProperty>(Property), PropertyValueAddress) )
{
return;
}
}
}
private:
/**
* FArrayProperty version - invokes ProcessProperty on the array's Inner member for each element in the array.
*
* @param ArrayProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessArrayProperty( FArrayProperty* ArrayProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if ( ArrayProp != NULL )
{
FScriptArrayHelper ArrayHelper(ArrayProp, PropertyValueAddress);
uint8* ArrayValue = (uint8*)ArrayHelper.GetRawPtr();
int32 ArraySize = ArrayHelper.Num();
for ( int32 ArrayIndex = 0; ArrayIndex < ArraySize; ArrayIndex++ )
{
ProcessProperty(ArrayProp->Inner, ArrayValue + ArrayIndex * ArrayProp->Inner->ElementSize);
}
bResult = true;
}
return bResult;
}
/**
* FSetProperty version - invokes ProcessProperty on the each item in the set
*
* @param SetProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessSetProperty( FSetProperty* SetProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if (SetProp != NULL)
{
FScriptSet* SetValuePtr = SetProp->GetPropertyValuePtr(PropertyValueAddress);
FScriptSetLayout SetLayout = SetValuePtr->GetScriptLayout(SetProp->ElementProp->ElementSize, SetProp->ElementProp->GetMinAlignment());
int32 ItemsLeft = SetValuePtr->Num();
for (int32 Index = 0; ItemsLeft > 0; ++Index)
{
if (SetValuePtr->IsValidIndex(Index))
{
--ItemsLeft;
ProcessProperty(SetProp->ElementProp, (uint8*)SetValuePtr->GetData(Index, SetLayout));
}
}
bResult = true;
}
return bResult;
}
/**
* FMapProperty version - invokes ProcessProperty on each item in the map
*
* @param MapProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessMapProperty( FMapProperty* MapProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if (MapProp != NULL)
{
FScriptMapHelper MapHelper(MapProp, PropertyValueAddress);
int32 ItemsLeft = MapHelper.Num();
for (int32 Index = 0; ItemsLeft > 0; ++Index)
{
if (MapHelper.IsValidIndex(Index))
{
--ItemsLeft;
uint8* Data = MapHelper.GetPairPtr(Index);
ProcessProperty(MapProp->KeyProp, MapProp->KeyProp->ContainerPtrToValuePtr<uint8>(Data));
ProcessProperty(MapProp->ValueProp, MapProp->ValueProp->ContainerPtrToValuePtr<uint8>(Data));
}
}
bResult = true;
}
return bResult;
}
/**
* FStructProperty version - invokes ProcessProperty on each property in the struct
*
* @param StructProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessStructProperty( FStructProperty* StructProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if ( StructProp != NULL )
{
for ( FProperty* Prop = StructProp->Struct->PropertyLink; Prop; Prop = Prop->PropertyLinkNext )
{
for ( int32 ArrayIndex = 0; ArrayIndex < Prop->ArrayDim; ArrayIndex++ )
{
ProcessProperty(Prop, Prop->ContainerPtrToValuePtr<uint8>(PropertyValueAddress, ArrayIndex));
}
}
bResult = true;
}
return bResult;
}
/**
* FObjectProperty version - if the object located at the specified address is instanced, adds the component the list.
*
* @param ObjectProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessObjectProperty( FObjectPropertyBase* ObjectProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if ( ObjectProp != NULL )
{
UObject* ObjValue = ObjectProp->GetObjectPropertyValue(PropertyValueAddress);
if (ObjectProp->PropertyFlags & CPF_InstancedReference)
{
Components.AddUnique(ObjValue);
}
bResult = true;
}
return bResult;
}
/**
* FInterfaceProperty version - if the FScriptInterface located at the specified address contains a reference to an instance, add the component to the list.
*
* @param InterfaceProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessInterfaceProperty( FInterfaceProperty* InterfaceProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if ( InterfaceProp != NULL )
{
FScriptInterface* InterfaceValue = InterfaceProp->GetPropertyValuePtr(PropertyValueAddress);
UObject* InterfaceObj = InterfaceValue->GetObject();
if (InterfaceObj && InterfaceObj->IsDefaultSubobject())
{
Components.AddUnique(InterfaceValue->GetObject());
}
bResult = true;
}
return bResult;
}
/**
* FDelegateProperty version - if the FScriptDelegate located at the specified address contains a reference to an instance, add the component to the list.
*
* @param DelegateProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessDelegateProperty( FDelegateProperty* DelegateProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if ( DelegateProp != NULL )
{
FScriptDelegate* DelegateValue = DelegateProp->GetPropertyValuePtr(PropertyValueAddress);
if (DelegateValue->GetUObject() && DelegateValue->GetUObject()->IsDefaultSubobject())
{
Components.AddUnique(DelegateValue->GetUObject());
}
bResult = true;
}
return bResult;
}
/**
* FMulticastDelegateProperty version - if the FMulticastScriptDelegate located at the specified address contains a reference to an instance, add the component to the list.
*
* @param MulticastDelegateProp the property to process
* @param PropertyValueAddress the address of the property's value
*
* @return true if the property was handled by this method
*/
bool ProcessMulticastDelegateProperty( FMulticastDelegateProperty* MulticastDelegateProp, uint8* PropertyValueAddress )
{
bool bResult = false;
if ( MulticastDelegateProp != NULL )
{
if (const FMulticastScriptDelegate* MulticastDelegateValue = MulticastDelegateProp->GetMulticastDelegate(PropertyValueAddress))
{
TArray<UObject*> AllObjects = MulticastDelegateValue->GetAllObjects();
for (TArray<UObject*>::TConstIterator CurObjectIt(AllObjects); CurObjectIt; ++CurObjectIt)
{
if ((*CurObjectIt)->IsDefaultSubobject())
{
Components.AddUnique((*CurObjectIt));
}
}
}
bResult = true;
}
return bResult;
}
};
bool FPropertyNode::GetDiffersFromDefaultForObject( FPropertyItemValueDataTrackerSlate& ValueTracker, FProperty* InProperty )
{
check( InProperty );
bool bDiffersFromDefaultForObject = false;
bool bIsValidTracker = ValueTracker.IsValidTracker();
bool bHasDefaultValue = ValueTracker.HasDefaultValue();
bool bHasParent = GetParentNode() != nullptr;
if (bIsValidTracker && bHasDefaultValue && bHasParent)
{
//////////////////////////
// Check the property against its default.
// If the property is an object property, we have to take special measures.
if (FArrayProperty* OuterArrayProperty = InProperty->GetOwner<FArrayProperty>())
{
// make sure we're not trying to compare against an element that doesn't exist
if (ValueTracker.GetPropertyDefaultBaseAddress() != nullptr)
{
// make sure we're not trying to compare against an element that doesn't exist
FScriptArrayHelper ArrayHelper(OuterArrayProperty, ValueTracker.GetPropertyDefaultBaseAddress());
if (GetArrayIndex() >= ArrayHelper.Num())
{
bDiffersFromDefaultForObject = true;
}
}
}
else if (FSetProperty* OuterSetProperty = InProperty->GetOwner<FSetProperty>())
{
if (ValueTracker.GetPropertyDefaultBaseAddress() != nullptr)
{
FScriptSetHelper SetHelper(OuterSetProperty, ValueTracker.GetPropertyDefaultBaseAddress());
if ( ValueTracker.GetPropertyDefaultBaseAddress() != NULL && (ArrayIndex < 0 || ArrayIndex >= SetHelper.Num()))
{
bDiffersFromDefaultForObject = true;
}
}
}
else if (FMapProperty* OuterMapProperty = InProperty->GetOwner<FMapProperty>())
{
if (ValueTracker.GetPropertyDefaultBaseAddress() != nullptr)
{
FScriptMapHelper MapHelper(OuterMapProperty, ValueTracker.GetPropertyDefaultBaseAddress());
if ( ValueTracker.GetPropertyDefaultBaseAddress() != NULL && (ArrayIndex < 0 || ArrayIndex >= MapHelper.Num()))
{
bDiffersFromDefaultForObject = true;
}
}
}
// The property is a simple field. Compare it against the enclosing object's default for that property.
if (!bDiffersFromDefaultForObject)
{
uint32 PortFlags = 0;
if (InProperty->ContainsInstancedObjectProperty())
{
PortFlags |= PPF_DeepComparison;
}
if ( ValueTracker.GetPropertyValueAddress() == NULL || ValueTracker.GetPropertyDefaultAddress() == NULL )
{
// if either are NULL, we had a dynamic array somewhere in our parent chain and the array doesn't
// have enough elements in either the default or the object
bDiffersFromDefaultForObject = true;
}
else if (GetArrayIndex() == INDEX_NONE && InProperty->ArrayDim > 1)
{
// this is a container; loop through all of its elements and see if any of them differ from the default
for (int32 Idx = 0; !bDiffersFromDefaultForObject && Idx < InProperty->ArrayDim; Idx++)
{
bDiffersFromDefaultForObject = !InProperty->Identical(
ValueTracker.GetPropertyValueAddress() + Idx * InProperty->ElementSize,
ValueTracker.GetPropertyDefaultAddress() + Idx * InProperty->ElementSize,
PortFlags
);
}
}
else
{
// try to compare the values at the current and default property addresses
uint8* PropertyValueAddr = ValueTracker.GetPropertyValueAddress();
uint8* DefaultPropertyValueAddr = ValueTracker.GetPropertyDefaultAddress();
if( PropertyValueAddr != NULL && DefaultPropertyValueAddr != NULL )
{
bDiffersFromDefaultForObject = !InProperty->Identical(
PropertyValueAddr,
DefaultPropertyValueAddr,
PortFlags
);
}
}
}
}
return bDiffersFromDefaultForObject;
}
/**
* If there is a property, sees if it matches. Otherwise sees if the entire parent structure matches
*/
bool FPropertyNode::GetDiffersFromDefault()
{
if( bUpdateDiffersFromDefault )
{
bUpdateDiffersFromDefault = false;
bDiffersFromDefault = false;
FProperty* Prop = GetProperty();
if (!Prop)
{
return bDiffersFromDefault;
}
FObjectPropertyNode* ObjectNode = FindObjectItemParent();
if (ObjectNode && Property.IsValid())
{
// Get an iterator for the enclosing objects.
for(int32 ObjIndex = 0; ObjIndex < ObjectNode->GetNumObjects(); ++ObjIndex)
{
UObject* Object = ObjectNode->GetUObject(ObjIndex);
TSharedPtr<FPropertyItemValueDataTrackerSlate> ValueTracker = GetValueTracker(Object, ObjIndex);
if(ValueTracker.IsValid() && Object && GetDiffersFromDefaultForObject(*ValueTracker, Property.Get()))
{
// If any object being observed differs from the result then there is no need to keep searching
bDiffersFromDefault = true;
break;
}
}
}
}
return bDiffersFromDefault;
}
FString FPropertyNode::GetDefaultValueAsStringForObject( FPropertyItemValueDataTrackerSlate& ValueTracker, UObject* InObject, FProperty* InProperty, bool bUseDisplayName)
{
check( InObject );
check( InProperty );
bool bDiffersFromDefaultForObject = false;
FString DefaultValue;
// special case for Object class - no defaults to compare against
if ( InObject != UObject::StaticClass() && InObject != UObject::StaticClass()->GetDefaultObject() )
{
if ( ValueTracker.IsValidTracker() && ValueTracker.HasDefaultValue() )
{
uint32 PortFlags = bUseDisplayName ? PPF_PropertyWindow : PPF_None;
if (InProperty->ContainsInstancedObjectProperty())
{
PortFlags |= PPF_DeepComparison;
}
if ( ValueTracker.GetPropertyDefaultAddress() == NULL )
{
// no default available, fall back on the default value for our primitive:
uint8* TempComplexPropAddr = (uint8*)FMemory::Malloc(InProperty->GetSize(), InProperty->GetMinAlignment());
InProperty->InitializeValue(TempComplexPropAddr);
ON_SCOPE_EXIT
{
InProperty->DestroyValue(TempComplexPropAddr);
FMemory::Free(TempComplexPropAddr);
};
InProperty->ExportText_Direct(DefaultValue, TempComplexPropAddr, TempComplexPropAddr, nullptr, PPF_None);
}
else if ( GetArrayIndex() == INDEX_NONE && InProperty->ArrayDim > 1 )
{
FArrayProperty::ExportTextInnerItem(DefaultValue, InProperty, ValueTracker.GetPropertyDefaultAddress(), InProperty->ArrayDim,
ValueTracker.GetPropertyDefaultAddress(), InProperty->ArrayDim, nullptr, PortFlags);
}
else
{
// Port flags will cause enums to display correctly
InProperty->ExportTextItem_Direct(DefaultValue, ValueTracker.GetPropertyDefaultAddress(), ValueTracker.GetPropertyDefaultAddress(), nullptr, PortFlags, nullptr);
}
}
}
return DefaultValue;
}
FString FPropertyNode::GetDefaultValueAsString(bool bUseDisplayName)
{
FString DefaultValue;
FString DelimitedValue;
bool bAllSame = true;
FObjectPropertyNode* ObjectNode = FindObjectItemParent();
if (ObjectNode && Property.IsValid())
{
TArray<FString> Values;
Values.Reserve(ObjectNode->GetNumObjects());
// Get an iterator for the enclosing objects.
for (int32 ObjIndex = 0; ObjIndex < ObjectNode->GetNumObjects(); ++ObjIndex)
{
UObject* Object = ObjectNode->GetUObject( ObjIndex );
TSharedPtr<FPropertyItemValueDataTrackerSlate> ValueTracker = GetValueTracker(Object, ObjIndex);
if (Object && ValueTracker.IsValid())
{
const FString NodeDefaultValue = GetDefaultValueAsStringForObject( *ValueTracker, Object, Property.Get(), bUseDisplayName );
if (DefaultValue.IsEmpty())
{
DefaultValue = NodeDefaultValue;
}
if (DelimitedValue.Len() > 0 && NodeDefaultValue.Len() > 0)
{
DelimitedValue += TEXT(", ");
}
DelimitedValue += NodeDefaultValue;
if (!ensureAlwaysMsgf(NodeDefaultValue == DefaultValue, TEXT("Default values differ for different objects of property '%s'. First: \"%s\", Other: \"%s\""), *Property->GetNameCPP(), *DefaultValue, *NodeDefaultValue))
{
bAllSame = false;
}
}
}
}
return bAllSame ? DefaultValue : DelimitedValue;
}
FText FPropertyNode::GetResetToDefaultLabel()
{
FString DefaultValue = GetDefaultValueAsString();
FText OutLabel = GetDisplayName();
if (DefaultValue.Len())
{
const int32 MaxValueLen = 60;
if (DefaultValue.Len() > MaxValueLen)
{
DefaultValue.LeftInline( MaxValueLen, false );
DefaultValue += TEXT( "..." );
}
return FText::Format(NSLOCTEXT("FPropertyNode", "ResetToDefaultLabelFmt", "{0}: {1}"), OutLabel, FText::FromString(MoveTemp(DefaultValue)));
}
return OutLabel;
}
bool FPropertyNode::IsReorderable()
{
FProperty* NodeProperty = GetProperty();
if (NodeProperty == nullptr)
{
return false;
}
// It is reorderable if the parent is an array and metadata doesn't prohibit it
const FArrayProperty* OuterArrayProp = NodeProperty->GetOwner<FArrayProperty>();
static const FName Name_DisableReordering("EditFixedOrder");
static const FName NAME_ArraySizeEnum("ArraySizeEnum");
return OuterArrayProp != nullptr
&& !OuterArrayProp->HasMetaData(Name_DisableReordering)
&& !IsEditConst()
&& !OuterArrayProp->HasMetaData(NAME_ArraySizeEnum)
&& !FApp::IsGame();
}
/**
* Helper function to obtain the display name for an enum property
* @param InEnum The enum whose metadata to pull from
* @param DisplayName The name of the enum value to adjust
*
* @return true if the DisplayName has been changed
*/
bool FPropertyNode::AdjustEnumPropDisplayName( UEnum *InEnum, FString& DisplayName ) const
{
// see if we have alternate text to use for displaying the value
UMetaData* PackageMetaData = InEnum->GetOutermost()->GetMetaData();
if (PackageMetaData)
{
FName AltDisplayName = FName(*(DisplayName+TEXT(".DisplayName")));
FString ValueText = PackageMetaData->GetValue(InEnum, AltDisplayName);
if (ValueText.Len() > 0)
{
// use the alternate text for this enum value
DisplayName = ValueText;
return true;
}
}
//DisplayName has been unmodified
return false;
}
/**Walks up the hierachy and return true if any parent node is a favorite*/
bool FPropertyNode::IsChildOfFavorite (void) const
{
for (const FPropertyNode* TestParentNode = GetParentNode(); TestParentNode != NULL; TestParentNode = TestParentNode->GetParentNode())
{
if (TestParentNode->HasNodeFlags(EPropertyNodeFlags::IsFavorite))
{
return true;
}
}
return false;
}
/**
* Destroys all node within the hierarchy
*/
void FPropertyNode::DestroyTree(const bool bInDestroySelf)
{
ChildNodes.Empty();
}
/**
* Marks windows as visible based on the filter strings (EVEN IF normally NOT EXPANDED)
*/
void FPropertyNode::FilterNodes( const TArray<FString>& InFilterStrings, const bool bParentSeenDueToFiltering )
{
//clear flags first. Default to hidden
SetNodeFlags(EPropertyNodeFlags::IsSeenDueToFiltering | EPropertyNodeFlags::IsSeenDueToChildFiltering | EPropertyNodeFlags::IsParentSeenDueToFiltering, false);
SetNodeFlags(EPropertyNodeFlags::IsBeingFiltered, InFilterStrings.Num() > 0 );
//FObjectPropertyNode* ParentPropertyNode = FindObjectItemParent();
//@todo slate property window
bool bMultiObjectOnlyShowDiffering = false;/*TopPropertyWindow->HasFlags(EPropertyWindowFlags::ShowOnlyDifferingItems) && (ParentPropertyNode->GetNumObjects()>1)*/;
if (InFilterStrings.Num() > 0 /*|| (TopPropertyWindow->HasFlags(EPropertyWindowFlags::ShowOnlyModifiedItems)*/ || bMultiObjectOnlyShowDiffering)
{
//if filtering, default to NOT-seen
bool bPassedFilter = false; //assuming that we aren't filtered
// Populate name aliases acceptable for searching / filtering
FText DisplayName = GetDisplayName();
const FString& DisplayNameStr = DisplayName.ToString();
TArray <FString> AcceptableNames;
AcceptableNames.Add(DisplayNameStr);
// For containers, check if base class metadata in parent includes 'TitleProperty', add corresponding value to filter names if so.
static const FName TitlePropertyFName = FName(TEXT("TitleProperty"));
if (ParentNode && ParentNode->GetProperty())
{
const FString& TitleProperty = ParentNode->GetProperty()->GetMetaData(TitlePropertyFName);
if (!TitleProperty.IsEmpty())
{
if (TSharedPtr<FPropertyNode> TitlePropertyNode = FindChildPropertyNode(*TitleProperty, true))
{
FString TitlePropertyValue;
if (TitlePropertyNode->GetPropertyValueString(TitlePropertyValue, true /*bAllowAlternateDisplayValue*/) != FPropertyAccess::Result::Fail)
{
AcceptableNames.Add(TitlePropertyValue);
}
}
}
}
// Get the basic name as well of the property
FProperty* TheProperty = GetProperty();
if (TheProperty && (TheProperty->GetName() != DisplayNameStr))
{
AcceptableNames.Add(TheProperty->GetName());
}
bPassedFilter = IsFilterAcceptable(AcceptableNames, InFilterStrings);
if (bPassedFilter)
{
SetNodeFlags(EPropertyNodeFlags::IsSeenDueToFiltering, true);
}
SetNodeFlags(EPropertyNodeFlags::IsParentSeenDueToFiltering, bParentSeenDueToFiltering);
}
else
{
//indicating that this node should not be force displayed, but opened normally
SetNodeFlags(EPropertyNodeFlags::IsParentSeenDueToFiltering, true);
}
// default to doing only one pass
int32 StartRecursionPass = HasNodeFlags(EPropertyNodeFlags::IsSeenDueToFiltering) ? 1 : 0;
//Pass 1, if a pass 1 exists (object or category), is to see if there are any children that pass the filter, if any do, trim the tree to the leaves.
// This will stop categories from showing ALL properties if they pass the filter AND a child passes the filter
//Pass 0, if no child exists that passes the filter OR this node didn't pass the filter
for (int32 RecursionPass = StartRecursionPass; RecursionPass >= 0; --RecursionPass)
{
for (int32 scan = 0; scan < ChildNodes.Num(); ++scan)
{
TSharedPtr<FPropertyNode>& ScanNode = ChildNodes[scan];
check(ScanNode.IsValid());
//default to telling the children this node is NOT visible, therefore if not in the base pass, only filtered nodes will survive the filtering process.
bool bChildParamParentVisible = false;
//if we're at the base pass, tell the children the truth about visibility
if (RecursionPass == 0)
{
bChildParamParentVisible = bParentSeenDueToFiltering || HasNodeFlags(EPropertyNodeFlags::IsSeenDueToFiltering);
}
ScanNode->FilterNodes(InFilterStrings, bChildParamParentVisible);
if (ScanNode->HasNodeFlags(EPropertyNodeFlags::IsSeenDueToFiltering | EPropertyNodeFlags::IsSeenDueToChildFiltering))
{
SetNodeFlags(EPropertyNodeFlags::IsSeenDueToChildFiltering, true);
}
}
//now that we've tried a pass at our children, if any of them have been successfully seen due to filtering, just quit now
if (HasNodeFlags(EPropertyNodeFlags::IsSeenDueToChildFiltering))
{
break;
}
}
}
void FPropertyNode::ProcessSeenFlags(const bool bParentAllowsVisible )
{
// Set initial state first
SetNodeFlags(EPropertyNodeFlags::IsSeen, false);
SetNodeFlags(EPropertyNodeFlags::IsSeenDueToChildFavorite, false );
bool bAllowChildrenVisible;
if ( AsObjectNode() )
{
bAllowChildrenVisible = true;
}
else
{
//can't show children unless they are seen due to child filtering
bAllowChildrenVisible = !!HasNodeFlags(EPropertyNodeFlags::IsSeenDueToChildFiltering);
}
//process children
for (int32 scan = 0; scan < ChildNodes.Num(); ++scan)
{
TSharedPtr<FPropertyNode>& ScanNode = ChildNodes[scan];
check(ScanNode.IsValid());
ScanNode->ProcessSeenFlags(bParentAllowsVisible && bAllowChildrenVisible ); //both parent AND myself have to allow children
}
if (HasNodeFlags(EPropertyNodeFlags::IsSeenDueToFiltering | EPropertyNodeFlags::IsSeenDueToChildFiltering))
{
SetNodeFlags(EPropertyNodeFlags::IsSeen, true);
}
else
{
//Finally, apply the REAL IsSeen
SetNodeFlags(EPropertyNodeFlags::IsSeen, bParentAllowsVisible && HasNodeFlags(EPropertyNodeFlags::IsParentSeenDueToFiltering));
}
}
/**
* Marks windows as visible based their favorites status
*/
void FPropertyNode::ProcessSeenFlagsForFavorites(void)
{
if( !HasNodeFlags(EPropertyNodeFlags::IsFavorite) )
{
bool bAnyChildFavorites = false;
//process children
for (int32 scan = 0; scan < ChildNodes.Num(); ++scan)
{
TSharedPtr<FPropertyNode>& ScanNode = ChildNodes[scan];
check(ScanNode.IsValid());
ScanNode->ProcessSeenFlagsForFavorites();
bAnyChildFavorites = bAnyChildFavorites || ScanNode->HasNodeFlags(EPropertyNodeFlags::IsFavorite | EPropertyNodeFlags::IsSeenDueToChildFavorite);
}
if (bAnyChildFavorites)
{
SetNodeFlags(EPropertyNodeFlags::IsSeenDueToChildFavorite, true);
}
}
}
void FPropertyNode::NotifyPreChange( FProperty* PropertyAboutToChange, FNotifyHook* InNotifyHook )
{
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain( PropertyAboutToChange );
NotifyPreChangeInternal(PropertyChain, PropertyAboutToChange, InNotifyHook);
}
void FPropertyNode::NotifyPreChange( FProperty* PropertyAboutToChange, FNotifyHook* InNotifyHook, const TSet<UObject*>& AffectedInstances )
{
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain( PropertyAboutToChange, AffectedInstances );
NotifyPreChangeInternal(PropertyChain, PropertyAboutToChange, InNotifyHook);
}
void FPropertyNode::NotifyPreChange( FProperty* PropertyAboutToChange, FNotifyHook* InNotifyHook, TSet<UObject*>&& AffectedInstances )
{
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain( PropertyAboutToChange, MoveTemp(AffectedInstances) );
NotifyPreChangeInternal(PropertyChain, PropertyAboutToChange, InNotifyHook);
}
void FPropertyNode::NotifyPreChangeInternal( TSharedRef<FEditPropertyChain> PropertyChain, FProperty* PropertyAboutToChange, FNotifyHook* InNotifyHook )
{
// Call through to the property window's notify hook.
if( InNotifyHook )
{
if ( PropertyChain->Num() == 0 )
{
InNotifyHook->NotifyPreChange( PropertyAboutToChange );
}
else
{
InNotifyHook->NotifyPreChange( &PropertyChain.Get() );
}
}
FObjectPropertyNode* ObjectNode = FindObjectItemParent();
if( ObjectNode )
{
FProperty* CurProperty = PropertyAboutToChange;
// Call PreEditChange on the object chain.
while ( true )
{
for( TPropObjectIterator Itor( ObjectNode->ObjectIterator() ) ; Itor ; ++Itor )
{
UObject* Object = Itor->Get();
if ( ensure( Object ) && PropertyChain->Num() == 0 )
{
Object->PreEditChange( Property.Get() );
}
else if( ensure( Object ) )
{
Object->PreEditChange( *PropertyChain );
}
}
// Pass this property to the parent's PreEditChange call.
CurProperty = ObjectNode->GetStoredProperty();
FObjectPropertyNode* PreviousObjectNode = ObjectNode;
// Traverse up a level in the nested object tree.
ObjectNode = NotifyFindObjectItemParent( ObjectNode );
if ( !ObjectNode )
{
// We've hit the root -- break.
break;
}
else if ( PropertyChain->Num() > 0 )
{
PropertyChain->SetActivePropertyNode( CurProperty->GetOwnerProperty() );
for ( FPropertyNode* BaseItem = PreviousObjectNode; BaseItem && BaseItem != ObjectNode; BaseItem = BaseItem->GetParentNode())
{
FProperty* ItemProperty = BaseItem->GetProperty();
if ( ItemProperty == NULL )
{
// if this property item doesn't have a Property, skip it...it may be a category item or the virtual
// item used as the root for an inline object
continue;
}
// skip over property window items that correspond to a single element in a static array, or
// the inner property of another FProperty (e.g. FArrayProperty->Inner)
if ( BaseItem->ArrayIndex == INDEX_NONE && ItemProperty->GetOwnerProperty() == ItemProperty )
{
PropertyChain->SetActiveMemberPropertyNode(ItemProperty);
}
}
}
}
}
// Broadcast the change to any listeners
BroadcastPropertyPreChangeDelegates();
}
void FPropertyNode::NotifyPostChange( FPropertyChangedEvent& InPropertyChangedEvent, class FNotifyHook* InNotifyHook )
{
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain( InPropertyChangedEvent.Property );
// remember the property that was the chain's original active property; this will correspond to the outermost property of struct/array that was modified
FProperty* const OriginalActiveProperty = PropertyChain->GetActiveMemberNode()->GetValue();
// invalidate the entire chain of objects in the hierarchy
{
FComplexPropertyNode* ComplexNode = FindComplexParent();
while (ComplexNode)
{
ComplexNode->InvalidateCachedState();
// FindComplexParent returns itself if the node is an object, so step up the hierarchy to get to its actual parent object
FPropertyNode* CurrentParent = ComplexNode->GetParentNode();
ComplexNode = CurrentParent != nullptr ? CurrentParent->FindComplexParent() : nullptr;
}
}
FObjectPropertyNode* ObjectNode = FindObjectItemParent();
if( ObjectNode )
{
TWeakPtr<FObjectPropertyNode> ObjectNodeAsWeakPtr = ObjectNode->SharedThis<FObjectPropertyNode>(ObjectNode);
TWeakPtr<FPropertyNode> ThisAsWeakPtr = AsShared();
FProperty* CurProperty = InPropertyChangedEvent.Property;
// Fire ULevel::LevelDirtiedEvent when falling out of scope.
FScopedLevelDirtied LevelDirtyCallback;
// Call PostEditChange on the object chain.
while ( true )
{
TArray<FString> ObjectPaths;
TArray<TWeakObjectPtr<UObject>> WeakObjects;
// It's possible that PostEditChangeProperty may cause a construction script to re-run
// which will invalidate the PropObjectIterator. We need to instead cache all of the objects
// before emitting any change events to ensure there is a PostChange for every PreChange.
for (TPropObjectIterator Itor(ObjectNode->ObjectIterator()); Itor; ++Itor)
{
WeakObjects.Add(*Itor);
ObjectPaths.Add((*Itor)->GetPathName());
}
for (int32 CurrentObjectIndex = 0; CurrentObjectIndex < WeakObjects.Num(); ++CurrentObjectIndex)
{
UObject* Object = WeakObjects[CurrentObjectIndex].Get();
if (Object == nullptr)
{
// If our weak pointer has gone out of scope, it means that a prior object has destroyed it,
// eg. by causing a blueprint construction script to run (which is triggered by PostEditChangeProperty())
// Find a new copy now.
Object = FindObject<UObject>(nullptr, *ObjectPaths[CurrentObjectIndex]);
if (Object == nullptr)
{
continue;
}
}
// Use a scope to ensure that only local variable are use in the loop.
// Since this object can be destroyed in this loop.
auto ScopePostEditChange = [&PropertyChain, &InPropertyChangedEvent, &CurProperty, CurrentObjectIndex](UObject* Object)
{
// copy the property changed event
FPropertyChangedEvent ChangedEvent = CurProperty != InPropertyChangedEvent.Property ?
FPropertyChangedEvent(CurProperty, InPropertyChangedEvent.ChangeType) :
InPropertyChangedEvent;
ChangedEvent.ObjectIteratorIndex = CurrentObjectIndex;
if (PropertyChain->Num() == 0)
{
Object->PostEditChangeProperty(ChangedEvent);
}
else
{
FPropertyChangedChainEvent ChainEvent(*PropertyChain, ChangedEvent);
ChainEvent.ObjectIteratorIndex = CurrentObjectIndex;
Object->PostEditChangeChainProperty(ChainEvent);
}
};
ScopePostEditChange(Object);
LevelDirtyCallback.Request();
}
if (!ThisAsWeakPtr.IsValid())
{
UE_LOG(LogPropertyNode, Error, TEXT("The FPropertyNode was destroy while processing the PostEditChangeProperty or PostEditChangeChainProperty."));
// Redraw viewports
FEditorSupportDelegates::RedrawAllViewports.Broadcast();
return;
}
if (!ObjectNodeAsWeakPtr.IsValid())
{
ObjectNode = nullptr;
UE_LOG(LogPropertyNode, Error, TEXT("Object for property '%s, was valid before the PostEditChange callback and now it's invalid"), *Property->GetName());
break;
}
// Pass this property to the parent's PostEditChange call.
CurProperty = ObjectNode->GetStoredProperty();
FObjectPropertyNode* PreviousObjectNode = ObjectNode;
// Traverse up a level in the nested object tree.
ObjectNode = NotifyFindObjectItemParent( ObjectNode );
if ( !ObjectNode )
{
// We've hit the root -- break.
break;
}
else if ( PropertyChain->Num() > 0 )
{
PropertyChain->SetActivePropertyNode(CurProperty->GetOwnerProperty());
for ( FPropertyNode* BaseItem = PreviousObjectNode; BaseItem && BaseItem != ObjectNode; BaseItem = BaseItem->GetParentNode())
{
FProperty* ItemProperty = BaseItem->GetProperty();
if ( ItemProperty == NULL )
{
// if this property item doesn't have a Property, skip it...it may be a category item or the virtual
// item used as the root for an inline object
continue;
}
// skip over property window items that correspond to a single element in a static array, or
// the inner property of another FProperty (e.g. FArrayProperty->Inner)
if ( BaseItem->GetArrayIndex() == INDEX_NONE && ItemProperty->GetOwnerProperty() == ItemProperty )
{
PropertyChain->SetActiveMemberPropertyNode(ItemProperty);
}
}
}
}
}
// Broadcast the change to any listeners
BroadcastPropertyChangedDelegates();
// Call through to the property window's notify hook.
if( InNotifyHook )
{
if ( PropertyChain->Num() == 0 )
{
InNotifyHook->NotifyPostChange( InPropertyChangedEvent, InPropertyChangedEvent.Property );
}
else
{
PropertyChain->SetActiveMemberPropertyNode( OriginalActiveProperty );
PropertyChain->SetActivePropertyNode( InPropertyChangedEvent.Property);
InPropertyChangedEvent.SetActiveMemberProperty(OriginalActiveProperty);
InNotifyHook->NotifyPostChange( InPropertyChangedEvent, &PropertyChain.Get() );
}
}
if( OriginalActiveProperty )
{
//if i have metadata forcing other property windows to rebuild
const FString& MetaData = OriginalActiveProperty->GetMetaData(TEXT("ForceRebuildProperty"));
if( MetaData.Len() > 0 )
{
// We need to find the property node beginning at the root/parent, not at our own node.
ObjectNode = FindObjectItemParent();
check(ObjectNode != NULL);
TSharedPtr<FPropertyNode> ForceRebuildNode = ObjectNode->FindChildPropertyNode( FName(*MetaData), true );
if( ForceRebuildNode.IsValid() )
{
ForceRebuildNode->RequestRebuildChildren();
}
}
}
// The value has changed so the cached value could be invalid
// Need to recurse here as we might be editing a struct with child properties that need re-caching
ClearCachedReadAddresses(true);
// Redraw viewports
FEditorSupportDelegates::RedrawAllViewports.Broadcast();
}
void FPropertyNode::BroadcastPropertyChangedDelegates()
{
PropertyValueChangedEvent.Broadcast();
// Walk through the parents and broadcast
FPropertyNode* LocalParentNode = GetParentNode();
while( LocalParentNode )
{
if( LocalParentNode->OnChildPropertyValueChanged().IsBound() )
{
LocalParentNode->OnChildPropertyValueChanged().Broadcast();
}
LocalParentNode = LocalParentNode->GetParentNode();
}
}
void FPropertyNode::BroadcastPropertyPreChangeDelegates()
{
PropertyValuePreChangeEvent.Broadcast();
// Walk through the parents and broadcast
FPropertyNode* LocalParentNode = GetParentNode();
while (LocalParentNode)
{
if (LocalParentNode->OnChildPropertyValuePreChange().IsBound())
{
LocalParentNode->OnChildPropertyValuePreChange().Broadcast();
}
LocalParentNode = LocalParentNode->GetParentNode();
}
}
void FPropertyNode::BroadcastPropertyResetToDefault()
{
PropertyResetToDefaultEvent.Broadcast();
}
void FPropertyNode::GetExpandedChildPropertyPaths(TSet<FString>& OutExpandedChildPropertyPaths) const
{
TArray<const FPropertyNode*> RecursiveStack;
RecursiveStack.Add(this);
do
{
const FPropertyNode* SearchNode = RecursiveStack.Pop();
if (SearchNode->HasNodeFlags(EPropertyNodeFlags::Expanded))
{
OutExpandedChildPropertyPaths.Add(SearchNode->PropertyPath);
for (int32 Index = 0; Index < SearchNode->GetNumChildNodes(); ++Index)
{
TSharedPtr<FPropertyNode> ChildNode = SearchNode->GetChildNode(Index);
if (ChildNode.IsValid())
{
RecursiveStack.Push(ChildNode.Get());
}
}
}
} while (RecursiveStack.Num() > 0);
}
void FPropertyNode::SetExpandedChildPropertyNodes(const TSet<FString>& InNodesToExpand)
{
TArray<FPropertyNode*> RecursiveStack;
RecursiveStack.Add(this);
do
{
FPropertyNode* SearchNode = RecursiveStack.Pop();
if (InNodesToExpand.Contains(SearchNode->PropertyPath))
{
SearchNode->SetNodeFlags(EPropertyNodeFlags::Expanded, true);
// Lets recurse over this nodes children to see if they need to be expanded
for (int32 Index = 0; Index < SearchNode->GetNumChildNodes(); ++Index)
{
TSharedPtr<FPropertyNode> ChildNode = SearchNode->GetChildNode(Index);
if (ChildNode.IsValid())
{
RecursiveStack.Push(ChildNode.Get());
}
}
}
else
{
// Collapse the target node if its not within the list of expanded nodes.
SearchNode->SetNodeFlags(EPropertyNodeFlags::Expanded, false);
}
} while (RecursiveStack.Num() > 0);
}
void FPropertyNode::SetOnRebuildChildren( FSimpleDelegate InOnRebuildChildren )
{
OnRebuildChildren = InOnRebuildChildren;
}
TSharedPtr< FPropertyItemValueDataTrackerSlate > FPropertyNode::GetValueTracker( UObject* Object, uint32 ObjIndex )
{
ensure( AsItemPropertyNode() );
TSharedPtr< FPropertyItemValueDataTrackerSlate > RetVal;
if( Object && Object != UObject::StaticClass() && Object != UObject::StaticClass()->GetDefaultObject() )
{
if( !ObjectDefaultValueTrackers.IsValidIndex(ObjIndex) )
{
uint32 NumToAdd = (ObjIndex - ObjectDefaultValueTrackers.Num()) + 1;
while( NumToAdd > 0 )
{
ObjectDefaultValueTrackers.Add( TSharedPtr<FPropertyItemValueDataTrackerSlate> () );
--NumToAdd;
}
}
TSharedPtr<FPropertyItemValueDataTrackerSlate>& ValueTracker = ObjectDefaultValueTrackers[ObjIndex];
if( !ValueTracker.IsValid() )
{
ValueTracker = MakeShareable( new FPropertyItemValueDataTrackerSlate( this, Object ) );
}
else
{
ValueTracker->Reset(this, Object);
}
RetVal = ValueTracker;
}
return RetVal;
}
TSharedRef<FEditPropertyChain> FPropertyNode::BuildPropertyChain( FProperty* InProperty ) const
{
TSharedRef<FEditPropertyChain> PropertyChain( MakeShareable( new FEditPropertyChain ) );
const FPropertyNode* ItemNode = this;
const FComplexPropertyNode* ComplexNode = FindComplexParent();
FProperty* MemberProperty = InProperty;
do
{
if (ItemNode == ComplexNode)
{
MemberProperty = PropertyChain->GetHead()->GetValue();
}
FProperty* TheProperty = ItemNode->Property.Get();
if ( TheProperty )
{
// Skip over property window items that correspond to a single element in a static array,
// or the inner property of another FProperty (e.g. FArrayProperty->Inner).
if ( ItemNode->GetArrayIndex() == INDEX_NONE && TheProperty->GetOwnerProperty() == TheProperty )
{
PropertyChain->AddHead( TheProperty );
}
}
ItemNode = ItemNode->GetParentNode();
}
while( ItemNode != NULL );
// If the modified property was a property of the object at the root of this property window, the member property will not have been set correctly
if (ItemNode == ComplexNode)
{
MemberProperty = PropertyChain->GetHead()->GetValue();
}
PropertyChain->SetActivePropertyNode( InProperty );
PropertyChain->SetActiveMemberPropertyNode( MemberProperty );
return PropertyChain;
}
TSharedRef<FEditPropertyChain> FPropertyNode::BuildPropertyChain( FProperty* InProperty, const TSet<UObject*>& InAffectedArchetypeInstances ) const
{
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain(InProperty);
PropertyChain->SetAffectedArchetypeInstances(InAffectedArchetypeInstances);
return PropertyChain;
}
TSharedRef<FEditPropertyChain> FPropertyNode::BuildPropertyChain( FProperty* InProperty, TSet<UObject*>&& InAffectedArchetypeInstances ) const
{
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain(InProperty);
PropertyChain->SetAffectedArchetypeInstances(MoveTemp(InAffectedArchetypeInstances));
return PropertyChain;
}
FPropertyChangedEvent& FPropertyNode::FixPropertiesInEvent(FPropertyChangedEvent& Event)
{
ensure(Event.Property);
TSharedRef<FEditPropertyChain> PropertyChain = BuildPropertyChain(Event.Property);
auto MemberProperty = PropertyChain->GetActiveMemberNode() ? PropertyChain->GetActiveMemberNode()->GetValue() : NULL;
if (ensure(MemberProperty))
{
Event.SetActiveMemberProperty(MemberProperty);
}
return Event;
}
void FPropertyNode::SetInstanceMetaData(const FName& Key, const FString& Value)
{
InstanceMetaData.Add(Key, Value);
}
const FString* FPropertyNode::GetInstanceMetaData(const FName& Key) const
{
return InstanceMetaData.Find(Key);
}
const TMap<FName, FString>* FPropertyNode::GetInstanceMetaDataMap() const
{
return &InstanceMetaData;
}
bool FPropertyNode::ParentOrSelfHasMetaData(const FName& MetaDataKey) const
{
return (Property.IsValid() && Property->HasMetaData(MetaDataKey)) || (ParentNode && ParentNode->ParentOrSelfHasMetaData(MetaDataKey));
}
void FPropertyNode::InvalidateCachedState()
{
bUpdateDiffersFromDefault = true;
bUpdateEditConstState = true;
for( TSharedPtr<FPropertyNode>& ChildNode : ChildNodes )
{
ChildNode->InvalidateCachedState();
}
}
/**
* Does the string compares to ensure this Name is acceptable to the filter that is passed in
* @return Return True if this property should be displayed. False if it should be culled
*/
bool FPropertyNode::IsFilterAcceptable(const TArray<FString>& InAcceptableNames, const TArray<FString>& InFilterStrings)
{
bool bCompleteMatchFound = true;
if (InFilterStrings.Num())
{
//we have to make sure one name matches all criteria
for (int32 TestNameIndex = 0; TestNameIndex < InAcceptableNames.Num(); ++TestNameIndex)
{
bCompleteMatchFound = true;
FString TestName = InAcceptableNames[TestNameIndex];
for (int32 scan = 0; scan < InFilterStrings.Num(); scan++)
{
if (!TestName.Contains(InFilterStrings[scan]))
{
bCompleteMatchFound = false;
break;
}
}
if (bCompleteMatchFound)
{
break;
}
}
}
return bCompleteMatchFound;
}
void FPropertyNode::PropagateContainerPropertyChange( UObject* ModifiedObject, const void* OriginalContainerAddr, EPropertyArrayChangeType::Type ChangeType, int32 Index, int32 SwapIndex /*= INDEX_NONE*/)
{
TArray<UObject*> AffectedInstances;
GatherInstancesAffectedByContainerPropertyChange(ModifiedObject, OriginalContainerAddr, ChangeType, AffectedInstances);
PropagateContainerPropertyChange(ModifiedObject, OriginalContainerAddr, AffectedInstances, ChangeType, Index, SwapIndex);
}
void FPropertyNode::GatherInstancesAffectedByContainerPropertyChange(UObject* ModifiedObject, const void* OriginalContainerAddr, EPropertyArrayChangeType::Type ChangeType, TArray<UObject*>& OutAffectedInstances)
{
check(OriginalContainerAddr);
FProperty* NodeProperty = GetProperty();
FPropertyNode* ParentPropertyNode = GetParentNode();
FComplexPropertyNode* ComplexParentNode = FindComplexParent();
FProperty* ConvertedProperty = NULL;
if (ChangeType == EPropertyArrayChangeType::Add || ChangeType == EPropertyArrayChangeType::Clear)
{
ConvertedProperty = NodeProperty;
}
else
{
ConvertedProperty = NodeProperty->GetOwner<FProperty>();
}
TArray<UObject*> ArchetypeInstances, ObjectsToChange;
FPropertyNode* SubobjectPropertyNode = NULL;
UObject* Object = ModifiedObject;
if (Object->HasAnyFlags(RF_ClassDefaultObject|RF_ArchetypeObject))
{
// Object is a default subobject, collect all instances.
Object->GetArchetypeInstances(ArchetypeInstances);
}
else if (Object->HasAnyFlags(RF_DefaultSubObject) && Object->GetOuter()->HasAnyFlags(RF_ClassDefaultObject|RF_ArchetypeObject))
{
// Object is a default subobject of a default object. Get the subobject property node and use its owner instead.
for (SubobjectPropertyNode = FindObjectItemParent(); SubobjectPropertyNode && !SubobjectPropertyNode->GetProperty(); SubobjectPropertyNode = SubobjectPropertyNode->GetParentNode());
if (SubobjectPropertyNode != NULL)
{
// Switch the object to the owner default object and collect its instances.
Object = Object->GetOuter();
Object->GetArchetypeInstances(ArchetypeInstances);
}
}
ObjectsToChange.Push(Object);
while (ObjectsToChange.Num() > 0)
{
check(ObjectsToChange.Num() > 0);
// Pop the first object to change
UObject* ObjToChange = ObjectsToChange[0];
UObject* ActualObjToChange = NULL;
ObjectsToChange.RemoveAt(0);
if (SubobjectPropertyNode)
{
// If the original object is a subobject, get the current object's subobject too.
// In this case we're not going to modify ObjToChange but its default subobject.
ActualObjToChange = *(UObject**)SubobjectPropertyNode->GetValueBaseAddressFromObject(ObjToChange);
}
else
{
ActualObjToChange = ObjToChange;
}
if (ActualObjToChange != ModifiedObject)
{
uint8* Addr = NULL;
if (ChangeType == EPropertyArrayChangeType::Add || ChangeType == EPropertyArrayChangeType::Clear)
{
Addr = GetValueBaseAddressFromObject(ActualObjToChange);
}
else
{
Addr = ParentPropertyNode->GetValueBaseAddressFromObject(ActualObjToChange);
}
if (Addr != nullptr)
{
if (OriginalContainerAddr == Addr)
{
if (HasNodeFlags(EPropertyNodeFlags::IsSparseClassData) || (ComplexParentNode && ComplexParentNode->AsStructureNode()))
{
// SparseClassData and StructureNodes will always return the same address from GetValueBaseAddressFromObject
// (see FPropertyNode::GetStartAddressFromObject and FStructurePropertyNode::GetValueBaseAddress)
continue;
}
checkf(false, TEXT("PropagateContainerPropertyChange tried to propagate a change onto itself!"));
}
const bool bIsDefaultContainerContent = ConvertedProperty->Identical(OriginalContainerAddr, Addr, PPF_DeepComparison);
if (bIsDefaultContainerContent)
{
OutAffectedInstances.Add(ActualObjToChange);
}
}
}
for (int32 i=0; i < ArchetypeInstances.Num(); ++i)
{
UObject* Obj = ArchetypeInstances[i];
if (Obj->GetArchetype() == ObjToChange)
{
ObjectsToChange.Push(Obj);
ArchetypeInstances.RemoveAt(i--);
}
}
}
}
void FPropertyNode::DuplicateArrayEntry(FProperty* NodeProperty, FScriptArrayHelper& ArrayHelper, int32 Index)
{
ArrayHelper.InsertValues(Index);
void* SrcAddress = ArrayHelper.GetRawPtr(Index + 1);
void* DestAddress = ArrayHelper.GetRawPtr(Index);
check(SrcAddress && DestAddress);
// Copy the selected item's value to the new item.
NodeProperty->CopyCompleteValue(DestAddress, SrcAddress);
if (FObjectProperty* ObjProp = CastField<FObjectProperty>(NodeProperty))
{
if (ObjProp->HasAnyPropertyFlags(CPF_InstancedReference))
{
UObject* CurrentObject = ObjProp->GetObjectPropertyValue(DestAddress);
// Make a deep copy
UObject* DuplicatedObject = DuplicateObject(CurrentObject, CurrentObject ? CurrentObject->GetOuter() : nullptr);
ObjProp->SetObjectPropertyValue(SrcAddress, DuplicatedObject);
}
}
else if (NodeProperty->HasAnyPropertyFlags(CPF_ContainsInstancedReference))
{
// If this is a container with instanced references within it the new entry will reference the old subobjects
// Go through and duplicate the subobjects so that each container has unique instances
FInstancedPropertyPath NodePropertyPath(NodeProperty);
FFindInstancedReferenceSubobjectHelper::ForEachInstancedSubObject<void*>(
NodePropertyPath,
SrcAddress,
[](const FInstancedSubObjRef& Ref, void* PropertyValueAddress)
{
UObject* Obj = Ref;
((FObjectProperty*)Ref.PropertyPath.Head())->SetObjectPropertyValue(PropertyValueAddress, DuplicateObject(Obj, Obj->GetOuter()));
}
);
}
}
void FPropertyNode::PropagateContainerPropertyChange( UObject* ModifiedObject, const void* OriginalContainerAddr, const TArray<UObject*>& AffectedInstances, EPropertyArrayChangeType::Type ChangeType, int32 Index, int32 SwapIndex /*= INDEX_NONE*/)
{
check(OriginalContainerAddr);
FProperty* NodeProperty = GetProperty();
FPropertyNode* ParentPropertyNode = GetParentNode();
FProperty* ConvertedProperty = NULL;
if (ChangeType == EPropertyArrayChangeType::Add || ChangeType == EPropertyArrayChangeType::Clear)
{
ConvertedProperty = NodeProperty;
}
else
{
ConvertedProperty = NodeProperty->GetOwner<FProperty>();
}
FArrayProperty* ArrayProperty = CastField<FArrayProperty>(ConvertedProperty);
FSetProperty* SetProperty = CastField<FSetProperty>(ConvertedProperty);
FMapProperty* MapProperty = CastField<FMapProperty>(ConvertedProperty);
check(ArrayProperty || SetProperty || MapProperty);
FPropertyNode* SubobjectPropertyNode = NULL;
UObject* Object = ModifiedObject;
if (Object->HasAnyFlags(RF_ClassDefaultObject|RF_ArchetypeObject))
{
// Object is a default subobject
}
else if (Object->HasAnyFlags(RF_DefaultSubObject) && Object->GetOuter()->HasAnyFlags(RF_ClassDefaultObject|RF_ArchetypeObject))
{
// Object is a default subobject of a default object. Get the subobject property node and use its owner instead.
for (SubobjectPropertyNode = FindObjectItemParent(); SubobjectPropertyNode && !SubobjectPropertyNode->GetProperty(); SubobjectPropertyNode = SubobjectPropertyNode->GetParentNode());
if (SubobjectPropertyNode != NULL)
{
// Switch the object to the owner default object
Object = Object->GetOuter();
}
}
for (UObject* InstanceToChange : AffectedInstances)
{
uint8* Addr = NULL;
if (ChangeType == EPropertyArrayChangeType::Add || ChangeType == EPropertyArrayChangeType::Clear)
{
Addr = GetValueBaseAddressFromObject(InstanceToChange);
}
else
{
Addr = ParentPropertyNode->GetValueBaseAddressFromObject(InstanceToChange);
}
if (ArrayProperty)
{
FScriptArrayHelper ArrayHelper(ArrayProperty, Addr);
int32 ElementToInitialize = -1;
switch (ChangeType)
{
case EPropertyArrayChangeType::Add:
ElementToInitialize = ArrayHelper.AddValue();
break;
case EPropertyArrayChangeType::Clear:
ArrayHelper.EmptyValues();
break;
case EPropertyArrayChangeType::Insert:
ArrayHelper.InsertValues(ArrayIndex, 1);
ElementToInitialize = ArrayIndex;
break;
case EPropertyArrayChangeType::Delete:
ArrayHelper.RemoveValues(ArrayIndex, 1);
break;
case EPropertyArrayChangeType::Duplicate:
DuplicateArrayEntry(NodeProperty, ArrayHelper, ArrayIndex);
break;
case EPropertyArrayChangeType::Swap:
if (SwapIndex != INDEX_NONE)
{
ArrayHelper.SwapValues(Index, SwapIndex);
}
break;
}
} // End Array
else if (SetProperty)
{
FScriptSetHelper SetHelper(SetProperty, Addr);
int32 ElementToInitialize = -1;
switch (ChangeType)
{
case EPropertyArrayChangeType::Add:
ElementToInitialize = SetHelper.AddDefaultValue_Invalid_NeedsRehash();
SetHelper.Rehash();
break;
case EPropertyArrayChangeType::Clear:
SetHelper.EmptyElements();
break;
case EPropertyArrayChangeType::Insert:
check(false); // Insert is not supported for sets
break;
case EPropertyArrayChangeType::Delete:
SetHelper.RemoveAt(SetHelper.FindInternalIndex(ArrayIndex));
SetHelper.Rehash();
break;
case EPropertyArrayChangeType::Duplicate:
check(false); // Duplicate not supported on sets
break;
}
} // End Set
else if (MapProperty)
{
FScriptMapHelper MapHelper(MapProperty, Addr);
// Check if the original value was the default value and change it only then
int32 ElementToInitialize = -1;
switch (ChangeType)
{
case EPropertyArrayChangeType::Add:
ElementToInitialize = MapHelper.AddDefaultValue_Invalid_NeedsRehash();
MapHelper.Rehash();
break;
case EPropertyArrayChangeType::Clear:
MapHelper.EmptyValues();
break;
case EPropertyArrayChangeType::Insert:
check(false); // Insert is not supported for maps
break;
case EPropertyArrayChangeType::Delete:
MapHelper.RemoveAt(MapHelper.FindInternalIndex(ArrayIndex));
MapHelper.Rehash();
break;
case EPropertyArrayChangeType::Duplicate:
check(false); // Duplicate is not supported for maps
break;
}
} // End Map
}
}
void FPropertyNode::PropagatePropertyChange( UObject* ModifiedObject, const TCHAR* NewValue, const FString& PreviousValue )
{
TArray<UObject*> ArchetypeInstances, ObjectsToChange;
FPropertyNode* SubobjectPropertyNode = NULL;
UObject* Object = ModifiedObject;
if (Object->HasAnyFlags(RF_ClassDefaultObject|RF_ArchetypeObject))
{
// Object is a default subobject, collect all instances.
Object->GetArchetypeInstances(ArchetypeInstances);
}
else if (Object->HasAnyFlags(RF_DefaultSubObject) && Object->GetOuter()->HasAnyFlags(RF_ClassDefaultObject|RF_ArchetypeObject))
{
// Object is a default subobject of a default object. Get the subobject property node and use its owner instead.
for (SubobjectPropertyNode = FindObjectItemParent(); SubobjectPropertyNode && !SubobjectPropertyNode->GetProperty(); SubobjectPropertyNode = SubobjectPropertyNode->GetParentNode());
if (SubobjectPropertyNode != NULL)
{
// Switch the object to the owner default object and collect its instances.
Object = Object->GetOuter();
Object->GetArchetypeInstances(ArchetypeInstances);
}
}
static const FName FNAME_EditableWhenInherited = GET_MEMBER_NAME_CHECKED(UActorComponent,bEditableWhenInherited);
if (GetProperty()->GetFName() == FNAME_EditableWhenInherited && ModifiedObject->IsA<UActorComponent>() && FString(TEXT("False")) == NewValue)
{
FBlueprintEditorUtils::HandleDisableEditableWhenInherited(ModifiedObject, ArchetypeInstances);
}
FPropertyNode* Parent = GetParentNode();
FProperty* ParentProp = Parent->GetProperty();
FArrayProperty* ParentArrayProp = CastField<FArrayProperty>(ParentProp);
FMapProperty* ParentMapProp = CastField<FMapProperty>(ParentProp);
FSetProperty* ParentSetProp = CastField<FSetProperty>(ParentProp);
FProperty* Prop = GetProperty();
if (ParentArrayProp && ParentArrayProp->Inner != Prop)
{
ParentArrayProp = nullptr;
}
if (ParentMapProp && ParentMapProp->KeyProp != Prop && ParentMapProp->ValueProp != Prop)
{
ParentMapProp = nullptr;
}
if (ParentSetProp && ParentSetProp->ElementProp != Prop)
{
ParentSetProp = nullptr;
}
ObjectsToChange.Push(Object);
while (ObjectsToChange.Num() > 0)
{
check(ObjectsToChange.Num() > 0);
// Pop the first object to change
UObject* ObjToChange = ObjectsToChange[0];
UObject* ActualObjToChange = NULL;
ObjectsToChange.RemoveAt(0);
if (SubobjectPropertyNode)
{
// If the original object is a subobject, get the current object's subobject too.
// In this case we're not going to modify ObjToChange but its default subobject.
ActualObjToChange = *(UObject**)SubobjectPropertyNode->GetValueBaseAddressFromObject(ObjToChange);
}
else
{
ActualObjToChange = ObjToChange;
}
if (ActualObjToChange != ModifiedObject)
{
uint8* DestSimplePropAddr = GetValueBaseAddressFromObject(ActualObjToChange);
if (DestSimplePropAddr != nullptr)
{
FProperty* ComplexProperty = Prop;
FPropertyNode* ComplexPropertyNode = this;
if (ParentArrayProp || ParentMapProp || ParentSetProp)
{
ComplexProperty = ParentProp;
ComplexPropertyNode = ParentNode;
}
uint8* DestComplexPropAddr = ComplexPropertyNode->GetValueBaseAddressFromObject(ActualObjToChange);
uint8* ModifiedComplexPropAddr = ComplexPropertyNode->GetValueBaseAddressFromObject(ModifiedObject);
bool bShouldImport = false;
{
uint8* TempComplexPropAddr = (uint8*)FMemory::Malloc(ComplexProperty->GetSize(), ComplexProperty->GetMinAlignment());
ComplexProperty->InitializeValue(TempComplexPropAddr);
ON_SCOPE_EXIT
{
ComplexProperty->DestroyValue(TempComplexPropAddr);
FMemory::Free(TempComplexPropAddr);
};
// Importing the previous value into the temporary property can potentially affect shared state (such as FText display string values), so we back-up the current value
// before we do this, so that we can restore it once we've checked whether the two properties are identical
// This ensures that shared state keeps the correct value, even if the destination property itself isn't imported (or only partly imported, as is the case with arrays/maps/sets)
FString CurrentValue;
ComplexProperty->ExportText_Direct(CurrentValue, ModifiedComplexPropAddr, ModifiedComplexPropAddr, ModifiedObject, PPF_None);
ComplexProperty->ImportText_Direct(*PreviousValue, TempComplexPropAddr, ModifiedObject, PPF_SerializedAsImportText);
bShouldImport = ComplexProperty->Identical(DestComplexPropAddr, TempComplexPropAddr, PPF_DeepComparison);
ComplexProperty->ImportText_Direct(*CurrentValue, TempComplexPropAddr, ModifiedObject, PPF_None);
}
// Only import if the value matches the previous value of the property that changed
if (bShouldImport)
{
Prop->ImportText_Direct(NewValue, DestSimplePropAddr, ActualObjToChange, PPF_InstanceSubobjects);
}
}
}
for (int32 InstanceIndex = 0; InstanceIndex < ArchetypeInstances.Num(); ++InstanceIndex)
{
UObject* Obj = ArchetypeInstances[InstanceIndex];
if (Obj->GetArchetype() == ObjToChange)
{
ObjectsToChange.Push(Obj);
ArchetypeInstances.RemoveAt(InstanceIndex--);
}
}
}
}
void FPropertyNode::AddRestriction( TSharedRef<const class FPropertyRestriction> Restriction )
{
Restrictions.AddUnique(Restriction);
}
bool FPropertyNode::IsHidden(const FString& Value, TArray<FText>* OutReasons) const
{
bool bIsHidden = false;
for( auto It = Restrictions.CreateConstIterator() ; It ; ++It )
{
TSharedRef<const FPropertyRestriction> Restriction = (*It);
if( Restriction->IsValueHidden(Value) )
{
bIsHidden = true;
if (OutReasons)
{
OutReasons->Add(Restriction->GetReason());
}
else
{
break;
}
}
}
return bIsHidden;
}
bool FPropertyNode::IsDisabled(const FString& Value, TArray<FText>* OutReasons) const
{
bool bIsDisabled = false;
for (const TSharedRef<const FPropertyRestriction>& Restriction : Restrictions)
{
if( Restriction->IsValueDisabled(Value) )
{
bIsDisabled = true;
if (OutReasons)
{
OutReasons->Add(Restriction->GetReason());
}
else
{
break;
}
}
}
return bIsDisabled;
}
bool FPropertyNode::IsRestricted(const FString& Value, TArray<FText>& OutReasons) const
{
const bool bIsHidden = IsHidden(Value, &OutReasons);
const bool bIsDisabled = IsDisabled(Value, &OutReasons);
return (bIsHidden || bIsDisabled);
}
bool FPropertyNode::GenerateRestrictionToolTip(const FString& Value, FText& OutTooltip) const
{
static FText ToolTipFormat = NSLOCTEXT("PropertyRestriction", "TooltipFormat ", "{0}{1}");
static FText MultipleRestrictionsToolTopAdditionFormat = NSLOCTEXT("PropertyRestriction", "MultipleRestrictionToolTipAdditionFormat ", "({0} restrictions...)");
TArray<FText> Reasons;
const bool bRestricted = IsRestricted(Value, Reasons);
FText Ret;
if( bRestricted && Reasons.Num() > 0 )
{
if( Reasons.Num() > 1 )
{
FText NumberOfRestrictions = FText::AsNumber(Reasons.Num());
OutTooltip = FText::Format(ToolTipFormat, Reasons[0], FText::Format(MultipleRestrictionsToolTopAdditionFormat,NumberOfRestrictions));
}
else
{
OutTooltip = FText::Format(ToolTipFormat, Reasons[0], FText());
}
}
return bRestricted;
}
#undef LOCTEXT_NAMESPACE