src/client/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 <array>
  22 #include "camera.h"
  23 #include "irrlichttypes_extrabloated.h"
  24 #include "skyparams.h"
  25
  26 #pragma once
  27
  28 #define SKY_MATERIAL_COUNT 12
  29
  30 class ITextureSource;
  31
  32 // Skybox, rendered with zbuffer turned off, before all other nodes.
  33 class Sky : public scene::ISceneNode
  34 {
  35 public:
  36         //! constructor
  37         Sky(s32 id, ITextureSource *tsrc);
  38
  39         virtual void OnRegisterSceneNode();
  40
  41         //! renders the node.
  42         virtual void render();
  43
  44         virtual const aabb3f &getBoundingBox() const { return m_box; }
  45
  46         // Used by Irrlicht for optimizing rendering
  47         virtual video::SMaterial &getMaterial(u32 i) { return m_materials[i]; }
  48         virtual u32 getMaterialCount() const { return SKY_MATERIAL_COUNT; }
  49
  50         void update(float m_time_of_day, float time_brightness, float direct_brightness,
  51                         bool sunlight_seen, CameraMode cam_mode, float yaw, float pitch);
  52
  53         float getBrightness() { return m_brightness; }
  54
  55         const video::SColor &getBgColor() const
  56         {
  57                 return m_visible ? m_bgcolor : m_fallback_bg_color;
  58         }
  59
  60         const video::SColor &getSkyColor() const
  61         {
  62                 return m_visible ? m_skycolor : m_fallback_bg_color;
  63         }
  64
  65         void setSunVisible(bool sun_visible) { m_sun_params.visible = sun_visible; }
  66         void setSunTexture(std::string sun_texture,
  67                 std::string sun_tonemap, ITextureSource *tsrc);
  68         void setSunScale(f32 sun_scale) { m_sun_params.scale = sun_scale; }
  69         void setSunriseVisible(bool glow_visible) { m_sun_params.sunrise_visible = glow_visible; }
  70         void setSunriseTexture(std::string sunglow_texture, ITextureSource* tsrc);
  71
  72         void setMoonVisible(bool moon_visible) { m_moon_params.visible = moon_visible; }
  73         void setMoonTexture(std::string moon_texture,
  74                 std::string moon_tonemap, ITextureSource *tsrc);
  75         void setMoonScale(f32 moon_scale) { m_moon_params.scale = moon_scale; }
  76
  77         void setStarsVisible(bool stars_visible) { m_star_params.visible = stars_visible; }
  78         void setStarCount(u16 star_count, bool force_update);
  79         void setStarColor(video::SColor star_color) { m_star_params.starcolor = star_color; }
  80         void setStarScale(f32 star_scale) { m_star_params.scale = star_scale; }
  81
  82         bool getCloudsVisible() const { return m_clouds_visible && m_clouds_enabled; }
  83         const video::SColorf &getCloudColor() const { return m_cloudcolor_f; }
  84
  85         void setVisible(bool visible) { m_visible = visible; }
  86         // Set only from set_sky API
  87         void setCloudsEnabled(bool clouds_enabled) { m_clouds_enabled = clouds_enabled; }
  88         void setFallbackBgColor(const video::SColor &fallback_bg_color)
  89         {
  90                 m_fallback_bg_color = fallback_bg_color;
  91         }
  92         void overrideColors(const video::SColor &bgcolor, const video::SColor &skycolor)
  93         {
  94                 m_bgcolor = bgcolor;
  95                 m_skycolor = skycolor;
  96         }
  97         void setSkyColors(const SkyColor &sky_color);
  98         void setHorizonTint(video::SColor sun_tint, video::SColor moon_tint,
  99                 std::string use_sun_tint);
 100         void setInClouds(bool clouds) { m_in_clouds = clouds; }
 101         void clearSkyboxTextures() { m_sky_params.textures.clear(); }
 102         void addTextureToSkybox(std::string texture, int material_id,
 103                 ITextureSource *tsrc);
 104 private:
 105         aabb3f m_box;
 106         video::SMaterial m_materials[SKY_MATERIAL_COUNT];
 107         // How much sun & moon transition should affect horizon color
 108         float m_horizon_blend()
 109         {
 110                 if (!m_sunlight_seen)
 111                         return 0;
 112                 float x = m_time_of_day >= 0.5 ? (1 - m_time_of_day) * 2
 113                                                : m_time_of_day * 2;
 114
 115                 if (x <= 0.3)
 116                         return 0;
 117                 if (x <= 0.4) // when the sun and moon are aligned
 118                         return (x - 0.3) * 10;
 119                 if (x <= 0.5)
 120                         return (0.5 - x) * 10;
 121                 return 0;
 122         }
 123
 124         // Mix two colors by a given amount
 125         video::SColor m_mix_scolor(video::SColor col1, video::SColor col2, f32 factor)
 126         {
 127                 video::SColor result = video::SColor(
 128                                 col1.getAlpha() * (1 - factor) + col2.getAlpha() * factor,
 129                                 col1.getRed() * (1 - factor) + col2.getRed() * factor,
 130                                 col1.getGreen() * (1 - factor) + col2.getGreen() * factor,
 131                                 col1.getBlue() * (1 - factor) + col2.getBlue() * factor);
 132                 return result;
 133         }
 134         video::SColorf m_mix_scolorf(video::SColorf col1, video::SColorf col2, f32 factor)
 135         {
 136                 video::SColorf result =
 137                                 video::SColorf(col1.r * (1 - factor) + col2.r * factor,
 138                                                 col1.g * (1 - factor) + col2.g * factor,
 139                                                 col1.b * (1 - factor) + col2.b * factor,
 140                                                 col1.a * (1 - factor) + col2.a * factor);
 141                 return result;
 142         }
 143
 144         bool m_visible = true;
 145         // Used when m_visible=false
 146         video::SColor m_fallback_bg_color = video::SColor(255, 255, 255, 255);
 147         bool m_first_update = true;
 148         float m_time_of_day;
 149         float m_time_brightness;
 150         bool m_sunlight_seen;
 151         float m_brightness = 0.5f;
 152         float m_cloud_brightness = 0.5f;
 153         bool m_clouds_visible; // Whether clouds are disabled due to player underground
 154         bool m_clouds_enabled = true; // Initialised to true, reset only by set_sky API
 155         bool m_directional_colored_fog;
 156         bool m_in_clouds = true; // Prevent duplicating bools to remember old values
 157
 158         video::SColorf m_bgcolor_bright_f = video::SColorf(1.0f, 1.0f, 1.0f, 1.0f);
 159         video::SColorf m_skycolor_bright_f = video::SColorf(1.0f, 1.0f, 1.0f, 1.0f);
 160         video::SColorf m_cloudcolor_bright_f = video::SColorf(1.0f, 1.0f, 1.0f, 1.0f);
 161         video::SColor m_bgcolor;
 162         video::SColor m_skycolor;
 163         video::SColorf m_cloudcolor_f;
 164
 165         // pure white: becomes "diffuse light component" for clouds
 166         video::SColorf m_cloudcolor_day_f = video::SColorf(1, 1, 1, 1);
 167         // dawn-factoring version of pure white (note: R is above 1.0)
 168         video::SColorf m_cloudcolor_dawn_f = video::SColorf(
 169                 255.0f/240.0f,
 170                 223.0f/240.0f,
 171                 191.0f/255.0f
 172         );
 173
 174         SkyboxParams m_sky_params;
 175         SunParams m_sun_params;
 176         MoonParams m_moon_params;
 177         StarParams m_star_params;
 178
 179         bool m_default_tint = true;
 180
 181         std::vector<v3f> m_stars;
 182
 183         video::ITexture *m_sun_texture;
 184         video::ITexture *m_moon_texture;
 185         video::ITexture *m_sun_tonemap;
 186         video::ITexture *m_moon_tonemap;
 187
 188         void draw_sun(video::IVideoDriver *driver, float sunsize, const video::SColor &suncolor,
 189                 const video::SColor &suncolor2, float wicked_time_of_day);
 190         void draw_moon(video::IVideoDriver *driver, float moonsize, const video::SColor &mooncolor,
 191                 const video::SColor &mooncolor2, float wicked_time_of_day);
 192         void draw_sky_body(std::array<video::S3DVertex, 4> &vertices,
 193                 float pos_1, float pos_2, const video::SColor &c);
 194         void draw_stars(video::IVideoDriver *driver, float wicked_time_of_day);
 195         void place_sky_body(std::array<video::S3DVertex, 4> &vertices,
 196                 float horizon_position, float day_position);
 197         void setSkyDefaults();
 198 };