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  * Tile borders are aligned along circles of latitude and longitude.
  29  * All tiles are 1/8 degree of latitude high and their width in degrees
  30  * longitude depends on their latitude, adjusted in such a way that
  31  * all tiles cover about the same amount of area of the earth surface.
  32  */
  33
  34 #ifndef _NEWBUCKET_HXX
  35 #define _NEWBUCKET_HXX
  36
  37 #include <simgear/compiler.h>
  38 #include <simgear/constants.h>
  39 #include <simgear/math/SGMath.hxx>
  40
  41 #include <cmath>
  42 #include <string>
  43 #include <iosfwd>
  44 #include <vector>
  45
  46 // #define NO_DEPRECATED_API
  47
  48 /**
  49  * standard size of a bucket in degrees (1/8 of a degree)
  50  */
  51 #define SG_BUCKET_SPAN      0.125
  52
  53 /**
  54  * half of a standard SG_BUCKET_SPAN
  55  */
  56 #define SG_HALF_BUCKET_SPAN ( 0.5 * SG_BUCKET_SPAN )
  57
  58
  59 // return the horizontal tile span factor based on latitude
  60 static double sg_bucket_span( double l ) {
  61     if ( l >= 89.0 ) {
  62         return 12.0;
  63     } else if ( l >= 86.0 ) {
  64         return 4.0;
  65     } else if ( l >= 83.0 ) {
  66         return 2.0;
  67     } else if ( l >= 76.0 ) {
  68         return 1.0;
  69     } else if ( l >= 62.0 ) {
  70         return 0.5;
  71     } else if ( l >= 22.0 ) {
  72         return 0.25;
  73     } else if ( l >= -22.0 ) {
  74         return 0.125;
  75     } else if ( l >= -62.0 ) {
  76         return 0.25;
  77     } else if ( l >= -76.0 ) {
  78         return 0.5;
  79     } else if ( l >= -83.0 ) {
  80         return 1.0;
  81     } else if ( l >= -86.0 ) {
  82         return 2.0;
  83     } else if ( l >= -89.0 ) {
  84         return 4.0;
  85     } else {
  86         return 12.0;
  87     }
  88 }
  89
  90
  91 /**
  92  * A class to manage world scenery tiling.
  93  * This class encapsulates the world tiling scheme.  It provides ways
  94  * to calculate a unique tile index from a lat/lon, and it can provide
  95  * information such as the dimensions of a given tile.
  96  */
  97
  98 class SGBucket {
  99
 100 private:
 101     short lon;        // longitude index (-180 to 179)
 102     short lat;        // latitude index (-90 to 89)
 103     unsigned char x;          // x subdivision (0 to 7)
 104     unsigned char y;          // y subdivision (0 to 7)
 105
 106     void innerSet( double dlon, double dlat );
 107 public:
 108
 109     /**
 110      * Default constructor, creates an invalid SGBucket
 111      */
 112     SGBucket();
 113
 114     /**
 115      * Check if this bucket refers to a valid tile, or not.
 116      */
 117     bool isValid() const;
 118
 119 #ifndef NO_DEPRECATED_API
 120     /**
 121      * Construct a bucket given a specific location.
 122      * @param dlon longitude specified in degrees
 123      * @param dlat latitude specified in degrees
 124      */
 125     SGBucket(const double dlon, const double dlat);
 126 #endif
 127
 128     /**
 129      * Construct a bucket given a specific location.
 130      * @param dlon longitude specified in degrees
 131      * @param dlat latitude specified in degrees
 132      */
 133     SGBucket(const SGGeod& geod);
 134
 135     /** Construct a bucket given a unique bucket index number.
 136      * @param bindex unique bucket index
 137      */
 138     SGBucket(const long int bindex);
 139
 140 #ifndef NO_DEPRECATED_API
 141     /**
 142      * Reset a bucket to represent a new lat and lon
 143      * @param dlon longitude specified in degrees
 144      * @param dlat latitude specified in degrees
 145      */
 146     void set_bucket(const SGGeod& geod);
 147
 148
 149     /**
 150      * Reset a bucket to represent a new lat and lon
 151      * @param dlon longitude specified in degrees
 152      * @param dlat latitude specified in degrees
 153      */
 154     void set_bucket( double dlon, double dlat );
 155 #endif
 156
 157     /**
 158      * Create an impossible bucket.
 159      * This is useful if you are comparing cur_bucket to last_bucket
 160      * and you want to make sure last_bucket starts out as something
 161      * impossible.
 162      */
 163     void make_bad();
 164
 165     /**
 166      * Generate the unique scenery tile index for this bucket
 167      *
 168      * The index is constructed as follows:
 169      *
 170      * 9 bits - to represent 360 degrees of longitude (-180 to 179)
 171      * 8 bits - to represent 180 degrees of latitude (-90 to 89)
 172      *
 173      * Each 1 degree by 1 degree tile is further broken down into an 8x8
 174      * grid.  So we also need:
 175      *
 176      * 3 bits - to represent x (0 to 7)
 177      * 3 bits - to represent y (0 to 7)
 178      * @return tile index
 179      */
 180     inline long int gen_index() const {
 181         return ((lon + 180) << 14) + ((lat + 90) << 6) + (y << 3) + x;
 182     }
 183
 184     /**
 185      * Generate the unique scenery tile index for this bucket in ascii
 186      * string form.
 187      * @return tile index in string form
 188      */
 189     std::string gen_index_str() const;
 190
 191     /**
 192      * Build the base path name for this bucket.
 193      * @return base path in string form
 194      */
 195     std::string gen_base_path() const;
 196
 197     /**
 198      * @return the center lon of a tile.
 199      */
 200     inline double get_center_lon() const {
 201         double span = sg_bucket_span( lat + y / 8.0 + SG_HALF_BUCKET_SPAN );
 202
 203         if ( span >= 1.0 ) {
 204             return lon + get_width() / 2.0;
 205         } else {
 206             return lon + x * span + get_width() / 2.0;
 207         }
 208     }
 209
 210     /**
 211      * @return the center lat of a tile.
 212      */
 213     inline double get_center_lat() const {
 214         return lat + y / 8.0 + SG_HALF_BUCKET_SPAN;
 215     }
 216
 217     /**
 218      * @return the highest (furthest from the equator) latitude of this
 219      * tile. This is the top edge for tiles north of the equator, and
 220      * the bottom edge for tiles south
 221      */
 222     double get_highest_lat() const;
 223
 224     /**
 225      * @return the width of the tile in degrees.
 226      */
 227     double get_width() const;
 228
 229     /**
 230      * @return the height of the tile in degrees.
 231      */
 232     double get_height() const;
 233
 234     /**
 235      * @return the width of the tile in meters.
 236      */
 237     double get_width_m() const;
 238
 239     /**
 240      * @return the height of the tile in meters.
 241      */
 242     double get_height_m() const;
 243
 244     /**
 245      * @return the center of the bucket in geodetic coordinates.
 246      */
 247     SGGeod get_center() const
 248     { return SGGeod::fromDeg(get_center_lon(), get_center_lat()); }
 249
 250     /**
 251      * @return the center of the bucket in geodetic coordinates.
 252      */
 253     SGGeod get_corner(unsigned num) const
 254     {
 255         double lonFac = ((num + 1) & 2) ? 0.5 : -0.5;
 256         double latFac = ((num    ) & 2) ? 0.5 : -0.5;
 257         return SGGeod::fromDeg(get_center_lon() + lonFac*get_width(),
 258                                get_center_lat() + latFac*get_height());
 259     }
 260
 261     // Informational methods.
 262
 263     /**
 264      * @return the lon of the lower left corner of
 265      * the 1x1 chunk containing this tile.
 266      */
 267     inline int get_chunk_lon() const { return lon; }
 268
 269     /**
 270      * @return the lat of the lower left corner of
 271      * the 1x1 chunk containing this tile.
 272      */
 273     inline int get_chunk_lat() const { return lat; }
 274
 275     /**
 276      * @return the x coord within the 1x1 degree chunk this tile.
 277      */
 278     inline int get_x() const { return x; }
 279
 280     /**
 281      * @return the y coord within the 1x1 degree chunk this tile.
 282      */
 283     inline int get_y() const { return y; }
 284
 285     /**
 286      * @return bucket offset from this by dx,dy
 287      */
 288     SGBucket sibling(int dx, int dy) const;
 289
 290     // friends
 291
 292     friend std::ostream& operator<< ( std::ostream&, const SGBucket& );
 293     friend bool operator== ( const SGBucket&, const SGBucket& );
 294 };
 295
 296 inline bool operator!= (const SGBucket& lhs, const SGBucket& rhs)
 297     {
 298         return !(lhs == rhs);
 299     }
 300
 301 #ifndef NO_DEPRECATED_API
 302 /**
 303  * \relates SGBucket
 304  * Return the bucket which is offset from the specified dlon, dlat by
 305  * the specified tile units in the X & Y direction.
 306  * @param dlon starting lon in degrees
 307  * @param dlat starting lat in degrees
 308  * @param x number of bucket units to offset in x (lon) direction
 309  * @param y number of bucket units to offset in y (lat) direction
 310  * @return offset bucket
 311  */
 312 SGBucket sgBucketOffset( double dlon, double dlat, int x, int y );
 313 #endif
 314
 315
 316 /**
 317  * \relates SGBucket
 318  * Calculate the offset between two buckets (in quantity of buckets).
 319  * @param b1 bucket 1
 320  * @param b2 bucket 2
 321  * @param dx offset distance (lon) in tile units
 322  * @param dy offset distance (lat) in tile units
 323  */
 324 void sgBucketDiff( const SGBucket& b1, const SGBucket& b2, int *dx, int *dy );
 325
 326
 327 /**
 328  * \relates SGBucket
 329  * retrieve a list of buckets in the given bounding box
 330  * @param min min lon,lat of bounding box in degrees
 331  * @param max max lon,lat of bounding box in degrees
 332  * @param list standard vector of buckets within the bounding box
 333  */
 334 void sgGetBuckets( const SGGeod& min, const SGGeod& max, std::vector<SGBucket>& list );
 335
 336 /**
 337  * Write the bucket lon, lat, x, and y to the output stream.
 338  * @param out output stream
 339  * @param b bucket
 340  */
 341 std::ostream& operator<< ( std::ostream& out, const SGBucket& b );
 342
 343 /**
 344  * Compare two bucket structures for equality.
 345  * @param b1 bucket 1
 346  * @param b2 bucket 2
 347  * @return comparison result
 348  */
 349 inline bool
 350 operator== ( const SGBucket& b1, const SGBucket& b2 )
 351 {
 352     return ( b1.lon == b2.lon &&
 353              b1.lat == b2.lat &&
 354              b1.x == b2.x &&
 355              b1.y == b2.y );
 356 }
 357
 358
 359 #endif // _NEWBUCKET_HXX
 360
 361