RobotScene.h

Go to the documentation of this file.

#pragma once
 
#include "Multibody.h"
 
#include "../core/Device.h"
#include "../core/Scene.h"
#include "../core/RenderContext.h"
#include "../core/LightUniforms.h"
#include "../core/DepthAndShadowPass.h"
#include "../core/Texture.h"
#include "../posteffects/SSAO.h"
#include "../utils/MeshData.h"
 
#include <magic_enum/magic_enum.hpp>
#include <entt/entity/fwd.hpp>
#include <coal/fwd.hh>
#include <pinocchio/multibody/fwd.hpp>
#include <set>
 
namespace candlewick {

template <typename T>
  requires std::is_enum_v<T>
[[noreturn]] void
invalid_enum(const char *msg, T type,
             std::source_location location = std::source_location::current()) {
  terminate_with_message(location, "Invalid enum: {:s} - {:s}", msg,
                         magic_enum::enum_name(type));
}
 
namespace multibody {

  void updateRobotTransforms(entt::registry &registry,
                             const pin::GeometryModel &geom_model,
                             const pin::GeometryData &geom_data);

  class RobotScene final {
    [[nodiscard]] bool hasInternalPointers() const {
      return m_geomModel && m_geomData;
    }
 
    void compositeTransparencyPass(CommandBuffer &command_buffer);
 
    void renderPBRTriangleGeometry(CommandBuffer &command_buffer,
                                   const Camera &camera, bool transparent);
 
    void renderOtherGeometry(CommandBuffer &command_buffer,
                             const Camera &camera);
 
    void initGBuffer();
 
    void initCompositePipeline(const MeshLayout &layout);
 
  public:
    enum PipelineType {
      PIPELINE_TRIANGLEMESH,
      PIPELINE_HEIGHTFIELD,
      PIPELINE_POINTCLOUD,
    };
    static constexpr size_t kNumPipelineTypes =
        magic_enum::enum_count<PipelineType>();
    enum VertexUniformSlots : Uint32 { TRANSFORM, LIGHT_MATRICES };
    enum FragmentUniformSlots : Uint32 {
      MATERIAL,
      LIGHTING,
      SSAO_FLAG,
      ATLAS_INFO
    };
    enum FragmentSamplerSlots { SHADOW_MAP_SLOT, SSAO_SLOT };

    static PipelineType pinGeomToPipeline(const coal::CollisionGeometry &geom);

    static constexpr SDL_GPUPrimitiveType
    getPrimitiveTopologyForType(PipelineType type) {
      switch (type) {
      case PIPELINE_TRIANGLEMESH:
        return SDL_GPU_PRIMITIVETYPE_TRIANGLELIST;
      case PIPELINE_HEIGHTFIELD:
        return SDL_GPU_PRIMITIVETYPE_LINELIST;
      case PIPELINE_POINTCLOUD:
        return SDL_GPU_PRIMITIVETYPE_POINTLIST;
      }
    }
 
    template <PipelineType t> using pipeline_tag = entt::tag<t>;
 
    struct PipelineConfig {
      // shader set
      const char *vertex_shader_path;
      const char *fragment_shader_path;
      SDL_GPUCullMode cull_mode = SDL_GPU_CULLMODE_BACK;
      SDL_GPUFillMode fill_mode = SDL_GPU_FILLMODE_FILL;
    };
    struct Config {
      struct TrianglePipelineConfig {
        PipelineConfig opaque{
            .vertex_shader_path = "PbrBasic.vert",
            .fragment_shader_path = "PbrBasic.frag",
        };
        PipelineConfig transparent{
            .vertex_shader_path = "PbrBasic.vert",
            .fragment_shader_path = "PbrTransparent.frag",
            .cull_mode = SDL_GPU_CULLMODE_NONE,
        };
      } triangle_config;
      PipelineConfig heightfield_config{
          .vertex_shader_path = "Hud3dElement.vert",
          .fragment_shader_path = "Hud3dElement.frag",
      };
      PipelineConfig pointcloud_config;
      bool enable_msaa = false;
      bool enable_shadows = true;
      bool enable_ssao = true;
      bool triangle_has_prepass = false;
      bool enable_normal_target = false;
      SDL_GPUSampleCount msaa_samples = SDL_GPU_SAMPLECOUNT_1;
      ShadowPassConfig shadow_config;
    };
 
    std::array<DirectionalLight, kNumLights> directionalLight;
    ssao::SsaoPass ssaoPass{NoInit};
    struct GBuffer {
      Texture normalMap{NoInit};
 
      // WBOIT buffers
      Texture accumTexture{NoInit};
      Texture revealTexture{NoInit};
      SDL_GPUSampler *sampler = nullptr; // composite pass
 
      bool initialized() const {
        return (sampler != nullptr) && normalMap && accumTexture &&
               revealTexture;
      }
    } gBuffer;
    ShadowMapPass shadowPass{NoInit};

    RobotScene(entt::registry &registry, const RenderContext &renderer);

    RobotScene(entt::registry &registry, const RenderContext &renderer,
               const pin::GeometryModel &geom_model,
               const pin::GeometryData &geom_data, Config config);
 
    RobotScene(const RobotScene &) = delete;
 
    void setConfig(const Config &config) {
      CANDLEWICK_ASSERT(
          !m_initialized,
          "Cannot call setConfig() after render system was initialized.");
      m_config = config;
    }

    void loadModels(const pin::GeometryModel &geom_model,
                    const pin::GeometryData &geom_data);

    void updateTransforms();
 
    void collectOpaqueCastables();
    const std::vector<OpaqueCastable> &castables() const { return m_castables; }
 
    Uint32 numLights() const noexcept { return shadowPass.numLights(); }
 
    entt::entity
    addEnvironmentObject(MeshData &&data, Mat4f placement,
                         PipelineType pipe_type = PIPELINE_TRIANGLEMESH);
 
    entt::entity
    addEnvironmentObject(MeshData &&data, const Eigen::Affine3f &T,
                         PipelineType pipe_type = PIPELINE_TRIANGLEMESH) {
      return addEnvironmentObject(std::move(data), T.matrix(), pipe_type);
    }

    void clearEnvironment();
    void clearRobotGeometries();
 
    void createRenderPipeline(const MeshLayout &layout,
                              SDL_GPUTextureFormat render_target_format,
                              SDL_GPUTextureFormat depth_stencil_format,
                              PipelineType type, bool transparent);

    void render(CommandBuffer &command_buffer, const Camera &camera);
 
    void renderOpaque(CommandBuffer &command_buffer, const Camera &camera);
 
    void renderTransparent(CommandBuffer &command_buffer, const Camera &camera);

    void release();
 
    Config &config() { return m_config; }
    const Config &config() const { return m_config; }
    inline bool pbrHasPrepass() const { return m_config.triangle_has_prepass; }
    inline bool shadowsEnabled() const { return m_config.enable_shadows; }

    void ensurePipelinesExist(
        const std::set<std::tuple<MeshLayout, PipelineType, bool>>
            &required_pipelines);

    const pin::GeometryModel &geomModel() const { return *m_geomModel; }

    const pin::GeometryData &geomData() const { return *m_geomData; }
 
    const Device &device() { return m_renderer.device; }
    entt::registry &registry() { return m_registry; }
    const entt::registry &registry() const { return m_registry; }
 
  private:
    entt::registry &m_registry;
    const RenderContext &m_renderer;
    Config m_config;
    const pin::GeometryModel *m_geomModel;
    const pin::GeometryData *m_geomData;
    std::vector<OpaqueCastable> m_castables;
    bool m_initialized;
    struct {
      SDL_GPUGraphicsPipeline *triangleMeshOpaque = nullptr;
      SDL_GPUGraphicsPipeline *triangleMeshTransparent = nullptr;
      SDL_GPUGraphicsPipeline *heightfield = nullptr;
      SDL_GPUGraphicsPipeline *pointcloud = nullptr;
      SDL_GPUGraphicsPipeline *wboitComposite = nullptr;
    } m_pipelines;
 
    SDL_GPUGraphicsPipeline *&routePipeline(PipelineType type,
                                            bool transparent = false) {
      switch (type) {
      case PIPELINE_TRIANGLEMESH:
        return transparent ? m_pipelines.triangleMeshTransparent
                           : m_pipelines.triangleMeshOpaque;
      case PIPELINE_HEIGHTFIELD:
        return m_pipelines.heightfield;
      case PIPELINE_POINTCLOUD:
        return m_pipelines.pointcloud;
      }
    }
  };
  static_assert(Scene<RobotScene>);
 
} // namespace multibody
} // namespace candlewick