AssetDocumentManager.h

#pragma once
 
#include <EditorFramework/Assets/AssetDocumentInfo.h>
#include <EditorFramework/Assets/Declarations.h>
#include <EditorFramework/EditorFrameworkDLL.h>
#include <Foundation/Types/Status.h>
#include <ToolsFoundation/Document/DocumentManager.h>
 
struct plSubAsset;
class plPlatformProfile;
 
class PL_EDITORFRAMEWORK_DLL plAssetDocumentManager : public plDocumentManager
{
  PL_ADD_DYNAMIC_REFLECTION(plAssetDocumentManager, plDocumentManager);
 
public:
  plAssetDocumentManager();
  ~plAssetDocumentManager();
 
  virtual plStatus ReadAssetDocumentInfo(plUniquePtr<plAssetDocumentInfo>& out_pInfo, plStreamReader& inout_stream) const;
  virtual void FillOutSubAssetList(const plAssetDocumentInfo& assetInfo, plDynamicArray<plSubAssetData>& out_subAssets) const {}
 
  virtual plStatus GetAdditionalOutputs(plDynamicArray<plString>& ref_files) { return plStatus(PL_SUCCESS); }
 
  // plDocumentManager overrides:
public:
  virtual plStatus CloneDocument(plStringView sPath, plStringView sClonePath, plUuid& inout_cloneGuid) override;
 
public:
  void ComputeAssetProfileHash(const plPlatformProfile* pAssetProfile);
 
  PL_ALWAYS_INLINE plUInt64 GetAssetProfileHash() const { return m_uiAssetProfileHash; }
 
  static const plPlatformProfile* DetermineFinalTargetProfile(const plPlatformProfile* pAssetProfile);
 
private:
  virtual plUInt64 ComputeAssetProfileHashImpl(const plPlatformProfile* pAssetProfile) const;
 
  // The hash that is combined with the asset document hash to determine whether the document output is up to date.
  // This hash needs to be computed in ComputeAssetProfileHash() and should reflect all important settings from the givne asset profile that
  // affect the asset output for this manager.
  // However, if GeneratesProfileSpecificAssets() return false, the hash must be zero, as then all outputs must be identical in all
  // profiles.
  plUInt64 m_uiAssetProfileHash = 0;
 
public:
  virtual plString GenerateResourceThumbnailPath(plStringView sDocumentPath, plStringView sSubAssetName = plStringView());
  virtual bool IsThumbnailUpToDate(plStringView sDocumentPath, plStringView sSubAssetName, plUInt64 uiThumbnailHash, plUInt32 uiTypeVersion);
 
 
  virtual void AddEntriesToAssetTable(plStringView sDataDirectory, const plPlatformProfile* pAssetProfile, plDelegate<void(plStringView sGuid, plStringView sPath, plStringView sType)> addEntry) const;
  virtual plString GetAssetTableEntry(const plSubAsset* pSubAsset, plStringView sDataDirectory, const plPlatformProfile* pAssetProfile) const;
 
  plString GetAbsoluteOutputFileName(const plAssetDocumentTypeDescriptor* pTypeDesc, plStringView sDocumentPath, plStringView sOutputTag, const plPlatformProfile* pAssetProfile = nullptr) const;
 
  virtual plString GetRelativeOutputFileName(const plAssetDocumentTypeDescriptor* pTypeDesc, plStringView sDataDirectory, plStringView sDocumentPath, plStringView sOutputTag, const plPlatformProfile* pAssetProfile = nullptr) const;
  virtual bool GeneratesProfileSpecificAssets() const = 0;
 
  bool IsOutputUpToDate(plStringView sDocumentPath, const plDynamicArray<plString>& outputs, plUInt64 uiHash, const plAssetDocumentTypeDescriptor* pTypeDescriptor);
  virtual bool IsOutputUpToDate(plStringView sDocumentPath, plStringView sOutputTag, plUInt64 uiHash, const plAssetDocumentTypeDescriptor* pTypeDescriptor);
 
  enum OutputReliability : plUInt8
  {
    Unknown = 0,
    Good = 1,
    Perfect = 2,
  };
 
  virtual OutputReliability GetAssetTypeOutputReliability() const { return OutputReliability::Unknown; }
 
 
 
  virtual plResult OpenPickedDocument(const plDocumentObject* pPickedComponent, plUInt32 uiPartIndex) { return PL_FAILURE; }
 
  plResult TryOpenAssetDocument(const char* szPathOrGuid);
 
  virtual void GetAssetTypesRequiringTransformForSceneExport(plSet<plTempHashedString>& inout_assetTypes){};
 
protected:
  static bool IsResourceUpToDate(const char* szResourceFile, plUInt64 uiHash, plUInt16 uiTypeVersion);
  static void GenerateOutputFilename(plStringBuilder& inout_sRelativeDocumentPath, const plPlatformProfile* pAssetProfile, const char* szExtension, bool bPlatformSpecific);
};