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
  32 #include <plib/ssg.h>
  33
  34 #include STL_STRING
  35 SG_USING_STD(string);
  36
  37 // #include <iostream>
  38 // SG_USING_STD(cout);
  39 // SG_USING_STD(endl);
  40
  41 class SGCloudField;
  42
  43 /**
  44  * A class layer to model a single cloud layer
  45  */
  46 class SGCloudLayer {
  47 public:
  48
  49     /**
  50      * This is the list of available cloud coverages/textures
  51      */
  52     enum Coverage {
  53         SG_CLOUD_OVERCAST = 0,
  54         SG_CLOUD_BROKEN,
  55         SG_CLOUD_SCATTERED,
  56         SG_CLOUD_FEW,
  57         SG_CLOUD_CIRRUS,
  58         SG_CLOUD_CLEAR,
  59         SG_MAX_CLOUD_COVERAGES
  60     };
  61
  62     /**
  63      * Constructor
  64      * @param tex_path the path to the set of cloud textures
  65      */
  66     SGCloudLayer( const string &tex_path );
  67
  68     /**
  69      * Destructor
  70      */
  71     ~SGCloudLayer( void );
  72
  73     /** get the cloud span (in meters) */
  74     float getSpan_m () const;
  75     /**
  76      * set the cloud span
  77      * @param span_m the cloud span in meters
  78      */
  79     void setSpan_m (float span_m);
  80
  81     /** get the layer elevation (in meters) */
  82     float getElevation_m () const;
  83     /**
  84      * set the layer elevation.  Note that this specifies the bottom
  85      * of the cloud layer.  The elevation of the top of the layer is
  86      * elevation_m + thickness_m.
  87      * @param elevation_m the layer elevation in meters
  88      * @param set_span defines whether it is allowed to adjust the span
  89      */
  90     void setElevation_m (float elevation_m, bool set_span = true);
  91
  92     /** get the layer thickness */
  93     float getThickness_m () const;
  94     /**
  95      * set the layer thickness.
  96      * @param thickness_m the layer thickness in meters.
  97      */
  98     void setThickness_m (float thickness_m);
  99
 100     /**
 101      * get the transition/boundary layer depth in meters.  This
 102      * allows gradual entry/exit from the cloud layer via adjusting
 103      * visibility.
 104      */
 105     float getTransition_m () const;
 106
 107     /**
 108      * set the transition layer size in meters
 109      * @param transition_m the transition layer size in meters
 110      */
 111     void setTransition_m (float transition_m);
 112
 113     /** get coverage type */
 114     Coverage getCoverage () const;
 115
 116     /**
 117      * set coverage type
 118      * @param coverage the coverage type
 119      */
 120     void setCoverage (Coverage coverage);
 121
 122     /**
 123      * set the cloud movement direction
 124      * @param dir the cloud movement direction
 125      */
 126     inline void setDirection(float dir) {
 127         // cout << "cloud dir = " << dir << endl;
 128         direction = dir;
 129     }
 130
 131     /** get the cloud movement direction */
 132     inline float getDirection() { return direction; }
 133
 134     /**
 135      * set the cloud movement speed
 136      * @param sp the cloud movement speed
 137      */
 138     inline void setSpeed(float sp) {
 139         // cout << "cloud speed = " << sp << endl;
 140         speed = sp;
 141     }
 142
 143     /** get the cloud movement speed */
 144     inline float getSpeed() { return speed; }
 145
 146     /**
 147      * set the alpha component of the cloud base color.  Normally this
 148      * should be 1.0, but you can set it anywhere in the range of 0.0
 149      * to 1.0 to fade a cloud layer in or out.
 150      * @param alpha cloud alpha value (0.0 to 1.0)
 151      */
 152     inline void setAlpha( float alpha ) {
 153         if ( alpha < 0.0 ) { alpha = 0.0; }
 154         if ( alpha > 1.0 ) { alpha = 1.0; }
 155         cloud_alpha = alpha;
 156     }
 157
 158     /** build the cloud object */
 159     void rebuild();
 160
 161     /**
 162      * repaint the cloud colors based on the specified fog_color
 163      * @param fog_color the fog color
 164      */
 165     bool repaint( sgVec3 fog_color );
 166
 167     /**
 168      * reposition the cloud layer at the specified origin and
 169      * orientation.
 170      * @param p position vector
 171      * @param up the local up vector
 172      * @param lon specifies a rotation about the Z axis
 173      * @param lat specifies a rotation about the new Y axis
 174      * @param spin specifies a rotation about the new Z axis
 175      *        (and orients the sunrise/set effects)
 176      * @param dt the time elapsed since the last call
 177      */
 178     bool reposition( sgVec3 p, sgVec3 up, double lon, double lat, double alt,
 179                      double dt = 0.0 );
 180
 181     /** draw the cloud layer */
 182     void draw( bool top );
 183
 184     static bool enable_bump_mapping;
 185
 186         /** return the 3D layer cloud associated with this 2D layer */
 187         SGCloudField *get_layer3D(void) { return layer3D; }
 188
 189 private:
 190
 191     struct CloudVertex {
 192         sgVec3 position;
 193         sgVec2 texCoord;
 194         sgVec3 tangentSpLight;
 195         sgVec3 sTangent;
 196         sgVec3 tTangent;
 197         sgVec3 normal;
 198         sgVec4 color;
 199     };
 200
 201     CloudVertex *vertices;
 202     unsigned int *indices;
 203
 204     ssgRoot *layer_root;
 205     ssgTransform *layer_transform;
 206     ssgLeaf *layer[4];
 207     ssgStateSelector *state_sel;
 208
 209     float cloud_alpha;          // 1.0 = drawn fully, 0.0 faded out completely
 210
 211     ssgColourArray *cl[4];
 212     ssgVertexArray *vl[4];
 213     ssgTexCoordArray *tl[4];
 214
 215     // height above sea level (meters)
 216     SGPath texture_path;
 217     float layer_span;
 218     float layer_asl;
 219     float layer_thickness;
 220     float layer_transition;
 221     Coverage layer_coverage;
 222     float scale;
 223     float speed;
 224     float direction;
 225
 226     // for handling texture coordinates to simulate cloud movement
 227     // from winds, and to simulate the clouds being tied to ground
 228     // position, not view position
 229     // double xoff, yoff;
 230     double last_lon, last_lat, last_course;
 231
 232         SGCloudField *layer3D;
 233 };
 234
 235
 236 // make an ssgSimpleState for a cloud layer given the named texture
 237 ssgSimpleState *sgCloudMakeState( const string &path );
 238
 239
 240 #endif // _SG_CLOUD_HXX_