Code/Engine/RendererCore/Utils/WorldGeoExtractionUtil.h - dev - redgpu/ezEngine

Code/Engine/RendererCore/Utils/WorldGeoExtractionUtil.h
66 строк3 KB
Jan Krassnigg
Added code documentation to RendererCore (#1697)
28 окт 2025, 13:18
28 окт 2025, 13:18d573105
#pragma once

#include <Core/ResourceManager/ResourceHandle.h>
#include <Core/World/Declarations.h>
#include <Foundation/Communication/Message.h>
#include <Foundation/Containers/Deque.h>
#include <Foundation/Types/TagSet.h>
#include <RendererCore/RendererCoreDLL.h>

class ezWorld;
using ezCpuMeshResourceHandle = ezTypedResourceHandle<class ezCpuMeshResource>;

/// \brief A utility to gather raw geometry from a world
///
/// The utility sends ezMsgExtractGeometry to world components and they may fill out the geometry information.
/// \a ExtractionMode defines what the geometry is needed for. This ranges from finding geometry that is used to generate the navmesh from
/// to exporting the geometry to a file for use in another program, e.g. a modeling software.
class EZ_RENDERERCORE_DLL ezWorldGeoExtractionUtil
{
public:
  struct MeshObject
  {
    ezTransform m_GlobalTransform;
    ezCpuMeshResourceHandle m_hMeshResource;
  };

  using MeshObjectList = ezDeque<MeshObject>;

  /// \brief Describes what the geometry is needed for
  enum class ExtractionMode
  {
    RenderMesh,    ///< The render geometry is desired. Typically for exporting it to file.
    CollisionMesh, ///< The collision geometry is desired. Typically for exporting it to file.
  };

  /// \brief Extracts the desired geometry from all objects in a world
  ///
  /// The geometry object is not cleared, so this can be called repeatedly to append more data.
  static void ExtractWorldGeometry(MeshObjectList& ref_objects, const ezWorld& world, ExtractionMode mode, ezTagSet* pExcludeTags = nullptr);

  /// \brief Extracts the desired geometry from a specified subset of objects in a world
  ///
  /// The geometry object is not cleared, so this can be called repeatedly to append more data.
  static void ExtractWorldGeometry(MeshObjectList& ref_objects, const ezWorld& world, ExtractionMode mode, const ezDeque<ezGameObjectHandle>& selection);

  /// \brief Writes the given geometry in .obj format to file
  static void WriteWorldGeometryToOBJ(const char* szFile, const MeshObjectList& objects, const ezMat3& mTransform);
};

/// \brief Sent by ezWorldGeoExtractionUtil to gather geometry information about objects in a world
///
/// The mode defines what the geometry is needed for, thus components should decide to participate or not
/// and how detailed the geometry is they return.
struct EZ_RENDERERCORE_DLL ezMsgExtractGeometry : public ezMessage
{
  EZ_DECLARE_MESSAGE_TYPE(ezMsgExtractGeometry, ezMessage);

  /// \brief Specifies what the geometry is extracted for, and thus what the message handler should write back
  ezWorldGeoExtractionUtil::ExtractionMode m_Mode = ezWorldGeoExtractionUtil::ExtractionMode::RenderMesh;

  /// \brief Append mesh objects to this to describe the requested world geometry
  ezWorldGeoExtractionUtil::MeshObjectList* m_pMeshObjects = nullptr;

  void AddMeshObject(const ezTransform& transform, ezCpuMeshResourceHandle hMeshResource);
  void AddBox(const ezTransform& transform, ezVec3 vExtents);
};