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