1 // Visual environment helper class
3 // Written by Harald JOHNSEN, started April 2005.
5 // Copyright (C) 2005 Harald JOHNSEN - hjohnsen@evc.net
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.
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.
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, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 #ifndef _VISUAL_ENVIRO_HXX
23 #define _VISUAL_ENVIRO_HXX
27 #include <simgear/compiler.h>
38 * Simulate some echo on a weather radar.
39 * Container class for the wx radar instrument.
43 SGWxRadarEcho(float _heading, float _alt, float _radius, float _dist, double _LWC, bool _lightning, int _cloudId) :
49 lightning ( _lightning ),
53 /** the heading in radian is versus north */
55 float alt, radius, dist;
56 /** reflectivity converted to liquid water content. */
58 /** if true then this data is for a lightning else it is for water echo. */
60 /** Unique identifier of cloud */
64 typedef vector<SGWxRadarEcho> list_of_SGWxRadarEcho;
67 * Visual environment helper class.
70 friend class SGLightning;
72 void DrawCone2(float baseRadius, float height, int slices, bool down, double rain_norm, double speed);
76 bool precipitation_enable_state;
77 float precipitation_density;
78 float precipitation_max_alt;
79 bool turbulence_enable_state;
80 double last_cloud_turbulence, cloud_turbulence;
81 bool lightning_enable_state;
82 double elapsed_time, dt;
85 double last_lon, last_lat, last_alt;
87 bool snd_active, snd_playing;
88 double snd_timer, snd_wait, snd_pos_lat, snd_pos_lon, snd_dist;
89 double min_time_before_lt;
91 float fov_width, fov_height;
93 /** a list of all the radar echo. */
94 list_of_SGWxRadarEcho radarEcho;
95 static sgVec3 min_light;
96 static SGfloat streak_bright_nearmost_layer,
97 streak_bright_farmost_layer,
99 streak_period_change_per_kt,
102 streak_length_change_per_kt,
104 static int streak_count_min, streak_count_max;
105 static SGfloat cone_base_radius,
112 /** Read the config from the precipitation rendering config properties.
113 * @param precip_rendering_cfgNode "/sim/rendering/precipitation" in fg
114 * Set from whatever info present in the
115 * subnodes passed, substituting hardwired defaults for missing fields.
116 * If NULL is given, do nothing.
118 void config(const class SGPropertyNode* precip_rendering_cfgNode);
121 * Forward a few states used for renderings.
123 void startOfFrame( sgVec3 p, sgVec3 up, double lon, double lat, double alt, double delta_time);
125 void endOfFrame(void);
128 * Whenever a cloud is drawn we check his 'impact' on the environment.
129 * @param heading direction of cloud in radians
130 * @param alt asl of cloud in meters
131 * @param radius radius of cloud in meters
132 * @param family cloud family
133 * @param dist squared dist to cloud in meters
135 void callback_cloud(float heading, float alt, float radius, int family, float dist, int cloudId);
137 void drawRain(double pitch, double roll, double heading, double hspeed, double rain_norm);
139 * Draw rain or snow precipitation around the viewer.
140 * @param rain_norm rain normalized intensity given by metar class
141 * @param snow_norm snow normalized intensity given by metar class
142 * @param hail_norm hail normalized intensity given by metar class
143 * @param pitch pitch rotation of viewer
144 * @param roll roll rotation of viewer
145 * @param hspeed moving horizontal speed of viewer in kt
147 void drawPrecipitation(double rain_norm, double snow_norm, double hail_norm,
148 double pitch, double roll, double heading, double hspeed);
151 * Draw the lightnings spawned by cumulo nimbus.
153 void drawLightning(void);
156 * Forward the fog color used by the rain rendering.
157 * @param adj_fog_color color of the fog
159 void setLight(sgVec4 adj_fog_color);
161 // this can be queried to add some turbulence for example
162 bool is_view_in_cloud(void) const;
163 void set_view_in_cloud(bool incloud);
164 double get_cloud_turbulence(void) const;
167 // return the size of the memory pool used by texture impostors
168 int get_clouds_CacheSize(void) const;
169 int get_CacheResolution(void) const;
170 float get_clouds_visibility(void) const;
171 float get_clouds_density(void) const;
172 bool get_clouds_enable_state(void) const;
173 bool get_turbulence_enable_state(void) const;
176 * Set the size of the impostor texture cache for 3D clouds.
177 * @param sizeKb size of the texture pool in Kb
179 void set_clouds_CacheSize(int sizeKb);
181 * Set the resolution of the impostor texture for 3D clouds.
182 * @param resolutionPixels size of each texture in pixels (64|128|256)
184 void set_CacheResolution(int resolutionPixels);
186 * Set the maximum range used when drawing clouds.
187 * Clouds are blended from totaly transparent at max range to totaly opaque around the viewer
188 * @param distance in meters
190 void set_clouds_visibility(float distance);
192 * Set the proportion of clouds that will be rendered to limit drop in FPS.
193 * @param density 0..100 no clouds drawn when density == 0, all are drawn when density == 100
195 void set_clouds_density(float density);
197 * Enable or disable the use of 3D clouds.
198 * @param enable when false we draw the 2D layers
200 void set_clouds_enable_state(bool enable);
202 * Enable or disable the use of proximity cloud turbulence.
203 * @param enable when true the turbulence is computed based on type of cloud around the AC
205 void set_turbulence_enable_state(bool enable);
208 float get_precipitation_density(void) const;
209 bool get_precipitation_enable_state(void) const;
212 * Decrease the precipitation density to the given percentage.
213 * (Only show the given percentage of rain streaks etc.)
214 * Default precipitation density upon construction is 100.0.
215 * @param density 0.0 to 100.0
217 void set_precipitation_density(float density);
219 * Enable or disable the rendering of precipitation around the viewer.
220 * @param enable when true we will draw precipitation depending on metar data
222 void set_precipitation_enable_state(bool enable);
225 bool get_lightning_enable_state(void) const;
227 * Enable or disable the rendering of lightning and the thunder sound.
228 * @param enable when true we will draw lightning spwaned by cumulonimbus
230 void set_lightning_enable_state(bool enable);
233 * Spawn a new lighning at specified lon/lat.
234 * @param lon position of the new lightning
235 * @param lat position of the new lightning
236 * @param alt asl of the starting point of the lightning in meters
238 void addLightning(double lon, double lat, double alt);
241 * Forward the sound manager instance to be able to play samples.
242 * @param mgr a running sound manager
244 void set_soundMgr(SGSoundMgr *mgr);
246 void setFOV( float w, float h );
247 void getFOV( float &w, float &h );
249 list_of_SGWxRadarEcho *get_radar_echo(void);
251 sgMat4 *get_transform(void) { return &transform; }
254 extern SGEnviro sgEnviro;
256 #endif // _VISUAL_ENVIRO_HXX