Refactoring: Overhaul internal Sky API, allow configuring sky mode, terminal options

src/CMakeLists.txt

@@ -79,8 +79,8 @@ add_library(REGothEngine STATIC
   components/ScriptBackedBy.hpp
   components/Sky.cpp
   components/Sky.hpp
-  components/SkyColoring.cpp
-  components/SkyColoring.hpp
+  components/SkyStateGenerator.cpp
+  components/SkyStateGenerator.hpp
   components/StoryInformation.cpp
   components/StoryInformation.hpp
   components/ThirdPersonCamera.cpp

src/components/Sky.cpp

@@ -1,62 +1,65 @@
 #include <components/Sky.hpp>
 
+#include <memory>
+
 #include <RenderAPI/BsViewport.h>
 #include <Renderer/BsCamera.h>
 #include <Scene/BsSceneManager.h>
 
 #include <RTTI/RTTI_Sky.hpp>
 #include <components/GameClock.hpp>
 #include <components/GameWorld.hpp>
-#include <components/SkyColoring.hpp>
+#include <components/SkyStateGenerator.hpp>
+#include <exception/Throw.hpp>
 
 namespace REGoth
 {
-  Sky::Sky(const bs::HSceneObject& parent, HGameWorld gameWorld, const bs::Color& skyColor)
-      : bs::Component(parent)
-      , mGameWorld(gameWorld)
-      , mSkyColor{skyColor}
+  Sky::Sky(const bs::HSceneObject& parent, HGameWorld gameWorld, const RenderMode& renderMode,
+           const bs::Color& skyColor)
+      : bs::Component{parent}
+      , mSkyStateGen{skyColor, gameWorld->worldName()}
+      , mGameWorld{gameWorld}
+      , mRenderMode{renderMode}
   {
     setName("Sky");
+
+    // TODO: Implement sky dome support for Gothic II.
+    if (renderMode == RenderMode::Dome)
+    {
+      REGOTH_THROW(NotImplementedException, "Dome sky not yet implemented.");
+    }
   }
 
   Sky::~Sky()
   {
     // pass
   }
 
-  void Sky::onInitialized()
-  {
-    if (!mSkyColoring)
-    {
-      mSkyColoring = bs::bs_shared_ptr_new<SkyColoring>(mSkyColor);
-      mSkyColoring->fillSkyStates();
-    }
-  }
-
   void Sky::update()
   {
-    mSkyColoring->interpolate(mGameWorld->gameclock()->getDayRatio());
+    // Update the sky state.
+    const float dayRatio                     = mGameWorld->gameclock()->getDayRatio();
+    std::shared_ptr<const SkyState> skyState = mSkyStateGen.update(dayRatio);
 
-    applySkySettingsToCamera();
+    // Render fog and sky.
+    renderFog(skyState->fogColor, skyState->fogNear, skyState->fogFar);
+    renderSky();
   }
 
-  void Sky::applySkySettingsToCamera() const
+  void Sky::renderFog(const bs::Color& fogColor, float fogNear, float fogFar) const
   {
-    const auto& camera = bs::gSceneManager().getMainCamera();
-    float near;
-    float far;
-    bs::Color fogColor;
-
-    mSkyColoring->calculateFogDistanceAndColor(near, far, fogColor);
-
-    // TODO: Use fog near and far
-    (void)near;
-    (void)far;
+    // TODO: Account for distances.
+    (void)fogNear;
+    (void)fogFar;
 
-    // FIXME: Fog color can actually be a little bit different. Get the correct color from master
-    // state.
+    const auto& camera = bs::gSceneManager().getMainCamera();
     camera->getViewport()->setClearColorValue(fogColor);
   }
 
+  void Sky::renderSky() const
+  {
+    // TODO: Render sky.
+  }
+
   REGOTH_DEFINE_RTTI(Sky)
 }  // namespace REGoth

src/components/Sky.hpp

@@ -4,11 +4,10 @@
 #include <Scene/BsComponent.h>
 
 #include <RTTI/RTTIUtil.hpp>
+#include <components/SkyStateGenerator.hpp>
 
 namespace REGoth
 {
-  class SkyColoring;
-
   class GameWorld;
   using HGameWorld = bs::GameObjectHandle<GameWorld>;
 
@@ -18,19 +17,28 @@ namespace REGoth
   class Sky : public bs::Component
   {
   public:
-    Sky(const bs::HSceneObject& parent, HGameWorld gameWorld, const bs::Color& skyColor);
+    /**
+     * The utilised render mode, i.e. render the sky as a textured dome or a plane.
+     */
+    enum class RenderMode
+    {
+      Dome,
+      Plane
+    };
+
+    Sky(const bs::HSceneObject& parent, HGameWorld gameWorld, const RenderMode& renderMode,
+        const bs::Color& skyColor);
     virtual ~Sky() override;
 
-    void onInitialized() override;
-
     void update() override;
 
   private:
-    void applySkySettingsToCamera() const;
+    void renderFog(const bs::Color& color, float fogNear, float fogFar) const;
+    void renderSky() const;
 
-    bs::SPtr<SkyColoring> mSkyColoring;
+    SkyStateGenerator mSkyStateGen{bs::Color{}, bs::String{}};
     HGameWorld mGameWorld;
-    const bs::Color mSkyColor;
+    const RenderMode mRenderMode = RenderMode::Plane;
 
   public:
     REGOTH_DECLARE_RTTI(Sky)