3 * Provides a class to model a single cloud layer
6 // Written by Curtis Olson, started June 2000.
8 // Copyright (C) 2000 Curtis L. Olson - http://www.flightgear.org/~curt
10 // This library is free software; you can redistribute it and/or
11 // modify it under the terms of the GNU Library General Public
12 // License as published by the Free Software Foundation; either
13 // version 2 of the License, or (at your option) any later version.
15 // This library is distributed in the hope that it will be useful,
16 // but WITHOUT ANY WARRANTY; without even the implied warranty of
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
18 // Library General Public License for more details.
20 // You should have received a copy of the GNU General Public License
21 // along with this program; if not, write to the Free Software
22 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
27 #ifndef _SG_CLOUD_HXX_
28 #define _SG_CLOUD_HXX_
30 #include <simgear/compiler.h>
31 #include <simgear/misc/sg_path.hxx>
32 #include <simgear/math/SGMath.hxx>
33 #include <simgear/structure/SGReferenced.hxx>
37 #include <osg/ref_ptr>
41 #include <osg/MatrixTransform>
47 * A class layer to model a single cloud layer
49 class SGCloudLayer : public SGReferenced {
53 * This is the list of available cloud coverages/textures
56 SG_CLOUD_OVERCAST = 0,
62 SG_MAX_CLOUD_COVERAGES
65 static const std::string SG_CLOUD_OVERCAST_STRING; // "overcast"
66 static const std::string SG_CLOUD_BROKEN_STRING; // "broken"
67 static const std::string SG_CLOUD_SCATTERED_STRING; // "scattered"
68 static const std::string SG_CLOUD_FEW_STRING; // "few"
69 static const std::string SG_CLOUD_CIRRUS_STRING; // "cirrus"
70 static const std::string SG_CLOUD_CLEAR_STRING; // "clear"
74 * @param tex_path the path to the set of cloud textures
76 SGCloudLayer( const std::string &tex_path );
81 ~SGCloudLayer( void );
83 /** get the cloud span (in meters) */
84 float getSpan_m () const;
87 * @param span_m the cloud span in meters
89 void setSpan_m (float span_m);
91 /** get the layer elevation (in meters) */
92 float getElevation_m () const;
94 * set the layer elevation. Note that this specifies the bottom
95 * of the cloud layer. The elevation of the top of the layer is
96 * elevation_m + thickness_m.
97 * @param elevation_m the layer elevation in meters
98 * @param set_span defines whether it is allowed to adjust the span
100 void setElevation_m (float elevation_m, bool set_span = true);
102 /** get the layer thickness */
103 float getThickness_m () const;
105 * set the layer thickness.
106 * @param thickness_m the layer thickness in meters.
108 void setThickness_m (float thickness_m);
110 /** get the layer visibility */
111 float getVisibility_m() const;
113 * set the layer visibility
114 * @param visibility_m the layer minimum visibility in meters.
116 void setVisibility_m(float visibility_m);
121 * get the transition/boundary layer depth in meters. This
122 * allows gradual entry/exit from the cloud layer via adjusting
125 float getTransition_m () const;
128 * set the transition layer size in meters
129 * @param transition_m the transition layer size in meters
131 void setTransition_m (float transition_m);
133 /** get coverage type */
134 Coverage getCoverage () const;
138 * @param coverage the coverage type
140 void setCoverage (Coverage coverage);
142 /** get coverage as string */
143 const std::string & getCoverageString() const;
145 /** get coverage as string */
146 static const std::string & getCoverageString( Coverage coverage );
148 /** get coverage type from string */
149 static Coverage getCoverageType( const std::string & coverage );
151 /** set coverage as string */
152 void setCoverageString( const std::string & coverage );
155 * set the cloud movement direction
156 * @param dir the cloud movement direction
158 inline void setDirection(float dir) {
159 // cout << "cloud dir = " << dir << endl;
163 /** get the cloud movement direction */
164 inline float getDirection() { return direction; }
167 * set the cloud movement speed
168 * @param sp the cloud movement speed
170 inline void setSpeed(float sp) {
171 // cout << "cloud speed = " << sp << endl;
175 /** get the cloud movement speed */
176 inline float getSpeed() { return speed; }
179 * set the alpha component of the cloud base color. Normally this
180 * should be 1.0, but you can set it anywhere in the range of 0.0
181 * to 1.0 to fade a cloud layer in or out.
182 * @param alpha cloud alpha value (0.0 to 1.0)
184 inline void setAlpha( float alpha ) {
185 if ( alpha < 0.0 ) { alpha = 0.0; }
186 if ( alpha > max_alpha ) { alpha = max_alpha; }
190 inline void setMaxAlpha( float alpha ) {
191 if ( alpha < 0.0 ) { alpha = 0.0; }
192 if ( alpha > 1.0 ) { alpha = 1.0; }
196 inline float getMaxAlpha() const {
200 /** build the cloud object */
203 /** Enable/disable 3D clouds in this layer */
204 void set_enable3dClouds(bool enable);
207 * repaint the cloud colors based on the specified fog_color
208 * @param fog_color the fog color
210 bool repaint( const SGVec3f& fog_color );
213 * reposition the cloud layer at the specified origin and
215 * @param p position vector
216 * @param up the local up vector
220 * @param dt the time elapsed since the last call
222 bool reposition( const SGVec3f& p,
224 double lon, double lat, double alt,
227 osg::Switch* getNode() { return cloud_root.get(); }
229 /** return the 3D layer cloud associated with this 2D layer */
230 SGCloudField *get_layer3D(void) { return layer3D; }
233 void setTextureOffset(const osg::Vec2& offset);
236 osg::ref_ptr<osg::Switch> cloud_root;
237 osg::ref_ptr<osg::Switch> layer_root;
238 osg::ref_ptr<osg::Group> group_top, group_bottom;
239 osg::ref_ptr<osg::MatrixTransform> layer_transform;
240 osg::ref_ptr<osg::Geode> layer[4];
242 float cloud_alpha; // 1.0 = drawn fully, 0.0 faded out completely
244 osg::ref_ptr<osg::Vec4Array> cl[4];
245 osg::ref_ptr<osg::Vec3Array> vl[4];
246 osg::ref_ptr<osg::Vec2Array> tl[4];
247 osg::ref_ptr<osg::Vec3Array> tl2[4];
249 // height above sea level (meters)
253 float layer_thickness;
254 float layer_transition;
255 float layer_visibility;
256 Coverage layer_coverage;
261 // for handling texture coordinates to simulate cloud movement
262 // from winds, and to simulate the clouds being tied to ground
263 // position, not view position
264 // double xoff, yoff;
271 SGCloudField *layer3D;
275 #endif // _SG_CLOUD_HXX_