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