Mike Balfour
895bbafa9e
The initial CreatePrefab flow was trying to go from absolute -> relative -> absolute path before the file had ever been saved, so the relative -> absolute path conversion generated an error and always produced a project-relative path, even if the initial path was in a gem. For example, trying to save "c:/o3de/Gems/Camera/Assets/Entity1.prefab" would instead create "c:/o3de/AutomatedTesting/Entity1.prefab". This change preserves the absolute path throughout the initial creation flow so that the file is saved in the correct location.
159 lines
7.8 KiB
C++
159 lines
7.8 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/Prefab/PrefabLoaderInterface.h>
|
|
|
|
#include <AzCore/IO/Path/Path.h>
|
|
#include <AzCore/Memory/SystemAllocator.h>
|
|
#include <AzCore/std/containers/unordered_set.h>
|
|
#include <AzCore/std/string/string.h>
|
|
#include <AzToolsFramework/Prefab/PrefabDomTypes.h>
|
|
|
|
namespace AZ
|
|
{
|
|
class Entity;
|
|
} // namespace AZ
|
|
|
|
namespace AzToolsFramework
|
|
{
|
|
namespace Prefab
|
|
{
|
|
class PrefabSystemComponentInterface;
|
|
|
|
/**
|
|
* The Prefab Loader helps saving/loading Prefab files.
|
|
*/
|
|
class PrefabLoader final
|
|
: public PrefabLoaderInterface
|
|
{
|
|
public:
|
|
AZ_CLASS_ALLOCATOR(PrefabLoader, AZ::SystemAllocator, 0);
|
|
AZ_RTTI(PrefabLoader, "{A302B072-4DC4-4B7E-9188-226F56A3429C8}", PrefabLoaderInterface);
|
|
|
|
//////////////////////////////////////////////////////////////////////////
|
|
// PrefabLoaderInterface interface implementation
|
|
|
|
/**
|
|
* Load Prefab Template from given file path to memory and return the id of loaded Template.
|
|
* Converts .prefab into Prefab Template form by expanding source path and patch info
|
|
* into fully formed nested template info.
|
|
* @param filePath A Prefab Template file path.
|
|
* @return A unique id of Template on filePath loaded. Return invalid template id if loading Template on filePath failed.
|
|
*/
|
|
TemplateId LoadTemplateFromFile(AZ::IO::PathView filePath) override;
|
|
|
|
/**
|
|
* Load Prefab Template from given content string to memory and return the id of loaded Template.
|
|
* Converts .prefab form into Prefab Template form by expanding source path and patch info
|
|
* into fully formed nested template info.
|
|
* @param content Json content of the prefab
|
|
* @param originPath Path that will be used for the prefab in case of saved into a file.
|
|
* @return A unique id of Template on filePath loaded. Return invalid template id if loading Template on filePath failed.
|
|
*/
|
|
TemplateId LoadTemplateFromString(AZStd::string_view content, AZ::IO::PathView originPath = GeneratePath()) override;
|
|
|
|
/**
|
|
* Saves a Prefab Template to the the source path registered with the template.
|
|
* Converts Prefab Template form into .prefab form by collapsing nested Template info
|
|
* into a source path and patches.
|
|
* @param templateId Id of the template to be saved
|
|
* @return bool on whether the operation succeeded or not
|
|
*/
|
|
bool SaveTemplate(TemplateId templateId) override;
|
|
|
|
/**
|
|
* Saves a Prefab Template to the provided absolute source path, which needs to match the relative path in the template.
|
|
* Converts Prefab Template form into .prefab form by collapsing nested Template info
|
|
* into a source path and patches.
|
|
* @param templateId Id of the template to be saved
|
|
* @param absolutePath Absolute path to save the file to
|
|
* @return bool on whether the operation succeeded or not
|
|
*/
|
|
bool SaveTemplateToFile(TemplateId templateId, AZ::IO::PathView absolutePath) override;
|
|
|
|
/**
|
|
* Saves a Prefab Template into the provided output string.
|
|
* Converts Prefab Template form into .prefab form by collapsing nested Template info
|
|
* into a source path and patches.
|
|
* @param templateId Id of the template to be saved
|
|
* @param outputJson Will contain the serialized template json on success
|
|
* @return bool on whether the operation succeeded or not
|
|
*/
|
|
bool SaveTemplateToString(TemplateId templateId, AZStd::string& outputJson) override;
|
|
|
|
//////////////////////////////////////////////////////////////////////////
|
|
|
|
void RegisterPrefabLoaderInterface();
|
|
void UnregisterPrefabLoaderInterface();
|
|
|
|
//! Converts path into full absolute path. This will be used by loading/save IO operations.
|
|
//! The path will always have the correct separator for the current OS
|
|
AZ::IO::Path GetFullPath(AZ::IO::PathView path) override;
|
|
|
|
//! Converts path into a path that's relative to the highest-priority containing folder of all the folders registered
|
|
//! with the engine.
|
|
//! This path will be the path that appears in the .prefab file.
|
|
//! The path will always use the '/' separator.
|
|
AZ::IO::Path GenerateRelativePath(AZ::IO::PathView path) override;
|
|
|
|
//! Returns if the path is a valid path for a prefab
|
|
static bool IsValidPrefabPath(AZ::IO::PathView path);
|
|
|
|
private:
|
|
|
|
/**
|
|
* Load Prefab Template from given file path to memory and return the id of loaded Template.
|
|
* @param filePath A path to a Prefab Template file.
|
|
* @param progressedFilePathsSet An unordered_set to track if there's any cyclical dependency between Templates.
|
|
* @return A unique id of Template on filePath loaded. Return invalid id if loading Template on filePath failed.
|
|
*/
|
|
TemplateId LoadTemplateFromFile(
|
|
AZ::IO::PathView filePath,
|
|
AZStd::unordered_set<AZ::IO::Path>& progressedFilePathsSet);
|
|
|
|
/**
|
|
* Load Prefab Template from given string to memory and return the id of loaded Template.
|
|
* @param fileContent Json content of the template
|
|
* @param filePath Path that will be used for the template if saved to file.
|
|
* @param progressedFilePathsSet An unordered_set to track if there's any cyclical dependency between Templates.
|
|
* @return A unique id of Template on filePath loaded. Return invalid id if loading Template on filePath failed.
|
|
*/
|
|
TemplateId LoadTemplateFromString(
|
|
AZStd::string_view fileContent,
|
|
AZ::IO::PathView filePath,
|
|
AZStd::unordered_set<AZ::IO::Path>& progressedFilePathsSet);
|
|
|
|
/**
|
|
* Load nested instance given a nested instance value iterator and target Template with its id.
|
|
* @param instanceIterator A nested instance value iterator.
|
|
* @param targetTemplateId A unique id of target Template.
|
|
* @param progressedFilePathsSet An unordered_set to track if there's any cyclical dependency between Templates.
|
|
* @return If loading the nested instance pointed by instanceIt on targetTemplate succeeded or not.
|
|
*/
|
|
bool LoadNestedInstance(
|
|
PrefabDomValue::MemberIterator& instanceIterator,
|
|
TemplateId targetTemplateId,
|
|
AZStd::unordered_set<AZ::IO::Path>& progressedFilePathsSet);
|
|
|
|
//! Retrieves Dom content and its path from a template id
|
|
AZStd::optional<AZStd::pair<PrefabDom, AZ::IO::Path>> StoreTemplateIntoFileFormat(TemplateId templateId);
|
|
|
|
PrefabSystemComponentInterface* m_prefabSystemComponentInterface = nullptr;
|
|
AZ::IO::Path m_projectPathWithOsSeparator;
|
|
AZ::IO::Path m_projectPathWithSlashSeparator;
|
|
};
|
|
} // namespace Prefab
|
|
} // namespace AzToolsFramework
|
|
|