OpenMW/apps/openmw/mwworld/weather.hpp

#ifndef GAME_MWWORLD_WEATHER_H
#define GAME_MWWORLD_WEATHER_H

#include <OgreString.h>
#include <OgreColourValue.h>

namespace MWRender
{
    class RenderingManager;
}

namespace MWWorld
{
    /// Global weather manager properties (according to INI)
    struct WeatherGlobals
    {
        /*
        [Weather]
        EnvReduceColor=255,255,255,255
        LerpCloseColor=037,046,048,255
        BumpFadeColor=230,239,255,255
        AlphaReduce=0.35
        Minimum Time Between Environmental Sounds=1.0
        Maximum Time Between Environmental Sounds=5.0
        Sun Glare Fader Max=0.5
        Sun Glare Fader Angle Max=30.0
        Sun Glare Fader Color=222,095,039
        Timescale Clouds=0
        Precip Gravity=575
        Hours Between Weather Changes=20
        Rain Ripples=1
        Rain Ripple Radius=1024
        Rain Ripples Per Drop=1
        Rain Ripple Scale=0.3
        Rain Ripple Speed=1.0
        Fog Depth Change Speed=3
        Sunrise Time=6
        Sunset Time=18
        Sunrise Duration=2
        Sunset Duration=2
        Sky Pre-Sunrise Time=.5
        Sky Post-Sunrise Time=1
        Sky Pre-Sunset Time=1.5
        Sky Post-Sunset Time=.5
        Ambient Pre-Sunrise Time=.5
        Ambient Post-Sunrise Time=2
        Ambient Pre-Sunset Time=1
        Ambient Post-Sunset Time=1.25
        Fog Pre-Sunrise Time=.5
        Fog Post-Sunrise Time=1
        Fog Pre-Sunset Time=2
        Fog Post-Sunset Time=1
        Sun Pre-Sunrise Time=0
        Sun Post-Sunrise Time=0
        Sun Pre-Sunset Time=1
        Sun Post-Sunset Time=1.25
        Stars Post-Sunset Start=1
        Stars Pre-Sunrise Finish=2
        Stars Fading Duration=2
        Snow Ripples=0
        Snow Ripple Radius=1024
        Snow Ripples Per Flake=1
        Snow Ripple Scale=0.3
        Snow Ripple Speed=1.0
        Snow Gravity Scale=0.1
        Snow High Kill=700
        Snow Low Kill=150


        [Moons]
        Masser Size=94
        Masser Fade In Start=14
        Masser Fade In Finish=15
        Masser Fade Out Start=7
        Masser Fade Out Finish=10
        Masser Axis Offset=35
        Masser Speed=.5
        Masser Daily Increment=1
        Masser Fade Start Angle=50
        Masser Fade End Angle=40
        Masser Moon Shadow Early Fade Angle=0.5
        Secunda Size=40
        Secunda Fade In Start=14
        Secunda Fade In Finish=15
        Secunda Fade Out Start=7
        Secunda Fade Out Finish=10
        Secunda Axis Offset=50
        Secunda Speed=.6
        Secunda Daily Increment=1.2
        Secunda Fade Start Angle=50
        Secunda Fade End Angle=30
        Secunda Moon Shadow Early Fade Angle=0.5
        Script Color=255,20,20
        */

        static const float mSunriseTime;
        static const float mSunsetTime;
        static const float mSunriseDuration;
        static const float mSunsetDuration;

        static const float mWeatherUpdateTime;

        // morrowind sets these per-weather, but since they are only used by 'thunderstorm'
        // weather setting anyway, we can just as well set them globally
        static const float mThunderFrequency;
        static const float mThunderThreshold;
        static const float mThunderSoundDelay;
        static const std::string mThunderSoundID0;
        static const std::string mThunderSoundID1;
        static const std::string mThunderSoundID2;
        static const std::string mThunderSoundID3;
    };

    /// Defines the actual weather that results from weather setting (see below), time of day and weather transition
    struct WeatherResult
    {
        Ogre::String mCloudTexture;
        Ogre::String mNextCloudTexture;
        float mCloudBlendFactor;

        Ogre::ColourValue mFogColor;

        Ogre::ColourValue mAmbientColor;

        Ogre::ColourValue mSkyColor;

        Ogre::ColourValue mSunColor;

        Ogre::ColourValue mSunDiscColor;

        float mFogDepth;

        float mWindSpeed;

        float mCloudSpeed;

        float mCloudOpacity;

        float mGlareView;

        bool mNight; // use night skybox
        float mNightFade; // fading factor for night skybox

        Ogre::String mAmbientLoopSoundID;
    };


    /// Defines a single weather setting (according to INI)
    struct Weather
    {
        Ogre::String mCloudTexture;

        // Sky (atmosphere) colors
        Ogre::ColourValue   mSkySunriseColor,
                            mSkyDayColor,
                            mSkySunsetColor,
                            mSkyNightColor;

        // Fog colors
        Ogre::ColourValue   mFogSunriseColor,
                            mFogDayColor,
                            mFogSunsetColor,
                            mFogNightColor;

        // Ambient lighting colors
        Ogre::ColourValue   mAmbientSunriseColor,
                            mAmbientDayColor,
                            mAmbientSunsetColor,
                            mAmbientNightColor;

        // Sun (directional) lighting colors
        Ogre::ColourValue   mSunSunriseColor,
                            mSunDayColor,
                            mSunSunsetColor,
                            mSunNightColor;

        // Fog depth/density
        float   mLandFogDayDepth,
                mLandFogNightDepth;

        // Color modulation for the sun itself during sunset (not completely sure)
        Ogre::ColourValue mSunDiscSunsetColor;

        // Duration of weather transition (in days)
        float mTransitionDelta;

        // No idea what this one is used for?
        float mWindSpeed;

        // Cloud animation speed multiplier
        float mCloudSpeed;

        // Multiplier for clouds transparency
        float mCloudsMaximumPercent;

        // Value between 0 and 1, defines the strength of the sun glare effect
        float mGlareView;

        // Sound effect
        // This is used for Blight, Ashstorm and Blizzard (Bloodmoon)
        Ogre::String mAmbientLoopSoundID;

        // Rain sound effect
        Ogre::String mRainLoopSoundID;

        /// \todo disease chance
    };

    ///
    /// Interface for weather settings
    ///
    class WeatherManager
    {
    public:
        WeatherManager(MWRender::RenderingManager*);

        /**
         * Change the weather in the specified region
         * @param region that should be changed
         * @param ID of the weather setting to shift to
         */
        void changeWeather(const std::string& region, const unsigned int id);

        /**
         * Per-frame update
         * @param duration
         */
        void update(float duration);

        void setHour(const float hour);

        void setDate(const int day, const int month);

        unsigned int getWeatherID() const;

    private:
        float mHour;
        int mDay, mMonth;

        MWRender::RenderingManager* mRendering;

        std::map<Ogre::String, Weather> mWeatherSettings;

        std::map<std::string, std::string> mRegionOverrides;

        std::vector<std::string> mSoundsPlaying;

        Ogre::String mCurrentWeather;
        Ogre::String mNextWeather;

        std::string mCurrentRegion;

        bool mFirstUpdate;

        float mWeatherUpdateTime;

        float mRemainingTransitionTime;

        float mThunderFlash;
        float mThunderChance;
        float mThunderChanceNeeded;
        float mThunderSoundDelay;

        WeatherResult transition(const float factor);
        WeatherResult getResult(const Ogre::String& weather);

        void setWeather(const Ogre::String& weather, bool instant=false);
    };
}

#endif // GAME_MWWORLD_WEATHER_H