EngineProcessDocumentContext.h

#pragma once
 
#include <EditorEngineProcessFramework/EditorEngineProcessFrameworkDLL.h>
#include <EditorEngineProcessFramework/EngineProcess/WorldRttiConverterContext.h>
#include <Foundation/Types/Uuid.h>
#include <RendererFoundation/Device/SwapChain.h>
#include <RendererFoundation/Resources/RenderTargetSetup.h>
 
class plEditorEngineSyncObjectMsg;
class plEditorEngineSyncObject;
class plEditorEngineDocumentMsg;
class plEngineProcessViewContext;
class plEngineProcessCommunicationChannel;
class plProcessMessage;
class plExportDocumentMsgToEngine;
class plCreateThumbnailMsgToEngine;
struct plResourceEvent;
 
struct plEngineProcessDocumentContextFlags
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    None = 0,
    CreateWorld = PL_BIT(0),
    Default = None
  };
 
  struct Bits
  {
    StorageType CreateWorld : 1;
  };
};
PL_DECLARE_FLAGS_OPERATORS(plEngineProcessDocumentContextFlags);
 
class PL_EDITORENGINEPROCESSFRAMEWORK_DLL plEngineProcessDocumentContext : public plReflectedClass
{
  PL_ADD_DYNAMIC_REFLECTION(plEngineProcessDocumentContext, plReflectedClass);
 
public:
  plEngineProcessDocumentContext(plBitflags<plEngineProcessDocumentContextFlags> flags);
  virtual ~plEngineProcessDocumentContext();
 
  virtual void Initialize(const plUuid& documentGuid, const plVariant& metaData, plEngineProcessCommunicationChannel* pIPC, plStringView sDocumentType);
  void Deinitialize();
 
  plStringView GetDocumentType() const { return m_sDocumentType; }
 
  void SendProcessMessage(plProcessMessage* pMsg = nullptr);
  virtual void HandleMessage(const plEditorEngineDocumentMsg* pMsg);
 
  static plEngineProcessDocumentContext* GetDocumentContext(plUuid guid);
  static void AddDocumentContext(plUuid guid, const plVariant& metaData, plEngineProcessDocumentContext* pView, plEngineProcessCommunicationChannel* pIPC, plStringView sDocumentType);
  static bool PendingOperationsInProgress();
  static void UpdateDocumentContexts();
  static void DestroyDocumentContext(plUuid guid);
 
  // \brief Returns the bounding box of the objects in the world.
  plBoundingBoxSphere GetWorldBounds(plWorld* pWorld);
 
  void ProcessEditorEngineSyncObjectMsg(const plEditorEngineSyncObjectMsg& msg);
 
  const plUuid& GetDocumentGuid() const { return m_DocumentGuid; }
 
  virtual void Reset();
  void ClearExistingObjects();
 
  plIPCObjectMirrorEngine m_Mirror;
  plWorldRttiConverterContext m_Context; // TODO: Move actual context into the EngineProcessDocumentContext
  virtual plWorldRttiConverterContext& GetContext() { return m_Context; }
  virtual const plWorldRttiConverterContext& GetContext() const { return m_Context; }
 
  plWorld* GetWorld() const { return m_pWorld; }
 
  virtual plGameObjectHandle ResolveStringToGameObjectHandle(const void* pString, plComponentHandle hThis, plStringView sProperty) const;
 
protected:
  virtual void OnInitialize();
  virtual void OnDeinitialize();
 
  virtual plEngineProcessViewContext* CreateViewContext() = 0;
  virtual void DestroyViewContext(plEngineProcessViewContext* pContext) = 0;
 
  virtual bool PendingOperationInProgress() const;
 
  virtual void UpdateDocumentContext();
 
  virtual plStatus ExportDocument(const plExportDocumentMsgToEngine* pMsg);
  void UpdateSyncObjects();
 
  void CreateThumbnailViewContext(const plCreateThumbnailMsgToEngine* pMsg);
 
  void DestroyThumbnailViewContext();
 
  virtual bool UpdateThumbnailViewContext(plEngineProcessViewContext* pThumbnailViewContext);
 
  virtual void OnThumbnailViewContextRequested() {}
  virtual void OnThumbnailViewContextCreated();
  virtual void OnDestroyThumbnailViewContext();
 
  plWorld* m_pWorld = nullptr;
 
  void SetTagOnObject(const plUuid& object, const char* szTag, bool bSet, bool recursive);
 
  void SetTagRecursive(plGameObject* pObject, const plTag& tag);
  void ClearTagRecursive(plGameObject* pObject, const plTag& tag);
 
protected:
  const plEngineProcessViewContext* GetViewContext(plUInt32 uiView) const
  {
    return uiView >= m_ViewContexts.GetCount() ? nullptr : m_ViewContexts[uiView];
  }
 
private:
  friend class plEditorEngineSyncObject;
 
  void AddSyncObject(plEditorEngineSyncObject* pSync);
  void RemoveSyncObject(plEditorEngineSyncObject* pSync);
  plEditorEngineSyncObject* FindSyncObject(const plUuid& guid);
 
 
private:
  void ClearViewContexts();
 
  // Maps a document guid to the corresponding context that handles that document on the engine side
  static plHashTable<plUuid, plEngineProcessDocumentContext*> s_DocumentContexts;
 
  void CleanUpContextSyncObjects();
 
protected:
  plBitflags<plEngineProcessDocumentContextFlags> m_Flags;
  plUuid m_DocumentGuid;
  plVariant m_MetaData;
 
  plEngineProcessCommunicationChannel* m_pIPC = nullptr;
  plHybridArray<plEngineProcessViewContext*, 4> m_ViewContexts;
 
  plMap<plUuid, plEditorEngineSyncObject*> m_SyncObjects;
 
private:
  enum Constants
  {
    ThumbnailSuperscaleFactor =
      2,                                 
    ThumbnailConvergenceFramesTarget = 4 
  };
 
  plUInt8 m_uiThumbnailConvergenceFrames = 0;
  plUInt16 m_uiThumbnailWidth = 0;
  plUInt16 m_uiThumbnailHeight = 0;
  plEngineProcessViewContext* m_pThumbnailViewContext = nullptr;
  plGALRenderTargets m_ThumbnailRenderTargets;
  plGALTextureHandle m_hThumbnailColorRT;
  plGALTextureHandle m_hThumbnailDepthRT;
  bool m_bWorldSimStateBeforeThumbnail = false;
  plString m_sDocumentType;
 
  // GameObject reference resolution
private:
  struct GoReferenceTo
  {
    plStringView m_sComponentProperty;
    plUuid m_ReferenceToGameObject;
  };
 
  struct GoReferencedBy
  {
    plStringView m_sComponentProperty;
    plUuid m_ReferencedByComponent;
  };
 
  // Components reference GameObjects
  mutable plMap<plUuid, plHybridArray<GoReferenceTo, 4>> m_GoRef_ReferencesTo;
 
  // GameObjects referenced by Components
  mutable plMap<plUuid, plHybridArray<GoReferencedBy, 4>> m_GoRef_ReferencedBy;
 
  void WorldRttiConverterContextEventHandler(const plWorldRttiConverterContext::Event& e);
};