Files
o3de/Gems/Atom/Feature/Common/Code/Source/Mesh/ModelReloader.h
T
Tommy Walton 256564a3e0 Model Hot-Reloading (#4304)
* Added a ModelReloader class that handles reloading the hierarchy of assets in the correct order. A ModelReloaderSystem that is used to make sure there is only one ModelReloader at a time for a given asset. Modified the Model, ModelLodAsset, and Buffer assets to not automatically reload, and instead handle reloads manually via AssetCatalog events. Modified the MeshLoader to kick off a reload via the ModelReloaderSystem whenever a model asset is added or changed.

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Comment updates

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Minor naming and comment updates based on PR feedback

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Correcting previous commit. I flipped == to != when switching from count to find, when it should have stayed ==

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Updating RenderCommon header

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Removing unneeded headers

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Reverting RayTracingFeatureProcessor change following Doug's guidance. This logic was tricky to get right initially, and leads to TDR when incorrect, so leaving as is.

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Removing a tab

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Added missing #include for AssetId

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Adding missing RTTI header

Signed-off-by: amzn-tommy <waltont@amazon.com>

* Include ModelAsset definition intead of forward declaring it to avoid a static assert on Linux

Signed-off-by: amzn-tommy <waltont@amazon.com>
2021-10-05 09:59:13 -07:00

75 lines
2.8 KiB
C++

/*
* Copyright (c) Contributors to the Open 3D Engine Project.
* For complete copyright and license terms please see the LICENSE at the root of this distribution.
*
* SPDX-License-Identifier: Apache-2.0 OR MIT
*
*/
#pragma once
#include <AzCore/Asset/AssetCommon.h>
#include <AzCore/RTTI/TypeInfo.h>
#include <Atom/Feature/Mesh/ModelReloaderSystemInterface.h>
#include <Source/Mesh/ModelReloaderSystem.h>
namespace AZ
{
namespace RPI
{
class ModelAsset;
}
namespace Render
{
//! ModelReloader takes care of reloading Buffer, ModelLod, and Model assets in the correct order
//! The ModelReloaderSystem should be used to reload a model, rather than using a ModelReloader directly
class ModelReloader
: private Data::AssetBus::MultiHandler
{
using DependencyList = AZStd::vector<Data::Asset<Data::AssetData>>;
public:
AZ_RTTI(AZ::Render::ModelReloader, "{99B75A6A-62B6-490A-9953-029BE7D69452}");
ModelReloader() = default;
//! Reload a model asset
//! @param modelAsset - the asset to be reloaded
//! @param removeReloaderFromSystemHandler - an event that will tell the ModelReloaderSystem when to remove the reloader because it is finished
ModelReloader(Data::Asset<RPI::ModelAsset> modelAsset, RemoveModelFromReloaderSystemEvent::Handler& removeReloaderFromSystemHandler);
//! Connects a handler that will handle an event when the model is finished reloading
void ConnectOnReloadedEventHandler(ModelReloadedEvent::Handler& onReloadedEventHandler);
private:
enum class State
{
WaitingForMeshDependencies,
WaitingForModelDependencies,
WaitingForModel
};
// Data::AssetBus::MultiHandler overrides...
void OnAssetReloaded(AZ::Data::Asset<AZ::Data::AssetData> asset) override;
void OnAssetReloadError(Data::Asset<Data::AssetData> asset) override;
void InsertMeshDependencyIfUnique(Data::Asset<Data::AssetData> asset);
void ReloadDependenciesAndWait();
void AdvanceToNextLevelOfHierarchy();
DependencyList& GetPendingDependencyList();
ModelReloadedEvent m_onModelReloaded;
RemoveModelFromReloaderSystemEvent m_onRemoveReloaderFromSystem;
// Keep track of all the asset references for each level of the hierarchy
DependencyList m_modelAsset;
DependencyList m_meshDependencies;
DependencyList m_modelDependencies;
AZStd::bitset<1024> m_pendingDependencyListStatus;
State m_state;
};
} // namespace Render
} // namespace AZ