AudioTriggerComponent.h

#pragma once
 
#include <AudioSystemPlugin/AudioSystemPluginDLL.h>
 
#include <AudioSystemPlugin/Components/AudioSystemComponent.h>
#include <AudioSystemPlugin/Core/AudioSystemData.h>
 
class plPhysicsWorldModuleInterface;
 
constexpr plUInt32 k_MaxOcclusionRaysCount = 32;
 
class PL_AUDIOSYSTEMPLUGIN_DLL plAudioTriggerComponentManager : public plComponentManager<class plAudioTriggerComponent, plBlockStorageType::FreeList>
{
public:
  explicit plAudioTriggerComponentManager(plWorld* pWorld);
 
  void Initialize() override;
  void Deinitialize() override;
 
private:
  friend class plAudioTriggerComponent;
 
 
  struct ObstructionOcclusionValue
  {
    float m_fTarget;
 
    float m_fValue;
 
    [[nodiscard]] float GetValue() const;
 
    void SetTarget(float fTarget, bool bReset = false);
 
    void Update(float fSmoothFactor = -1.0f);
 
    void Reset(float fInitialValue = 0.0f);
  };
 
  struct ObstructionOcclusionState
  {
    plAudioTriggerComponent* m_pComponent{nullptr};
 
    plUInt8 m_uiNextRayIndex{0};
 
    ObstructionOcclusionValue m_ObstructionValue;
    ObstructionOcclusionValue m_OcclusionValue;
 
    plStaticArray<float, k_MaxOcclusionRaysCount> m_ObstructionRaysValues;
  };
 
  plUInt32 AddObstructionOcclusionState(plAudioTriggerComponent* pComponent);
  void RemoveObstructionOcclusionState(plUInt32 uiIndex);
  [[nodiscard]] const ObstructionOcclusionState& GetObstructionOcclusionState(plUInt32 uiIndex) const { return m_ObstructionOcclusionStates[uiIndex]; }
 
  void ShootOcclusionRays(ObstructionOcclusionState& state, plVec3 listenerPos, plUInt32 uiNumRays, const plPhysicsWorldModuleInterface* pPhysicsWorldModule);
  void CastRay(ObstructionOcclusionState& state, plVec3 sourcePos, plVec3 direction, plUInt8 collisionLayer, const plPhysicsWorldModuleInterface* pPhysicsWorldModule, plUInt32 rayIndex);
  void ProcessOcclusion(const plWorldModule::UpdateContext& context);
  void Update(const plWorldModule::UpdateContext& context);
 
  plDynamicArray<ObstructionOcclusionState> m_ObstructionOcclusionStates;
};
 
class PL_AUDIOSYSTEMPLUGIN_DLL plAudioTriggerComponent : public plAudioSystemProxyDependentComponent
{
  PL_DECLARE_COMPONENT_TYPE(plAudioTriggerComponent, plAudioSystemProxyDependentComponent, plAudioTriggerComponentManager);
 
  // plComponent
 
public:
  void Initialize() override;
  void OnActivated() override;
  void OnSimulationStarted() override;
  void OnDeactivated() override;
  void Deinitialize() override;
  void SerializeComponent(plWorldWriter& stream) const override;
  void DeserializeComponent(plWorldReader& stream) override;
 
  // plAudioSystemComponent
 
private:
  void plAudioSystemComponentIsAbstract() override {}
 
  // plAudioTriggerComponent
 
public:
  plAudioTriggerComponent();
  ~plAudioTriggerComponent() override;
 
  void SetOcclusionCollisionLayer(plUInt8 uiCollisionLayer);
 
  [[nodiscard]] plUInt8 GetOcclusionCollisionLayer() const { return m_uiOcclusionCollisionLayer; }
 
  void SetPlayTrigger(plString sName);
 
  [[nodiscard]] const plString& GetPlayTrigger() const;
 
  void SetStopTrigger(plString sName);
 
  [[nodiscard]] const plString& GetStopTrigger() const;
 
  [[nodiscard]] const plEnum<plAudioSystemTriggerState>& GetState() const;
 
  [[nodiscard]] bool IsLoading() const;
 
  [[nodiscard]] bool IsReady() const;
 
  [[nodiscard]] bool IsStarting() const;
 
  [[nodiscard]] bool IsPlaying() const;
 
  [[nodiscard]] bool IsStopping() const;
 
  [[nodiscard]] bool IsStopped() const;
 
  [[nodiscard]] bool IsUnloading() const;
 
  void Play(bool bSync = false);
 
  void Stop(bool bSync = false);
 
private:
  void LoadPlayTrigger(bool bSync);
  void LoadStopTrigger(bool bSync, bool bDeinit);
  void UnloadPlayTrigger(bool bSync, bool bDeinit = false);
  void UnloadStopTrigger(bool bSync, bool bDeinit = false);
 
  void UpdateOcclusion();
  void Update();
 
  void StopInternal(bool bSync = false, bool bDeinit = false);
 
  plEnum<plAudioSystemTriggerState> m_eState;
 
  plAudioSystemDataID m_uiPlayEventId = 0;
  plAudioSystemDataID m_uiStopEventId = 0;
 
  plString m_sPlayTrigger;
  plString m_sStopTrigger;
 
  plEnum<plAudioSystemSoundObstructionType> m_eObstructionType;
  plUInt8 m_uiOcclusionCollisionLayer;
  plUInt32 m_uiObstructionOcclusionStateIndex;
 
  bool m_bLoadOnInit;
  bool m_bPlayOnActivate;
 
  bool m_bPlayTriggerLoaded{false};
  bool m_bStopTriggerLoaded{false};
 
  bool m_bHasPlayedOnActivate{false};
 
  bool m_bCanPlay{false};
};