Merge pull request #176 from SHADE-DP/SP3-1-BuiltInMesh

Pregenerates default meshes and provides a function to retrieve them

SHADE_Engine/src/Graphics/MiddleEnd/Interface/SHGraphicsSystem.cpp

@@ -41,6 +41,7 @@ of DigiPen Institute of Technology is prohibited.
 #include "Resource/SHResourceManager.h"
 #include "Graphics/SHVkUtil.h"
 #include "Graphics/RenderGraph/SHRenderGraphNodeCompute.h"
+#include "../Meshes/SHPrimitiveGenerator.h"
 
 namespace SHADE
 {
@@ -259,7 +260,6 @@ namespace SHADE
     // Generate world render graph
     worldRenderGraph->Generate();
 
-
     /*-----------------------------------------------------------------------*/
     /* BIND RENDER GRAPH TO RENDERER                                         */
     /*-----------------------------------------------------------------------*/
@@ -269,17 +269,6 @@ namespace SHADE
 
     worldRenderer->SetCameraDirector(cameraSystem->CreateDirector());
 
-    // Create default materials
-    std::array<SHTexture::PixelChannel, 4> defaultTexture = { 255, 255, 255, 255 };
-    std::vector<uint32_t> mipOffsets{};
-    mipOffsets.push_back(0);
-    auto tex = AddTexture(4, defaultTexture.data(), 1, 1, SHTexture::TextureFormat::eR8G8B8A8Unorm, mipOffsets);
-    BuildTextures();
-
-    defaultMaterial = AddMaterial(defaultVertShader, defaultFragShader, gBufferSubpass);
-    defaultMaterial->SetProperty("data.textureIndex", tex->TextureArrayIndex);
-
-
     // Create debug draw pipeline
     debugDrawPipeline      = createDebugDrawPipeline(debugDrawNode->GetRenderpass(), debugDrawSubpass);
     debugDrawDepthPipeline = createDebugDrawPipeline(debugDrawNodeDepth->GetRenderpass(), debugDrawDepthSubpass);
@@ -321,7 +310,29 @@ namespace SHADE
 
     lightingSubSystem = resourceManager.Create<SHLightingSubSystem>();
     lightingSubSystem->Init(device, descPool);
+  }
 
+  void SHGraphicsSystem::InitBuiltInResources(void)
+  {
+    // Create default texture
+    std::array<SHTexture::PixelChannel, 4> defaultTextureData = { 255, 255, 255, 255 };
+    std::vector<uint32_t> mipOffsets{};
+    mipOffsets.push_back(0);
+    defaultTexture = AddTexture(4, defaultTextureData.data(), 1, 1, SHTexture::TextureFormat::eR8G8B8A8Unorm, mipOffsets);
+    BuildTextures();
+
+    // Create default meshes
+    primitiveMeshes[static_cast<int>(PrimitiveType::Cube)]   = SHPrimitiveGenerator::Cube(meshLibrary);
+    primitiveMeshes[static_cast<int>(PrimitiveType::Sphere)] = SHPrimitiveGenerator::Sphere(meshLibrary);
+    BuildMeshBuffers();
+
+    // Create default materials
+    defaultMaterial = AddMaterial
+    (
+      defaultVertShader, defaultFragShader, 
+      worldRenderGraph->GetNode("G-Buffer")->GetSubpass("G-Buffer Write")
+    );
+    defaultMaterial->SetProperty("data.textureIndex", defaultTexture->TextureArrayIndex);
   }
 
 #ifdef SHEDITOR
@@ -364,8 +375,7 @@ namespace SHADE
     InitBoilerplate();
     InitMiddleEnd();
     InitSubsystems();
-
+    InitBuiltInResources();
-
   }
 
   void SHGraphicsSystem::Exit(void)
@@ -690,7 +700,7 @@ namespace SHADE
 
   SHADE::Handle<SHADE::SHMaterialInstance> SHGraphicsSystem::AddMaterialInstanceCopy(Handle<SHMaterialInstance> materialInst)
   {
-	  return resourceManager.Create<SHMaterialInstance>(materialInst->GetBaseMaterial());
+    return resourceManager.Create<SHMaterialInstance>(materialInst->GetBaseMaterial());
   }
 
   void SHGraphicsSystem::RemoveMaterialInstance(Handle<SHMaterialInstance> materialInstance)
@@ -703,26 +713,38 @@ namespace SHADE
   /*---------------------------------------------------------------------------------*/
   SHADE::Handle<SHADE::SHMesh> SHGraphicsSystem::AddMesh(uint32_t vertexCount, const SHMesh::VertexPosition* const positions, const SHMesh::VertexTexCoord* const texCoords, const SHMesh::VertexTangent* const tangents, const SHMesh::VertexNormal* const normals, uint32_t indexCount, const SHMesh::Index* const indices)
   {
-	  return meshLibrary.AddMesh(vertexCount, positions, texCoords, tangents, normals, indexCount, indices);
+    return meshLibrary.AddMesh(vertexCount, positions, texCoords, tangents, normals, indexCount, indices);
   }
 
   void SHGraphicsSystem::RemoveMesh(Handle<SHMesh> mesh)
   {
-	  meshLibrary.RemoveMesh(mesh);
+    meshLibrary.RemoveMesh(mesh);
   }
 
   void SHGraphicsSystem::BuildMeshBuffers()
   {
       transferCmdBuffer = graphicsCmdPool->RequestCommandBuffer(SH_CMD_BUFFER_TYPE::PRIMARY);
       device->WaitIdle();
-	  transferCmdBuffer->BeginRecording();
+    transferCmdBuffer->BeginRecording();
-	  meshLibrary.BuildBuffers(device, transferCmdBuffer);
+    meshLibrary.BuildBuffers(device, transferCmdBuffer);
-	  transferCmdBuffer->EndRecording();
+    transferCmdBuffer->EndRecording();
-	  graphicsQueue->SubmitCommandBuffer({ transferCmdBuffer });
+    graphicsQueue->SubmitCommandBuffer({ transferCmdBuffer });
       device->WaitIdle();
       transferCmdBuffer.Free(); transferCmdBuffer = {};
   }
 
+  Handle<SHMesh> SHGraphicsSystem::GetMeshPrimitive(PrimitiveType type) const noexcept
+  {
+    switch (type)
+    {
+      case PrimitiveType::Cube:
+      case PrimitiveType::Sphere:
+        return primitiveMeshes[static_cast<int>(type)];
+      default:
+        return {};
+    }
+  }
+
   /*---------------------------------------------------------------------------------*/
   /* Texture Registration Functions                                                  */
   /*---------------------------------------------------------------------------------*/
@@ -809,7 +831,7 @@ namespace SHADE
 
   void SHGraphicsSystem::BatcherDispatcherRoutine::Execute(double) noexcept
   {
-	auto& renderables = SHComponentManager::GetDense<SHRenderable>();
+  auto& renderables = SHComponentManager::GetDense<SHRenderable>();
     for (auto& renderable : renderables)
     {
       if (!renderable.HasChanged())

SHADE_Engine/src/Graphics/MiddleEnd/Interface/SHGraphicsSystem.h

@@ -58,6 +58,19 @@ namespace SHADE
   /*---------------------------------------------------------------------------------*/
   /* Type Definitions                                                                */
   /*---------------------------------------------------------------------------------*/
+  /***********************************************************************************/
+  /*!
+    \brief
+      Type of built-in primitive meshes that are available.
+  */
+  /***********************************************************************************/
+  enum class PrimitiveType
+  {
+    Cube,
+    Sphere
+  };
+  static constexpr int MAX_PRIMITIVE_TYPES = 2;
+
   /***********************************************************************************/
   /*!
     \brief
@@ -72,6 +85,7 @@ namespace SHADE
     void InitSceneRenderGraph  (void) noexcept;
     void InitMiddleEnd         (void) noexcept;
     void InitSubsystems        (void) noexcept;
+    void InitBuiltInResources  (void);
 
 #ifdef SHEDITOR
     void InitEditorRenderGraph (void) noexcept;
@@ -81,25 +95,25 @@ namespace SHADE
     class SH_API BeginRoutine final : public SHSystemRoutine
     {
       public:
-	  BeginRoutine();
+    BeginRoutine();
       virtual void Execute(double dt) noexcept override final;
     };
     class SH_API RenderRoutine final : public SHSystemRoutine
     {
       public:
-	  RenderRoutine();
+    RenderRoutine();
       virtual void Execute(double dt) noexcept override final;
     };
     class SH_API EndRoutine final : public SHSystemRoutine
     {
       public:
-	  EndRoutine();
+    EndRoutine();
       virtual void Execute(double dt) noexcept override final;
     };
     class SH_API BatcherDispatcherRoutine final : public SHSystemRoutine
     {
       public:
-	  BatcherDispatcherRoutine();
+    BatcherDispatcherRoutine();
       virtual void Execute(double dt) noexcept override final;
     };
 
@@ -152,34 +166,34 @@ namespace SHADE
     /*******************************************************************************/
     /*!
         
-	 \brief
+   \brief
-	   Adds a mesh to the Mesh Library. But this does not mean that the meshes have
+     Adds a mesh to the Mesh Library. But this does not mean that the meshes have
-	   been added yet. A call to "BuildBuffers()" is required to transfer all
+     been added yet. A call to "BuildBuffers()" is required to transfer all
-	   meshes into the GPU.
+     meshes into the GPU.
      
      \param vertexCount
        Number of vertices in this Mesh.
      \param positions
-	   Pointer to the first in a contiguous array of SHMathVec3s that define vertex
+     Pointer to the first in a contiguous array of SHMathVec3s that define vertex
-	   positions.
+     positions.
-	 \param texCoords
+   \param texCoords
-	   Pointer to the first in a contiguous array of SHMathVec2s that define vertex
+     Pointer to the first in a contiguous array of SHMathVec2s that define vertex
-	   texture coordinates.
+     texture coordinates.
-	 \param tangents
+   \param tangents
-	   Pointer to the first in a contiguous array of SHMathVec3s that define vertex
+     Pointer to the first in a contiguous array of SHMathVec3s that define vertex
-	   tangents.
+     tangents.
-	 \param normals
+   \param normals
-	   Pointer to the first in a contiguous array of SHMathVec3s that define vertex
+     Pointer to the first in a contiguous array of SHMathVec3s that define vertex
-	   normals.
+     normals.
      \param indexCount
        Number of indices in this mesh.
      \param indices
-	   Pointer to the first in a contiguous array of uint32_ts that define mesh
+     Pointer to the first in a contiguous array of uint32_ts that define mesh
-	   indices.
+     indices.
      
-	 \return
+   \return
-	   Handle to the created Mesh. This is not valid to be used until a call to
+     Handle to the created Mesh. This is not valid to be used until a call to
-	   BuildBuffers().
+     BuildBuffers().
         
     */ 
     /*******************************************************************************/
@@ -188,9 +202,9 @@ namespace SHADE
     /*!
 
      \brief
-	   Removes a mesh from the MeshLibrary. But this does not mean that the meshes
+     Removes a mesh from the MeshLibrary. But this does not mean that the meshes
-	   have been removed yet.  A call to "BuildBuffers()" is required to finalise all
+     have been removed yet.  A call to "BuildBuffers()" is required to finalise all
-	   changes.
+     changes.
 
      \param mesh
        Handle to the mesh to remove.
@@ -207,6 +221,21 @@ namespace SHADE
     */
     /***************************************************************************/
     void BuildMeshBuffers();
+    /*******************************************************************************/
+    /*!
+
+     \brief
+     Retrieves the built-in mesh specified.
+
+     \param type
+       Type of built-in mesh to retrieve.
+
+     \returns
+       Handle to the mesh that was specfied. However, if an invalid type is specified,
+       a null Handle will be returned.
+    */
+    /*******************************************************************************/
+    Handle<SHMesh> GetMeshPrimitive(PrimitiveType type) const noexcept;
 
     /*-----------------------------------------------------------------------------*/
     /* Texture Registration Functions                                              */
@@ -278,6 +307,18 @@ namespace SHADE
     */
     /***************************************************************************/
     Handle<SHTexture> GetTextureHandle(SHTexture::Index textureId) const;
+    /***************************************************************************/
+    /*!
+    *
+     \brief
+       Retrieves the handle to the default texture. A white 1x1 texture.
+
+     \returns
+       Handle to the default texture.
+
+    */
+    /***************************************************************************/
+    Handle<SHTexture> GetDefaultTexture() const noexcept { return defaultTexture; }
 
     void PrepareResize(uint32_t newWidth, uint32_t newHeight) noexcept;
     void HandleResize(void) noexcept;
@@ -378,6 +419,13 @@ namespace SHADE
     Handle<SHVkPipeline>                                      debugDrawPipeline;
     Handle<SHVkPipeline>                                      debugDrawDepthPipeline;
 
+    // Built-In Textures
+    Handle<SHTexture>                                         defaultTexture;
+
+    // Built-In Meshes
+    std::array<Handle<SHMesh>, MAX_PRIMITIVE_TYPES>           primitiveMeshes;
+
+    // Render Graphs
     Handle<SHRenderGraph>                                     worldRenderGraph;
 
     // Sub systems