ClientConfig.h

Go to the documentation of this file.

#pragma once
 
#include <wx/string.h>
#include <wx/colour.h>
 
//Defaults - these are also written into the seeded config file so the user sees editable starting values.
//static gives each including .cpp its own internal-linkage copy. The numeric consts get that automatically
//(a const-qualified type has internal linkage), but a "const char*" is a non-const pointer to const char, so
//without static those would have external linkage and collide when this header is included by more than one .cpp.
static const char*  CLIENTCONFIG_DEFAULT_LOCATION_NAME = "Greenview";       
static const char*  CLIENTCONFIG_DEFAULT_IMAGES_FOLDER = "~/rumpi_images";  
static const long   CLIENTCONFIG_DEFAULT_ANIMATION_FPS = 20;                
static const double CLIENTCONFIG_DEFAULT_CO2_FRESH_MAX = 800.0;             
static const double CLIENTCONFIG_DEFAULT_CO2_ELEVATED_MAX = 1200.0;         
static const double CLIENTCONFIG_DEFAULT_TEMP_WARM_ABOVE = 22.0;                
static const double CLIENTCONFIG_DEFAULT_TEMP_COOL_BELOW = 16.0;                
static const double CLIENTCONFIG_DEFAULT_DUSK_GLOW_OPACITY = 0.18;          
static const double CLIENTCONFIG_DEFAULT_TEMP_TINT_OPACITY = 0.30;          
static const double CLIENTCONFIG_DEFAULT_CLOUD_OPACITY = 0.85;              
static const double CLIENTCONFIG_DEFAULT_HAZE_OPACITY = 0.70;               
static const double CLIENTCONFIG_DEFAULT_MIST_OPACITY = 0.35;               
static const double CLIENTCONFIG_DEFAULT_WIND_OPACITY = 0.55;               
static const char*  CLIENTCONFIG_DEFAULT_CO2_FRESH_COLOUR = "#4CAF50";      
static const char*  CLIENTCONFIG_DEFAULT_CO2_ELEVATED_COLOUR = "#E0A93B";   
static const char*  CLIENTCONFIG_DEFAULT_CO2_HIGH_COLOUR = "#D9534F";       
 
class ClientConfig
{
private:
    ClientConfig();
    ClientConfig(const ClientConfig&);
    ClientConfig& operator=(const ClientConfig&);
 
    void Load();
 
    wxString ConfigFilePath() const;
 
    void SeedDefaultFileIfMissing(const wxString& path) const;
 
    wxString myLocation;                
    wxString myImagesFolder;            
    int myAnimationFps;                 
    double myCo2FreshMax;               
    double myCo2ElevatedMax;            
    double myTempWarmAbove;             
    double myTempCoolBelow;             
    double myDuskGlowOpacity;           
    double myTemperatureTintOpacity;    
    double myCloudOpacity;              
    double myHazeOpacity;               
    double myMistOpacity;               
    double myWindOpacity;               
    wxColour myCo2FreshColour;          
    wxColour myCo2ElevatedColour;       
    wxColour myCo2HighColour;           
 
public:
    static ClientConfig& GetInstance();
 
    //[General]
    const wxString& GetLocation() const;
 
    //[Scene]
    const wxString& GetImagesFolder() const;
 
    int GetAnimationFps() const;
 
    //[Thresholds]
    double GetCo2FreshMax() const;
 
    double GetCo2ElevatedMax() const;
 
    double GetTempWarmAbove() const;
 
    double GetTempCoolBelow() const;
 
    //[Overlays] - maximum opacity of each atmospheric overlay (0.0 - 1.0).
    double GetDuskGlowOpacity() const;
 
    double GetTemperatureTintOpacity() const;
 
    double GetCloudOpacity() const;
 
    double GetHazeOpacity() const;
 
    double GetMistOpacity() const;
 
    double GetWindOpacity() const;
 
    //[Colors] - status indicator colours, overridable for accessibility (colour blindness / contrast).
    wxColour GetCo2FreshColour() const;
 
    wxColour GetCo2ElevatedColour() const;
 
    wxColour GetCo2HighColour() const;
 
};