Code/EnginePlugins/ParticlePlugin/WorldModule/ParticleWorldModule.h - dev - redgpu/ezEngine

Code/EnginePlugins/ParticlePlugin/WorldModule/ParticleWorldModule.h
94 строки5 KB
Ingrater
Implement parameter coding guidelines in clang-tidy (#808)
18 фев 2023, 13:18
18 фев 2023, 13:183c98d47
#pragma once

#include <Core/ResourceManager/ResourceHandle.h>
#include <Core/World/WorldModule.h>
#include <Foundation/Containers/IdTable.h>
#include <ParticlePlugin/Effect/ParticleEffectInstance.h>
#include <ParticlePlugin/Events/ParticleEvent.h>
#include <ParticlePlugin/ParticlePluginDLL.h>

using ezParticleEffectResourceHandle = ezTypedResourceHandle<class ezParticleEffectResource>;
class ezParticleEffectInstance;
struct ezResourceEvent;
class ezTaskGroupID;
class ezParticleStream;
class ezParticleStreamFactory;

/// \brief This world module stores all particle effect data that is active in a given ezWorld instance
///
/// It is used to update all effects in one world and also to render them.
/// When an effect is stopped, it only stops emitting new particles, but it lives on until all particles are dead.
/// Therefore particle effects need to be managed outside of components. When a component dies, it only tells the
/// world module to 'destroy' it's effect, the rest is handled behind the scenes.
class EZ_PARTICLEPLUGIN_DLL ezParticleWorldModule final : public ezWorldModule
{
  EZ_DECLARE_WORLD_MODULE();
  EZ_ADD_DYNAMIC_REFLECTION(ezParticleWorldModule, ezWorldModule);

public:
  ezParticleWorldModule(ezWorld* pWorld);
  ~ezParticleWorldModule();

  virtual void Initialize() override;
  virtual void Deinitialize() override;

  ezParticleEffectHandle CreateEffectInstance(const ezParticleEffectResourceHandle& hResource, ezUInt64 uiRandomSeed, const char* szSharedName /*= nullptr*/, const void*& inout_pSharedInstanceOwner, ezArrayPtr<ezParticleEffectFloatParam> floatParams, ezArrayPtr<ezParticleEffectColorParam> colorParams);

  /// \brief This does not actually the effect, it first stops it from emitting and destroys it once all particles have actually died of old age.
  void DestroyEffectInstance(const ezParticleEffectHandle& hEffect, bool bInterruptImmediately, const void* pSharedInstanceOwner);

  bool TryGetEffectInstance(const ezParticleEffectHandle& hEffect, ezParticleEffectInstance*& out_pEffect);
  bool TryGetEffectInstance(const ezParticleEffectHandle& hEffect, const ezParticleEffectInstance*& out_pEffect) const;

  /// \brief Extracts render data for the given effect.
  void ExtractEffectRenderData(const ezParticleEffectInstance* pEffect, ezMsgExtractRenderData& ref_msg, const ezTransform& systemTransform) const;

  ezParticleSystemInstance* CreateSystemInstance(ezUInt32 uiMaxParticles, ezWorld* pWorld, ezParticleEffectInstance* pOwnerEffect, float fSpawnMultiplier);
  void DestroySystemInstance(ezParticleSystemInstance* pInstance);

  ezParticleStream* CreateStreamDefaultInitializer(ezParticleSystemInstance* pOwner, const char* szFullStreamName) const;

  /// \brief Can be called at any time (e.g. during ezParticleBehaviorFactory::CopyBehaviorProperties()) to query a previously cached world module,
  /// even if that happens on a thread which would not be allowed to query this from the ezWorld at that time.
  ezWorldModule* GetCachedWorldModule(const ezRTTI* pRtti) const;

  /// \brief Should be called by ezParticleModule::RequestRequiredWorldModulesForCache() to cache a pointer to a world module that is needed later.
  template <class T>
  void CacheWorldModule()
  {
    CacheWorldModule(ezGetStaticRTTI<T>());
  }

  /// \brief Should be called by ezParticleModule::RequestRequiredWorldModulesForCache() to cache a pointer to a world module that is needed later.
  void CacheWorldModule(const ezRTTI* pRtti);

private:
  virtual void WorldClear() override;

  void UpdateEffects(const ezWorldModule::UpdateContext& context);
  void EnsureUpdatesFinished(const ezWorldModule::UpdateContext& context);

  void DestroyFinishedEffects();
  void CreateFinisherComponent(ezParticleEffectInstance* pEffect);
  void ResourceEventHandler(const ezResourceEvent& e);
  void ReconfigureEffects();
  ezParticleEffectHandle InternalCreateSharedEffectInstance(const char* szSharedName, const ezParticleEffectResourceHandle& hResource, ezUInt64 uiRandomSeed, const void* pSharedInstanceOwner);
  ezParticleEffectHandle InternalCreateEffectInstance(const ezParticleEffectResourceHandle& hResource, ezUInt64 uiRandomSeed, bool bIsShared, ezArrayPtr<ezParticleEffectFloatParam> floatParams, ezArrayPtr<ezParticleEffectColorParam> colorParams);

  void ConfigureParticleStreamFactories();
  void ClearParticleStreamFactories();

  mutable ezMutex m_Mutex;
  ezDeque<ezParticleEffectInstance> m_ParticleEffects;
  ezDynamicArray<ezParticleEffectInstance*> m_FinishingEffects;
  ezDynamicArray<ezParticleEffectInstance*> m_NeedFinisherComponent;
  ezDynamicArray<ezParticleEffectInstance*> m_EffectsToReconfigure;
  ezDynamicArray<ezParticleEffectInstance*> m_ParticleEffectsFreeList;
  ezMap<ezString, ezParticleEffectHandle> m_SharedEffects;
  ezIdTable<ezParticleEffectId, ezParticleEffectInstance*> m_ActiveEffects;
  ezDeque<ezParticleSystemInstance> m_ParticleSystems;
  ezDynamicArray<ezParticleSystemInstance*> m_ParticleSystemFreeList;
  ezTaskGroupID m_EffectUpdateTaskGroup;
  ezMap<ezString, ezParticleStreamFactory*> m_StreamFactories;
  ezHashTable<const ezRTTI*, ezWorldModule*> m_WorldModuleCache;
};