Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow adjusting scan folder priority for project-relative Gems #14028

Merged
merged 6 commits into from
Jan 20, 2023
Merged

Allow adjusting scan folder priority for project-relative Gems #14028

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e3a78f2
Add functionality to configure priority of gems
amzn-phist Jan 11, 2023
43815c2
Renamed the settings registry keys
amzn-phist Jan 12, 2023
3fc8ff2
Simplified comments
amzn-phist Jan 12, 2023
f6d84a9
Removes old gem order global variable
amzn-phist Jan 12, 2023
82067c3
Addressing PR feedback 1
amzn-phist Jan 13, 2023
3997df4
Minor typo
amzn-phist Jan 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Addressing PR feedback 1 
- Fix the FindScanFolder iterator & return.
- Change an index-based find function to use FindScanFolder.
- Add string constants.
- Check for gem paths that are relative to the project path (simplify).

Signed-off-by: amzn-phist <52085794+amzn-phist@users.noreply.github.com>
  • Loading branch information
@amzn-phist
amzn-phist committed Jan 13, 2023
commit 82067c39a2a5241fc1e553cab517ca6e35e80b36
39 changes: 14 additions & 25 deletions Code/Tools/AssetProcessor/native/utilities/PlatformConfiguration.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,6 +619,9 @@ namespace AssetProcessor

const char AssetConfigPlatformDir[] = "AssetProcessorConfig/";
const char AssetProcessorPlatformConfigFileName[] = "AssetProcessorPlatformConfig.ini";
constexpr const char* ProjectScanFolderKey = "Project/Assets";
constexpr const char* GemStartingPriorityOrderKey = "/GemScanFolderStartingPriorityOrder";
constexpr const char* ProjectRelativeGemPriorityKey = "/ProjectRelativeGemsScanFolderPriority";

PlatformConfiguration::PlatformConfiguration(QObject* pParent)
: QObject(pParent)
Expand Down Expand Up @@ -1325,7 +1328,7 @@ namespace AssetProcessor
{
auto mainProjectScanFolder = FindScanFolder([](const AssetProcessor::ScanFolderInfo& scanFolderInfo) -> bool
{
return scanFolderInfo.GetPortableKey() == "Project/Assets";
return scanFolderInfo.GetPortableKey() == ProjectScanFolderKey;
});
if (mainProjectScanFolder)
{
Expand Down Expand Up @@ -1457,9 +1460,8 @@ namespace AssetProcessor
const AssetProcessor::ScanFolderInfo* PlatformConfiguration::FindScanFolder(
AZStd::function<bool(const AssetProcessor::ScanFolderInfo&)> predicate) const
{
const AssetProcessor::ScanFolderInfo* result = AZStd::ranges::find_if(m_scanFolders, predicate);

return result != m_scanFolders.end() ? result : nullptr;
auto resultIt = AZStd::ranges::find_if(m_scanFolders, predicate);
return resultIt != m_scanFolders.end() ? &(*resultIt) : nullptr;
}

const AssetProcessor::ScanFolderInfo* PlatformConfiguration::GetScanFolderById(AZ::s64 id) const
Expand Down Expand Up @@ -1818,14 +1820,10 @@ namespace AssetProcessor
//! Given a scan folder path, get its complete info
const AssetProcessor::ScanFolderInfo* PlatformConfiguration::GetScanFolderByPath(const QString& scanFolderPath) const
{
for (int pathIdx = 0; pathIdx < m_scanFolders.size(); ++pathIdx)
{
if (m_scanFolders[pathIdx].ScanPath() == scanFolderPath)
return FindScanFolder([&scanFolderPath](const AssetProcessor::ScanFolderInfo& scanFolder)
{
return &m_scanFolders[pathIdx];
}
}
return nullptr;
return scanFolder.ScanPath() == scanFolderPath;
});
}

int PlatformConfiguration::GetMinJobs() const
Expand Down Expand Up @@ -1874,35 +1872,26 @@ namespace AssetProcessor

void PlatformConfiguration::AddGemScanFolders(const AZStd::vector<AzFramework::GemInfo>& gemInfoList)
{
// Determine if a Gem is relative to the project. Cross-check gem paths against visited project gem paths.
// If the gem is project-relative, make adjustments to it's priority order based on registry settings:
// /Amazon/AssetProcessor/Settings/GemScanFolderStartingPriorityOrder
// /Amazon/AssetProcessor/Settings/ProjectRelativeGemsScanFolderPriority
// See <o3de-root>/Registry/AssetProcessorPlatformConfig.setreg for more information.

AZ::s64 gemStartingOrder = 100;
AZStd::string projectGemPrioritySetting{};
AZStd::vector<AZ::IO::Path> projectGemPaths{};
const AZ::IO::FixedMaxPath projectPath = AZ::Utils::GetProjectPath();
int pathCount = 0;

const int projectScanOrder = GetProjectScanFolderOrder();

auto const settingsRegistry = AZ::SettingsRegistry::Get();
if (settingsRegistry != nullptr)
if (auto const settingsRegistry = AZ::SettingsRegistry::Get(); settingsRegistry != nullptr)
{
settingsRegistry->Get(gemStartingOrder,
AZ::SettingsRegistryInterface::FixedValueString(AssetProcessorSettingsKey) + "/GemScanFolderStartingPriorityOrder");
AZ::SettingsRegistryInterface::FixedValueString(AssetProcessorSettingsKey) + GemStartingPriorityOrderKey);

settingsRegistry->Get(projectGemPrioritySetting,
AZ::SettingsRegistryInterface::FixedValueString(AssetProcessorSettingsKey) + "/ProjectRelativeGemsScanFolderPriority");
AZ::SettingsRegistryInterface::FixedValueString(AssetProcessorSettingsKey) + ProjectRelativeGemPriorityKey);
AZStd::to_lower(projectGemPrioritySetting.begin(), projectGemPrioritySetting.end());

auto projectGemCallback = [&projectGemPaths]([[maybe_unused]] AZStd::string_view manifestObjectKey,
[[maybe_unused]] AZStd::string_view manifestObjectName, AZStd::string_view manifestRootPath)
{
projectGemPaths.push_back(AZ::IO::Path{ manifestRootPath });
};
AZ::SettingsRegistryMergeUtils::VisitProjectGems(*settingsRegistry, projectGemCallback);
}

auto GetGemFolderOrder = [&](bool isProjectRelativeGem) -> int
Expand Down Expand Up @@ -1935,7 +1924,7 @@ namespace AssetProcessor
const AZ::IO::Path& absoluteSourcePath = gemElement.m_absoluteSourcePaths[sourcePathIndex];
QString gemAbsolutePath = QString::fromUtf8(absoluteSourcePath.c_str(), aznumeric_cast<int>(absoluteSourcePath.Native().size())); // this is an absolute path!

bool isProjectGem = AZStd::find(projectGemPaths.begin(), projectGemPaths.end(), absoluteSourcePath) != projectGemPaths.end();
const bool isProjectGem = absoluteSourcePath.IsRelativeTo(projectPath);

// Append the index of the source path array element to make a unique portable key is created for each path of a gem
AZ::Uuid gemNameUuid = AZ::Uuid::CreateName((gemElement.m_gemName + AZStd::to_string(sourcePathIndex)).c_str());
Expand Down
3 changes: 2 additions & 1 deletion Registry/AssetProcessorPlatformConfig.setreg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,9 @@
"order": 40000
},

// Configurable starting prioirity for all Gem scan folders to use.
// Configurable starting priority for all Gem scan folders to use.
// Each Gem scan folder added will increment this.
// NOTE: Each successive gem priority will be lower than the last.
"GemScanFolderStartingPriorityOrder": 100,

// Control how project-relative Gem scan folders are prioritized against the project's main scan folder (key: "Project/Assets", alias: @PROJECTROOT@).
Expand Down