Files
UnrealEngineUWP/Engine/Source/Editor/PropertyEditor/Private/SDetailsView.cpp
matt kuhlenschmidt 2466840461 Added filtering to details panels to filter the set of incoming objects passed to a details panel
Changed the way details panels handle multiple root objects.  The filter can now specify this without setting a specific flag on a details panel at creation time.

[CODEREVIEW] chris.gagnon


#ROBOMERGE-OWNER: matt.kuhlenschmidt
#ROBOMERGE-AUTHOR: matt.kuhlenschmidt
#ROBOMERGE-SOURCE: CL 11308033 via CL 11308037 via CL 11308040
#ROBOMERGE-BOT: (v653-11302973)
#rb none

[CL 11310703 by matt kuhlenschmidt in Main branch]
2020-02-10 15:43:53 -05:00

958 lines
29 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "SDetailsView.h"
#include "GameFramework/Actor.h"
#include "Framework/MultiBox/MultiBoxBuilder.h"
#include "Misc/ConfigCacheIni.h"
#include "ObjectPropertyNode.h"
#include "Modules/ModuleManager.h"
#include "Widgets/Images/SImage.h"
#include "Widgets/Input/SButton.h"
#include "Widgets/Input/SComboButton.h"
#include "SDetailNameArea.h"
#include "PropertyEditorHelpers.h"
#include "UserInterface/PropertyDetails/PropertyDetailsUtilities.h"
#include "Widgets/Colors/SColorPicker.h"
#include "Widgets/Input/SSearchBox.h"
#include "Classes/EditorStyleSettings.h"
#include "DetailLayoutBuilderImpl.h"
#include "DetailsViewPropertyGenerationUtilities.h"
#include "DetailsViewGenericObjectFilter.h"
#define LOCTEXT_NAMESPACE "SDetailsView"
SDetailsView::~SDetailsView()
{
const FRootPropertyNodeList& RootNodes = GetRootNodes();
for(const TSharedPtr<FComplexPropertyNode>& RootNode : RootNodes)
{
SaveExpandedItems(RootNode.ToSharedRef());
}
};
/**
* Constructs the widget
*
* @param InArgs Declaration from which to construct this widget.
*/
void SDetailsView::Construct(const FArguments& InArgs, const FDetailsViewArgs& InDetailsViewArgs)
{
DetailsViewArgs = InDetailsViewArgs;
SetObjectFilter(InDetailsViewArgs.ObjectFilter);
bViewingClassDefaultObject = false;
PropertyUtilities = MakeShareable( new FPropertyDetailsUtilities( *this ) );
PropertyGenerationUtilities = MakeShareable( new FDetailsViewPropertyGenerationUtilities(*this) );
ColumnWidth = DetailsViewArgs.ColumnWidth;
ColumnSizeData.LeftColumnWidth = TAttribute<float>( this, &SDetailsView::OnGetLeftColumnWidth );
ColumnSizeData.RightColumnWidth = TAttribute<float>( this, &SDetailsView::OnGetRightColumnWidth );
ColumnSizeData.OnWidthChanged = SSplitter::FOnSlotResized::CreateSP( this, &SDetailsView::OnSetColumnWidth );
// We want the scrollbar to always be visible when objects are selected, but not when there is no selection - however:
// - We can't use AlwaysShowScrollbar for this, as this will also show the scrollbar when nothing is selected
// - We can't use the Visibility construction parameter, as it gets translated into user visibility and can hide the scrollbar even when objects are selected
// We instead have to explicitly set the visibility after the scrollbar has been constructed to get the exact behavior we want
TSharedRef<SScrollBar> ExternalScrollbar = SNew(SScrollBar);
ExternalScrollbar->SetVisibility( TAttribute<EVisibility>( this, &SDetailsView::GetScrollBarVisibility ) );
FMenuBuilder DetailViewOptions( true, nullptr);
if (DetailsViewArgs.bShowModifiedPropertiesOption)
{
DetailViewOptions.AddMenuEntry(
LOCTEXT("ShowOnlyModified", "Show Only Modified Properties"),
LOCTEXT("ShowOnlyModified_ToolTip", "Displays only properties which have been changed from their default"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP( this, &SDetailsView::OnShowOnlyModifiedClicked ),
FCanExecuteAction(),
FIsActionChecked::CreateSP( this, &SDetailsView::IsShowOnlyModifiedChecked )
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
}
if (DetailsViewArgs.bShowCustomFilterOption)
{
TAttribute<FText> CustomFilterLabelDelegate;
CustomFilterLabelDelegate.BindRaw(this, &SDetailsView::GetCustomFilterLabel);
DetailViewOptions.AddMenuEntry(
CustomFilterLabelDelegate,
FText(),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP(this, &SDetailsView::OnCustomFilterClicked),
FCanExecuteAction(),
FIsActionChecked::CreateSP(this, &SDetailsView::IsCustomFilterChecked)
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
}
if( DetailsViewArgs.bShowDifferingPropertiesOption )
{
DetailViewOptions.AddMenuEntry(
LOCTEXT("ShowOnlyDiffering", "Show Only Differing Properties"),
LOCTEXT("ShowOnlyDiffering_ToolTip", "Displays only properties in this instance which have been changed or added from the instance being compared"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP(this, &SDetailsView::OnShowOnlyDifferingClicked),
FCanExecuteAction(),
FIsActionChecked::CreateSP(this, &SDetailsView::IsShowOnlyDifferingChecked)
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
}
if (DetailsViewArgs.bShowKeyablePropertiesOption)
{
DetailViewOptions.AddMenuEntry(
LOCTEXT("ShowOnlyKeyable", "Show Only Keyable Properties"),
LOCTEXT("ShowOnlyKeyable_ToolTip", "Displays only properties which are keyable"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP(this, &SDetailsView::OnShowKeyableClicked),
FCanExecuteAction(),
FIsActionChecked::CreateSP(this, &SDetailsView::IsShowKeyableChecked)
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
}
if (DetailsViewArgs.bShowAnimatedPropertiesOption)
{
DetailViewOptions.AddMenuEntry(
LOCTEXT("ShowAnimated", "Show Only Animated Properties"),
LOCTEXT("ShowAnimated_ToolTip", "Displays only properties which are animated (have tracks)"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP(this, &SDetailsView::OnShowAnimatedClicked),
FCanExecuteAction(),
FIsActionChecked::CreateSP(this, &SDetailsView::IsShowAnimatedChecked)
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
}
DetailViewOptions.AddMenuEntry(
LOCTEXT("ShowAllAdvanced", "Show All Advanced Details"),
LOCTEXT("ShowAllAdvanced_ToolTip", "Shows all advanced detail sections in each category"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP( this, &SDetailsView::OnShowAllAdvancedClicked ),
FCanExecuteAction(),
FIsActionChecked::CreateSP( this, &SDetailsView::IsShowAllAdvancedChecked )
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
DetailViewOptions.AddMenuEntry(
LOCTEXT("ShowHiddenPropertiesWhilePlaying", "Show Hidden Properties while Playing"),
LOCTEXT("ShowHiddenPropertiesWhilePlaying_ToolTip", "When Playing or Simulating, shows all properties (even non-visible and non-editable properties), if the object belongs to a simulating world. This is useful for debugging."),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP( this, &SDetailsView::OnShowHiddenPropertiesWhilePlayingClicked ),
FCanExecuteAction(),
FIsActionChecked::CreateSP( this, &SDetailsView::IsShowHiddenPropertiesWhilePlayingChecked )
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
DetailViewOptions.AddMenuEntry(
LOCTEXT("ShowAllChildrenIfCategoryMatches", "Show Child On Category Match"),
LOCTEXT("ShowAllChildrenIfCategoryMatches_ToolTip", "Shows children if their category matches the search criteria"),
FSlateIcon(),
FUIAction(
FExecuteAction::CreateSP( this, &SDetailsView::OnShowAllChildrenIfCategoryMatchesClicked ),
FCanExecuteAction(),
FIsActionChecked::CreateSP( this, &SDetailsView::IsShowAllChildrenIfCategoryMatchesChecked )
),
NAME_None,
EUserInterfaceActionType::ToggleButton
);
DetailViewOptions.AddMenuEntry(
LOCTEXT("CollapseAll", "Collapse All Categories"),
LOCTEXT("CollapseAll_ToolTip", "Collapses all root level categories"),
FSlateIcon(),
FUIAction(FExecuteAction::CreateSP(this, &SDetailsView::SetRootExpansionStates, /*bExpanded=*/false, /*bRecurse=*/false )));
DetailViewOptions.AddMenuEntry(
LOCTEXT("ExpandAll", "Expand All Categories"),
LOCTEXT("ExpandAll_ToolTip", "Expands all root level categories"),
FSlateIcon(),
FUIAction(FExecuteAction::CreateSP(this, &SDetailsView::SetRootExpansionStates, /*bExpanded=*/true, /*bRecurse=*/false )));
FilterRow =
SNew( SHorizontalBox )
.Visibility( this, &SDetailsView::GetFilterBoxVisibility )
+SHorizontalBox::Slot()
.FillWidth( 1 )
[
SNew(SOverlay)
+SOverlay::Slot()
.Padding(0.0f, 0.0f, 0.0f, 0.0f)
[
SNew(SImage)
.Image(FEditorStyle::GetBrush("Searching.SearchActiveTab"))
.Visibility_Lambda([&](){ return this->bHasActiveFilter ? EVisibility::Visible : EVisibility::Collapsed; })
]
+SOverlay::Slot()
.Padding(2.f, 2.0f, 4.f, 2.f)
.VAlign( VAlign_Center )
[
// Create the search box
SAssignNew(SearchBox, SSearchBox)
.HintText(LOCTEXT("SearchDetailsHint", "Search Details"))
.OnTextChanged(this, &SDetailsView::OnFilterTextChanged)
.OnTextCommitted(this, &SDetailsView::OnFilterTextCommitted)
.AddMetaData<FTagMetaData>(TEXT("Details.Search"))
]
];
if (DetailsViewArgs.bShowPropertyMatrixButton)
{
FilterRow->AddSlot()
.Padding(4.0f, 0.0f, 0.0f, 0.0f)
.AutoWidth()
[
// Create the property matrix button
SNew(SButton)
.OnClicked(this, &SDetailsView::OnOpenRawPropertyEditorClicked)
.IsEnabled(this, &SDetailsView::CanOpenRawPropertyEditor)
.ToolTipText(LOCTEXT("RawPropertyEditorButtonLabel", "Open Selection in Property Matrix"))
[
SNew(SImage)
.Image(FEditorStyle::GetBrush("DetailsView.EditRawProperties"))
]
];
}
if (DetailsViewArgs.bShowOptions)
{
FilterRow->AddSlot()
.HAlign(HAlign_Right)
.AutoWidth()
[
SNew( SComboButton )
.ContentPadding(0)
.ForegroundColor( FSlateColor::UseForeground() )
.ButtonStyle( FEditorStyle::Get(), "ToggleButton" )
.AddMetaData<FTagMetaData>(FTagMetaData(TEXT("ViewOptions")))
.MenuContent()
[
DetailViewOptions.MakeWidget()
]
.ButtonContent()
[
SNew(SImage)
.Image( FEditorStyle::GetBrush("GenericViewButton") )
]
];
}
// Create the name area which does not change when selection changes
SAssignNew(NameArea, SDetailNameArea, &SelectedObjects)
// the name area is only for actors
.Visibility(this, &SDetailsView::GetActorNameAreaVisibility)
.OnLockButtonClicked(this, &SDetailsView::OnLockButtonClicked)
.IsLocked(this, &SDetailsView::IsLocked)
.ShowLockButton(DetailsViewArgs.bLockable)
.ShowActorLabel(DetailsViewArgs.bShowActorLabel)
// only show the selection tip if we're not selecting objects
.SelectionTip(!DetailsViewArgs.bHideSelectionTip);
TSharedRef<SVerticalBox> VerticalBox = SNew(SVerticalBox);
if( !DetailsViewArgs.bCustomNameAreaLocation )
{
VerticalBox->AddSlot()
.AutoHeight()
.Padding(0.0f, 0.0f, 0.0f, 4.0f)
[
NameArea.ToSharedRef()
];
}
if( !DetailsViewArgs.bCustomFilterAreaLocation )
{
VerticalBox->AddSlot()
.AutoHeight()
[
FilterRow.ToSharedRef()
];
}
VerticalBox->AddSlot()
.FillHeight(1)
.Padding(0)
[
SNew(SOverlay)
+ SOverlay::Slot()
[
ConstructTreeView(ExternalScrollbar)
]
+ SOverlay::Slot()
.HAlign(HAlign_Right)
[
SNew(SBox)
.WidthOverride(16.0f)
[
ExternalScrollbar
]
]
+ SOverlay::Slot()
[
SNew(SImage)
.Image(FEditorStyle::GetBrush("Searching.SearchActiveBorder"))
.Visibility_Lambda([&]() { return this->bHasActiveFilter ? EVisibility::HitTestInvisible : EVisibility::Collapsed; })
]
];
ChildSlot
[
VerticalBox
];
}
TSharedRef<SDetailTree> SDetailsView::ConstructTreeView( TSharedRef<SScrollBar>& ScrollBar )
{
check( !DetailTree.IsValid() || DetailTree.IsUnique() );
return
SAssignNew(DetailTree, SDetailTree)
.Visibility(this, &SDetailsView::GetTreeVisibility)
.TreeItemsSource(&RootTreeNodes)
.OnGetChildren(this, &SDetailsView::OnGetChildrenForDetailTree)
.OnSetExpansionRecursive(this, &SDetailsView::SetNodeExpansionStateRecursive)
.OnGenerateRow(this, &SDetailsView::OnGenerateRowForDetailTree)
.OnExpansionChanged(this, &SDetailsView::OnItemExpansionChanged)
.SelectionMode(ESelectionMode::None)
.HandleDirectionalNavigation(false)
.AllowOverscroll(DetailsViewArgs.bShowScrollBar ? EAllowOverscroll::Yes : EAllowOverscroll::No)
.ExternalScrollbar(ScrollBar);
}
bool SDetailsView::CanOpenRawPropertyEditor() const
{
return SelectedObjects.Num() > 0 && IsPropertyEditingEnabled();
}
FReply SDetailsView::OnOpenRawPropertyEditorClicked()
{
FPropertyEditorModule& PropertyEditorModule = FModuleManager::LoadModuleChecked<FPropertyEditorModule>( "PropertyEditor" );
PropertyEditorModule.CreatePropertyEditorToolkit( EToolkitMode::Standalone, TSharedPtr<IToolkitHost>(), SelectedObjects );
return FReply::Handled();
}
EVisibility SDetailsView::GetActorNameAreaVisibility() const
{
const bool bVisible = DetailsViewArgs.NameAreaSettings != FDetailsViewArgs::HideNameArea && !bViewingClassDefaultObject;
return bVisible ? EVisibility::Visible : EVisibility::Collapsed;
}
EVisibility SDetailsView::GetScrollBarVisibility() const
{
const bool bHasAnythingToShow = RootTreeNodes.Num() > 0;
const bool bShowScrollBar = DetailsViewArgs.bShowScrollBar && bHasAnythingToShow;
return bShowScrollBar ? EVisibility::Visible : EVisibility::Collapsed;
}
void SDetailsView::ForceRefresh()
{
TArray<UObject*> NewObjectList;
const FRootPropertyNodeList& RootNodes = GetRootNodes();
for(const TSharedPtr<FComplexPropertyNode>& ComplexRootNode : RootNodes)
{
FObjectPropertyNode* RootNode = ComplexRootNode->AsObjectNode();
if(RootNode)
{
// Simply re-add the same existing objects to cause a refresh
for(TPropObjectIterator Itor(RootNode->ObjectIterator()); Itor; ++Itor)
{
TWeakObjectPtr<UObject> Object = *Itor;
if(Object.IsValid())
{
NewObjectList.Add(Object.Get());
}
}
}
}
SetObjectArrayPrivate( NewObjectList );
}
void SDetailsView::MoveScrollOffset(int32 DeltaOffset)
{
DetailTree->AddScrollOffset((float)DeltaOffset);
}
void SDetailsView::SetObjects(const TArray<UObject*>& InObjects, bool bForceRefresh/* = false*/, bool bOverrideLock/* = false*/)
{
if (!IsLocked() || bOverrideLock)
{
if( bForceRefresh || ShouldSetNewObjects(InObjects) )
{
SetObjectArrayPrivate(InObjects);
}
}
}
void SDetailsView::SetObjects(const TArray<TWeakObjectPtr<UObject>>& InObjects, bool bForceRefresh/* = false*/, bool bOverrideLock/* = false*/)
{
if (!IsLocked() || bOverrideLock)
{
TArray<UObject*> SourceObjects;
SourceObjects.Reserve(InObjects.Num());
for (const TWeakObjectPtr<UObject>& Object : InObjects)
{
if (Object.IsValid())
{
SourceObjects.Add(Object.Get());
}
}
if(bForceRefresh || ShouldSetNewObjects(SourceObjects))
{
SetObjectArrayPrivate(SourceObjects);
}
}
}
void SDetailsView::SetObject(UObject* InObject, bool bForceRefresh)
{
TArray<UObject*> SourceObjects;
SourceObjects.Reserve(1);
SourceObjects.Add(InObject);
SetObjects(SourceObjects, bForceRefresh);
}
void SDetailsView::RemoveInvalidObjects()
{
TArray<UObject*> ResetArray;
bool bAllFound = true;
for(const TSharedPtr<FComplexPropertyNode>& ComplexRootNode : RootPropertyNodes)
{
FObjectPropertyNode* RootPropertyNode = ComplexRootNode->AsObjectNode();
if(RootPropertyNode)
{
for(TPropObjectIterator Itor(RootPropertyNode->ObjectIterator()); Itor; ++Itor)
{
TWeakObjectPtr<UObject> Object = *Itor;
if(Object.IsValid() && !Object->IsPendingKill())
{
ResetArray.Add(Object.Get());
}
else
{
bAllFound = false;
}
}
}
}
if (!bAllFound)
{
SetObjectArrayPrivate(ResetArray);
}
}
void SDetailsView::SetObjectPackageOverrides(const TMap<TWeakObjectPtr<UObject>, TWeakObjectPtr<UPackage>>& InMapping)
{
for(TSharedPtr<FComplexPropertyNode>& ComplexRootNode : RootPropertyNodes)
{
FObjectPropertyNode* RootNode = ComplexRootNode->AsObjectNode();
if(RootNode)
{
RootNode->SetObjectPackageOverrides(InMapping);
}
}
}
void SDetailsView::SetRootObjectCustomizationInstance(TSharedPtr<IDetailRootObjectCustomization> InRootObjectCustomization)
{
RootObjectCustomization = InRootObjectCustomization;
RerunCurrentFilter();
}
void SDetailsView::ClearSearch()
{
CurrentFilter.FilterStrings.Empty();
SearchBox->SetText(FText::GetEmpty());
RerunCurrentFilter();
}
void SDetailsView::SetObjectFilter(TSharedPtr<FDetailsViewObjectFilter> InFilter)
{
ObjectFilter = InFilter;
if (!ObjectFilter.IsValid())
{
ObjectFilter = MakeShared<FDetailsViewDefaultObjectFilter>(!!DetailsViewArgs.bAllowMultipleTopLevelObjects);
}
}
bool SDetailsView::ShouldSetNewObjects(const TArray<UObject*>& InObjects) const
{
bool bShouldSetObjects = false;
const bool bHadBSPBrushSelected = SelectedActorInfo.bHaveBSPBrush;
if( bHadBSPBrushSelected == true )
{
// If a BSP brush was selected we need to refresh because surface could have been selected and the object set not updated
bShouldSetObjects = true;
}
else if( InObjects.Num() != GetNumObjects() )
{
// If the object arrays differ in size then at least one object is different so we must reset
bShouldSetObjects = true;
}
else if(InObjects.Num() == 0)
{
// User is likely resetting details panel
bShouldSetObjects = true;
}
else
{
// Check to see if the objects passed in are different. If not we do not need to set anything
TSet<UObject*> NewObjects;
NewObjects.Append(InObjects);
if(RootPropertyNodes.Num() > 1)
{
// For multiple top level node support, if the single object in each node is not found in the new object set
// then we need to refresh
for(int32 RootNodeIndex = 0; RootNodeIndex < RootPropertyNodes.Num(); ++RootNodeIndex)
{
FObjectPropertyNode* RootPropertyNode = RootPropertyNodes[RootNodeIndex]->AsObjectNode();
if(RootPropertyNode && RootPropertyNode->GetNumObjects() > 0)
{
if(!NewObjects.Contains(RootPropertyNode->GetUObject(0)))
{
bShouldSetObjects = true;
break;
}
}
else
{
bShouldSetObjects = true;
break;
}
}
}
else
{
FObjectPropertyNode* RootPropertyNode = RootPropertyNodes[0]->AsObjectNode();
if( RootPropertyNode )
{
for(TPropObjectIterator Itor(RootPropertyNode->ObjectIterator()); Itor; ++Itor)
{
TWeakObjectPtr<UObject> Object = *Itor;
if(Object.IsValid() && !NewObjects.Contains(Object.Get()))
{
// An existing object is not in the list of new objects to set
bShouldSetObjects = true;
break;
}
else if(!Object.IsValid())
{
// An existing object is invalid
bShouldSetObjects = true;
break;
}
}
}
else
{
bShouldSetObjects = true;
}
}
}
if (!bShouldSetObjects && AssetSelectionUtils::IsAnySurfaceSelected(nullptr))
{
bShouldSetObjects = true;
}
return bShouldSetObjects;
}
int32 SDetailsView::GetNumObjects() const
{
if(RootPropertyNodes.Num() > 1)
{
return RootPropertyNodes.Num();
}
else if( RootPropertyNodes.Num() > 0 && RootPropertyNodes[0]->AsObjectNode())
{
return RootPropertyNodes[0]->AsObjectNode()->GetNumObjects();
}
return 0;
}
void SDetailsView::SetObjectArrayPrivate(const TArray<UObject*>& InObjects)
{
double StartTime = FPlatformTime::Seconds();
const TArray<FDetailsViewObjectRoot> Roots = ObjectFilter->FilterObjects(InObjects);
PreSetObject(Roots.Num());
// Selected actors for building SelectedActorInfo
TArray<AActor*> SelectedRawActors;
bViewingClassDefaultObject = InObjects.Num() > 0 ? true : false;
bool bOwnedByLockedLevel = false;
check(RootPropertyNodes.Num() == Roots.Num());
for(int32 RootIndex = 0; RootIndex < Roots.Num(); ++RootIndex)
{
const FDetailsViewObjectRoot& Root = Roots[RootIndex];
FObjectPropertyNode* RootNode = RootPropertyNodes[RootIndex]->AsObjectNode();
for(const TWeakObjectPtr<UObject>& Object : Root.Objects)
{
if (Object.IsValid())
{
bViewingClassDefaultObject &= Object->HasAnyFlags(RF_ClassDefaultObject);
RootNode->AddObject(Object.Get());
SelectedObjects.Add(Object);
if (AActor* Actor = Cast<AActor>(Object.Get()))
{
SelectedActors.Add(Actor);
SelectedRawActors.Add(Actor);
}
}
}
}
if(SelectedObjects.Num() == 0)
{
// Unlock the view automatically if we are viewing nothing
bIsLocked = false;
}
// Selection changed, refresh the detail area
if (DetailsViewArgs.NameAreaSettings != FDetailsViewArgs::ActorsUseNameArea && DetailsViewArgs.NameAreaSettings != FDetailsViewArgs::ComponentsAndActorsUseNameArea)
{
NameArea->Refresh(SelectedObjects);
}
else
{
NameArea->Refresh(SelectedActors, SelectedObjects, DetailsViewArgs.NameAreaSettings);
}
// When selection changes rebuild information about the selection
SelectedActorInfo = AssetSelectionUtils::BuildSelectedActorInfo(SelectedRawActors);
PostSetObject(Roots);
// Set the title of the window based on the objects we are viewing
// Or call the delegate for handling when the title changed
FString Title;
if(SelectedObjects.Num() == 0 )
{
Title = NSLOCTEXT("PropertyView", "NothingSelectedTitle", "Nothing selected").ToString();
}
else if(Roots.Num() == 1 && RootPropertyNodes[0]->AsObjectNode()->GetNumObjects() == 1)
{
// if the object is the default metaobject for a UClass, use the UClass's name instead
UObject* Object = RootPropertyNodes[0]->AsObjectNode()->GetUObject(0);
FString ObjectName;
if ( Object && Object->GetClass()->GetDefaultObject() == Object )
{
ObjectName = Object->GetClass()->GetName();
}
else if( Object )
{
ObjectName = Object->GetName();
// Is this an actor? If so, it might have a friendly name to display
const AActor* Actor = Cast<const AActor >( Object );
if( Actor != nullptr)
{
// Use the friendly label for this actor
ObjectName = Actor->GetActorLabel();
}
}
Title = ObjectName;
}
else if(Roots.Num() > 1)
{
Title = FText::Format(NSLOCTEXT("PropertyView", "MultipleToLevelObjectsSelectedFmt", "{0} selected"), Roots.Num()).ToString();
}
else
{
FObjectPropertyNode* RootPropertyNode = RootPropertyNodes[0]->AsObjectNode();
Title = FText::Format( NSLOCTEXT("PropertyView", "MultipleSelected", "{0} ({1} selected)"), FText::FromString(RootPropertyNode->GetObjectBaseClass()->GetName()), RootPropertyNode->GetNumObjects() ).ToString();
}
OnObjectArrayChanged.ExecuteIfBound(Title, InObjects);
double ElapsedTime = FPlatformTime::Seconds() - StartTime;
}
void SDetailsView::ReplaceObjects( const TMap<UObject*, UObject*>& OldToNewObjectMap )
{
TArray<UObject*> NewObjectList;
bool bObjectsReplaced = false;
TArray<FObjectPropertyNode*> ObjectNodes;
for (TSharedPtr<FComplexPropertyNode>& RootNode : RootPropertyNodes)
{
PropertyEditorHelpers::CollectObjectNodes(RootNode, ObjectNodes);
}
for (FObjectPropertyNode* CurrentNode : ObjectNodes)
{
// Scan all objects and look for objects which need to be replaced
for (int32 Idx = 0; Idx < CurrentNode->GetNumObjects(); ++Idx)
{
// We could be replacing an object that has already been garbage collected, so look up the object using the raw pointer.
TWeakObjectPtr<UObject> Existing = CurrentNode->GetInstanceAsUObject(Idx);
UObject* Replacement = OldToNewObjectMap.FindRef(Existing.GetEvenIfUnreachable());
// Note: only root objects count for the new object list.
// Sub-Objects (i.e components) count as needing to be replaced but they don't belong in the top level object list)
if (Replacement)
{
bObjectsReplaced = true;
if (CurrentNode->IsRootNode())
{
NewObjectList.Add(Replacement);
}
}
else if (CurrentNode->IsRootNode())
{
NewObjectList.Add(Existing.Get());
}
}
}
if (bObjectsReplaced)
{
SetObjectArrayPrivate(NewObjectList);
}
}
void SDetailsView::RemoveDeletedObjects(const TArray<UObject*>& DeletedObjects)
{
TArray<UObject*> NewObjectList;
bool bObjectsRemoved = false;
for(const TSharedPtr<FComplexPropertyNode>& ComplexRootNode : RootPropertyNodes)
{
FObjectPropertyNode* RootPropertyNode = ComplexRootNode->AsObjectNode();
// Scan all objects and look for objects which need to be replaced
for (TPropObjectIterator Itor( RootPropertyNode->ObjectIterator() ); Itor; ++Itor)
{
if(DeletedObjects.Contains( Itor->Get()))
{
// An object we had needs to be removed
bObjectsRemoved = true;
}
else
{
// If the deleted object list does not contain the current object, its ok to keep it in the list
NewObjectList.Add( Itor->Get() );
}
}
}
// if any objects were replaced update the observed objects
if( bObjectsRemoved )
{
SetObjectArrayPrivate(NewObjectList);
}
}
/** Called before during SetObjectArray before we change the objects being observed */
void SDetailsView::PreSetObject(int32 InNewNumObjects)
{
// Save existing expanded items first
for(TSharedPtr<FComplexPropertyNode>& RootNode : RootPropertyNodes)
{
SaveExpandedItems(RootNode.ToSharedRef());
RootNodesPendingKill.Add(RootNode);
FObjectPropertyNode* RootObjectNode = RootNode->AsObjectNode();
RootObjectNode->RemoveAllObjects();
RootObjectNode->ClearCachedReadAddresses(true);
RootObjectNode->ClearObjectPackageOverrides();
}
for(const FDetailLayoutData& Layout : DetailLayouts)
{
FRootPropertyNodeList& ExternalRootPropertyNodes = Layout.DetailLayout->GetExternalRootPropertyNodes();
for (auto ExternalRootNode : ExternalRootPropertyNodes)
{
if (ExternalRootNode.IsValid())
{
SaveExpandedItems(ExternalRootNode.ToSharedRef());
FComplexPropertyNode* ComplexNode = ExternalRootNode->AsComplexNode();
if (ComplexNode)
{
ComplexNode->Disconnect();
}
}
}
}
RootPropertyNodes.Empty(InNewNumObjects);
ExpandedDetailNodes.Empty();
for (int32 NewRootIndex = 0; NewRootIndex < InNewNumObjects; ++NewRootIndex)
{
RootPropertyNodes.Add(MakeShareable(new FObjectPropertyNode));
}
SelectedActors.Empty();
SelectedObjects.Empty();
}
/** Called at the end of SetObjectArray after we change the objects being observed */
void SDetailsView::PostSetObject(const TArray<FDetailsViewObjectRoot>& Roots)
{
TSharedPtr<SColorPicker> ExistingColorPicker = GetColorPicker();
if (ExistingColorPicker.IsValid()
&& (!ExistingColorPicker->GetOptionalOwningDetailsView().IsValid()
|| ExistingColorPicker->GetOptionalOwningDetailsView().Get() == this))
{
DestroyColorPicker();
}
ColorPropertyNode = nullptr;
// Are we editing PIE objects? If the bShowHiddenPropertiesWhilePlaying setting is enabled, we may want to
// show all of the properties that would normally be hidden for objects that are part of the PIE world.
bool bAnyPIEObjects = false;
{
for( int32 RootNodeIndex = 0; RootNodeIndex < RootPropertyNodes.Num(); ++RootNodeIndex )
{
FObjectPropertyNode* RootPropertyNode = RootPropertyNodes[ RootNodeIndex ]->AsObjectNode();
if( RootPropertyNode != nullptr )
{
const int32 ObjectCount = RootPropertyNode->GetNumObjects();
for( int32 ObjectIndex = 0; ObjectIndex < ObjectCount; ++ObjectIndex )
{
UObject* Object = RootPropertyNode->GetUObject( ObjectIndex );
if( Object->GetOutermost()->HasAnyPackageFlags( PKG_PlayInEditor ) )
{
bAnyPIEObjects = true;
break;
}
}
}
}
}
FPropertyNodeInitParams InitParams;
InitParams.ParentNode = nullptr;
InitParams.Property = nullptr;
InitParams.ArrayOffset = 0;
InitParams.ArrayIndex = INDEX_NONE;
InitParams.bAllowChildren = true;
InitParams.bForceHiddenPropertyVisibility =
FPropertySettings::Get().ShowHiddenProperties() ||
( GetDefault<UEditorStyleSettings>()->bShowHiddenPropertiesWhilePlaying && bAnyPIEObjects ) ||
DetailsViewArgs.bForceHiddenPropertyVisibility;
switch ( DetailsViewArgs.DefaultsOnlyVisibility )
{
case EEditDefaultsOnlyNodeVisibility::Hide:
InitParams.bCreateDisableEditOnInstanceNodes = false;
break;
case EEditDefaultsOnlyNodeVisibility::Show:
InitParams.bCreateDisableEditOnInstanceNodes = true;
break;
case EEditDefaultsOnlyNodeVisibility::Automatic:
InitParams.bCreateDisableEditOnInstanceNodes = HasClassDefaultObject();
break;
default:
check(false);
}
for( TSharedPtr<FComplexPropertyNode>& ComplexRootNode : RootPropertyNodes )
{
FObjectPropertyNode* RootPropertyNode = ComplexRootNode->AsObjectNode();
RootPropertyNode->InitNode( InitParams );
RestoreExpandedItems(ComplexRootNode.ToSharedRef());
}
UpdatePropertyMaps();
UpdateFilteredDetails();
}
void SDetailsView::SetOnObjectArrayChanged(FOnObjectArrayChanged OnObjectArrayChangedDelegate)
{
OnObjectArrayChanged = OnObjectArrayChangedDelegate;
}
bool SDetailsView::IsConnected() const
{
return GetNumObjects() > 0;
}
const FSlateBrush* SDetailsView::OnGetLockButtonImageResource() const
{
if (bIsLocked)
{
return FEditorStyle::GetBrush(TEXT("PropertyWindow.Locked"));
}
else
{
return FEditorStyle::GetBrush(TEXT("PropertyWindow.Unlocked"));
}
}
bool SDetailsView::IsShowHiddenPropertiesWhilePlayingChecked() const
{
return GetDefault<UEditorStyleSettings>()->bShowHiddenPropertiesWhilePlaying;
}
void SDetailsView::OnShowHiddenPropertiesWhilePlayingClicked()
{
GetMutableDefault<UEditorStyleSettings>()->bShowHiddenPropertiesWhilePlaying = !GetDefault<UEditorStyleSettings>()->bShowHiddenPropertiesWhilePlaying;
GConfig->SetBool(TEXT("/Script/EditorStyle.EditorStyleSettings"), TEXT("bShowHiddenPropertiesWhilePlaying"), GetMutableDefault<UEditorStyleSettings>()->bShowHiddenPropertiesWhilePlaying, GEditorPerProjectIni);
// Force a refresh of the whole details panel, as the entire set of visible properties may be different
ForceRefresh();
}
#undef LOCTEXT_NAMESPACE