simgear/sky/sky.hxx

   1 // sky.hxx -- ssg based sky model
   2 //
   3 // Written by Curtis Olson, started December 1997.
   4 // SSG-ified by Curtis Olson, February 2000.
   5 //
   6 // Copyright (C) 1997-2000  Curtis L. Olson  - curt@flightgear.org
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  21 //
  22 // $Id$
  23
  24
  25 #ifndef _SG_SKY_HXX
  26 #define _SG_SKY_HXX
  27
  28
  29 #ifndef __cplusplus
  30 # error This library requires C++
  31 #endif
  32
  33
  34 #include <plib/ssg.h>           // plib include
  35
  36 #include <simgear/compiler.h>
  37 #include <simgear/misc/fgpath.hxx>
  38
  39 #include <vector>
  40
  41 #include "cloud.hxx"
  42 #include "dome.hxx"
  43 #include "moon.hxx"
  44 #include "oursun.hxx"
  45 #include "stars.hxx"
  46
  47 FG_USING_STD(vector);
  48
  49
  50 typedef vector < SGCloudLayer* > layer_list_type;
  51 typedef layer_list_type::iterator layer_list_iterator;
  52 typedef layer_list_type::const_iterator layer_list_const_iterator;
  53
  54
  55 class SGSky {
  56
  57 private:
  58
  59     // components of the sky
  60     SGSkyDome *dome;
  61     SGSun *oursun;
  62     SGMoon *moon;
  63     SGStars *planets;
  64     SGStars *stars;
  65     ssgSimpleState *cloud_mats[SG_MAX_CLOUD_TYPES];
  66     layer_list_type cloud_layers;
  67
  68     ssgRoot *pre_root, *post_root;
  69
  70     ssgSelector *pre_selector, *post_selector;
  71     ssgTransform *pre_transform, *post_transform;
  72
  73     FGPath tex_path;
  74
  75     // visibility
  76     float visibility;
  77     float effective_visibility;
  78
  79     // near cloud visibility state variables
  80     bool in_puff;
  81     double puff_length;         // in seconds
  82     double puff_progression;    // in seconds
  83     double ramp_up;             // in seconds
  84     double ramp_down;           // in seconds
  85
  86 public:
  87
  88     // Constructor
  89     SGSky( void );
  90
  91     // Destructor
  92     ~SGSky( void );
  93
  94     // initialize the sky and connect the components to the scene
  95     // graph at the provided branch
  96     void build( double sun_size, double moon_size,
  97                 int nplanets, sgdVec3 *planet_data, double planet_dist,
  98                 int nstars, sgdVec3 *star_data, double star_dist );
  99
 100     // repaint the sky components based on current value of sun_angle,
 101     // sky, and fog colors.
 102     //
 103     // sun angle in degrees relative to verticle
 104     // 0 degrees = high noon
 105     // 90 degrees = sun rise/set
 106     // 180 degrees = darkest midnight
 107     bool repaint( sgVec4 sky_color, sgVec4 fog_color,
 108                   double sun_angle, double moon_angle,
 109                   int nplanets, sgdVec3 *planet_data,
 110                   int nstars, sgdVec3 *star_data );
 111
 112     // reposition the sky at the specified origin and orientation
 113     //
 114     // lon specifies a rotation about the Z axis
 115     // lat specifies a rotation about the new Y axis
 116     // spin specifies a rotation about the new Z axis (this allows
 117     // additional orientation for the sunrise/set effects and is used
 118     // by the skydome and perhaps clouds.
 119     bool reposition( sgVec3 view_pos, sgVec3 zero_elev, sgVec3 view_up,
 120                      double lon, double lat, double alt, double spin,
 121                      double gst,
 122                      double sun_ra, double sun_dec, double sun_dist,
 123                      double moon_ra, double moon_dec, double moon_dist );
 124
 125     // modify the given visibility based on cloud layers, thickness,
 126     // transition range, and simulated "puffs".
 127     void modify_vis( float alt, float time_factor );
 128
 129     // draw background portions of the sky ... do this before you draw
 130     // the rest of your scene.
 131     void preDraw();
 132
 133     // draw translucent clouds ... do this after you've drawn all the
 134     // oapaque elements of your scene.
 135     void postDraw( float alt );
 136
 137     // specify the texture path (optional, defaults to current directory)
 138     inline void texture_path( const string& path ) {
 139         tex_path = FGPath( path );
 140     }
 141
 142     // enable the sky
 143     inline void enable() {
 144         pre_selector->select( 1 );
 145         post_selector->select( 1 );
 146     }
 147
 148     // disable the sky in the scene graph.  The leaf node is still
 149     // there, how ever it won't be traversed on by ssgCullandRender()
 150     inline void disable() {
 151         pre_selector->select( 0 );
 152         post_selector->select( 0 );
 153     }
 154
 155     // add a cloud layer (above sea level in meters)
 156     void add_cloud_layer( double asl, double thickness, double transition,
 157                           SGCloudType type );
 158     void add_cloud_layer( double asl, double thickness, double transition,
 159                           const string &tex_path );
 160     void add_cloud_layer( double asl, double thickness, double transition,
 161                           ssgSimpleState *state );
 162
 163     inline int get_num_layers() const { return cloud_layers.size(); }
 164     inline SGCloudLayer *get_cloud_layer( int i ) const {
 165         return cloud_layers[i];
 166     }
 167
 168     inline float get_visibility() const { return effective_visibility; }
 169     inline void set_visibility( float v ) {
 170         effective_visibility = visibility = v;
 171     }
 172 };
 173
 174
 175 #endif // _SG_SKY_HXX
 176
 177