simgear/scene/sky/cloud.hxx

   1 /**
   2  * \file cloud.hxx
   3  * Provides a class to model a single cloud layer
   4  */
   5
   6 // Written by Curtis Olson, started June 2000.
   7 //
   8 // Copyright (C) 2000  Curtis L. Olson  - http://www.flightgear.org/~curt
   9 //
  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.
  14 //
  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.
  19 //
  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.
  23 //
  24 // $Id$
  25
  26
  27 #ifndef _SG_CLOUD_HXX_
  28 #define _SG_CLOUD_HXX_
  29
  30 #include <simgear/compiler.h>
  31 #include <simgear/misc/sg_path.hxx>
  32 #include <simgear/math/SGMath.hxx>
  33 #include <simgear/structure/SGReferenced.hxx>
  34
  35 #include <string>
  36 using std::string;
  37
  38 #include <osg/ref_ptr>
  39 #include <osg/Array>
  40 #include <osg/Geode>
  41 #include <osg/Group>
  42 #include <osg/MatrixTransform>
  43 #include <osg/Switch>
  44
  45 class SGCloudField;
  46
  47 /**
  48  * A class layer to model a single cloud layer
  49  */
  50 class SGCloudLayer : public SGReferenced {
  51 public:
  52
  53     /**
  54      * This is the list of available cloud coverages/textures
  55      */
  56     enum Coverage {
  57         SG_CLOUD_OVERCAST = 0,
  58         SG_CLOUD_BROKEN,
  59         SG_CLOUD_SCATTERED,
  60         SG_CLOUD_FEW,
  61         SG_CLOUD_CIRRUS,
  62         SG_CLOUD_CLEAR,
  63         SG_MAX_CLOUD_COVERAGES
  64     };
  65
  66     static const std::string SG_CLOUD_OVERCAST_STRING; // "overcast"
  67     static const std::string SG_CLOUD_BROKEN_STRING; // "broken"
  68     static const std::string SG_CLOUD_SCATTERED_STRING; // "scattered"
  69     static const std::string SG_CLOUD_FEW_STRING; // "few"
  70     static const std::string SG_CLOUD_CIRRUS_STRING; // "cirrus"
  71     static const std::string SG_CLOUD_CLEAR_STRING; // "clear"
  72
  73     /**
  74      * Constructor
  75      * @param tex_path the path to the set of cloud textures
  76      */
  77     SGCloudLayer( const string &tex_path );
  78
  79     /**
  80      * Destructor
  81      */
  82     ~SGCloudLayer( void );
  83
  84     /** get the cloud span (in meters) */
  85     float getSpan_m () const;
  86     /**
  87      * set the cloud span
  88      * @param span_m the cloud span in meters
  89      */
  90     void setSpan_m (float span_m);
  91
  92     /** get the layer elevation (in meters) */
  93     float getElevation_m () const;
  94     /**
  95      * set the layer elevation.  Note that this specifies the bottom
  96      * of the cloud layer.  The elevation of the top of the layer is
  97      * elevation_m + thickness_m.
  98      * @param elevation_m the layer elevation in meters
  99      * @param set_span defines whether it is allowed to adjust the span
 100      */
 101     void setElevation_m (float elevation_m, bool set_span = true);
 102
 103     /** get the layer thickness */
 104     float getThickness_m () const;
 105     /**
 106      * set the layer thickness.
 107      * @param thickness_m the layer thickness in meters.
 108      */
 109     void setThickness_m (float thickness_m);
 110
 111     /**
 112      * get the transition/boundary layer depth in meters.  This
 113      * allows gradual entry/exit from the cloud layer via adjusting
 114      * visibility.
 115      */
 116     float getTransition_m () const;
 117
 118     /**
 119      * set the transition layer size in meters
 120      * @param transition_m the transition layer size in meters
 121      */
 122     void setTransition_m (float transition_m);
 123
 124     /** get coverage type */
 125     Coverage getCoverage () const;
 126
 127     /**
 128      * set coverage type
 129      * @param coverage the coverage type
 130      */
 131     void setCoverage (Coverage coverage);
 132
 133     /** get coverage as string */
 134     const string & getCoverageString() const;
 135
 136     /** get coverage as string */
 137     static const string & getCoverageString( Coverage coverage );
 138
 139     /** get coverage type from string */
 140     static Coverage getCoverageType( const std::string & coverage );
 141
 142     /** set coverage as string */
 143     void setCoverageString( const string & coverage );
 144
 145     /**
 146      * set the cloud movement direction
 147      * @param dir the cloud movement direction
 148      */
 149     inline void setDirection(float dir) {
 150         // cout << "cloud dir = " << dir << endl;
 151         direction = dir;
 152     }
 153
 154     /** get the cloud movement direction */
 155     inline float getDirection() { return direction; }
 156
 157     /**
 158      * set the cloud movement speed
 159      * @param sp the cloud movement speed
 160      */
 161     inline void setSpeed(float sp) {
 162         // cout << "cloud speed = " << sp << endl;
 163         speed = sp;
 164     }
 165
 166     /** get the cloud movement speed */
 167     inline float getSpeed() { return speed; }
 168
 169     /**
 170      * set the alpha component of the cloud base color.  Normally this
 171      * should be 1.0, but you can set it anywhere in the range of 0.0
 172      * to 1.0 to fade a cloud layer in or out.
 173      * @param alpha cloud alpha value (0.0 to 1.0)
 174      */
 175     inline void setAlpha( float alpha ) {
 176         if ( alpha < 0.0 ) { alpha = 0.0; }
 177         if ( alpha > 1.0 ) { alpha = 1.0; }
 178         cloud_alpha = alpha;
 179     }
 180
 181     /** build the cloud object */
 182     void rebuild();
 183
 184     /** Enable/disable 3D clouds in this layer */
 185     void set_enable3dClouds(bool enable);
 186
 187     /**
 188      * repaint the cloud colors based on the specified fog_color
 189      * @param fog_color the fog color
 190      */
 191     bool repaint( const SGVec3f& fog_color );
 192
 193     /**
 194      * reposition the cloud layer at the specified origin and
 195      * orientation.
 196      * @param p position vector
 197      * @param up the local up vector
 198      * @param lon specifies a rotation about the Z axis
 199      * @param lat specifies a rotation about the new Y axis
 200      * @param spin specifies a rotation about the new Z axis
 201      *        (and orients the sunrise/set effects)
 202      * @param dt the time elapsed since the last call
 203      */
 204     bool reposition( const SGVec3f& p, const SGVec3f& up,
 205                      double lon, double lat, double alt,
 206                      double dt = 0.0 );
 207
 208     osg::Switch* getNode() { return cloud_root.get(); }
 209
 210     static bool enable_bump_mapping;
 211
 212     /** return the 3D layer cloud associated with this 2D layer */
 213     SGCloudField *get_layer3D(void) { return layer3D; }
 214
 215 protected:
 216     void setTextureOffset(const osg::Vec2& offset);
 217 private:
 218
 219     osg::ref_ptr<osg::Switch> cloud_root;
 220     osg::ref_ptr<osg::Switch> layer_root;
 221     osg::ref_ptr<osg::Group> group_top, group_bottom;
 222     osg::ref_ptr<osg::MatrixTransform> layer_transform;
 223     osg::ref_ptr<osg::Geode> layer[4];
 224
 225     float cloud_alpha;          // 1.0 = drawn fully, 0.0 faded out completely
 226
 227     osg::ref_ptr<osg::Vec4Array> cl[4];
 228     osg::ref_ptr<osg::Vec3Array> vl[4];
 229     osg::ref_ptr<osg::Vec2Array> tl[4];
 230     osg::ref_ptr<osg::Vec3Array> tl2[4];
 231
 232     // height above sea level (meters)
 233     SGPath texture_path;
 234     float layer_span;
 235     float layer_asl;
 236     float layer_thickness;
 237     float layer_transition;
 238     Coverage layer_coverage;
 239     float scale;
 240     float speed;
 241     float direction;
 242
 243     // for handling texture coordinates to simulate cloud movement
 244     // from winds, and to simulate the clouds being tied to ground
 245     // position, not view position
 246     // double xoff, yoff;
 247     SGGeod last_pos;
 248     double last_course;
 249
 250     osg::Vec2 base;
 251
 252     SGCloudField *layer3D;
 253
 254 };
 255
 256 #endif // _SG_CLOUD_HXX_