AssetDocument.h

#pragma once
 
#include <EditorFramework/Assets/AssetDocumentInfo.h>
#include <EditorFramework/Assets/Declarations.h>
#include <EditorFramework/EditorFrameworkDLL.h>
#include <EditorFramework/IPC/IPCObjectMirrorEditor.h>
#include <ToolsFoundation/Document/Document.h>
#include <ToolsFoundation/Object/DocumentObjectManager.h>
 
class plEditorEngineConnection;
class plEditorEngineSyncObject;
class plAssetDocumentManager;
class plPlatformProfile;
class QImage;
 
enum class plAssetDocEngineConnection : plUInt8
{
  None,               
  Simple,             
  FullObjectMirroring 
};
 
struct plCommonAssetUiState
{
  enum Enum : plUInt32
  {
    Pause = PL_BIT(0),
    Restart = PL_BIT(1),
    Loop = PL_BIT(2),
    SimulationSpeed = PL_BIT(3),
    Grid = PL_BIT(4),
    Visualizers = PL_BIT(5),
  };
 
  Enum m_State;
  double m_fValue = 0;
};
 
class PL_EDITORFRAMEWORK_DLL plAssetDocument : public plDocument
{
  PL_ADD_DYNAMIC_REFLECTION(plAssetDocument, plDocument);
 
public:
  class PL_EDITORFRAMEWORK_DLL ThumbnailInfo
  {
  public:
    plResult Deserialize(plStreamReader& inout_reader);
    plResult Serialize(plStreamWriter& inout_writer) const;
 
    bool IsThumbnailUpToDate(plUInt64 uiExpectedHash, plUInt16 uiVersion) const { return (m_uiHash == uiExpectedHash && m_uiVersion == uiVersion); }
 
    void SetFileHashAndVersion(plUInt64 uiHash, plUInt16 v)
    {
      m_uiHash = uiHash;
      m_uiVersion = v;
    }
 
    constexpr plUInt32 GetSerializedSize() const { return 19; }
 
  private:
    plUInt64 m_uiHash = 0;
    plUInt16 m_uiVersion = 0;
    plUInt16 m_uiReserved = 0;
  };
 
  plAssetDocument(plStringView sDocumentPath, plDocumentObjectManager* pObjectManager, plAssetDocEngineConnection engineConnectionType);
  ~plAssetDocument();
 
 
  plAssetDocumentManager* GetAssetDocumentManager() const;
  const plAssetDocumentInfo* GetAssetDocumentInfo() const;
 
  plBitflags<plAssetDocumentFlags> GetAssetFlags() const;
 
  const plAssetDocumentTypeDescriptor* GetAssetDocumentTypeDescriptor() const
  {
    return static_cast<const plAssetDocumentTypeDescriptor*>(GetDocumentTypeDescriptor());
  }
 
  plTransformStatus TransformAsset(plBitflags<plTransformFlags> transformFlags, const plPlatformProfile* pAssetProfile = nullptr);
 
  plTransformStatus CreateThumbnail();
 
  plUInt16 GetAssetTypeVersion() const;
 
 
  enum class EngineStatus
  {
    Unsupported,  
    Disconnected, 
    Initializing, 
    Loaded,       
  };
 
  EngineStatus GetEngineStatus() const { return m_EngineStatus; }
 
  virtual plVariant GetCreateEngineMetaData() const { return plVariant(); }
 
  bool SendMessageToEngine(plEditorEngineDocumentMsg* pMessage) const;
 
  virtual void HandleEngineMessage(const plEditorEngineDocumentMsg* pMsg);
 
  plEditorEngineConnection* GetEditorEngineConnection() const { return m_pEngineConnection; }
 
  void AddSyncObject(plEditorEngineSyncObject* pSync) const;
 
  void RemoveSyncObject(plEditorEngineSyncObject* pSync) const;
 
  plEditorEngineSyncObject* FindSyncObject(const plUuid& guid) const;
 
  plEditorEngineSyncObject* FindSyncObject(const plRTTI* pType) const;
 
  void SyncObjectsToEngine() const;
 
  void SendDocumentOpenMessage(bool bOpen);
 
 
 
  plEvent<const plEditorEngineDocumentMsg*> m_ProcessMessageEvent;
 
protected:
  void EngineConnectionEventHandler(const plEditorEngineProcessConnection::Event& e);
 
 
  plUInt64 GetDocumentHash() const;
 
  void GetChildHash(const plDocumentObject* pObject, plUInt64& inout_uiHash) const;
 
  virtual void InternalGetMetaDataHash(const plDocumentObject* pObject, plUInt64& inout_uiHash) const {}
 
 
  virtual plTaskGroupID InternalSaveDocument(AfterSaveCallback callback) override;
 
  virtual void InternalAfterSaveDocument() override;
 
  virtual void InitializeAfterLoading(bool bFirstTimeCreation) override;
  virtual void InitializeAfterLoadingAndSaving() override;
 
 
  virtual void UpdateAssetDocumentInfo(plAssetDocumentInfo* pInfo) const;
 
  virtual plTransformStatus InternalTransformAsset(plStreamWriter& stream, plStringView sOutputTag, const plPlatformProfile* pAssetProfile,
    const plAssetFileHeader& AssetHeader, plBitflags<plTransformFlags> transformFlags) = 0;
 
  virtual plTransformStatus InternalTransformAsset(const char* szTargetFile, plStringView sOutputTag, const plPlatformProfile* pAssetProfile,
    const plAssetFileHeader& AssetHeader, plBitflags<plTransformFlags> transformFlags);
 
  plStatus RemoteExport(const plAssetFileHeader& header, const char* szOutputTarget) const;
 
 
  virtual plTransformStatus InternalCreateThumbnail(const ThumbnailInfo& thumbnailInfo);
 
  plString GetThumbnailFilePath(plStringView sSubAssetName = plStringView()) const;
 
  void InvalidateAssetThumbnail(plStringView sSubAssetName = plStringView()) const;
 
  plStatus RemoteCreateThumbnail(const ThumbnailInfo& thumbnailInfo, plArrayPtr<plStringView> viewExclusionTags /*= plStringView("SkyLight")*/) const;
  plStatus RemoteCreateThumbnail(const ThumbnailInfo& thumbnailInfo) const
  {
    plStringView defVal("SkyLight");
    return RemoteCreateThumbnail(thumbnailInfo, {&defVal, 1});
  }
 
  plStatus SaveThumbnail(const plImage& img, const ThumbnailInfo& thumbnailInfo) const;
 
  plStatus SaveThumbnail(const QImage& img, const ThumbnailInfo& thumbnailInfo) const;
 
  void AppendThumbnailInfo(plStringView sThumbnailFile, const ThumbnailInfo& thumbnailInfo) const;
 
 
public:
  virtual void SetCommonAssetUiState(plCommonAssetUiState::Enum state, double value);
 
  virtual double GetCommonAssetUiState(plCommonAssetUiState::Enum state) const;
 
  plEvent<const plCommonAssetUiState&> m_CommonAssetUiChangeEvent;
 
protected:
  plUInt32 m_uiCommonAssetStateFlags = 0;
 
 
protected:
  void AddPrefabDependencies(const plDocumentObject* pObject, plAssetDocumentInfo* pInfo) const;
 
  void AddReferences(const plDocumentObject* pObject, plAssetDocumentInfo* pInfo, bool bInsidePrefab) const;
 
protected:
  plUniquePtr<plIPCObjectMirrorEditor> m_pMirror;
 
  virtual plDocumentInfo* CreateDocumentInfo() override;
 
  plTransformStatus DoTransformAsset(const plPlatformProfile* pAssetProfile, plBitflags<plTransformFlags> transformFlags);
 
  EngineStatus m_EngineStatus;
  plAssetDocEngineConnection m_EngineConnectionType = plAssetDocEngineConnection::None;
 
  plEditorEngineConnection* m_pEngineConnection;
 
  mutable plHashTable<plUuid, plEditorEngineSyncObject*> m_AllSyncObjects;
  mutable plDeque<plEditorEngineSyncObject*> m_SyncObjects;
 
  mutable plHybridArray<plUuid, 32> m_DeletedObjects;
};