Code/Tools/Libs/ToolsFoundation/Object/DocumentObjectBase.h - dev - redgpu/ezEngine

Code/Tools/Libs/ToolsFoundation/Object/DocumentObjectBase.h
74 строки2 KB
Jan Krassnigg
Added a few documentation comments
10 июл 2025, 10:23
10 июл 2025, 10:23892ad83
#pragma once

#include <Foundation/Strings/HashedString.h>
#include <Foundation/Types/Uuid.h>
#include <ToolsFoundation/Reflection/ReflectedTypeStorageAccessor.h>
#include <ToolsFoundation/ToolsFoundationDLL.h>

class ezDocumentObjectManager;

class EZ_TOOLSFOUNDATION_DLL ezDocumentObject
{
public:
  ezDocumentObject() = default;
  virtual ~ezDocumentObject() = default;

  // Accessors
  const ezUuid& GetGuid() const { return m_Guid; }
  /// \brief Returns the RTTI type of the object that is represented by this ezDocumentObject.
  const ezRTTI* GetType() const { return GetTypeAccessor().GetType(); }

  const ezDocumentObjectManager* GetDocumentObjectManager() const { return m_pDocumentObjectManager; }
  ezDocumentObjectManager* GetDocumentObjectManager() { return m_pDocumentObjectManager; }

  virtual const ezIReflectedTypeAccessor& GetTypeAccessor() const = 0;
  ezIReflectedTypeAccessor& GetTypeAccessor();

  // Ownership
  const ezDocumentObject* GetParent() const { return m_pParent; }

  virtual void InsertSubObject(ezDocumentObject* pObject, ezStringView sProperty, const ezVariant& index);
  virtual void RemoveSubObject(ezDocumentObject* pObject);

  // Helper
  void ComputeObjectHash(ezUInt64& ref_uiHash) const;
  const ezHybridArray<ezDocumentObject*, 8>& GetChildren() const { return m_Children; }
  ezDocumentObject* GetChild(const ezUuid& guid);
  const ezDocumentObject* GetChild(const ezUuid& guid) const;
  ezStringView GetParentProperty() const { return m_sParentProperty; }
  const ezAbstractProperty* GetParentPropertyType() const;
  ezVariant GetPropertyIndex() const;
  bool IsOnHeap() const;
  ezUInt32 GetChildIndex(const ezDocumentObject* pChild) const;

private:
  friend class ezDocumentObjectManager;
  void HashPropertiesRecursive(const ezIReflectedTypeAccessor& acc, ezUInt64& uiHash, const ezRTTI* pType) const;

protected:
  ezUuid m_Guid;
  ezDocumentObjectManager* m_pDocumentObjectManager = nullptr;

  ezDocumentObject* m_pParent = nullptr;
  ezHybridArray<ezDocumentObject*, 8> m_Children;

  // Sub object data
  ezString m_sParentProperty;
};

class EZ_TOOLSFOUNDATION_DLL ezDocumentStorageObject : public ezDocumentObject
{
public:
  ezDocumentStorageObject(const ezRTTI* pType)
    : ezDocumentObject()
    , m_ObjectPropertiesAccessor(pType, this)
  {
  }

  virtual ~ezDocumentStorageObject() = default;

  virtual const ezIReflectedTypeAccessor& GetTypeAccessor() const override { return m_ObjectPropertiesAccessor; }

protected:
  ezReflectedTypeStorageAccessor m_ObjectPropertiesAccessor;
};