src/sky.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #include <ISceneNode.h>
  21 #include "camera.h"
  22 #include "irrlichttypes_extrabloated.h"
  23
  24 #pragma once
  25
  26 #define SKY_MATERIAL_COUNT 5
  27 #define SKY_STAR_COUNT 200
  28
  29 class ITextureSource;
  30
  31 // Skybox, rendered with zbuffer turned off, before all other nodes.
  32 class Sky : public scene::ISceneNode
  33 {
  34 public:
  35         //! constructor
  36         Sky(s32 id, ITextureSource *tsrc);
  37
  38         virtual void OnRegisterSceneNode();
  39
  40         //! renders the node.
  41         virtual void render();
  42
  43         virtual const aabb3f &getBoundingBox() const { return m_box; }
  44
  45         // Used by Irrlicht for optimizing rendering
  46         virtual video::SMaterial &getMaterial(u32 i) { return m_materials[i]; }
  47
  48         // Used by Irrlicht for optimizing rendering
  49         virtual u32 getMaterialCount() const { return SKY_MATERIAL_COUNT; }
  50
  51         void update(float m_time_of_day, float time_brightness, float direct_brightness,
  52                         bool sunlight_seen, CameraMode cam_mode, float yaw, float pitch);
  53
  54         float getBrightness() { return m_brightness; }
  55
  56         const video::SColor &getBgColor() const
  57         {
  58                 return m_visible ? m_bgcolor : m_fallback_bg_color;
  59         }
  60
  61         const video::SColor &getSkyColor() const
  62         {
  63                 return m_visible ? m_skycolor : m_fallback_bg_color;
  64         }
  65
  66         bool getCloudsVisible() const { return m_clouds_visible && m_clouds_enabled; }
  67         const video::SColorf &getCloudColor() const { return m_cloudcolor_f; }
  68
  69         void setVisible(bool visible) { m_visible = visible; }
  70         // Set only from set_sky API
  71         void setCloudsEnabled(bool clouds_enabled) { m_clouds_enabled = clouds_enabled; }
  72         void setFallbackBgColor(const video::SColor &fallback_bg_color)
  73         {
  74                 m_fallback_bg_color = fallback_bg_color;
  75         }
  76         void overrideColors(const video::SColor &bgcolor, const video::SColor &skycolor)
  77         {
  78                 m_bgcolor = bgcolor;
  79                 m_skycolor = skycolor;
  80         }
  81         void setBodiesVisible(bool visible) { m_bodies_visible = visible; }
  82
  83 private:
  84         aabb3f m_box;
  85         video::SMaterial m_materials[SKY_MATERIAL_COUNT];
  86
  87         // How much sun & moon transition should affect horizon color
  88         float m_horizon_blend()
  89         {
  90                 if (!m_sunlight_seen)
  91                         return 0;
  92                 float x = m_time_of_day >= 0.5 ? (1 - m_time_of_day) * 2
  93                                                : m_time_of_day * 2;
  94
  95                 if (x <= 0.3)
  96                         return 0;
  97                 if (x <= 0.4) // when the sun and moon are aligned
  98                         return (x - 0.3) * 10;
  99                 if (x <= 0.5)
 100                         return (0.5 - x) * 10;
 101                 return 0;
 102         }
 103
 104         // Mix two colors by a given amount
 105         video::SColor m_mix_scolor(video::SColor col1, video::SColor col2, f32 factor)
 106         {
 107                 video::SColor result = video::SColor(
 108                                 col1.getAlpha() * (1 - factor) + col2.getAlpha() * factor,
 109                                 col1.getRed() * (1 - factor) + col2.getRed() * factor,
 110                                 col1.getGreen() * (1 - factor) + col2.getGreen() * factor,
 111                                 col1.getBlue() * (1 - factor) + col2.getBlue() * factor);
 112                 return result;
 113         }
 114         video::SColorf m_mix_scolorf(video::SColorf col1, video::SColorf col2, f32 factor)
 115         {
 116                 video::SColorf result =
 117                                 video::SColorf(col1.r * (1 - factor) + col2.r * factor,
 118                                                 col1.g * (1 - factor) + col2.g * factor,
 119                                                 col1.b * (1 - factor) + col2.b * factor,
 120                                                 col1.a * (1 - factor) + col2.a * factor);
 121                 return result;
 122         }
 123
 124         bool m_visible = true;
 125         // Used when m_visible=false
 126         video::SColor m_fallback_bg_color = video::SColor(255, 255, 255, 255);
 127         bool m_first_update = true;
 128         float m_time_of_day;
 129         float m_time_brightness;
 130         bool m_sunlight_seen;
 131         float m_brightness = 0.5f;
 132         float m_cloud_brightness = 0.5f;
 133         bool m_clouds_visible; // Whether clouds are disabled due to player underground
 134         bool m_clouds_enabled = true; // Initialised to true, reset only by set_sky API
 135         bool m_directional_colored_fog;
 136         bool m_bodies_visible = true; // sun, moon, stars
 137         video::SColorf m_bgcolor_bright_f = video::SColorf(1.0f, 1.0f, 1.0f, 1.0f);
 138         video::SColorf m_skycolor_bright_f = video::SColorf(1.0f, 1.0f, 1.0f, 1.0f);
 139         video::SColorf m_cloudcolor_bright_f = video::SColorf(1.0f, 1.0f, 1.0f, 1.0f);
 140         video::SColor m_bgcolor;
 141         video::SColor m_skycolor;
 142         video::SColorf m_cloudcolor_f;
 143         v3f m_stars[SKY_STAR_COUNT];
 144         video::ITexture *m_sun_texture;
 145         video::ITexture *m_moon_texture;
 146         video::ITexture *m_sun_tonemap;
 147         video::ITexture *m_moon_tonemap;
 148 };