simgear/bucket/newbucket.hxx

   1 /**************************************************************************
   2  * newbucket.hxx -- new bucket routines for better world modeling
   3  *
   4  * Written by Curtis L. Olson, started February 1999.
   5  *
   6  * Copyright (C) 1999  Curtis L. Olson - http://www.flightgear.org/~curt
   7  *
   8  * This library is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU Library General Public
  10  * License as published by the Free Software Foundation; either
  11  * version 2 of the License, or (at your option) any later version.
  12  *
  13  * This library is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16  * Library 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., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21  *
  22  * $Id$
  23  **************************************************************************/
  24
  25 /** \file newbucket.hxx
  26  * A class and associated utiltity functions to manage world scenery tiling.
  27  */
  28
  29 #ifndef _NEWBUCKET_HXX
  30 #define _NEWBUCKET_HXX
  31
  32 #include <simgear/compiler.h>
  33 #include <simgear/constants.h>
  34 #include <simgear/math/SGMath.hxx>
  35
  36 #ifdef SG_HAVE_STD_INCLUDES
  37 #  include <cmath>
  38 #  include <cstdio> // sprintf()
  39 #else
  40 #  include <math.h>
  41 #  include <stdio.h> // sprintf()
  42 #endif
  43
  44 #include STL_IOSTREAM
  45
  46 // I don't understand ... <math.h> or <cmath> should be included
  47 // already depending on how you defined SG_HAVE_STD_INCLUDES, but I
  48 // can go ahead and add this -- CLO
  49 #ifdef __MWERKS__
  50 SG_USING_STD(sprintf);
  51 SG_USING_STD(fabs);
  52 #endif
  53
  54 #include STL_STRING
  55
  56 SG_USING_STD(string);
  57 SG_USING_STD(ostream);
  58
  59
  60 /**
  61  * standard size of a bucket in degrees (1/8 of a degree)
  62  */
  63 #define SG_BUCKET_SPAN      0.125
  64
  65 /**
  66  * half of a standard SG_BUCKET_SPAN
  67  */
  68 #define SG_HALF_BUCKET_SPAN ( 0.5 * SG_BUCKET_SPAN )
  69
  70
  71 // return the horizontal tile span factor based on latitude
  72 static double sg_bucket_span( double l ) {
  73     if ( l >= 89.0 ) {
  74         return 360.0;
  75     } else if ( l >= 88.0 ) {
  76         return 8.0;
  77     } else if ( l >= 86.0 ) {
  78         return 4.0;
  79     } else if ( l >= 83.0 ) {
  80         return 2.0;
  81     } else if ( l >= 76.0 ) {
  82         return 1.0;
  83     } else if ( l >= 62.0 ) {
  84         return 0.5;
  85     } else if ( l >= 22.0 ) {
  86         return 0.25;
  87     } else if ( l >= -22.0 ) {
  88         return 0.125;
  89     } else if ( l >= -62.0 ) {
  90         return 0.25;
  91     } else if ( l >= -76.0 ) {
  92         return 0.5;
  93     } else if ( l >= -83.0 ) {
  94         return 1.0;
  95     } else if ( l >= -86.0 ) {
  96         return 2.0;
  97     } else if ( l >= -88.0 ) {
  98         return 4.0;
  99     } else if ( l >= -89.0 ) {
 100         return 8.0;
 101     } else {
 102         return 360.0;
 103     }
 104 }
 105
 106
 107 /**
 108  * A class to manage world scenery tiling.
 109  * This class encapsulates the world tiling scheme.  It provides ways
 110  * to calculate a unique tile index from a lat/lon, and it can provide
 111  * information such as the dimensions of a given tile.
 112  */
 113
 114 class SGBucket {
 115
 116 private:
 117     double cx, cy;  // centerpoint (lon, lat) in degrees of bucket
 118     short lon;        // longitude index (-180 to 179)
 119     short lat;        // latitude index (-90 to 89)
 120     char x;          // x subdivision (0 to 7)
 121     char y;          // y subdivision (0 to 7)
 122
 123 public:
 124
 125     /**
 126      * Default constructor.
 127      */
 128     SGBucket();
 129
 130     /**
 131      * Construct a bucket given a specific location.
 132      * @param dlon longitude specified in degrees
 133      * @param dlat latitude specified in degrees
 134      */
 135     SGBucket(const double dlon, const double dlat);
 136
 137     /**
 138      * Construct a bucket given a specific location.
 139      * @param dlon longitude specified in degrees
 140      * @param dlat latitude specified in degrees
 141      */
 142     SGBucket(const SGGeod& geod);
 143
 144     /** Construct a bucket.
 145      *  @param is_good if false, create an invalid bucket.  This is
 146      *  useful * if you are comparing cur_bucket to last_bucket and
 147      *  you want to * make sure last_bucket starts out as something
 148      *  impossible.
 149      */
 150     SGBucket(const bool is_good);
 151
 152     /** Construct a bucket given a unique bucket index number.
 153      * @param bindex unique bucket index
 154      */
 155     SGBucket(const long int bindex);
 156
 157     /**
 158      * Reset a bucket to represent a new lat and lon
 159      * @param dlon longitude specified in degrees
 160      * @param dlat latitude specified in degrees
 161      */
 162     void set_bucket( double dlon, double dlat );
 163
 164     /**
 165      * Reset a bucket to represent a new lat and lon
 166      * @param lonlat an array of double[2] holding lon and lat
 167      * (specified) in degrees
 168      */
 169     void set_bucket( double *lonlat );
 170
 171     /**
 172      * Reset a bucket to represent a new lat and lon
 173      * @param dlon longitude specified in degrees
 174      * @param dlat latitude specified in degrees
 175      */
 176     void set_bucket(const SGGeod& geod);
 177
 178     /**
 179      * Create an impossible bucket.
 180      * This is useful if you are comparing cur_bucket to last_bucket
 181      * and you want to make sure last_bucket starts out as something
 182      * impossible.
 183      */
 184     inline void make_bad() {
 185         set_bucket(0.0, 0.0);
 186         lon = -1000;
 187     }
 188
 189     /**
 190      * Generate the unique scenery tile index for this bucket
 191      *
 192      * The index is constructed as follows:
 193      *
 194      * 9 bits - to represent 360 degrees of longitude (-180 to 179)
 195      * 8 bits - to represent 180 degrees of latitude (-90 to 89)
 196      *
 197      * Each 1 degree by 1 degree tile is further broken down into an 8x8
 198      * grid.  So we also need:
 199      *
 200      * 3 bits - to represent x (0 to 7)
 201      * 3 bits - to represent y (0 to 7)
 202      * @return tile index
 203      */
 204     inline long int gen_index() const {
 205         return ((lon + 180) << 14) + ((lat + 90) << 6) + (y << 3) + x;
 206     }
 207
 208     /**
 209      * Generate the unique scenery tile index for this bucket in ascii
 210      * string form.
 211      * @return tile index in string form
 212      */
 213     inline string gen_index_str() const {
 214         char tmp[20];
 215         sprintf(tmp, "%ld",
 216                 (((long)lon + 180) << 14) + ((lat + 90) << 6) + (y << 3) + x);
 217         return (string)tmp;
 218     }
 219
 220     /**
 221      * Build the base path name for this bucket.
 222      * @return base path in string form
 223      */
 224     string gen_base_path() const;
 225
 226     /**
 227      * @return the center lon of a tile.
 228      */
 229     inline double get_center_lon() const {
 230         double span = sg_bucket_span( lat + y / 8.0 + SG_HALF_BUCKET_SPAN );
 231
 232         if ( span >= 1.0 ) {
 233             return lon + span / 2.0;
 234         } else {
 235             return lon + x * span + span / 2.0;
 236         }
 237     }
 238
 239     /**
 240      * @return the center lat of a tile.
 241      */
 242     inline double get_center_lat() const {
 243         return lat + y / 8.0 + SG_HALF_BUCKET_SPAN;
 244     }
 245
 246     /**
 247      * @return the width of the tile in degrees.
 248      */
 249     double get_width() const;
 250
 251     /**
 252      * @return the height of the tile in degrees.
 253      */
 254     double get_height() const;
 255
 256     /**
 257      * @return the width of the tile in meters.
 258      */
 259     double get_width_m() const;
 260
 261     /**
 262      * @return the height of the tile in meters.
 263      */
 264     double get_height_m() const;
 265
 266     /**
 267      * @return the center of the bucket in geodetic coordinates.
 268      */
 269     SGGeod get_center() const
 270     { return SGGeod::fromDeg(get_center_lon(), get_center_lat()); }
 271
 272     /**
 273      * @return the center of the bucket in geodetic coordinates.
 274      */
 275     SGGeod get_corner(unsigned num) const
 276     {
 277         double lonFac = ((num + 1) & 2) ? 0.5 : -0.5;
 278         double latFac = ((num    ) & 2) ? 0.5 : -0.5;
 279         return SGGeod::fromDeg(get_center_lon() + lonFac*get_width(),
 280                                get_center_lat() + latFac*get_height());
 281     }
 282
 283     // Informational methods.
 284
 285     /**
 286      * @return the lon of the lower left corner of
 287      * the 1x1 chunk containing this tile.
 288      */
 289     inline int get_chunk_lon() const { return lon; }
 290
 291     /**
 292      * @return the lat of the lower left corner of
 293      * the 1x1 chunk containing this tile.
 294      */
 295     inline int get_chunk_lat() const { return lat; }
 296
 297     /**
 298      * @return the x coord within the 1x1 degree chunk this tile.
 299      */
 300     inline int get_x() const { return x; }
 301
 302     /**
 303      * @return the y coord within the 1x1 degree chunk this tile.
 304      */
 305     inline int get_y() const { return y; }
 306
 307     // friends
 308
 309     friend ostream& operator<< ( ostream&, const SGBucket& );
 310     friend bool operator== ( const SGBucket&, const SGBucket& );
 311 };
 312
 313
 314 /**
 315  * \relates SGBucket
 316  * Return the bucket which is offset from the specified dlon, dlat by
 317  * the specified tile units in the X & Y direction.
 318  * @param dlon starting lon in degrees
 319  * @param dlat starting lat in degrees
 320  * @param x number of bucket units to offset in x (lon) direction
 321  * @param y number of bucket units to offset in y (lat) direction
 322  * @return offset bucket
 323  */
 324 SGBucket sgBucketOffset( double dlon, double dlat, int x, int y );
 325
 326
 327 /**
 328  * \relates SGBucket
 329  * Calculate the offset between two buckets (in quantity of buckets).
 330  * @param b1 bucket 1
 331  * @param b2 bucket 2
 332  * @param dx offset distance (lon) in tile units
 333  * @param dy offset distance (lat) in tile units
 334  */
 335 void sgBucketDiff( const SGBucket& b1, const SGBucket& b2, int *dx, int *dy );
 336
 337
 338 /**
 339  * Write the bucket lon, lat, x, and y to the output stream.
 340  * @param out output stream
 341  * @param b bucket
 342  */
 343 inline ostream&
 344 operator<< ( ostream& out, const SGBucket& b )
 345 {
 346     return out << b.lon << ":" << b.x << ", " << b.lat << ":" << b.y;
 347 }
 348
 349
 350 /**
 351  * Compare two bucket structures for equality.
 352  * @param b1 bucket 1
 353  * @param b2 bucket 2
 354  * @return comparison result
 355  */
 356 inline bool
 357 operator== ( const SGBucket& b1, const SGBucket& b2 )
 358 {
 359     return ( b1.lon == b2.lon &&
 360              b1.lat == b2.lat &&
 361              b1.x == b2.x &&
 362              b1.y == b2.y );
 363 }
 364
 365
 366 #endif // _NEWBUCKET_HXX
 367
 368