Files
FlaxEngine/Source/Engine/Content/Factories/BinaryAssetFactory.h
2023-01-10 15:29:37 +01:00

93 lines
3.1 KiB
C++

// Copyright (c) 2012-2023 Wojciech Figat. All rights reserved.
#pragma once
#include "IAssetFactory.h"
#if USE_EDITOR
#include "Engine/Content/Upgraders/BinaryAssetUpgrader.h"
#endif
#include "Engine/Content/AssetInfo.h"
#include "Engine/Scripting/ScriptingObject.h"
class BinaryAsset;
class FlaxStorage;
/// <summary>
/// The binary assets factory base class.
/// </summary>
/// <seealso cref="IAssetFactory" />
class FLAXENGINE_API BinaryAssetFactoryBase : public IAssetFactory
{
public:
/// <summary>
/// Initializes the specified asset. It's called in background before actual asset loading.
/// </summary>
/// <param name="asset">The asset.</param>
/// <returns>True if failed, otherwise false.</returns>
bool Init(BinaryAsset* asset);
protected:
virtual BinaryAsset* Create(const AssetInfo& info) = 0;
virtual bool IsVersionSupported(uint32 serializedVersion) const = 0;
#if USE_EDITOR
bool UpgradeAsset(const AssetInfo& info, FlaxStorage* storage, AssetMigrationContext& context);
#endif
public:
// [IAssetFactory]
Asset* New(const AssetInfo& info) override;
Asset* NewVirtual(const AssetInfo& info) override;
};
/// <summary>
/// The binary assets factory.
/// </summary>
/// <seealso cref="BinaryAssetFactoryBase" />
template<typename T>
class BinaryAssetFactory : public BinaryAssetFactoryBase
{
public:
// [BinaryAssetFactoryBase]
bool IsVersionSupported(uint32 serializedVersion) const override
{
return T::SerializedVersion == serializedVersion;
}
protected:
// [BinaryAssetFactoryBase]
BinaryAsset* Create(const AssetInfo& info) override
{
ScriptingObjectSpawnParams params(info.ID, T::TypeInitializer);
return ::New<T>(params, &info);
}
};
#define REGISTER_BINARY_ASSET(type, typeName, supportsVirtualAssets) \
const String type::TypeName = TEXT(typeName); \
class CONCAT_MACROS(Factory, type) : public BinaryAssetFactory<type> \
{ \
public: \
CONCAT_MACROS(Factory, type)() { IAssetFactory::Get().Add(type::TypeName, this); } \
~CONCAT_MACROS(Factory, type)() { IAssetFactory::Get().Remove(type::TypeName); } \
bool SupportsVirtualAssets() const override { return supportsVirtualAssets; } \
}; \
static CONCAT_MACROS(Factory, type) CONCAT_MACROS(CFactory, type)
#if USE_EDITOR
#define REGISTER_BINARY_ASSET_WITH_UPGRADER(type, typeName, upgrader, supportsVirtualAssets) \
const String type::TypeName = TEXT(typeName); \
class CONCAT_MACROS(Factory, type) : public BinaryAssetFactory<type> \
{ \
private: \
IAssetUpgrader* _upgrader = ::New<upgrader>(); \
public: \
CONCAT_MACROS(Factory, type)() { IAssetFactory::Get().Add(type::TypeName, this); } \
~CONCAT_MACROS(Factory, type)() { Delete(_upgrader); IAssetFactory::Get().Remove(type::TypeName); } \
bool SupportsVirtualAssets() const override { return supportsVirtualAssets; } \
IAssetUpgrader* GetUpgrader() const override { return _upgrader; } \
}; \
static CONCAT_MACROS(Factory, type) CONCAT_MACROS(CFactory, type)
#else
#define REGISTER_BINARY_ASSET_WITH_UPGRADER(type, typeName, upgrader, supportsVirtualAssets) REGISTER_BINARY_ASSET(type, typeName, supportsVirtualAssets)
#endif