SceneDocument.h

#pragma once
 
#include <EditorPluginScene/EditorPluginSceneDLL.h>
 
#include <EditorFramework/Document/GameObjectDocument.h>
 
class plExposedSceneProperty;
class plSceneDocumentSettingsBase;
class plPushObjectStateMsgToEditor;
 
struct GameMode
{
  enum Enum
  {
    Off,
    Simulate,
    Play,
  };
};
 
class PL_EDITORPLUGINSCENE_DLL plSceneDocument : public plGameObjectDocument
{
  PL_ADD_DYNAMIC_REFLECTION(plSceneDocument, plGameObjectDocument);
 
public:
  enum class DocumentType
  {
    Scene,
    Prefab,
    Layer
  };
 
public:
  plSceneDocument(plStringView sDocumentPath, DocumentType documentType);
  ~plSceneDocument();
 
  enum class ShowOrHide
  {
    Show,
    Hide
  };
 
  void GroupSelection();
 
  void DuplicateSpecial();
 
  void DeltaTransform();
 
 
  void SnapObjectToCamera();
 
 
  void AttachToObject();
 
  void DetachFromParent();
 
  void CopyReference();
 
  plStatus CreateEmptyObject(bool bAttachToParent, bool bAtPickedPosition);
 
  void DuplicateSelection();
  void ToggleHideSelectedObjects();
  void ShowOrHideSelectedObjects(ShowOrHide action);
  void ShowOrHideAllObjects(ShowOrHide action);
  void HideUnselectedObjects();
 
  bool IsPrefab() const { return m_DocumentType == DocumentType::Prefab; }
 
  bool IsObjectEditorPrefab(const plUuid& object, plUuid* out_pPrefabAssetGuid = nullptr) const;
 
  bool IsObjectEnginePrefab(const plUuid& object, plUuid* out_pPrefabAssetGuid = nullptr) const;
 
  virtual bool ArePrefabsAllowed() const override { return !IsPrefab(); }
 
 
  virtual void GetSupportedMimeTypesForPasting(plHybridArray<plString, 4>& out_mimeTypes) const override;
  virtual bool CopySelectedObjects(plAbstractObjectGraph& out_objectGraph, plStringBuilder& out_sMimeType) const override;
  virtual bool Paste(
    const plArrayPtr<PasteInfo>& info, const plAbstractObjectGraph& objectGraph, bool bAllowPickedPosition, plStringView sMimeType) override;
  bool DuplicateSelectedObjects(const plArrayPtr<PasteInfo>& info, const plAbstractObjectGraph& objectGraph, bool bSetSelected);
  bool CopySelectedObjects(plAbstractObjectGraph& ref_graph, plMap<plUuid, plUuid>* out_pParents) const;
  bool PasteAt(const plArrayPtr<PasteInfo>& info, const plVec3& vPos);
  bool PasteAtOrignalPosition(const plArrayPtr<PasteInfo>& info, const plAbstractObjectGraph& objectGraph);
 
  virtual void UpdatePrefabs() override;
 
  virtual void UnlinkPrefabs(const plDeque<const plDocumentObject*>& selection) override;
 
  virtual plUuid ReplaceByPrefab(
    const plDocumentObject* pRootObject, plStringView sPrefabFile, const plUuid& prefabAsset, const plUuid& prefabSeed, bool bEnginePrefab) override;
 
  virtual plUuid RevertPrefab(const plDocumentObject* pObject) override;
 
  virtual void ConvertToEditorPrefab(const plDeque<const plDocumentObject*>& selection);
  virtual void ConvertToEnginePrefab(const plDeque<const plDocumentObject*>& selection);
 
  virtual plStatus CreatePrefabDocumentFromSelection(plStringView sFile, const plRTTI* pRootType, plDelegate<void(plAbstractObjectNode*)> adjustGraphNodeCB = {}, plDelegate<void(plDocumentObject*)> adjustNewNodesCB = {}, plDelegate<void(plAbstractObjectGraph& graph, plDynamicArray<plAbstractObjectNode*>& graphRootNodes)> finalizeGraphCB = {}) override;
 
  GameMode::Enum GetGameMode() const { return m_GameMode; }
 
  virtual bool CanEngineProcessBeRestarted() const override;
 
  void StartSimulateWorld();
  void TriggerGameModePlay(bool bUsePickedPositionAsStart);
 
  bool StopGameMode();
 
  plTransformStatus ExportScene(bool bCreateThumbnail);
  void ExportSceneGeometry(
    const char* szFile, bool bOnlySelection, int iExtractionMode /* plWorldGeoExtractionUtil::ExtractionMode */, const plMat3& mTransform);
 
  virtual void HandleEngineMessage(const plEditorEngineDocumentMsg* pMsg) override;
  void HandleGameModeMsg(const plGameModeMsgToEditor* pMsg);
  void HandleObjectStateFromEngineMsg(const plPushObjectStateMsgToEditor* pMsg);
 
  void SendObjectMsg(const plDocumentObject* pObj, plObjectTagMsgToEngine* pMsg);
  void SendObjectMsgRecursive(const plDocumentObject* pObj, plObjectTagMsgToEngine* pMsg);
 
 
  virtual const plDocumentObject* GetSettingsObject() const;
  const plSceneDocumentSettingsBase* GetSettingsBase() const;
  template <typename T>
  const T* GetSettings() const
  {
    return plDynamicCast<const T*>(GetSettingsBase());
  }
 
  plStatus CreateExposedProperty(
    const plDocumentObject* pObject, const plAbstractProperty* pProperty, plVariant index, plExposedSceneProperty& out_key) const;
  plStatus AddExposedParameter(const char* szName, const plDocumentObject* pObject, const plAbstractProperty* pProperty, plVariant index);
  plInt32 FindExposedParameter(const plDocumentObject* pObject, const plAbstractProperty* pProperty, plVariant index);
  plStatus RemoveExposedParameter(plInt32 iIndex);
 
 
  void StoreFavoriteCamera(plUInt8 uiSlot);
 
  void RestoreFavoriteCamera(plUInt8 uiSlot);
 
  plResult JumpToLevelCamera(plUInt8 uiSlot, bool bImmediate);
 
  plResult CreateLevelCamera(plUInt8 uiSlot);
 
  virtual plManipulatorSearchStrategy GetManipulatorSearchStrategy() const override
  {
    return plManipulatorSearchStrategy::ChildrenOfSelectedObject;
  }
 
 
protected:
  void SetGameMode(GameMode::Enum mode);
 
  virtual void InitializeAfterLoading(bool bFirstTimeCreation) override;
  virtual void UpdatePrefabObject(plDocumentObject* pObject, const plUuid& PrefabAsset, const plUuid& PrefabSeed, plStringView sBasePrefab) override;
  virtual void UpdateAssetDocumentInfo(plAssetDocumentInfo* pInfo) const override;
 
  template <typename Func>
  void ApplyRecursive(const plDocumentObject* pObject, Func f)
  {
    f(pObject);
 
    for (auto pChild : pObject->GetChildren())
    {
      ApplyRecursive<Func>(pChild, f);
    }
  }
 
protected:
  void EnsureSettingsObjectExist();
  void DocumentObjectMetaDataEventHandler(const plObjectMetaData<plUuid, plDocumentObjectMetaData>::EventData& e);
  void EngineConnectionEventHandler(const plEditorEngineProcessConnection::Event& e);
  void ToolsProjectEventHandler(const plToolsProjectEvent& e);
 
  plStatus RequestExportScene(const char* szTargetFile, const plAssetFileHeader& header);
 
  virtual plTransformStatus InternalTransformAsset(const char* szTargetFile, plStringView sOutputTag, const plPlatformProfile* pAssetProfile,
    const plAssetFileHeader& AssetHeader, plBitflags<plTransformFlags> transformFlags) override;
  virtual plTransformStatus InternalTransformAsset(plStreamWriter& stream, plStringView sOutputTag, const plPlatformProfile* pAssetProfile,
    const plAssetFileHeader& AssetHeader, plBitflags<plTransformFlags> transformFlags) override;
  plTransformStatus InternalCreateThumbnail(const ThumbnailInfo& ThumbnailInfo) override;
 
  void SyncObjectHiddenState();
  void SyncObjectHiddenState(plDocumentObject* pObject);
 
  void UpdateObjectDebugTargets();
 
  DocumentType m_DocumentType = DocumentType::Scene;
 
  GameMode::Enum m_GameMode;
 
  GameModeData m_GameModeData[3];
 
  // Local mirror for settings
  plDocumentObjectMirror m_ObjectMirror;
  plRttiConverterContext m_Context;
 
  virtual void OnInterDocumentMessage(plReflectedClass* pMessage, plDocument* pSender) override;
  void GatherObjectsOfType(plDocumentObject* pRoot, plGatherObjectsOfTypeMsgInterDoc* pMsg) const;
};