Code/Engine/GameEngine/Volumes/VolumeComponent.h - dev - redgpu/ezEngine

Code/Engine/GameEngine/Volumes/VolumeComponent.h
152 строки6 KB
Jan Krassnigg
Fixed #1164: Made it easier to reflect resource handles (#1376)
23 авг 2024, 08:36
23 авг 2024, 08:368a46458
#pragma once

#include <Core/ResourceManager/ResourceHandle.h>
#include <Core/World/World.h>
#include <Foundation/Types/RangeView.h>
#include <GameEngine/GameEngineDLL.h>

struct ezMsgUpdateLocalBounds;

using ezBlackboardTemplateResourceHandle = ezTypedResourceHandle<class ezBlackboardTemplateResource>;

/// \brief A volume component can hold generic values either from a blackboard template or set directly on the component.
///
/// The values can be sampled with an ezVolumeSampler and then used for things like e.g. post-processing, reverb etc.
/// They can also be used to represent knowledge in a scene, like e.g. smell or threat, and can be detected by an ezSensorComponent and then processed by AI.
class EZ_GAMEENGINE_DLL ezVolumeComponent : public ezComponent
{
  EZ_DECLARE_ABSTRACT_COMPONENT_TYPE(ezVolumeComponent, ezComponent);

  //////////////////////////////////////////////////////////////////////////
  // ezComponent

protected:
  virtual void OnActivated() override;
  virtual void OnDeactivated() override;

public:
  virtual void SerializeComponent(ezWorldWriter& inout_stream) const override;
  virtual void DeserializeComponent(ezWorldReader& inout_stream) override;

  //////////////////////////////////////////////////////////////////////////
  // ezVolumeComponent

public:
  ezVolumeComponent();
  ~ezVolumeComponent();

  /// \brief Sets the blackboard template to use.
  void SetTemplate(const ezBlackboardTemplateResourceHandle& hResource);                        // [ property ]
  const ezBlackboardTemplateResourceHandle& GetTemplate() const { return m_hTemplateResource; } // [ property ]

  /// \brief In case two volumes overlap, the one with a higher sort order value has precedence.
  void SetSortOrder(float fOrder);                    // [ property ]
  float GetSortOrder() const { return m_fSortOrder; } // [ property ]

  /// \brief Sets the spatial category under which this volume can be detected.
  void SetVolumeType(const char* szType); // [ property ]
  const char* GetVolumeType() const;      // [ property ]

  /// \brief Adds or replaces a value with a given name.
  void SetValue(const ezHashedString& sName, const ezVariant& value); // [ scriptable ]
  ezVariant GetValue(ezTempHashedString sName) const                  // [ scriptable ]
  {
    ezVariant v;
    m_Values.TryGetValue(sName, v);
    return v;
  }

protected:
  const ezRangeView<const ezString&, ezUInt32> Reflection_GetKeys() const;
  bool Reflection_GetValue(const char* szName, ezVariant& value) const;
  void Reflection_InsertValue(const char* szName, const ezVariant& value);
  void Reflection_RemoveValue(const char* szName);

  void InitializeFromTemplate();
  void ReloadTemplate();
  void RemoveReloadFunction();

  ezBlackboardTemplateResourceHandle m_hTemplateResource;
  ezHashTable<ezHashedString, ezVariant> m_Values;
  ezSmallArray<ezHashedString, 1> m_OverwrittenValues; // only used in editor
  float m_fSortOrder = 0.0f;
  ezSpatialData::Category m_SpatialCategory = ezInvalidSpatialDataCategory;
  bool m_bReloadFunctionAdded = false;
};

//////////////////////////////////////////////////////////////////////////

using ezVolumeSphereComponentManager = ezComponentManager<class ezVolumeSphereComponent, ezBlockStorageType::Compact>;

/// \brief A sphere implementation of the ezVolumeComponent
class EZ_GAMEENGINE_DLL ezVolumeSphereComponent : public ezVolumeComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezVolumeSphereComponent, ezVolumeComponent, ezVolumeSphereComponentManager);

  //////////////////////////////////////////////////////////////////////////
  // ezVolumeComponent

public:
  virtual void SerializeComponent(ezWorldWriter& inout_stream) const override;
  virtual void DeserializeComponent(ezWorldReader& inout_stream) override;

  //////////////////////////////////////////////////////////////////////////
  // ezVolumeSphereComponent

public:
  ezVolumeSphereComponent();
  ~ezVolumeSphereComponent();

  void SetRadius(float fRadius);
  float GetRadius() const { return m_fRadius; }

  /// \brief Values above 1 make the sphere influence drop off more rapidly, below 1 more slowly.
  void SetFalloff(float fFalloff);
  float GetFalloff() const { return m_fFalloff; }

protected:
  void OnUpdateLocalBounds(ezMsgUpdateLocalBounds& ref_msg) const;

  float m_fRadius = 5.0f;
  float m_fFalloff = 0.5f;
};

//////////////////////////////////////////////////////////////////////////

using ezVolumeBoxComponentManager = ezComponentManager<class ezVolumeBoxComponent, ezBlockStorageType::Compact>;

/// \brief A box implementation of the ezVolumeComponent
class EZ_GAMEENGINE_DLL ezVolumeBoxComponent : public ezVolumeComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezVolumeBoxComponent, ezVolumeComponent, ezVolumeBoxComponentManager);

  //////////////////////////////////////////////////////////////////////////
  // ezVolumeComponent

public:
  virtual void SerializeComponent(ezWorldWriter& inout_stream) const override;
  virtual void DeserializeComponent(ezWorldReader& inout_stream) override;

  //////////////////////////////////////////////////////////////////////////
  // ezVolumeBoxComponent

public:
  ezVolumeBoxComponent();
  ~ezVolumeBoxComponent();

  /// \brief Sets the size of the box.
  void SetExtents(const ezVec3& vExtents);
  const ezVec3& GetExtents() const { return m_vExtents; }

  /// \brief Values above 1 make the box influence drop off more rapidly, below 1 more slowly.
  ///
  /// Falloff is per cardinal axis.
  void SetFalloff(const ezVec3& vFalloff);
  const ezVec3& GetFalloff() const { return m_vFalloff; }

protected:
  void OnUpdateLocalBounds(ezMsgUpdateLocalBounds& ref_msg) const;

  ezVec3 m_vExtents = ezVec3(10.0f);
  ezVec3 m_vFalloff = ezVec3(0.5f);
};