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>
38 #include <osg/ref_ptr>
42 #include <osg/MatrixTransform>
48 * A class layer to model a single cloud layer
50 class SGCloudLayer : public SGReferenced {
54 * This is the list of available cloud coverages/textures
57 SG_CLOUD_OVERCAST = 0,
63 SG_MAX_CLOUD_COVERAGES
68 * @param tex_path the path to the set of cloud textures
70 SGCloudLayer( const string &tex_path );
75 ~SGCloudLayer( void );
77 /** get the cloud span (in meters) */
78 float getSpan_m () const;
81 * @param span_m the cloud span in meters
83 void setSpan_m (float span_m);
85 /** get the layer elevation (in meters) */
86 float getElevation_m () const;
88 * set the layer elevation. Note that this specifies the bottom
89 * of the cloud layer. The elevation of the top of the layer is
90 * elevation_m + thickness_m.
91 * @param elevation_m the layer elevation in meters
92 * @param set_span defines whether it is allowed to adjust the span
94 void setElevation_m (float elevation_m, bool set_span = true);
96 /** get the layer thickness */
97 float getThickness_m () const;
99 * set the layer thickness.
100 * @param thickness_m the layer thickness in meters.
102 void setThickness_m (float thickness_m);
105 * get the transition/boundary layer depth in meters. This
106 * allows gradual entry/exit from the cloud layer via adjusting
109 float getTransition_m () const;
112 * set the transition layer size in meters
113 * @param transition_m the transition layer size in meters
115 void setTransition_m (float transition_m);
117 /** get coverage type */
118 Coverage getCoverage () const;
122 * @param coverage the coverage type
124 void setCoverage (Coverage coverage);
127 * set the cloud movement direction
128 * @param dir the cloud movement direction
130 inline void setDirection(float dir) {
131 // cout << "cloud dir = " << dir << endl;
135 /** get the cloud movement direction */
136 inline float getDirection() { return direction; }
139 * set the cloud movement speed
140 * @param sp the cloud movement speed
142 inline void setSpeed(float sp) {
143 // cout << "cloud speed = " << sp << endl;
147 /** get the cloud movement speed */
148 inline float getSpeed() { return speed; }
151 * set the alpha component of the cloud base color. Normally this
152 * should be 1.0, but you can set it anywhere in the range of 0.0
153 * to 1.0 to fade a cloud layer in or out.
154 * @param alpha cloud alpha value (0.0 to 1.0)
156 inline void setAlpha( float alpha ) {
157 if ( alpha < 0.0 ) { alpha = 0.0; }
158 if ( alpha > 1.0 ) { alpha = 1.0; }
162 /** build the cloud object */
165 /** Enable/disable 3D clouds in this layer */
166 void set_enable3dClouds(bool enable);
169 * repaint the cloud colors based on the specified fog_color
170 * @param fog_color the fog color
172 bool repaint( const SGVec3f& fog_color );
175 * reposition the cloud layer at the specified origin and
177 * @param p position vector
178 * @param up the local up vector
179 * @param lon specifies a rotation about the Z axis
180 * @param lat specifies a rotation about the new Y axis
181 * @param spin specifies a rotation about the new Z axis
182 * (and orients the sunrise/set effects)
183 * @param dt the time elapsed since the last call
185 bool reposition( const SGVec3f& p, const SGVec3f& up,
186 double lon, double lat, double alt,
189 osg::Switch* getNode() { return cloud_root.get(); }
191 static bool enable_bump_mapping;
193 /** return the 3D layer cloud associated with this 2D layer */
194 SGCloudField *get_layer3D(void) { return layer3D; }
197 void setTextureOffset(const osg::Vec2& offset);
200 osg::ref_ptr<osg::Switch> cloud_root;
201 osg::ref_ptr<osg::Switch> layer_root;
202 osg::ref_ptr<osg::Group> group_top, group_bottom;
203 osg::ref_ptr<osg::MatrixTransform> layer_transform;
204 osg::ref_ptr<osg::Geode> layer[4];
206 float cloud_alpha; // 1.0 = drawn fully, 0.0 faded out completely
208 osg::ref_ptr<osg::Vec4Array> cl[4];
209 osg::ref_ptr<osg::Vec3Array> vl[4];
210 osg::ref_ptr<osg::Vec2Array> tl[4];
211 osg::ref_ptr<osg::Vec3Array> tl2[4];
213 // height above sea level (meters)
217 float layer_thickness;
218 float layer_transition;
219 Coverage layer_coverage;
224 // for handling texture coordinates to simulate cloud movement
225 // from winds, and to simulate the clouds being tied to ground
226 // position, not view position
227 // double xoff, yoff;
228 double last_lon, last_lat, last_course;
232 SGCloudField *layer3D;
236 #endif // _SG_CLOUD_HXX_