Open 3D Engine AzToolsFramework API Reference 23.10.0
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Classes | Public Types | Public Member Functions | Static Public Member Functions | List of all members
AzToolsFramework::Prefab::PrefabConversionUtils::ProcessedObjectStore Class Reference

#include <ProcesedObjectStore.h>

Classes

struct  AssetSmartPtrDeleter
 

Public Types

using SerializerFunction = AZStd::function< bool(AZStd::vector< uint8_t > &, const ProcessedObjectStore &)>
 
using AssetSmartPtr = AZStd::unique_ptr< AZ::Data::AssetData, AssetSmartPtrDeleter >
 

Public Member Functions

bool Serialize (AZStd::vector< uint8_t > &output) const
 
uint32_t GetSubId () const
 
bool HasAsset () const
 
AZ::Data::AssetType GetAssetType () const
 
const AZ::Data::AssetData & GetAsset () const
 
AZ::Data::AssetData & GetAsset ()
 
AssetSmartPtr ReleaseAsset ()
 
AZStd::vector< AZ::Data::Asset< AZ::Data::AssetData > > & GetReferencedAssets ()
 
const AZStd::vector< AZ::Data::Asset< AZ::Data::AssetData > > & GetReferencedAssets () const
 
const AZStd::string & GetId () const
 

Static Public Member Functions

template<typename T >
static AZStd::pair< ProcessedObjectStore, T * > Create (AZStd::string uniqueId, const AZ::Uuid &sourceId, SerializerFunction assetSerializer)
 
static uint32_t BuildSubId (AZStd::string_view id)
 

Detailed Description

Storage for objects created through the Prefab processing pipeline. These typically store the created object for immediate use in the editor plus additional information to allow the Prefab Builder to convert the object into a serialized form and register it with the Asset Database.

Member Function Documentation

◆ Create()

template<typename T >
AZStd::pair< ProcessedObjectStore, T * > AzToolsFramework::Prefab::PrefabConversionUtils::ProcessedObjectStore::Create ( AZStd::string  uniqueId,
const AZ::Uuid &  sourceId,
SerializerFunction  assetSerializer 
)
static

Constructs a new instance.

Parameters
uniqueIdA name for the object that's unique within the scope of the Prefab. This name will be used to generate a sub id for the product which requires that the name to be stable between runs.
sourceIdThe uuid for the source file.
assetSerializerThe callback used to convert the provided asset into a binary version.
The documentation for this class was generated from the following file: