Code/Engine/Foundation/DataProcessing/Stream/ProcessingStreamGroup.h - dev - redgpu/ezEngine

Code/Engine/Foundation/DataProcessing/Stream/ProcessingStreamGroup.h
106 строк4 KB
C-Core
Particle fixes and improvements (#1931)
05 май 2026, 13:36
05 май 2026, 13:363e4c257

#pragma once

#include <Foundation/Basics.h>
#include <Foundation/Communication/Event.h>
#include <Foundation/Containers/HybridArray.h>
#include <Foundation/DataProcessing/Stream/ProcessingStream.h>

class ezProcessingStreamProcessor;
class ezProcessingStreamGroup;

struct ezStreamGroupElementRemovedEvent
{
  ezProcessingStreamGroup* m_pStreamGroup;
  ezUInt64 m_uiElementIndex;
};

struct ezStreamGroupElementsClearedEvent
{
  ezProcessingStreamGroup* m_pStreamGroup;
};

/// \brief A stream group encapsulates the streams and the corresponding data processors.
class EZ_FOUNDATION_DLL ezProcessingStreamGroup
{
public:
  /// \brief Constructor
  ezProcessingStreamGroup();

  /// \brief Destructor
  ~ezProcessingStreamGroup();

  void Clear();

  /// \brief Adds a stream processor to the stream group.
  /// Ownership is transferred to the stream group and the processor will be deallocated using the RTTI deallocator on destruction.
  /// Processors are executed in the order they are added to the stream group.
  void AddProcessor(ezProcessingStreamProcessor* pProcessor);

  /// \brief Removes the given stream processor from the group.
  void RemoveProcessor(ezProcessingStreamProcessor* pProcessor);

  /// \brief Removes all stream processors from the group.
  void ClearProcessors();

  /// \brief Adds a stream with the given name to the stream group. Adding a stream two times with the same name will return nullptr for the second
  /// attempt to signal an error.
  ezProcessingStream* AddStream(ezStringView sName, ezProcessingStream::DataType type);

  /// \brief Removes the stream with the given name, if it exists.
  void RemoveStreamByName(ezTempHashedString sName);

  /// \brief Returns the stream by it's name, returns nullptr if not existent. More efficient since direct use of ezHashedString.
  ezProcessingStream* GetStreamByName(ezTempHashedString sName) const;

  /// \brief Resizes all streams to contain storage for uiNumElements. Any pending remove and spawn operations will be reset!
  void SetSize(ezUInt64 uiNumElements);

  /// \brief Removes an element (e.g. due to the death of a particle etc.), this will be enqueued (and thus is safe to be called from within data
  /// processors).
  void RemoveElement(ezUInt64 uiElementIndex);

  /// \brief Spawns a number of new elements, they will be added as newly initialized stream elements. Safe to call from data processors since the
  /// spawning will be queued.
  void InitializeElements(ezUInt64 uiNumElements);

  /// \brief Runs the stream processors which have been added to the stream group.
  void Process();

  /// \brief Returns the number of elements the streams store.
  inline ezUInt64 GetNumElements() const { return m_uiNumElements; }

  /// \brief Returns the number of currently active elements.
  inline ezUInt64 GetNumActiveElements() const { return m_uiNumActiveElements; }

  /// \brief Returns the highest number of active elements since the last SetSize() call.
  inline ezUInt64 GetHighestNumActiveElements() const { return m_uiHighestNumActiveElements; }

  /// \brief Subscribe to this event to be informed when (shortly before) items are deleted.
  ezEvent<const ezStreamGroupElementRemovedEvent&> m_ElementRemovedEvent;

private:
  /// \brief Internal helper function which removes any pending elements and spawns new elements as needed
  void RunPendingDeletions();

  void EnsureStreamAssignmentValid();

  void RunPendingSpawns();

  void SortProcessorsByPriority();

  ezHybridArray<ezProcessingStreamProcessor*, 8> m_Processors;

  ezHybridArray<ezProcessingStream*, 8> m_DataStreams;

  ezHybridArray<ezUInt64, 64> m_PendingRemoveIndices;

  ezUInt64 m_uiPendingNumberOfElementsToSpawn;

  ezUInt64 m_uiNumElements;

  ezUInt64 m_uiNumActiveElements;

  ezUInt64 m_uiHighestNumActiveElements;

  bool m_bStreamAssignmentDirty;
};