Code/Engine/RendererCore/Components/OccluderComponent.h - dev - redgpu/ezEngine

Code/Engine/RendererCore/Components/OccluderComponent.h
92 строки3 KB
Jan Krassnigg
Added support for meshes to the occluder component (#1626)
06 авг 2025, 21:24
06 авг 2025, 21:24c5bb5b2
#pragma once

#include <Core/World/Component.h>
#include <Core/World/World.h>
#include <RendererCore/Meshes/CpuMeshResource.h>
#include <RendererCore/Rasterizer/RasterizerObject.h>
#include <RendererCore/RendererCoreDLL.h>

struct ezMsgTransformChanged;
struct ezMsgUpdateLocalBounds;
struct ezMsgExtractOccluderData;

class EZ_RENDERERCORE_DLL ezOccluderComponentManager final : public ezComponentManager<class ezOccluderComponent, ezBlockStorageType::FreeList>
{
public:
  ezOccluderComponentManager(ezWorld* pWorld);
};

struct ezOccluderType
{
  using StorageType = ezUInt8;

  enum Enum : StorageType
  {
    Box,      ///< The occluder is a box with 6 faces.
    QuadPosX, ///< The occluder is only a single face at the positive X extent of the surrounding box.
    Mesh,

    Default = Box
  };
};

EZ_DECLARE_REFLECTABLE_TYPE(EZ_RENDERERCORE_DLL, ezOccluderType);

/// \brief Adds invisible geometry to a scene that is used for occlusion culling.
///
/// The component adds a box occluder to the scene. The renderer uses this geometry
/// to cull other objects which are behind occluder geometry. Use occluder components to optimize levels.
/// Make the shapes conservative, meaning that they shouldn't be bigger than the actual shapes, otherwise
/// they may incorrectly occlude other objects and lead to incorrectly culled objects.
///
/// The ezGreyBoxComponent can also create occluder geometry in different shapes.
///
/// Contrary to ezGreyBoxComponent, occluder components can be moved around dynamically and thus can be attached to
/// doors and other objects that may dynamically change the visible areas of a level.
class EZ_RENDERERCORE_DLL ezOccluderComponent : public ezComponent
{
  EZ_DECLARE_COMPONENT_TYPE(ezOccluderComponent, ezComponent, ezOccluderComponentManager);

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

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

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

  //////////////////////////////////////////////////////////////////////////
  // ezOccluderComponent

public:
  ezOccluderComponent();
  ~ezOccluderComponent();

  /// \brief Sets the extents of the occluder.
  void SetExtents(const ezVec3& vExtents);                // [ property ]
  const ezVec3& GetExtents() const { return m_vExtents; } // [ property ]

  /// \brief Sets the type of occluder.
  void SetType(ezEnum<ezOccluderType> type);                // [ property ]
  ezEnum<ezOccluderType> GetType() const { return m_Type; } // [ property ]

  // adds SetMeshFile() and GetMeshFile() for convenience
  EZ_ADD_RESOURCEHANDLE_ACCESSORS_WITH_SETTER(Mesh, m_hMesh, SetMesh);

  void SetMesh(const ezCpuMeshResourceHandle& hCubeMap); // [ property ]
  const ezCpuMeshResourceHandle& GetMesh() const;        // [ property ]

private:
  ezVec3 m_vExtents = ezVec3(5.0f);
  ezEnum<ezOccluderType> m_Type;
  ezCpuMeshResourceHandle m_hMesh;

  mutable ezSharedPtr<const ezRasterizerObject> m_pOccluderObject;

  void OnUpdateLocalBounds(ezMsgUpdateLocalBounds& msg);
  void OnMsgExtractOccluderData(ezMsgExtractOccluderData& msg) const;
  void UpdateOccluder();
};