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
25 #include <simgear/compiler.h>
29 #include <simgear/math/SGMath.hxx>
35 * Simulate some echo on a weather radar.
36 * Container class for the wx radar instrument.
40 SGWxRadarEcho(float _heading, float _alt, float _radius, float _dist,
41 double _LWC, bool _lightning, int _cloudId ) :
47 lightning ( _lightning ),
51 /** the heading in radian is versus north */
53 float alt, radius, dist;
54 /** reflectivity converted to liquid water content. */
56 /** if true then this data is for a lightning else it is for water echo. */
58 /** Unique identifier of cloud */
62 typedef std::vector<SGWxRadarEcho> list_of_SGWxRadarEcho;
65 * Visual environment helper class.
68 friend class SGLightning;
70 void DrawCone2(float baseRadius, float height, int slices, bool down, double rain_norm, double speed);
74 bool precipitation_enable_state;
75 float precipitation_density;
76 float precipitation_max_alt;
77 bool turbulence_enable_state;
78 double last_cloud_turbulence, cloud_turbulence;
79 bool lightning_enable_state;
80 double elapsed_time, dt;
83 double last_lon, last_lat, last_alt;
84 SGSampleGroup *sampleGroup;
85 bool snd_active, snd_playing;
86 double snd_timer, snd_wait, snd_pos_lat, snd_pos_lon, snd_dist;
87 double min_time_before_lt;
89 float fov_width, fov_height;
91 /** a list of all the radar echo. */
92 list_of_SGWxRadarEcho radarEcho;
93 static SGVec3f min_light;
94 static float streak_bright_nearmost_layer,
95 streak_bright_farmost_layer,
97 streak_period_change_per_kt,
100 streak_length_change_per_kt,
102 static int streak_count_min, streak_count_max;
103 static float cone_base_radius,
110 /** Read the config from the precipitation rendering config properties.
111 * @param precip_rendering_cfgNode "/sim/rendering/precipitation" in fg
112 * Set from whatever info present in the
113 * subnodes passed, substituting hardwired defaults for missing fields.
114 * If NULL is given, do nothing.
116 void config(const class SGPropertyNode* precip_rendering_cfgNode);
119 * Forward a few states used for renderings.
121 void startOfFrame( SGVec3f p, SGVec3f up, double lon, double lat, double alt, double delta_time);
123 void endOfFrame(void);
127 * Whenever a cloud is drawn we check his 'impact' on the environment.
128 * @param heading direction of cloud in radians
129 * @param alt asl of cloud in meters
130 * @param radius radius of cloud in meters
131 * @param family cloud family
132 * @param dist squared dist to cloud in meters
134 void callback_cloud(float heading, float alt, float radius, int family, float dist, int cloudId);
136 void drawRain(double pitch, double roll, double heading, double hspeed, double rain_norm);
138 * Draw rain or snow precipitation around the viewer.
139 * @param rain_norm rain normalized intensity given by metar class
140 * @param snow_norm snow normalized intensity given by metar class
141 * @param hail_norm hail normalized intensity given by metar class
142 * @param pitch pitch rotation of viewer
143 * @param roll roll rotation of viewer
144 * @param hspeed moving horizontal speed of viewer in kt
146 void drawPrecipitation(double rain_norm, double snow_norm, double hail_norm,
147 double pitch, double roll, double heading, double hspeed);
150 * Draw the lightnings spawned by cumulo nimbus.
152 void drawLightning(void);
155 * Forward the fog color used by the rain rendering.
156 * @param adj_fog_color color of the fog
158 void setLight(SGVec4f adj_fog_color);
160 // this can be queried to add some turbulence for example
161 bool is_view_in_cloud(void) const;
162 void set_view_in_cloud(bool incloud);
163 double get_cloud_turbulence(void) const;
166 // return the size of the memory pool used by texture impostors
167 int get_clouds_CacheSize(void) const;
168 int get_CacheResolution(void) const;
169 float get_clouds_visibility(void) const;
170 float get_clouds_density(void) const;
171 bool get_clouds_enable_state(void) const;
172 bool get_turbulence_enable_state(void) const;
175 * Set the size of the impostor texture cache for 3D clouds.
176 * @param sizeKb size of the texture pool in Kb
178 void set_clouds_CacheSize(int sizeKb);
180 * Set the resolution of the impostor texture for 3D clouds.
181 * @param resolutionPixels size of each texture in pixels (64|128|256)
183 void set_CacheResolution(int resolutionPixels);
185 * Set the maximum range used when drawing clouds.
186 * Clouds are blended from totaly transparent at max range to totaly opaque around the viewer
187 * @param distance in meters
189 void set_clouds_visibility(float distance);
191 * Set the proportion of clouds that will be rendered to limit drop in FPS.
192 * @param density 0..100 no clouds drawn when density == 0, all are drawn when density == 100
194 void set_clouds_density(float density);
196 * Enable or disable the use of 3D clouds.
197 * @param enable when false we draw the 2D layers
199 void set_clouds_enable_state(bool enable);
201 * Enable or disable the use of proximity cloud turbulence.
202 * @param enable when true the turbulence is computed based on type of cloud around the AC
204 void set_turbulence_enable_state(bool enable);
207 float get_precipitation_density(void) const;
208 bool get_precipitation_enable_state(void) const;
211 * Decrease the precipitation density to the given percentage.
212 * (Only show the given percentage of rain streaks etc.)
213 * Default precipitation density upon construction is 100.0.
214 * @param density 0.0 to 100.0
216 void set_precipitation_density(float density);
218 * Enable or disable the rendering of precipitation around the viewer.
219 * @param enable when true we will draw precipitation depending on metar data
221 void set_precipitation_enable_state(bool enable);
224 bool get_lightning_enable_state(void) const;
226 * Enable or disable the rendering of lightning and the thunder sound.
227 * @param enable when true we will draw lightning spwaned by cumulonimbus
229 void set_lightning_enable_state(bool enable);
232 * Spawn a new lighning at specified lon/lat.
233 * @param lon position of the new lightning
234 * @param lat position of the new lightning
235 * @param alt asl of the starting point of the lightning in meters
237 void addLightning(double lon, double lat, double alt);
240 * Forward the sound manager instance to be able to play samples.
241 * @param mgr a running sound manager
243 void set_sampleGroup(SGSampleGroup *sgr);
245 void setFOV( float w, float h );
246 void getFOV( float &w, float &h );
248 list_of_SGWxRadarEcho *get_radar_echo(void);
250 SGMatrixf *get_transform(void) { return &transform; }
253 extern SGEnviro sgEnviro;
255 #endif // _VISUAL_ENVIRO_HXX