Mike Balfour
6c17c7bfb3
There are already APIs for getting a relative product path from an absolute source path, or getting a relative source path for an *existing* source file, but there were no APIs for getting a relative source path for a *new* source file. Prefabs will need this ability to be able to correctly generate a relative source path inside the prefab file before the file has been saved. The logic for relative source paths is a little bit tricky because the paths are relative to the watch folders, and the watch folders can be nested, with different priorities to explain which should take precedence. The input paths can also include specifiers like "." and "..", which need to be reconciled before creating the final correct relative path. The included unit tests test all of the tricky edge cases that I was able to identify.
78 lines
4.0 KiB
C++
78 lines
4.0 KiB
C++
/*
|
|
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
|
* its licensors.
|
|
*
|
|
* For complete copyright and license terms please see the LICENSE at the root of this
|
|
* distribution (the "License"). All use of this software is governed by the License,
|
|
* or, if provided, by the license below or the license accompanying this file. Do not
|
|
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
*
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
|
|
#include <AzToolsFramework/API/EditorAssetSystemAPI.h>
|
|
|
|
namespace UnitTest
|
|
{
|
|
/**
|
|
* This class can stub out the asset system to enable the RPI's AssetUtils class to look up test assets.
|
|
* This is included in the RPITestFixture class. To use it, first create a test asset using AssetManager::Create()
|
|
* or one of the RPI's AssetCreators. This will register the asset with the asset database. Example:
|
|
*
|
|
* Data::Asset<MaterialAsset> myTestMaterialAsset1;
|
|
* MaterialAssetCreator creator;
|
|
* creator.Begin(...);
|
|
* // set some stuff
|
|
* creator.End(myTestMaterialAsset1);
|
|
*
|
|
* Then call RegisterSourceInfo for whatever test assets you want to be able to access via AssetUtils.
|
|
* This associates an AssetInfo object with some dummy source file name. No source file is actually created;
|
|
* it just allows AssetUtils to find the desired AssetInfo when looking up a source file name that your unit
|
|
* test provides. Example:
|
|
*
|
|
* m_assetSystemStub.RegisterSourceInfo("MyTestMaterial1.material", Data::AssetInfo{ myTestMaterialAsset1.GetId() }, "");
|
|
* m_assetSystemStub.RegisterSourceInfo("MyTestMaterial2.material", Data::AssetInfo{ myTestMaterialAsset2.GetId() }, "");
|
|
*
|
|
* Now the RPI should be able to use AssetUtils like normal to access your test assets. Example:
|
|
*
|
|
* RPI::AssetUtils::LoadAsset("MyTestMaterial1.material"); // Returns myTestMaterialAsset1
|
|
*/
|
|
class AssetSystemStub : public AzToolsFramework::AssetSystemRequestBus::Handler
|
|
{
|
|
public:
|
|
|
|
void Activate();
|
|
void Deactivate();
|
|
|
|
void RegisterSourceInfo(const char* sourcePath, const AZ::Data::AssetId& assetId);
|
|
void RegisterSourceInfo(const char* sourcePath, const AZ::Data::AssetInfo& assetInfo, const AZStd::string& watchFolder);
|
|
|
|
private:
|
|
struct SourceInfo
|
|
{
|
|
AZ::Data::AssetInfo m_assetInfo;
|
|
AZStd::string m_watchFolder;
|
|
};
|
|
|
|
AZStd::unordered_map<AZStd::string, SourceInfo> m_sourceInfoMap;
|
|
|
|
bool GetSourceInfoBySourcePath(const char* sourcePath, AZ::Data::AssetInfo& assetInfo, AZStd::string& watchFolder) override;
|
|
const char* GetAbsoluteDevGameFolderPath() override;
|
|
const char* GetAbsoluteDevRootFolderPath() override;
|
|
bool GetRelativeProductPathFromFullSourceOrProductPath(const AZStd::string& fullPath, AZStd::string& relativeProductPath) override;
|
|
bool GenerateRelativeSourcePath(
|
|
const AZStd::string& sourcePath, AZStd::string& relativePath, AZStd::string& watchFolder) override;
|
|
bool GetFullSourcePathFromRelativeProductPath(const AZStd::string& relPath, AZStd::string& fullSourcePath) override;
|
|
bool GetAssetInfoById(const AZ::Data::AssetId& assetId, const AZ::Data::AssetType& assetType, const AZStd::string& platformName, AZ::Data::AssetInfo& assetInfo, AZStd::string& rootFilePath) override;
|
|
bool GetSourceInfoBySourceUUID(const AZ::Uuid& sourceUuid, AZ::Data::AssetInfo& assetInfo, AZStd::string& watchFolder) override;
|
|
bool GetScanFolders(AZStd::vector<AZStd::string>& scanFolders) override;
|
|
bool GetAssetSafeFolders(AZStd::vector<AZStd::string>& assetSafeFolders) override;
|
|
bool IsAssetPlatformEnabled(const char* platform) override;
|
|
int GetPendingAssetsForPlatform(const char* platform) override;
|
|
bool GetAssetsProducedBySourceUUID(const AZ::Uuid& sourceUuid, AZStd::vector<AZ::Data::AssetInfo>& productsAssetInfo) override;
|
|
};
|
|
} // namespace UnitTest
|