Merge pull request ezEngine#478 from ezEngine/feature/scene_layers

# Scene Layer Support

Code/Editor/EditorEngineProcess/EngineProcGameApp.cpp

@@ -384,7 +384,10 @@ void ezEngineProcessGameApplication::EventHandlerIPC(const ezEngineProcessCommun
   if (const auto* pMsg = ezDynamicCast<const ezDocumentClearMsgToEngine*>(e.m_pMessage))
   {
     ezEngineProcessDocumentContext* pDocumentContext = ezEngineProcessDocumentContext::GetDocumentContext(pMsg->m_DocumentGuid);
-    pDocumentContext->ClearExistingObjects();
+    if (pDocumentContext)
+    {
+      pDocumentContext->ClearExistingObjects();
+    }
     return;
   }
 
@@ -417,10 +420,29 @@ ezEngineProcessDocumentContext* ezEngineProcessGameApplication::CreateDocumentCo
           if (sDocTypes.FindSubString(sRequestedType) != nullptr)
           {
             ezLog::Dev("Created Context of type '{0}' for '{1}'", pRtti->GetTypeName(), pMsg->m_sDocumentType);
-
-            pDocumentContext = pRtti->GetAllocator()->Allocate<ezEngineProcessDocumentContext>();
-
-            ezEngineProcessDocumentContext::AddDocumentContext(pMsg->m_DocumentGuid, pDocumentContext, &m_IPC);
+            for (ezAbstractFunctionProperty* pFunc : pRtti->GetFunctions())
+            {
+              if (ezStringUtils::IsEqual(pFunc->GetPropertyName(), "AllocateContext"))
+              {
+                ezVariant res;
+                ezHybridArray<ezVariant, 1> params;
+                params.PushBack(pMsg);
+                pFunc->Execute(nullptr, params, res);
+                if (res.IsA<ezEngineProcessDocumentContext*>())
+                {
+                  pDocumentContext = res.Get<ezEngineProcessDocumentContext*>();
+                }
+                else
+                {
+                  ezLog::Error("Failed to call custom allocator '{}::{}'.", pRtti->GetTypeName(), pFunc->GetPropertyName());
+                }
+              }
+            }
+
+            if (!pDocumentContext)
+              pDocumentContext = pRtti->GetAllocator()->Allocate<ezEngineProcessDocumentContext>();
+
+            ezEngineProcessDocumentContext::AddDocumentContext(pMsg->m_DocumentGuid, pMsg->m_DocumentMetaData, pDocumentContext, &m_IPC);
             break;
           }
         }

Code/Editor/EditorEngineProcessFramework/EngineProcess/EngineProcessDocumentContext.h

@@ -15,6 +15,24 @@ class ezExportDocumentMsgToEngine;
 class ezCreateThumbnailMsgToEngine;
 struct ezResourceEvent;
 
+struct ezEngineProcessDocumentContextFlags
+{
+  typedef ezUInt8 StorageType;
+
+  enum Enum
+  {
+    None = 0,
+    CreateWorld = EZ_BIT(0),
+    Default = None
+  };
+
+  struct Bits
+  {
+    StorageType CreateWorld : 1;
+  };
+};
+EZ_DECLARE_FLAGS_OPERATORS(ezEngineProcessDocumentContextFlags);
+
 /// \brief A document context is the counter part to an editor document on the engine side.
 ///
 /// For every document in the editor that requires engine output (rendering, picking, etc.), there is a ezEngineProcessDocumentContext
@@ -24,17 +42,17 @@ class EZ_EDITORENGINEPROCESSFRAMEWORK_DLL ezEngineProcessDocumentContext : publi
   EZ_ADD_DYNAMIC_REFLECTION(ezEngineProcessDocumentContext, ezReflectedClass);
 
 public:
-  ezEngineProcessDocumentContext();
+  ezEngineProcessDocumentContext(ezBitflags<ezEngineProcessDocumentContextFlags> flags);
   virtual ~ezEngineProcessDocumentContext();
 
-  void Initialize(const ezUuid& DocumentGuid, ezEngineProcessCommunicationChannel* pIPC);
+  virtual void Initialize(const ezUuid& DocumentGuid, const ezVariant& metaData, ezEngineProcessCommunicationChannel* pIPC);
   void Deinitialize();
 
   void SendProcessMessage(ezProcessMessage* pMsg = nullptr);
   virtual void HandleMessage(const ezEditorEngineDocumentMsg* pMsg);
 
   static ezEngineProcessDocumentContext* GetDocumentContext(ezUuid guid);
-  static void AddDocumentContext(ezUuid guid, ezEngineProcessDocumentContext* pView, ezEngineProcessCommunicationChannel* pIPC);
+  static void AddDocumentContext(ezUuid guid, const ezVariant& metaData, ezEngineProcessDocumentContext* pView, ezEngineProcessCommunicationChannel* pIPC);
   static bool PendingOperationsInProgress();
   static void UpdateDocumentContexts();
   static void DestroyDocumentContext(ezUuid guid);
@@ -52,7 +70,10 @@ class EZ_EDITORENGINEPROCESSFRAMEWORK_DLL ezEngineProcessDocumentContext : publi
   ezIPCObjectMirrorEngine m_Mirror;
   ezWorldRttiConverterContext m_Context; // TODO: Move actual context into the EngineProcessDocumentContext
 
-  ezWorld* GetWorld() const { return m_pWorld.Borrow(); }
+  ezWorld* GetWorld() const { return m_pWorld; }
+
+  /// \brief Tries to resolve a 'reference' (given in pData) to an ezGameObject.
+  virtual ezGameObjectHandle ResolveStringToGameObjectHandle(const void* pString, ezComponentHandle hThis, const char* szProperty) const;
 
 protected:
   virtual void OnInitialize();
@@ -100,7 +121,7 @@ class EZ_EDITORENGINEPROCESSFRAMEWORK_DLL ezEngineProcessDocumentContext : publi
   /// \brief Called before a thumbnail context is destroyed. Used for cleanup of what was done in OnThumbnailViewContextCreated()
   virtual void OnDestroyThumbnailViewContext();
 
-  ezUniquePtr<ezWorld> m_pWorld;
+  ezWorld* m_pWorld = nullptr;
 
   /// \brief Sets or removes the given tag on the object and optionally all children
   void SetTagOnObject(const ezUuid& object, const char* szTag, bool bSet, bool recursive);
@@ -116,9 +137,6 @@ class EZ_EDITORENGINEPROCESSFRAMEWORK_DLL ezEngineProcessDocumentContext : publi
     return uiView >= m_ViewContexts.GetCount() ? nullptr : m_ViewContexts[uiView];
   }
 
-  /// \brief Tries to resolve a 'reference' (given in pData) to an ezGameObject.
-  ezGameObjectHandle ResolveStringToGameObjectHandle(const void* pString, ezComponentHandle hThis, const char* szProperty) const;
-
 private:
   friend class ezEditorEngineSyncObject;
 
@@ -136,7 +154,10 @@ class EZ_EDITORENGINEPROCESSFRAMEWORK_DLL ezEngineProcessDocumentContext : publi
   /// Removes all sync objects that are tied to this context
   void CleanUpContextSyncObjects();
 
+protected:
+  ezBitflags<ezEngineProcessDocumentContextFlags> m_flags;
   ezUuid m_DocumentGuid;
+  ezVariant m_MetaData;
 
   ezEngineProcessCommunicationChannel* m_pIPC = nullptr;
   ezHybridArray<ezEngineProcessViewContext*, 4> m_ViewContexts;

Code/Editor/EditorEngineProcessFramework/EngineProcess/EngineProcessMessages.h

@@ -217,6 +217,7 @@ class EZ_EDITORENGINEPROCESSFRAMEWORK_DLL ezDocumentOpenMsgToEngine : public ezE
 
   bool m_bDocumentOpen;
   ezString m_sDocumentType;
+  ezVariant m_DocumentMetaData;
 };
 
 /// \brief Used to reset the engine side to an empty document before sending the full document state over

Code/Editor/EditorEngineProcessFramework/EngineProcess/Implementation/EngineProcessDocumentContext.cpp

@@ -27,12 +27,12 @@ ezEngineProcessDocumentContext* ezEngineProcessDocumentContext::GetDocumentConte
   return pResult;
 }
 
-void ezEngineProcessDocumentContext::AddDocumentContext(ezUuid guid, ezEngineProcessDocumentContext* pContext, ezEngineProcessCommunicationChannel* pIPC)
+void ezEngineProcessDocumentContext::AddDocumentContext(ezUuid guid, const ezVariant& metaData, ezEngineProcessDocumentContext* pContext, ezEngineProcessCommunicationChannel* pIPC)
 {
   EZ_ASSERT_DEV(!s_DocumentContexts.Contains(guid), "Cannot add a view with an index that already exists");
   s_DocumentContexts[guid] = pContext;
 
-  pContext->Initialize(guid, pIPC);
+  pContext->Initialize(guid, metaData, pIPC);
 }
 
 bool ezEngineProcessDocumentContext::PendingOperationsInProgress()
@@ -91,7 +91,8 @@ ezBoundingBoxSphere ezEngineProcessDocumentContext::GetWorldBounds(ezWorld* pWor
   return bounds;
 }
 
-ezEngineProcessDocumentContext::ezEngineProcessDocumentContext()
+ezEngineProcessDocumentContext::ezEngineProcessDocumentContext(ezBitflags<ezEngineProcessDocumentContextFlags> flags)
+  : m_flags(flags)
 {
   m_Context.m_Events.AddEventHandler(ezMakeDelegate(&ezEngineProcessDocumentContext::WorldRttiConverterContextEventHandler, this));
 }
@@ -103,35 +104,41 @@ ezEngineProcessDocumentContext::~ezEngineProcessDocumentContext()
   m_Context.m_Events.RemoveEventHandler(ezMakeDelegate(&ezEngineProcessDocumentContext::WorldRttiConverterContextEventHandler, this));
 }
 
-void ezEngineProcessDocumentContext::Initialize(const ezUuid& DocumentGuid, ezEngineProcessCommunicationChannel* pIPC)
+void ezEngineProcessDocumentContext::Initialize(const ezUuid& DocumentGuid, const ezVariant& metaData, ezEngineProcessCommunicationChannel* pIPC)
 {
   m_DocumentGuid = DocumentGuid;
+  m_MetaData = metaData;
   m_pIPC = pIPC;
 
-  ezStringBuilder tmp;
-  ezWorldDesc desc(ezConversionUtils::ToString(m_DocumentGuid, tmp));
-  desc.m_bReportErrorWhenStaticObjectMoves = false;
-
-  m_pWorld = EZ_DEFAULT_NEW(ezWorld, desc);
-  m_pWorld->SetGameObjectReferenceResolver(ezMakeDelegate(&ezEngineProcessDocumentContext::ResolveStringToGameObjectHandle, this));
+  if (m_flags.IsSet(ezEngineProcessDocumentContextFlags::CreateWorld))
+  {
+    ezStringBuilder tmp;
+    ezWorldDesc desc(ezConversionUtils::ToString(m_DocumentGuid, tmp));
+    desc.m_bReportErrorWhenStaticObjectMoves = false;
 
-  m_Context.m_pWorld = m_pWorld.Borrow();
-  m_Mirror.InitReceiver(&m_Context);
+    m_pWorld = EZ_DEFAULT_NEW(ezWorld, desc);
+    m_pWorld->SetGameObjectReferenceResolver(ezMakeDelegate(&ezEngineProcessDocumentContext::ResolveStringToGameObjectHandle, this));
 
+    m_Context.m_pWorld = m_pWorld;
+    m_Mirror.InitReceiver(&m_Context);
+  }
   OnInitialize();
 }
 
 void ezEngineProcessDocumentContext::Deinitialize()
 {
+  OnDeinitialize();
+
   ClearViewContexts();
   m_Mirror.Clear();
   m_Mirror.DeInit();
   m_Context.Clear();
 
-  OnDeinitialize();
-
   CleanUpContextSyncObjects();
-
+  if (m_flags.IsSet(ezEngineProcessDocumentContextFlags::CreateWorld))
+  {
+    EZ_DEFAULT_DELETE(m_pWorld);
+  }
   m_pWorld = nullptr;
 }
 
@@ -370,7 +377,7 @@ void ezEngineProcessDocumentContext::Reset()
 
   Deinitialize();
 
-  Initialize(guid, ipc);
+  Initialize(guid, m_MetaData, ipc);
 }
 
 void ezEngineProcessDocumentContext::ClearExistingObjects()
@@ -912,13 +919,13 @@ void ezEngineProcessDocumentContext::UpdateSyncObjects()
 
       EZ_LOCK(m_pWorld->GetWriteMarker());
 
-      if (pSyncObject->SetupForEngine(m_pWorld.Borrow(), m_Context.m_uiNextComponentPickingID))
+      if (pSyncObject->SetupForEngine(m_pWorld, m_Context.m_uiNextComponentPickingID))
       {
         m_Context.m_OtherPickingMap.RegisterObject(pSyncObject->GetGuid(), m_Context.m_uiNextComponentPickingID);
         ++m_Context.m_uiNextComponentPickingID;
       }
 
-      pSyncObject->UpdateForEngine(m_pWorld.Borrow());
+      pSyncObject->UpdateForEngine(m_pWorld);
     }
   }
 }

Code/Editor/EditorEngineProcessFramework/EngineProcess/Implementation/EngineProcessMessages.cpp

@@ -230,7 +230,8 @@ EZ_BEGIN_DYNAMIC_REFLECTED_TYPE(ezDocumentOpenMsgToEngine, 1, ezRTTIDefaultAlloc
   EZ_BEGIN_PROPERTIES
   {
     EZ_MEMBER_PROPERTY("DocumentOpen", m_bDocumentOpen),
-    EZ_MEMBER_PROPERTY("DocumentType", m_sDocumentType),
+    EZ_MEMBER_PROPERTY("DocumentType", m_sDocumentType),
+    EZ_MEMBER_PROPERTY("DocumentMetaData", m_DocumentMetaData),
   }
   EZ_END_PROPERTIES;
 }

Code/Editor/EditorFramework/Actions/Implementation/ViewActions.cpp

@@ -1,6 +1,7 @@
 #include <EditorFramework/EditorFrameworkPCH.h>
 
 #include <EditorFramework/Actions/ViewActions.h>
+#include <EditorFramework/Assets/AssetDocument.h>
 #include <EditorFramework/DocumentWindow/EngineViewWidget.moc.h>
 
 ezActionDescriptorHandle ezViewActions::s_hRenderMode;
@@ -143,15 +144,15 @@ void ezViewAction::Execute(const ezVariant& value)
   {
     case ezViewAction::ButtonType::ActivateRemoteProcess:
     {
-      ezEditorEngineProcessConnection::GetSingleton()->ActivateRemoteProcess(m_Context.m_pDocument, pView->GetViewID());
+      ezEditorEngineProcessConnection::GetSingleton()->ActivateRemoteProcess(ezDynamicCast<ezAssetDocument*>(m_Context.m_pDocument), pView->GetViewID());
     }
     break;
 
     case ezViewAction::ButtonType::LinkDeviceCamera:
     {
       pView->m_pViewConfig->m_bUseCameraTransformOnDevice = !pView->m_pViewConfig->m_bUseCameraTransformOnDevice;
       SetChecked(pView->m_pViewConfig->m_bUseCameraTransformOnDevice);
-      ezEditorEngineProcessConnection::GetSingleton()->ActivateRemoteProcess(m_Context.m_pDocument, pView->GetViewID());
+      ezEditorEngineProcessConnection::GetSingleton()->ActivateRemoteProcess(ezDynamicCast<ezAssetDocument*>(m_Context.m_pDocument), pView->GetViewID());
     }
     break;
   }

Code/Editor/EditorFramework/Assets/AssetDocument.h

@@ -116,6 +116,9 @@ class EZ_EDITORFRAMEWORK_DLL ezAssetDocument : public ezDocument
 
   /// \brief Returns the current state of the engine process side of this document.
   EngineStatus GetEngineStatus() const { return m_EngineStatus; }
+
+  /// \brief Passed into ezEngineProcessDocumentContext::Initialize on the engine process side. Allows the document to provide additional data to the engine process during context creation.
+  virtual ezVariant GetCreateEngineMetaData() const { return ezVariant(); }
 
   /// \brief Sends a message to the corresponding ezEngineProcessDocumentContext on the engine process.
   void SendMessageToEngine(ezEditorEngineDocumentMsg* pMessage) const;

Code/Editor/EditorFramework/Assets/Implementation/AssetDocument.cpp

@@ -150,15 +150,15 @@ void ezAssetDocument::InitializeAfterLoadingAndSaving()
 void ezAssetDocument::AddPrefabDependencies(const ezDocumentObject* pObject, ezAssetDocumentInfo* pInfo) const
 {
   {
-    const ezDocumentObjectMetaData* pMeta = m_DocumentObjectMetaData.BeginReadMetaData(pObject->GetGuid());
+    const ezDocumentObjectMetaData* pMeta = m_DocumentObjectMetaData->BeginReadMetaData(pObject->GetGuid());
 
     if (pMeta->m_CreateFromPrefab.IsValid())
     {
       ezStringBuilder tmp;
       pInfo->m_AssetTransformDependencies.Insert(ezConversionUtils::ToString(pMeta->m_CreateFromPrefab, tmp));
     }
 
-    m_DocumentObjectMetaData.EndReadMetaData();
+    m_DocumentObjectMetaData->EndReadMetaData();
   }
 
 
@@ -176,7 +176,7 @@ void ezAssetDocument::AddPrefabDependencies(const ezDocumentObject* pObject, ezA
 void ezAssetDocument::AddReferences(const ezDocumentObject* pObject, ezAssetDocumentInfo* pInfo, bool bInsidePrefab) const
 {
   {
-    const ezDocumentObjectMetaData* pMeta = m_DocumentObjectMetaData.BeginReadMetaData(pObject->GetGuid());
+    const ezDocumentObjectMetaData* pMeta = m_DocumentObjectMetaData->BeginReadMetaData(pObject->GetGuid());
 
     if (pMeta->m_CreateFromPrefab.IsValid())
     {
@@ -185,7 +185,7 @@ void ezAssetDocument::AddReferences(const ezDocumentObject* pObject, ezAssetDocu
       pInfo->m_RuntimeDependencies.Insert(ezConversionUtils::ToString(pMeta->m_CreateFromPrefab, tmp));
     }
 
-    m_DocumentObjectMetaData.EndReadMetaData();
+    m_DocumentObjectMetaData->EndReadMetaData();
   }
 
   const ezRTTI* pType = pObject->GetTypeAccessor().GetType();

Code/Editor/EditorFramework/Document/GameObjectDocument.h

@@ -100,8 +100,13 @@ class EZ_EDITORFRAMEWORK_DLL ezGameObjectDocument : public ezAssetDocument
     ezAssetDocEngineConnection engineConnectionType = ezAssetDocEngineConnection::FullObjectMirroring);
   ~ezGameObjectDocument();
 
+
   virtual ezEditorInputContext* GetEditorInputContextOverride() override;
 
+protected:
+  void SubscribeGameObjectEventHandlers();
+  void UnsubscribeGameObjectEventHandlers();
+
   /// \name Gizmo
   ///@{
 public:
@@ -229,21 +234,21 @@ class EZ_EDITORFRAMEWORK_DLL ezGameObjectDocument : public ezAssetDocument
 
 public:
   mutable ezEvent<const ezGameObjectEvent&> m_GameObjectEvents;
-  mutable ezObjectMetaData<ezUuid, ezGameObjectMetaData> m_GameObjectMetaData;
+  mutable ezUniquePtr<ezObjectMetaData<ezUuid, ezGameObjectMetaData>> m_GameObjectMetaData;
 
   static ezEvent<const ezGameObjectDocumentEvent&> s_GameObjectDocumentEvents;
 
 protected:
   void InvalidateGlobalTransformValue(const ezDocumentObject* pObject) const;
   /// \brief Sends the current state of the scene to the engine process. This is typically done after scene load or when the world might have deviated
   /// on the engine side (after play the game etc.)
-  void SendGameWorldToEngine();
+  virtual void SendGameWorldToEngine();
 
   virtual void InitializeAfterLoading(bool bFirstTimeCreation) override;
   virtual void AttachMetaDataBeforeSaving(ezAbstractObjectGraph& graph) const override;
   virtual void RestoreMetaDataAfterLoading(const ezAbstractObjectGraph& graph, bool bUndoable) override;
 
-private:
+public:
   void SelectionManagerEventHandler(const ezSelectionManagerEvent& e);
   void ObjectPropertyEventHandler(const ezDocumentObjectPropertyEvent& e);
   void ObjectStructureEventHandler(const ezDocumentObjectStructureEvent& e);
@@ -273,4 +278,10 @@ class EZ_EDITORFRAMEWORK_DLL ezGameObjectDocument : public ezAssetDocument
   // therefore when the selection is changed in the first frame, it might not be fully correct
   // by sending it a second time, we can fix that easily
   ezInt8 m_iResendSelection = 0;
+
+protected:
+  ezEventSubscriptionID m_SelectionManagerEventHandlerID;
+  ezEventSubscriptionID m_ObjectPropertyEventHandlerID;
+  ezEventSubscriptionID m_ObjectStructureEventHandlerID;
+  ezEventSubscriptionID m_ObjectEventHandlerID;
 };