Code/Engine/Foundation/Serialization/ApplyNativePropertyChangesContext.h - dev - redgpu/ezEngine

Code/Engine/Foundation/Serialization/ApplyNativePropertyChangesContext.h

40 строк2 KB

Jan Krassnigg

Improved documentation of the Foundation library (#1664)

20 сен 2025, 19:53

20 сен 2025, 19:530e28096

#pragma once

#include <Foundation/Serialization/RttiConverter.h>

/// \brief Specialized context for tracking and applying native object changes to abstract object graphs.
///
/// This context enables a sophisticated bidirectional synchronization workflow between native
/// C++ objects and their serialized representations in ezAbstractObjectGraph form. It ensures
/// that modifications made to native objects can be properly tracked and applied back to the
/// abstract representation while maintaining object identity through consistent GUID generation.
///
/// The key capability is generating GUIDs for native objects that exactly match the GUIDs
/// used in the original abstract object graph. This allows the system to correlate changes
/// made to native objects with their counterparts in the serialized form.
///
/// Typical workflow:
/// 1. Deserialize an abstract object graph to native objects
/// 2. Create this context to track GUID relationships
/// 3. Modify the native objects through normal C++ operations
/// 4. Use the context to detect and apply changes back to the abstract graph
/// 5. Serialize the updated abstract graph for persistence
///
/// This is particularly useful for:
/// - Editor scenarios where objects are modified through UI and need to be saved
/// - Undo/redo systems that operate on abstract object graphs
/// - Network synchronization where changes need to be transmitted efficiently
/// - Asset pipeline where native modifications need to be persisted
///
/// \sa ezAbstractObjectGraph::ModifyNodeViaNativeCounterpart
class EZ_FOUNDATION_DLL ezApplyNativePropertyChangesContext : public ezRttiConverterContext
{
public:
  ezApplyNativePropertyChangesContext(ezRttiConverterContext& ref_source, const ezAbstractObjectGraph& originalGraph);

  virtual ezUuid GenerateObjectGuid(const ezUuid& parentGuid, const ezAbstractProperty* pProp, ezVariant index, void* pObject) const override;

private:
  ezRttiConverterContext& m_NativeContext;
  const ezAbstractObjectGraph& m_OriginalGraph;
};