simgear/environment/visual_enviro.hxx

   1 // Visual environment helper class
   2 //
   3 // Written by Harald JOHNSEN, started April 2005.
   4 //
   5 // Copyright (C) 2005  Harald JOHNSEN - hjohnsen@evc.net
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA
  20 //
  21 //
  22 #ifndef _VISUAL_ENVIRO_HXX
  23 #define _VISUAL_ENVIRO_HXX
  24
  25 #include <simgear/compiler.h>
  26 #include STL_STRING
  27
  28 SG_USING_STD(string);
  29
  30 class SGLightning;
  31 class SGSoundMgr;
  32
  33 /**
  34  * Simulate some echo on a weather radar.
  35  * Container class for the wx radar instrument.
  36  */
  37 class SGWxRadarEcho {
  38 public:
  39         SGWxRadarEcho(float _heading, float _alt, float _radius, float _dist, double _LWC, bool _lightning, int _cloudId) :
  40           heading( _heading ),
  41           alt ( _alt ),
  42           radius ( _radius ),
  43           dist ( _dist ),
  44           LWC ( _LWC ),
  45           lightning ( _lightning ),
  46           cloudId ( _cloudId )
  47         {}
  48
  49         /** the heading in radian is versus north */
  50         float heading;
  51         float alt, radius, dist;
  52         /** reflectivity converted to liquid water content. */
  53         double LWC;
  54         /** if true then this data is for a lightning else it is for water echo. */
  55         bool   lightning;
  56         /** Unique identifier of cloud */
  57         int cloudId;
  58 };
  59
  60 typedef vector<SGWxRadarEcho> list_of_SGWxRadarEcho;
  61
  62 /**
  63  * Visual environment helper class.
  64  */
  65 class SGEnviro {
  66 friend class SGLightning;
  67 private:
  68         void DrawCone2(float baseRadius, float height, int slices, bool down, double rain_norm, double speed);
  69         void lt_update(void);
  70
  71         bool view_in_cloud;
  72         bool precipitation_enable_state;
  73         float precipitation_density;
  74         float precipitation_max_alt;
  75         bool turbulence_enable_state;
  76         double last_cloud_turbulence, cloud_turbulence;
  77         bool lightning_enable_state;
  78         double elapsed_time, dt;
  79         sgVec4  fog_color;
  80         sgMat4 transform;
  81         double last_lon, last_lat, last_alt;
  82         SGSoundMgr      *soundMgr;
  83         bool            snd_active, snd_playing;
  84         double          snd_timer, snd_wait, snd_pos_lat, snd_pos_lon, snd_dist;
  85         double          min_time_before_lt;
  86
  87         float fov_width, fov_height;
  88
  89         /** a list of all the radar echo. */
  90         list_of_SGWxRadarEcho radarEcho;
  91
  92 public:
  93         SGEnviro();
  94         ~SGEnviro();
  95
  96     /**
  97      * Forward a few states used for renderings.
  98      */
  99         void startOfFrame( sgVec3 p, sgVec3 up, double lon, double lat, double alt, double delta_time);
 100
 101         void endOfFrame(void);
 102
 103     /**
 104      * Whenever a cloud is drawn we check his 'impact' on the environment.
 105      * @param heading direction of cloud in radians
 106      * @param alt asl of cloud in meters
 107      * @param radius radius of cloud in meters
 108      * @param familly cloud familly
 109      * @param dist  squared dist to cloud in meters
 110      */
 111         void callback_cloud(float heading, float alt, float radius, int familly, float dist, int cloudId);
 112
 113         void drawRain(double pitch, double roll, double heading, double speed, double rain_norm);
 114     /**
 115      * Draw rain or snow precipitation around the viewer.
 116      * @param rain_norm rain normalized intensity given by metar class
 117      * @param snow_norm snow normalized intensity given by metar class
 118      * @param hail_norm hail normalized intensity given by metar class
 119      * @param pitch pitch rotation of viewer
 120      * @param roll roll rotation of viewer
 121      * @param speed moving speed of viewer in kt
 122      */
 123         void drawPrecipitation(double rain_norm, double snow_norm, double hail_norm,
 124                                                         double pitch, double roll, double heading, double speed);
 125
 126     /**
 127      * Draw the lightnings spawned by cumulo nimbus.
 128      */
 129         void drawLightning(void);
 130
 131     /**
 132      * Forward the fog color used by the rain rendering.
 133      * @param adj_fog_color color of the fog
 134      */
 135         void setLight(sgVec4 adj_fog_color);
 136
 137         // this can be queried to add some turbulence for example
 138         bool is_view_in_cloud(void) const;
 139         void set_view_in_cloud(bool incloud);
 140         double get_cloud_turbulence(void) const;
 141
 142         // Clouds
 143         // return the size of the memory pool used by texture impostors
 144         int get_clouds_CacheSize(void) const;
 145         int get_CacheResolution(void) const;
 146         float get_clouds_visibility(void) const;
 147         float get_clouds_density(void) const;
 148         bool get_clouds_enable_state(void) const;
 149         bool get_turbulence_enable_state(void) const;
 150
 151     /**
 152      * Set the size of the impostor texture cache for 3D clouds.
 153      * @param sizeKb size of the texture pool in Kb
 154      */
 155         void set_clouds_CacheSize(int sizeKb);
 156     /**
 157      * Set the resolution of the impostor texture for 3D clouds.
 158      * @param resolutionPixels size of each texture in pixels (64|128|256)
 159      */
 160         void set_CacheResolution(int resolutionPixels);
 161     /**
 162      * Set the maximum range used when drawing clouds.
 163          * Clouds are blended from totaly transparent at max range to totaly opaque around the viewer
 164      * @param distance in meters
 165      */
 166         void set_clouds_visibility(float distance);
 167     /**
 168      * Set the proportion of clouds that will be rendered to limit drop in FPS.
 169      * @param density 0..100 no clouds drawn when density == 0, all are drawn when density == 100
 170      */
 171         void set_clouds_density(float density);
 172     /**
 173      * Enable or disable the use of 3D clouds.
 174      * @param enable when false we draw the 2D layers
 175      */
 176         void set_clouds_enable_state(bool enable);
 177     /**
 178      * Enable or disable the use of proximity cloud turbulence.
 179      * @param enable when true the turbulence is computed based on type of cloud around the AC
 180      */
 181         void set_turbulence_enable_state(bool enable);
 182
 183         // rain/snow
 184         float get_precipitation_density(void) const;
 185         bool get_precipitation_enable_state(void) const;
 186
 187         void set_precipitation_density(float density);
 188     /**
 189      * Enable or disable the rendering of precipitation around the viewer.
 190      * @param enable when true we will draw precipitation depending on metar data
 191      */
 192         void set_precipitation_enable_state(bool enable);
 193
 194         // others
 195         bool get_lightning_enable_state(void) const;
 196     /**
 197      * Enable or disable the rendering of lightning and the thunder sound.
 198      * @param enable when true we will draw lightning spwaned by cumulonimbus
 199      */
 200         void set_lightning_enable_state(bool enable);
 201
 202     /**
 203      * Spawn a new lighning at specified lon/lat.
 204      * @param lon position of the new lightning
 205      * @param lat position of the new lightning
 206      * @param alt asl of the starting point of the lightning in meters
 207      */
 208         void addLightning(double lon, double lat, double alt);
 209
 210     /**
 211      * Forward the sound manager instance to be able to play samples.
 212      * @param mgr a running sound manager
 213      */
 214         void set_soundMgr(SGSoundMgr *mgr);
 215
 216         void setFOV( float w, float h );
 217         void getFOV( float &w, float &h );
 218
 219         list_of_SGWxRadarEcho *get_radar_echo(void);
 220 };
 221
 222 extern SGEnviro sgEnviro;
 223
 224 #endif // _VISUAL_ENVIRO_HXX