Files
UnrealEngineUWP/Engine/Plugins/Editor/MaterialAnalyzer/Source/Private/SMaterialAnalyzer.cpp
robert manuszewski d1443992e1 Deprecating ANY_PACKAGE.
This change consists of multiple changes:

Core:
- Deprecation of ANY_PACKAGE macro. Added ANY_PACKAGE_DEPRECATED macro which can still be used for backwards compatibility purposes (only used in CoreUObject)
- Deprecation of StaticFindObjectFast* functions that take bAnyPackage parameter
- Added UStruct::GetStructPathName function that returns FTopLevelAssetPath representing the path name (package + object FName, super quick compared to UObject::GetPathName) + wrapper UClass::GetClassPathName to make it look better when used with UClasses
- Added (Static)FindFirstObject* functions that find a first object given its Name (no Outer). These functions are used in places I consider valid to do global UObject (UClass) lookups like parsing command line parameters / checking for unique object names
- Added static UClass::TryFindType function which serves a similar purpose as FindFirstObject however it's going to throw a warning (with a callstack / maybe ensure in the future?) if short class name is provided. This function is used  in places that used to use short class names but now should have been converted to use path names to catch any potential regressions and or edge cases I missed.
- Added static UClass::TryConvertShortNameToPathName utility function
- Added static UClass::TryFixShortClassNameExportPath utility function
- Object text export paths will now also include class path (Texture2D'/Game/Textures/Grass.Grass' -> /Script/Engine.Texture2D'/Game/Textures/Grass.Grass')
- All places that manually generated object export paths for objects will now use FObjectPropertyBase::GetExportPath
- Added a new startup test that checks for short type names in UClass/FProperty MetaData values

AssetRegistry:
- Deprecated any member variables (FAssetData / FARFilter) or functions that use FNames to represent class names and replaced them with FTopLevelAssetPath
- Added new member variables and new function overloads that use FTopLevelAssetPath to represent class names
- This also applies to a few other modules' APIs to match AssetRegistry changes

Everything else:
- Updated code that used ANY_PACKAGE (depending on the use case) to use FindObject(nullptr, PathToObject), UClass::TryFindType (used when path name is expected, warns if it's a short name) or FindFirstObject (usually for finding types based on user input but there's been a few legitimate use cases not related to user input)
- Updated code that used AssetRegistry API to use FTopLevelAssetPaths and USomeClass::StaticClass()->GetClassPathName() instead of GetFName()
- Updated meta data and hardcoded FindObject(ANY_PACKAGE, "EEnumNameOrClassName") calls to use path names

#jira UE-99463
#rb many.people
[FYI] Marcus.Wassmer
#preflight 629248ec2256738f75de9b32

#codereviewnumbers 20320742, 20320791, 20320799, 20320756, 20320809, 20320830, 20320840, 20320846, 20320851, 20320863, 20320780, 20320765, 20320876, 20320786

#ROBOMERGE-OWNER: robert.manuszewski
#ROBOMERGE-AUTHOR: robert.manuszewski
#ROBOMERGE-SOURCE: CL 20430220 via CL 20433854 via CL 20435474 via CL 20435484
#ROBOMERGE-BOT: UE5 (Release-Engine-Staging -> Main) (v949-20362246)

[CL 20448496 by robert manuszewski in ue5-main branch]
2022-06-01 03:46:59 -04:00

985 lines
33 KiB
C++

// Copyright Epic Games, Inc. All Rights Reserved.
#include "SMaterialAnalyzer.h"
#include "Widgets/Input/SSearchBox.h"
#include "AssetRegistry/AssetRegistryModule.h"
#include "Async/AsyncWork.h"
#include "Framework/MultiBox/MultiBoxBuilder.h"
#include "Styling/SlateIconFinder.h"
#include "Framework/Commands/UIAction.h"
#include "Materials/MaterialLayersFunctions.h"
#include "Hash/CityHash.h"
#include "Styling/AppStyle.h"
#include "PropertyCustomizationHelpers.h"
#include "CollectionManagerTypes.h"
#include "CollectionManagerModule.h"
#include "ICollectionManager.h"
#include "AssetManagerEditorModule.h"
#include "Widgets/Images/SImage.h"
#define LOCTEXT_NAMESPACE "MaterialAnalyzer"
static TMap<FName, FName> BasePropertyOverrideNames;
SMaterialAnalyzer::SMaterialAnalyzer()
: BuildBaseMaterialTreeTask(nullptr)
, AnalyzeTreeTask(nullptr)
, AnalyzeForIdenticalPermutationsTask(nullptr)
, bRequestedTreeRefresh(false)
, bWaitingForAssetRegistryLoad(false)
{
BasePropertyOverrideNames.Empty();
BasePropertyOverrideNames.Add(TEXT("bOverride_OpacityMaskClipValue"), TEXT("OpacityMaskClipValueOverride"));
BasePropertyOverrideNames.Add(TEXT("bOverride_BlendMode"), TEXT("BlendModeOverride"));
BasePropertyOverrideNames.Add(TEXT("bOverride_ShadingModel"), TEXT("ShadingModelOverride"));
BasePropertyOverrideNames.Add(TEXT("bOverride_DitheredLODTransition"), TEXT("DitheredLODTransitionOverride"));
BasePropertyOverrideNames.Add(TEXT("bOverride_CastDynamicShadowAsMasked"), TEXT("CastDynamicShadowAsMaskedOverride"));
BasePropertyOverrideNames.Add(TEXT("bOverride_TwoSided"), TEXT("TwoSidedOverride"));
BasePropertyOverrideNames.Add(TEXT("bOverride_OutputTranslucentVelocity"), TEXT("bOutputTranslucentVelocity"));
}
SMaterialAnalyzer::~SMaterialAnalyzer()
{
}
const FAssetData* FindParentAssetData(const FAssetData* InAssetData, const TArray<FAssetData>& ArrayToSearch)
{
check(InAssetData != nullptr);
static const FName NAME_Parent = TEXT("Parent");
FString ParentPath = InAssetData->GetTagValueRef<FString>(NAME_Parent);
int32 FirstCut = INDEX_NONE;
ParentPath.FindChar(L'\'', FirstCut);
FName ParentPathName = NAME_None;
if(FirstCut != INDEX_NONE)
{
ParentPathName = FName(*ParentPath.Mid(FirstCut + 1, ParentPath.Len() - FirstCut - 2));
}
else
{
ParentPathName = FName(*ParentPath);
}
if(ParentPathName.IsValid() && !ParentPathName.IsNone())
{
return ArrayToSearch.FindByPredicate(
[&](FAssetData& Entry)
{
return Entry.ObjectPath == ParentPathName;
}
);
}
return nullptr;
}
void SMaterialAnalyzer::Construct(const FArguments& InArgs, const TSharedRef<SDockTab>& ConstructUnderMajorTab, const TSharedPtr<SWindow>& ConstructUnderWindow)
{
TArray<const UClass*> AllowedClasses;
AllowedClasses.Add(UMaterialInterface::StaticClass());
TSharedRef<SWidget> AssetPickerWidget = SNew(SObjectPropertyEntryBox)
.ObjectPath(this, &SMaterialAnalyzer::GetCurrentAssetPath)
.AllowedClass(UMaterialInterface::StaticClass())
.OnObjectChanged(this, &SMaterialAnalyzer::OnAssetSelected)
.AllowClear(false)
.DisplayUseSelected(true)
.DisplayBrowse(true)
.NewAssetFactories(TArray<UFactory*>())
.IsEnabled(this, &SMaterialAnalyzer::IsMaterialSelectionAllowed);
this->ChildSlot
[
SNew(SBorder)
.BorderImage(FCoreStyle::Get().GetBrush("ToolPanel.GroupBorder"))
.BorderBackgroundColor(FLinearColor::Gray) // Darken the outer border
[
SNew(SVerticalBox)
+ SVerticalBox::Slot()
.AutoHeight()
.Padding(FMargin(5.0f, 5.0f, 5.0f, 5.0f))
[
SNew(SHorizontalBox)
+ SHorizontalBox::Slot()
.AutoWidth()
.VAlign(VAlign_Center)
[
SNew(STextBlock)
.Text(LOCTEXT("MaterialToAnalyzeLabel", "Material To Analyze: "))
]
+ SHorizontalBox::Slot()
.FillWidth(0.5f)
[
AssetPickerWidget
]
+SHorizontalBox::Slot()
.FillWidth(0.5f)
[
SNullWidget::NullWidget
]
]
+ SVerticalBox::Slot()
.FillHeight(1.0f)
[
SNew(SSplitter)
.Orientation(EOrientation::Orient_Vertical)
+ SSplitter::Slot()
[
SNew(SBorder)
.Padding(0)
.BorderImage(FCoreStyle::Get().GetBrush("ToolPanel.GroupBorder"))
[
SAssignNew(MaterialTree, SAnalyzedMaterialTree)
.ItemHeight(24.0f)
.TreeItemsSource(&MaterialTreeRoot)
.OnGenerateRow(this, &SMaterialAnalyzer::HandleReflectorTreeGenerateRow)
.OnGetChildren(this, &SMaterialAnalyzer::HandleReflectorTreeGetChildren)
.OnSetExpansionRecursive(this, &SMaterialAnalyzer::HandleReflectorTreeRecursiveExpansion)
.HeaderRow
(
SNew(SHeaderRow)
+ SHeaderRow::Column(SAnalyzedMaterialNodeWidgetItem::NAME_MaterialName)
.DefaultLabel(LOCTEXT("MaterialNameLabel", "Material Name"))
.FillWidth(0.80f)
+ SHeaderRow::Column(SAnalyzedMaterialNodeWidgetItem::NAME_NumberOfChildren)
.DefaultLabel(LOCTEXT("NumberOfMaterialChildrenLabel", "Number of Children (Direct/Total)"))
+ SHeaderRow::Column(SAnalyzedMaterialNodeWidgetItem::NAME_BasePropertyOverrides)
.DefaultLabel(LOCTEXT("BasePropertyOverridesLabel", "Base Property Overrides"))
+ SHeaderRow::Column(SAnalyzedMaterialNodeWidgetItem::NAME_MaterialLayerParameters)
.DefaultLabel(LOCTEXT("MaterialLayerParametersLabel", "Material Layer Parameters"))
+ SHeaderRow::Column(SAnalyzedMaterialNodeWidgetItem::NAME_StaticSwitchParameters)
.DefaultLabel(LOCTEXT("StaticSwitchParametersLabel", "Static Switch Parameters"))
+ SHeaderRow::Column(SAnalyzedMaterialNodeWidgetItem::NAME_StaticComponentMaskParameters)
.DefaultLabel(LOCTEXT("StaticComponenetMaskParametersLabel", "Static Component Mask Parameters"))
)
]
]
+ SSplitter::Slot()
[
SNew(SBorder)
.BorderImage(FCoreStyle::Get().GetBrush("ToolPanel.GroupBorder"))
.BorderBackgroundColor(FLinearColor::Gray) // Darken the outer border
[
SNew(SVerticalBox)
+ SVerticalBox::Slot()
.AutoHeight()
.VAlign(VAlign_Center)
[
SNew(STextBlock)
.Text(LOCTEXT("SuggestionsLabel", "Suggestions"))
]
+ SVerticalBox::Slot()
[
SAssignNew(SuggestionsBox, SScrollBox)
]
]
]
]
+ SVerticalBox::Slot()
.AutoHeight()
.VAlign(EVerticalAlignment::VAlign_Bottom)
[
SNew(SHorizontalBox)
+SHorizontalBox::Slot()
.VAlign(VAlign_Center)
[
SAssignNew(StatusBox, STextBlock)
.Text(LOCTEXT("DoneLabel", "Done"))
]
+SHorizontalBox::Slot()
.HAlign(HAlign_Right)
.Padding(0,0,4,0)
[
SAssignNew(StatusThrobber, SThrobber)
.Animate(SThrobber::EAnimation::None)
]
]
]
];
// Load the asset registry module to listen for updates
FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked<FAssetRegistryModule>(TEXT("AssetRegistry"));
if(AssetRegistryModule.Get().IsLoadingAssets())
{
StartAsyncWork(LOCTEXT("WaitingForAssetRegistry", "Waiting for Asset Registry to finish loading"));
bWaitingForAssetRegistryLoad = true;
}
else
{
SetupAssetRegistryCallbacks();
BuildBasicMaterialTree();
}
}
void SMaterialAnalyzer::SetupAssetRegistryCallbacks()
{
FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked<FAssetRegistryModule>(TEXT("AssetRegistry"));
AssetRegistryModule.Get().OnAssetAdded().AddSP(this, &SMaterialAnalyzer::OnAssetAdded);
}
void SMaterialAnalyzer::OnAssetAdded(const FAssetData& InAssetData)
{
if(InAssetData.IsInstanceOf(UMaterialInterface::StaticClass()))
{
RecentlyAddedAssetData.Add(InAssetData);
}
}
void SMaterialAnalyzer::OnAssetSelected(const FAssetData& AssetData)
{
if(AnalyzeTreeTask == nullptr)
{
CurrentlySelectedAsset = AssetData;
const FAssetData* ParentAssetData = &AssetData;
const FAssetData* NextParentAssetData = FindParentAssetData(&AssetData, AssetDataArray);
// get the topmost parent
while (NextParentAssetData != nullptr)
{
ParentAssetData = NextParentAssetData;
NextParentAssetData = FindParentAssetData(ParentAssetData, AssetDataArray);
}
// empty the previous tree root
MaterialTreeRoot.Empty(1);
// Add the new tree root
FAnalyzedMaterialNodeRef* NewRoot = AllMaterialTreeRoots.FindByPredicate([&](FAnalyzedMaterialNodeRef& Entry)
{
return Entry->ObjectPath == ParentAssetData->ObjectPath;
});
check(NewRoot != nullptr);
MaterialTreeRoot.Add(*NewRoot);
MaterialTree->RequestTreeRefresh();
SuggestionsBox->ClearChildren();
AnalyzeTreeTask = new FAsyncTask<FAnalyzeMaterialTreeAsyncTask>(*NewRoot, AssetDataArray);
StartAsyncWork(FText::Format(LOCTEXT("AnalyzingMaterial", "Analyzing {0}"), FText::FromString(AnalyzeTreeTask->GetTask().CurrentMaterialNode->Path)));
AnalyzeTreeTask->StartBackgroundTask();
}
}
void SMaterialAnalyzer::Tick(const FGeometry& AllottedGeometry, const double InCurrentTime, const float InDeltaTime)
{
SCompoundWidget::Tick(AllottedGeometry, InCurrentTime, InDeltaTime);
if (bWaitingForAssetRegistryLoad)
{
FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked<FAssetRegistryModule>(TEXT("AssetRegistry"));
if(!AssetRegistryModule.Get().IsLoadingAssets())
{
SetupAssetRegistryCallbacks();
BuildBasicMaterialTree();
bWaitingForAssetRegistryLoad = false;
}
}
else
{
if (BuildBaseMaterialTreeTask != nullptr && BuildBaseMaterialTreeTask->IsDone())
{
delete BuildBaseMaterialTreeTask;
BuildBaseMaterialTreeTask = nullptr;
AsyncWorkFinished(FText::Format(FTextFormat(LOCTEXT("DoneWithMaterialInterfaces", "Done with {0} MaterialInterfaces")), GetTotalNumberOfMaterialNodes()));
}
if (BuildBaseMaterialTreeTask == nullptr && RecentlyAddedAssetData.Num() > 0)
{
// Need to make this append to the previously generated list instead of erase all of the old info
// Current problem is that if we only have a portion of the asset registry it will create duplicate
// nodes since it won't find all parents in the tree. Need to modify the async task to not create
// nodes that don't have parents until we can find their parent.
AssetDataArray.Append(RecentlyAddedAssetData);
RecentlyAddedAssetData.Empty();
AllMaterialTreeRoots.Empty(AllMaterialTreeRoots.Num());
BuildBaseMaterialTreeTask = new FAsyncTask<FBuildBasicMaterialTreeAsyncTask>(AllMaterialTreeRoots, AssetDataArray);
BuildBaseMaterialTreeTask->StartBackgroundTask();
StartAsyncWork(LOCTEXT("BuildingBasicTree", "Building Basic MaterialTree"));
}
if (AnalyzeTreeTask != nullptr && AnalyzeTreeTask->IsDone())
{
if (AnalyzeTreeTask->GetTask().LoadNextMaterial())
{
StartAsyncWork(FText::Format(LOCTEXT("AnalyzingMaterial", "Analyzing {0}"), FText::FromString(AnalyzeTreeTask->GetTask().CurrentMaterialNode->Path)));
AnalyzeTreeTask->StartBackgroundTask();
}
else
{
MaterialTree->RequestListRefresh();
// Kick off a check for identical permutations
// @todo make this a series of tests that users can choose to run
AnalyzeForIdenticalPermutationsTask = new FAsyncTask<FAnalyzeForIdenticalPermutationsAsyncTask>(AnalyzeTreeTask->GetTask().MaterialTreeRoot);
AnalyzeForIdenticalPermutationsTask->StartBackgroundTask();
delete AnalyzeTreeTask;
AnalyzeTreeTask = nullptr;
StartAsyncWork(LOCTEXT("AnalyzingTreeForIdenticalPermutations", "Analyzing material tree for identical permutations"));
}
}
if (AnalyzeForIdenticalPermutationsTask != nullptr && AnalyzeForIdenticalPermutationsTask->IsDone())
{
MaterialTree->RequestListRefresh();
AsyncWorkFinished(LOCTEXT("Done", "Done!"));
TMultiMap<int32, FPermutationSuggestionData> Suggestions = AnalyzeForIdenticalPermutationsTask->GetTask().GetSuggestions();
Suggestions.KeySort([](int32 A, int32 B) {
return A > B; // sort to show most improvement possibility first
});
int32 BackgroundColorCounter = 0;
SuggestionDataArray.Empty();
for (auto It = Suggestions.CreateConstIterator(); It; ++It)
{
TSharedPtr<FPermutationSuggestionView> SuggestionHeader = MakeShareable(new FPermutationSuggestionView());
SuggestionHeader->Header = It.Value().Header;
for (FString Material : It.Value().Materials)
{
TSharedPtr<FPermutationSuggestionView> SuggestionChild = MakeShareable(new FPermutationSuggestionView());
SuggestionChild->Header = FText::FromString(Material);
SuggestionHeader->Children.Add(SuggestionChild);
}
SuggestionDataArray.Add(SuggestionHeader);
}
SuggestionsBox->AddSlot()
[
SAssignNew(SuggestionsTree, STreeView<TSharedPtr<FPermutationSuggestionView>>)
.TreeItemsSource(&SuggestionDataArray)
.OnGenerateRow(this, &SMaterialAnalyzer::OnGenerateSuggestionRow)
.OnGetChildren(this, &SMaterialAnalyzer::OnGetSuggestionChildren)
];
delete AnalyzeForIdenticalPermutationsTask;
AnalyzeForIdenticalPermutationsTask = nullptr;
}
}
}
TSharedRef< ITableRow > SMaterialAnalyzer::OnGenerateSuggestionRow(TSharedPtr<FPermutationSuggestionView> Item, const TSharedRef< STableViewBase >& OwnerTable)
{
if (Item->Children.Num() > 0)
{
return SNew(STableRow<TSharedPtr<FPermutationSuggestionView>>, OwnerTable)
[
SNew(SVerticalBox)
+SVerticalBox::Slot()
.AutoHeight()
.VAlign(VAlign_Bottom)
[
SNew(SEditableText)
.IsReadOnly(true)
.Text(Item->Header)
]
+ SVerticalBox::Slot()
[
SNew(SHorizontalBox)
+ SHorizontalBox::Slot()
.AutoWidth()
[
SNew(STextBlock)
.Visibility(this, &SMaterialAnalyzer::ShouldShowAdvancedRecommendations, Item)
.Text(LOCTEXT("PermutationRecommendation", "It is recommended that you reparent them in a way so only dynamic parameters differ."))
]
+ SHorizontalBox::Slot()
.FillWidth(1.0f)
[
SNullWidget::NullWidget
]
+SHorizontalBox::Slot()
.AutoWidth()
[
SNew(SButton)
.ButtonStyle(FAppStyle::Get(), "SimpleSharpButton")
.Visibility(this, &SMaterialAnalyzer::ShouldShowAdvancedRecommendations, Item)
.OnClicked(this, &SMaterialAnalyzer::CreateLocalSuggestionCollection, Item)
.ContentPadding(FMargin(2.0f))
.Content()
[
SNew(SHorizontalBox)
+SHorizontalBox::Slot()
.AutoWidth()
.Padding(2.0f)
[
SNew(SImage)
.Image(FAppStyle::Get().GetBrush("Icons.Plus"))
.ColorAndOpacity(FSlateColor::UseForeground())
]
+SHorizontalBox::Slot()
.AutoWidth()
.Padding(2.0f)
[
SNew(STextBlock)
.Text(LOCTEXT("CreateLocalCollection", "Create Local Collection"))
]
]
]
]
];
}
return SNew(STableRow<TSharedPtr<FPermutationSuggestionView>>, OwnerTable)
[
SNew(SEditableText)
.IsReadOnly(true)
.Text(Item->Header)
];
}
EVisibility SMaterialAnalyzer::ShouldShowAdvancedRecommendations(TSharedPtr<FPermutationSuggestionView> Item) const
{
return SuggestionsTree->IsItemExpanded(Item) ? EVisibility::Visible : EVisibility::Collapsed;
}
void SMaterialAnalyzer::OnGetSuggestionChildren(TSharedPtr<FPermutationSuggestionView> InParent, TArray< TSharedPtr<FPermutationSuggestionView> >& OutChildren)
{
OutChildren = InParent->Children;
}
FReply SMaterialAnalyzer::CreateLocalSuggestionCollection(TSharedPtr<FPermutationSuggestionView> InSuggestion)
{
TArray<FString> AllSelectedPackageNames;
ECollectionShareType::Type ShareType = ECollectionShareType::CST_Local;
for (TSharedPtr<FPermutationSuggestionView> Child : InSuggestion->Children)
{
AllSelectedPackageNames.Add(Child->Header.ToString());
}
if (AllSelectedPackageNames.Num() > 0)
{
FCollectionManagerModule& CollectionManagerModule = FCollectionManagerModule::GetModule();
FString FirstAssetString = CurrentlySelectedAsset.AssetName.ToString() + TEXT("_") + FString::FromInt(InSuggestion->Children.Num());
FName FirstAssetName = FName(*FirstAssetString);
CollectionManagerModule.Get().CreateUniqueCollectionName(FirstAssetName, ShareType, FirstAssetName);
FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked<FAssetRegistryModule>(TEXT("AssetRegistry"));
TArray<FName> PackageNamesToAddToCollection;
TArray<FName> PackageNameSet;
for (FString PackageToAdd : AllSelectedPackageNames)
{
PackageNameSet.Add(FName(*FPaths::GetBaseFilename(*PackageToAdd, false)));
}
ICollectionManager& CollectionManager = FCollectionManagerModule::GetModule().Get();
const FText MaterialAnalyzerText = LOCTEXT("MaterialAnalyzerPrefix", "MaterialAnalyzer");
FName ParentName = FName(*MaterialAnalyzerText.ToString());
if (!CollectionManager.CollectionExists(ParentName, ShareType))
{
CollectionManager.CreateCollection(ParentName, ShareType, ECollectionStorageMode::Static);
}
const bool bCollectionSucceeded = IAssetManagerEditorModule::Get().WriteCollection(FirstAssetName, ShareType, PackageNameSet, true);
if (bCollectionSucceeded)
{
CollectionManager.ReparentCollection(FirstAssetName, ShareType, ParentName, ShareType);
}
}
return FReply::Handled();
}
void SMaterialAnalyzer::StartAsyncWork(const FText& WorkText)
{
if(StatusBox.IsValid())
{
StatusBox->SetText(WorkText);
}
if(StatusThrobber.IsValid())
{
StatusThrobber->SetAnimate(SThrobber::Horizontal);
StatusThrobber->SetVisibility(EVisibility::SelfHitTestInvisible);
}
bAllowMaterialSelection = false;
}
void SMaterialAnalyzer::AsyncWorkFinished(const FText& CompleteText)
{
if (StatusBox.IsValid())
{
StatusBox->SetText(CompleteText);
}
if (StatusThrobber.IsValid())
{
StatusThrobber->SetAnimate(SThrobber::None);
StatusThrobber->SetVisibility(EVisibility::Collapsed);
}
bAllowMaterialSelection = true;
}
int32 SMaterialAnalyzer::GetTotalNumberOfMaterialNodes()
{
int32 NumMaterialNodes = AllMaterialTreeRoots.Num();
for(int i = 0; i < AllMaterialTreeRoots.Num(); ++i)
{
NumMaterialNodes += AllMaterialTreeRoots[i]->TotalNumberOfChildren();
}
return NumMaterialNodes;
}
FString SMaterialAnalyzer::GetCurrentAssetPath() const
{
return CurrentlySelectedAsset.IsValid() ? CurrentlySelectedAsset.ObjectPath.ToString() : FString("");
}
void SMaterialAnalyzer::BuildBasicMaterialTree()
{
static const FName AssetRegistryName(TEXT("AssetRegistry"));
FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked<FAssetRegistryModule>(AssetRegistryName);
IAssetRegistry& AssetRegistry = AssetRegistryModule.Get();
AssetRegistry.GetAssetsByClass(UMaterial::StaticClass()->GetClassPathName(), AssetDataArray, true);
AssetRegistry.GetAssetsByClass(UMaterialInstance::StaticClass()->GetClassPathName(), AssetDataArray, true);
if (BuildBaseMaterialTreeTask == nullptr && AssetDataArray.Num() > 0)
{
AllMaterialTreeRoots.Empty(AllMaterialTreeRoots.Num());
BuildBaseMaterialTreeTask = new FAsyncTask<FBuildBasicMaterialTreeAsyncTask>(AllMaterialTreeRoots, AssetDataArray);
BuildBaseMaterialTreeTask->StartBackgroundTask();
StartAsyncWork(LOCTEXT("BuildingBasicTree", "Building Basic MaterialTree"));
if (StatusThrobber.IsValid())
{
StatusThrobber->SetAnimate(SThrobber::EAnimation::Horizontal);
}
}
}
TSharedRef<ITableRow> SMaterialAnalyzer::HandleReflectorTreeGenerateRow(FAnalyzedMaterialNodeRef InMaterialNode, const TSharedRef<STableViewBase>& OwnerTable)
{
TSharedPtr<SAnalyzedMaterialNodeWidgetItem> NewWidget = SNew(SAnalyzedMaterialNodeWidgetItem, OwnerTable)
.MaterialInfoToVisualize(InMaterialNode);
// if we're the base level we're going to expand right away
if(!InMaterialNode->Parent.IsValid())
{
MaterialTree->SetItemExpansion(InMaterialNode, true);
}
return NewWidget.ToSharedRef();
}
void SMaterialAnalyzer::HandleReflectorTreeGetChildren(FAnalyzedMaterialNodeRef InMaterialNode, TArray<FAnalyzedMaterialNodeRef>& OutChildren)
{
OutChildren = InMaterialNode->GetChildNodes();
}
void SMaterialAnalyzer::HandleReflectorTreeRecursiveExpansion(FAnalyzedMaterialNodeRef InTreeNode, bool bIsItemExpanded)
{
TArray< FAnalyzedMaterialNodeRef > Children = InTreeNode->GetChildNodes();
if (Children.Num())
{
MaterialTree->SetItemExpansion(InTreeNode, bIsItemExpanded);
const bool bShouldSaveState = true;
for (int32 ChildIndex = 0; ChildIndex < Children.Num(); ++ChildIndex)
{
FAnalyzedMaterialNodeRef Child = Children[ChildIndex];
MaterialTree->SetItemExpansion(Child, bIsItemExpanded);
}
}
}
FAnalyzedMaterialNodePtr FBuildBasicMaterialTreeAsyncTask::FindOrMakeBranchNode(FAnalyzedMaterialNodePtr ParentNode, const FAssetData* ChildData)
{
check(ChildData != nullptr);
FAnalyzedMaterialNodeRef* OutNode = nullptr;
FName ChildName = ChildData->ObjectPath;
TArray<FAnalyzedMaterialNodeRef>& NodesToSearch = ParentNode.IsValid() ? ParentNode->GetChildNodes() : MaterialTreeRoot;
OutNode = NodesToSearch.FindByPredicate([&](FAnalyzedMaterialNodeRef& Entry) { return Entry->ObjectPath == ChildName; });
if (OutNode == nullptr)
{
FAnalyzedMaterialNode ChildNode;
ChildNode.Path = ChildData->AssetName.ToString();
ChildNode.ObjectPath = ChildData->ObjectPath;
ChildNode.Parent = ParentNode;
ChildNode.AssetData = *ChildData;
NodesToSearch.Add(FAnalyzedMaterialNodeRef(new FAnalyzedMaterialNode(ChildNode)));
OutNode = &NodesToSearch[NodesToSearch.Num() - 1];
}
return FAnalyzedMaterialNodePtr (*OutNode);
}
void FBuildBasicMaterialTreeAsyncTask::DoWork()
{
for(int i = 0; i < AssetDataToAnalyze.Num(); ++i)
{
const FAssetData& AssetData = AssetDataToAnalyze[i];
TArray<const FAssetData*> FullBranch;
const FAssetData* CurrentBranchNode = &AssetData;
while(CurrentBranchNode)
{
FullBranch.Add(CurrentBranchNode);
CurrentBranchNode = FindParentAssetData(CurrentBranchNode, AssetDataToAnalyze);
}
FAnalyzedMaterialNodePtr ParentNode = nullptr;
for(int Depth = FullBranch.Num() - 1; Depth >= 0; --Depth)
{
ParentNode = FindOrMakeBranchNode(ParentNode, FullBranch[Depth]);
}
}
}
bool FAnalyzeMaterialTreeAsyncTask::LoadNextMaterial()
{
if (CurrentMaterialQueueIndex < MaterialQueue.Num())
{
CurrentMaterialNode = MaterialQueue[CurrentMaterialQueueIndex];
check(CurrentMaterialNode->ObjectPath.IsValid());
CurrentMaterialInterface = FindObject<UMaterialInterface>(NULL, *CurrentMaterialNode->ObjectPath.ToString());
if (CurrentMaterialInterface == nullptr)
{
CurrentMaterialInterface = LoadObject<UMaterialInterface>(NULL, *CurrentMaterialNode->ObjectPath.ToString());
check(CurrentMaterialInterface);
}
return true;
}
return false;
}
void FAnalyzeMaterialTreeAsyncTask::DoWork()
{
MaterialQueue.Append(CurrentMaterialNode->GetChildNodes());
TArray<FMaterialParameterInfo> MaterialLayersParameterInfo;
check(CurrentMaterialInterface != nullptr);
TArray<FMaterialParameterInfo> ParameterInfo;
TArray<FGuid> Guids;
UMaterial* CurrentMaterial = Cast<UMaterial>(CurrentMaterialInterface);
UMaterialInstance* CurrentMaterialInstance = Cast<UMaterialInstance>(CurrentMaterialInterface);
bool bCanBeOverriden = CurrentMaterial != nullptr;
if(CurrentMaterial != nullptr)
{
CurrentMaterial->GetAllStaticSwitchParameterInfo(StaticSwitchParameterInfo, StaticSwitchGuids);
CurrentMaterial->GetAllStaticComponentMaskParameterInfo(StaticMaskParameterInfo, StaticMaskGuids);
}
CurrentMaterialNode->BasePropertyOverrides.Empty(BasePropertyOverrideNames.Num());
for (const TPair<FName, FName>& BasePropertyOverrideName : BasePropertyOverrideNames)
{
float TempValue = 0.0f;
bool bIsOverridden = false;
if (BasePropertyOverrideName.Key.IsEqual(TEXT("bOverride_OpacityMaskClipValue")))
{
TempValue = CurrentMaterialInterface->GetOpacityMaskClipValue();
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->BasePropertyOverrides.bOverride_OpacityMaskClipValue;
}
}
else if (BasePropertyOverrideName.Key.IsEqual(TEXT("bOverride_BlendMode")))
{
TempValue = (float)CurrentMaterialInterface->GetBlendMode();
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->BasePropertyOverrides.bOverride_BlendMode;
}
}
else if (BasePropertyOverrideName.Key.IsEqual(TEXT("bOverride_ShadingModel")))
{
if (CurrentMaterialInterface->IsShadingModelFromMaterialExpression())
{
TempValue = (float)MSM_FromMaterialExpression;
}
else
{
ensure(CurrentMaterialInterface->GetShadingModels().CountShadingModels() == 1);
TempValue = (float)CurrentMaterialInterface->GetShadingModels().GetFirstShadingModel();
}
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->BasePropertyOverrides.bOverride_ShadingModel;
}
}
else if (BasePropertyOverrideName.Key.IsEqual(TEXT("bOverride_DitheredLODTransition")))
{
TempValue = (float)CurrentMaterialInterface->IsDitheredLODTransition();
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->BasePropertyOverrides.bOverride_DitheredLODTransition;
}
}
else if (BasePropertyOverrideName.Key.IsEqual(TEXT("bOverride_CastDynamicShadowAsMasked")))
{
TempValue = CurrentMaterialInterface->GetCastShadowAsMasked();
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->BasePropertyOverrides.bOverride_CastDynamicShadowAsMasked;
}
}
else if (BasePropertyOverrideName.Key.IsEqual(TEXT("bOverride_TwoSided")))
{
TempValue = CurrentMaterialInterface->IsTwoSided();
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->BasePropertyOverrides.bOverride_TwoSided;
}
}
else if (BasePropertyOverrideName.Key.IsEqual(TEXT("bOverride_OutputTranslucentVelocity")))
{
TempValue = CurrentMaterialInterface->IsTranslucencyWritingVelocity();
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->BasePropertyOverrides.bOverride_OutputTranslucentVelocity;
}
}
// Check the parent for this variable
FAnalyzedMaterialNodePtr Parent = CurrentMaterialNode->Parent;
if (!bIsOverridden && Parent.IsValid())
{
// We shouldn't be able to get in here for the base Material
FBasePropertyOverrideNodeRef ParentParameter = Parent->FindBasePropertyOverride(BasePropertyOverrideName.Value);
CurrentMaterialNode->BasePropertyOverrides.Add(FBasePropertyOverrideNodeRef(
new FBasePropertyOverrideNode(ParentParameter->ParameterName,
ParentParameter->ParameterID,
ParentParameter->ParameterValue,
false)));
}
else
{
CurrentMaterialNode->BasePropertyOverrides.Add(FBasePropertyOverrideNodeRef(
new FBasePropertyOverrideNode(BasePropertyOverrideName.Value, BasePropertyOverrideName.Key, TempValue, bIsOverridden)));
}
}
FMaterialLayersFunctions MaterialLayers;
if (CurrentMaterialInterface->GetMaterialLayers(MaterialLayers))
{
bool bIsOverridden = false;
if (CurrentMaterialInstance)
{
FMaterialLayersFunctions ParentMaterialLayers;
const bool bParentHasLayers = CurrentMaterialInstance->Parent->GetMaterialLayers(ParentMaterialLayers);
bIsOverridden = !bParentHasLayers || MaterialLayers != ParentMaterialLayers;
}
CurrentMaterialNode->MaterialLayerParameters.Add(FStaticMaterialLayerParameterNodeRef(
new FStaticMaterialLayerParameterNode(FName(),
MaterialLayers.GetStaticPermutationString(),
bIsOverridden)));
}
CurrentMaterialNode->StaticSwitchParameters.Empty(StaticSwitchParameterInfo.Num());
for (int ParameterIndex = 0; ParameterIndex < StaticSwitchParameterInfo.Num(); ++ParameterIndex)
{
FMaterialParameterMetadata Meta;
bool bIsOverridden = false;
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->GetParameterOverrideValue(EMaterialParameterType::StaticSwitch, StaticSwitchParameterInfo[ParameterIndex], Meta);
}
else if(CurrentMaterial)
{
bIsOverridden = CurrentMaterial->GetParameterValue(EMaterialParameterType::StaticSwitch, StaticSwitchParameterInfo[ParameterIndex], Meta);
}
if (!bIsOverridden)
{
// Check the parent for this variable
FAnalyzedMaterialNodePtr Parent = CurrentMaterialNode->Parent;
// We shouldn't be able to get in here for the base Material
check(Parent.IsValid());
FStaticSwitchParameterNodeRef ParentParameter = Parent->FindStaticSwitchParameter(StaticSwitchParameterInfo[ParameterIndex].Name);
CurrentMaterialNode->StaticSwitchParameters.Add(FStaticSwitchParameterNodeRef(
new FStaticSwitchParameterNode(ParentParameter->ParameterName,
ParentParameter->ParameterValue,
false)));
}
else
{
CurrentMaterialNode->StaticSwitchParameters.Add(FStaticSwitchParameterNodeRef(
new FStaticSwitchParameterNode(StaticSwitchParameterInfo[ParameterIndex].Name, Meta.Value.AsStaticSwitch(), true)));
}
}
CurrentMaterialNode->StaticComponentMaskParameters.Empty(StaticMaskParameterInfo.Num());
for (int ParameterIndex = 0; ParameterIndex < StaticMaskParameterInfo.Num(); ++ParameterIndex)
{
FMaterialParameterMetadata Meta;
bool bIsOverridden = false;
if (CurrentMaterialInstance)
{
bIsOverridden = CurrentMaterialInstance->GetParameterOverrideValue(EMaterialParameterType::StaticComponentMask, StaticSwitchParameterInfo[ParameterIndex], Meta);
}
else if (CurrentMaterial)
{
bIsOverridden = CurrentMaterial->GetParameterValue(EMaterialParameterType::StaticComponentMask, StaticSwitchParameterInfo[ParameterIndex], Meta);
}
if(!bIsOverridden)
{
// Check the parent for this variable
FAnalyzedMaterialNodePtr Parent = CurrentMaterialNode->Parent;
// We shouldn't be able to get in here for the base Material
check(Parent.IsValid());
FStaticComponentMaskParameterNodeRef ParentParameter = Parent->FindStaticComponentMaskParameter(StaticMaskParameterInfo[ParameterIndex].Name);
CurrentMaterialNode->StaticComponentMaskParameters.Add(FStaticComponentMaskParameterNodeRef(
new FStaticComponentMaskParameterNode(ParentParameter->ParameterName,
ParentParameter->R,
ParentParameter->G,
ParentParameter->B,
ParentParameter->A,
false)));
}
else
{
CurrentMaterialNode->StaticComponentMaskParameters.Add(FStaticComponentMaskParameterNodeRef(
new FStaticComponentMaskParameterNode(StaticMaskParameterInfo[ParameterIndex].Name,
Meta.Value.Bool[0],
Meta.Value.Bool[1],
Meta.Value.Bool[2],
Meta.Value.Bool[3],
true)));
}
}
CurrentMaterialQueueIndex++;
}
bool FAnalyzeForIdenticalPermutationsAsyncTask::CreateMaterialPermutationHashForNode(const FAnalyzedMaterialNodeRef& MaterialNode, uint32& OutHash)
{
TArray<char> ByteArray;
bool bAnyOverrides = false;
for (int ParameterIndex = 0; ParameterIndex < MaterialNode->BasePropertyOverrides.Num(); ++ParameterIndex)
{
FString FloatToHash = FString::SanitizeFloat(MaterialNode->BasePropertyOverrides[ParameterIndex]->ParameterValue);
ByteArray.Append(TCHAR_TO_ANSI(*FloatToHash), FloatToHash.Len());
bAnyOverrides = bAnyOverrides || MaterialNode->BasePropertyOverrides[ParameterIndex]->bOverride;
}
for (int ParameterIndex = 0; ParameterIndex < MaterialNode->MaterialLayerParameters.Num(); ++ParameterIndex)
{
ByteArray.Append(TCHAR_TO_ANSI(*MaterialNode->MaterialLayerParameters[ParameterIndex]->ParameterValue), MaterialNode->MaterialLayerParameters[ParameterIndex]->ParameterValue.Len());
bAnyOverrides = bAnyOverrides || MaterialNode->MaterialLayerParameters[ParameterIndex]->bOverride;
}
for(int ParameterIndex = 0; ParameterIndex < MaterialNode->StaticSwitchParameters.Num(); ++ParameterIndex)
{
ByteArray.Add(MaterialNode->StaticSwitchParameters[ParameterIndex]->ParameterValue ? 1 : 0);
bAnyOverrides = bAnyOverrides || MaterialNode->StaticSwitchParameters[ParameterIndex]->bOverride;
}
for(int ParameterIndex = 0; ParameterIndex < MaterialNode->StaticComponentMaskParameters.Num(); ++ParameterIndex)
{
FStaticComponentMaskParameterNodeRef NodeRef = MaterialNode->StaticComponentMaskParameters[ParameterIndex];
ByteArray.Add(NodeRef->R ? 1 : 0);
ByteArray.Add(NodeRef->G ? 1 : 0);
ByteArray.Add(NodeRef->B ? 1 : 0);
ByteArray.Add(NodeRef->A ? 1 : 0);
bAnyOverrides = bAnyOverrides || NodeRef->bOverride;
}
OutHash = CityHash32(ByteArray.GetData(), ByteArray.Num());
return bAnyOverrides;
}
void FAnalyzeForIdenticalPermutationsAsyncTask::DoWork()
{
for(int i = 0; i < MaterialQueue.Num(); ++i)
{
FAnalyzedMaterialNodeRef CurrentMaterialNode = MaterialQueue[i];
MaterialQueue.Append(CurrentMaterialNode->GetChildNodes());
uint32 MaterialPermutationHash = 0;
if(CreateMaterialPermutationHashForNode(CurrentMaterialNode, MaterialPermutationHash))
{
MaterialPermutationHashToMaterialObjectPath.FindOrAdd(MaterialPermutationHash).Add(CurrentMaterialNode->ObjectPath);
}
}
GatherSuggestions();
}
void FAnalyzeForIdenticalPermutationsAsyncTask::GatherSuggestions()
{
Suggestions.Empty();
for (TPair<uint32, TArray<FName>>& IdenticalPermutations : MaterialPermutationHashToMaterialObjectPath)
{
if (IdenticalPermutations.Value.Num() > 1)
{
TArray<FString> AllNames;
AssetCount = IdenticalPermutations.Value.Num();
for (int i = 0; i < IdenticalPermutations.Value.Num(); ++i)
{
FString PermutationString = IdenticalPermutations.Value[i].ToString();
AllNames.Add(PermutationString);
}
FPermutationSuggestionData NewData = FPermutationSuggestionData(FText::Format(LOCTEXT("IdenticalStaticPermutationSuggestions", "The following {0} materials all have identical static parameter permutations."),
FText::AsNumber(AssetCount)),
AllNames);
Suggestions.Add
(
AssetCount,
NewData
);
}
}
}
#undef LOCTEXT_NAMESPACE