ParticleComponent.h

#pragma once
 
#include <Core/ResourceManager/Resource.h>
#include <Core/ResourceManager/ResourceHandle.h>
#include <Core/World/World.h>
#include <Foundation/Types/RangeView.h>
#include <ParticlePlugin/Effect/ParticleEffectController.h>
#include <ParticlePlugin/Effect/ParticleEffectInstance.h>
#include <ParticlePlugin/ParticlePluginDLL.h>
#include <RendererCore/Components/RenderComponent.h>
 
class plParticleRenderData;
struct plMsgUpdateLocalBounds;
struct plMsgExtractRenderData;
class plParticleSystemInstance;
class plParticleComponent;
struct plMsgSetPlaying;
 
using plParticleEffectResourceHandle = plTypedResourceHandle<class plParticleEffectResource>;
 
class PL_PARTICLEPLUGIN_DLL plParticleComponentManager final : public plComponentManager<class plParticleComponent, plBlockStorageType::Compact>
{
  using SUPER = plComponentManager<class plParticleComponent, plBlockStorageType::Compact>;
 
public:
  plParticleComponentManager(plWorld* pWorld);
 
  virtual void Initialize() override;
 
  void Update(const plWorldModule::UpdateContext& context);
 
  void UpdatePfxTransformsAndBounds();
};
 
class PL_PARTICLEPLUGIN_DLL plParticleComponent final : public plRenderComponent
{
  PL_DECLARE_COMPONENT_TYPE(plParticleComponent, plRenderComponent, plParticleComponentManager);
 
  // plComponent
 
public:
  virtual void SerializeComponent(plWorldWriter& inout_stream) const override;
  virtual void DeserializeComponent(plWorldReader& inout_stream) override;
 
protected:
  virtual void OnDeactivated() override;
 
  // plRenderComponent
 
public:
  virtual plResult GetLocalBounds(plBoundingBoxSphere& ref_bounds, bool& ref_bAlwaysVisible, plMsgUpdateLocalBounds& ref_msg) override;
 
  // plParticleComponent
 
public:
  plParticleComponent();
  ~plParticleComponent();
 
  bool StartEffect(); // [ scriptable ]
 
  void StopEffect(); // [ scriptable ]
 
  void InterruptEffect(); // [ scriptable ]
 
  bool IsEffectActive() const; // [ scriptable ]
 
  void OnMsgSetPlaying(plMsgSetPlaying& ref_msg); // [ msg handler ]
 
  void SetParticleEffect(const plParticleEffectResourceHandle& hEffect);
  PL_ALWAYS_INLINE const plParticleEffectResourceHandle& GetParticleEffect() const { return m_hEffectResource; }
 
  void SetParticleEffectFile(const char* szFile); // [ property ]
  const char* GetParticleEffectFile() const;      // [ property ]
 
  // Exposed Parameters
  const plRangeView<const char*, plUInt32> GetParameters() const;   // [ property ]
  void SetParameter(const char* szKey, const plVariant& value);     // [ property ]
  void RemoveParameter(const char* szKey);                          // [ property ]
  bool GetParameter(const char* szKey, plVariant& out_value) const; // [ property ]
 
  plUInt64 m_uiRandomSeed = 0; // [ property ]
 
  plString m_sSharedInstanceName; // [ property ]
 
  bool m_bSpawnAtStart = true; // [ property ]
 
  bool m_bIgnoreOwnerRotation = false; // [ property ]
 
  plEnum<plOnComponentFinishedAction2> m_OnFinishedAction; // [ property ]
 
  plTime m_MinRestartDelay; // [ property ]
 
  plTime m_RestartDelayRange; // [ property ]
 
  plEnum<plBasisAxis> m_SpawnDirection = plBasisAxis::PositiveZ; // [ property ]
 
  plParticleEffectController m_EffectController;
 
protected:
  void Update();
  plTransform GetPfxTransform() const;
  void UpdatePfxTransformAndBounds();
 
  void OnMsgExtractRenderData(plMsgExtractRenderData& msg) const;
  void OnMsgDeleteGameObject(plMsgDeleteGameObject& msg);
 
  plParticleEffectResourceHandle m_hEffectResource;
 
  plTime m_RestartTime;
 
  // Exposed Parameters
  friend class plParticleEventReaction_Effect;
  bool m_bIfContinuousStopRightAway = false;
  bool m_bFloatParamsChanged = false;
  bool m_bColorParamsChanged = false;
  plHybridArray<plParticleEffectFloatParam, 2> m_FloatParams;
  plHybridArray<plParticleEffectColorParam, 2> m_ColorParams;
};