X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=simgear%2Fbucket%2Fnewbucket.hxx;h=2ba7de551e669d4a0da76fa0f5c901cf5265b8b4;hb=dcb95d131bc6aef1abe25d1f415e309f06e52436;hp=8e27579f7c7a50feee374f5c8308367ddd62f8b9;hpb=a09806bb984b32607614df92dd430494d7af05de;p=simgear.git diff --git a/simgear/bucket/newbucket.hxx b/simgear/bucket/newbucket.hxx index 8e27579f..2ba7de55 100644 --- a/simgear/bucket/newbucket.hxx +++ b/simgear/bucket/newbucket.hxx @@ -3,7 +3,7 @@ * * Written by Curtis L. Olson, started February 1999. * - * Copyright (C) 1999 Curtis L. Olson - curt@flightgear.org + * Copyright (C) 1999 Curtis L. Olson - http://www.flightgear.org/~curt * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Library General Public @@ -15,14 +15,16 @@ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Library General Public License for more details. * - * You should have received a copy of the GNU Library General Public - * License along with this library; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place - Suite 330, - * Boston, MA 02111-1307, USA. + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software + * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. * * $Id$ **************************************************************************/ +/** \file newbucket.hxx + * A class and associated utiltity functions to manage world scenery tiling. + */ #ifndef _NEWBUCKET_HXX #define _NEWBUCKET_HXX @@ -30,43 +32,43 @@ #include #include -#ifdef FG_HAVE_STD_INCLUDES +#ifdef SG_HAVE_STD_INCLUDES # include # include // sprintf() -# include #else # include # include // sprintf() -# include #endif +#include STL_IOSTREAM + // I don't understand ... or should be included -// already depending on how you defined FG_HAVE_STD_INCLUDES, but I +// already depending on how you defined SG_HAVE_STD_INCLUDES, but I // can go ahead and add this -- CLO #ifdef __MWERKS__ -# include // needed fabs() +SG_USING_STD(sprintf); +SG_USING_STD(fabs); #endif #include STL_STRING -FG_USING_STD(string); - -#if ! defined( FG_HAVE_NATIVE_SGI_COMPILERS ) -FG_USING_STD(ostream); -#endif - +SG_USING_STD(string); +SG_USING_STD(ostream); -#define SG_BUCKET_SPAN 0.125 // 1/8 of a degree -#define SG_HALF_BUCKET_SPAN 0.0625 // 1/2 of 1/8 of a degree = 1/16 = 0.0625 +/** + * standard size of a bucket in degrees (1/8 of a degree) + */ +#define SG_BUCKET_SPAN 0.125 -class SGBucket; -ostream& operator<< ( ostream&, const SGBucket& ); -bool operator== ( const SGBucket&, const SGBucket& ); +/** + * half of a standard SG_BUCKET_SPAN + */ +#define SG_HALF_BUCKET_SPAN ( 0.5 * SG_BUCKET_SPAN ) // return the horizontal tile span factor based on latitude -inline double sg_bucket_span( double l ) { +static double sg_bucket_span( double l ) { if ( l >= 89.0 ) { return 360.0; } else if ( l >= 88.0 ) { @@ -101,70 +103,119 @@ inline double sg_bucket_span( double l ) { } +/** + * A class to manage world scenery tiling. + * This class encapsulates the world tiling scheme. It provides ways + * to calculate a unique tile index from a lat/lon, and it can provide + * information such as the dimensions of a given tile. + */ + class SGBucket { private: double cx, cy; // centerpoint (lon, lat) in degrees of bucket - int lon; // longitude index (-180 to 179) - int lat; // latitude index (-90 to 89) - int x; // x subdivision (0 to 7) - int y; // y subdivision (0 to 7) + short lon; // longitude index (-180 to 179) + short lat; // latitude index (-90 to 89) + char x; // x subdivision (0 to 7) + char y; // y subdivision (0 to 7) public: - // default constructor - inline SGBucket(); - - // constructor for specified location - inline SGBucket(const double dlon, const double dlat); - - // create an impossible bucket if false - inline SGBucket(const bool is_good); - - // Parse a unique scenery tile index and find the lon, lat, x, and y - inline SGBucket(const long int bindex); - - // default destructor - inline ~SGBucket(); - - // Set the bucket params for the specified lat and lon + /** + * Default constructor. + */ + SGBucket(); + + /** + * Construct a bucket given a specific location. + * @param dlon longitude specified in degrees + * @param dlat latitude specified in degrees + */ + SGBucket(const double dlon, const double dlat); + + /** Construct a bucket. + * @param is_good if false, create an invalid bucket. This is + * useful * if you are comparing cur_bucket to last_bucket and + * you want to * make sure last_bucket starts out as something + * impossible. + */ + SGBucket(const bool is_good); + + /** Construct a bucket given a unique bucket index number. + * @param bindex unique bucket index + */ + SGBucket(const long int bindex); + + /** + * Default destructor. + */ + ~SGBucket(); + + /** + * Reset a bucket to represent a new lat and lon + * @param dlon longitude specified in degrees + * @param dlat latitude specified in degrees + */ void set_bucket( double dlon, double dlat ); + + /** + * Reset a bucket to represent a new lat and lon + * @param lonlat an array of double[2] holding lon and lat + * (specified) in degrees + */ void set_bucket( double *lonlat ); - // create an impossible bucket - inline void SGBucket::make_bad( void ) { + /** + * Create an impossible bucket. + * This is useful if you are comparing cur_bucket to last_bucket + * and you want to make sure last_bucket starts out as something + * impossible. + */ + inline void make_bad() { set_bucket(0.0, 0.0); lon = -1000; } - // Generate the unique scenery tile index for this bucket - // - // The index is constructed as follows: - // - // 9 bits - to represent 360 degrees of longitude (-180 to 179) - // 8 bits - to represent 180 degrees of latitude (-90 to 89) - // - // Each 1 degree by 1 degree tile is further broken down into an 8x8 - // grid. So we also need: - // - // 3 bits - to represent x (0 to 7) - // 3 bits - to represent y (0 to 7) - + /** + * Generate the unique scenery tile index for this bucket + * + * The index is constructed as follows: + * + * 9 bits - to represent 360 degrees of longitude (-180 to 179) + * 8 bits - to represent 180 degrees of latitude (-90 to 89) + * + * Each 1 degree by 1 degree tile is further broken down into an 8x8 + * grid. So we also need: + * + * 3 bits - to represent x (0 to 7) + * 3 bits - to represent y (0 to 7) + * @return tile index + */ inline long int gen_index() const { return ((lon + 180) << 14) + ((lat + 90) << 6) + (y << 3) + x; } + /** + * Generate the unique scenery tile index for this bucket in ascii + * string form. + * @return tile index in string form + */ inline string gen_index_str() const { char tmp[20]; sprintf(tmp, "%ld", - (((long)lon + 180) << 14) + ((lat + 90) << 6) + (y << 3) + x); + (((long)lon + 180) << 14) + ((lat + 90) << 6) + (y << 3) + x); return (string)tmp; } - // Build the path name for this bucket + /** + * Build the base path name for this bucket. + * @return base path in string form + */ string gen_base_path() const; - // return the center lon of a tile + /** + * @return the center lon of a tile. + */ inline double get_center_lon() const { double span = sg_bucket_span( lat + y / 8.0 + SG_HALF_BUCKET_SPAN ); @@ -175,42 +226,93 @@ public: } } - // return the center lat of a tile + /** + * @return the center lat of a tile. + */ inline double get_center_lat() const { return lat + y / 8.0 + SG_HALF_BUCKET_SPAN; } - // return width of the tile in degrees + /** + * @return the width of the tile in degrees. + */ double get_width() const; - // return height of the tile in degrees + + /** + * @return the height of the tile in degrees. + */ double get_height() const; - // return width of the tile in meters + /** + * @return the width of the tile in meters. + */ double get_width_m() const; - // return height of the tile in meters + + /** + * @return the height of the tile in meters. + */ double get_height_m() const; - // Informational methods - inline int get_lon() const { return lon; } - inline int get_lat() const { return lat; } + // Informational methods. + + /** + * @return the lon of the lower left corner of + * the 1x1 chunk containing this tile. + */ + inline int get_chunk_lon() const { return lon; } + + /** + * @return the lat of the lower left corner of + * the 1x1 chunk containing this tile. + */ + inline int get_chunk_lat() const { return lat; } + + /** + * @return the x coord within the 1x1 degree chunk this tile. + */ inline int get_x() const { return x; } + + /** + * @return the y coord within the 1x1 degree chunk this tile. + */ inline int get_y() const { return y; } // friends + friend ostream& operator<< ( ostream&, const SGBucket& ); friend bool operator== ( const SGBucket&, const SGBucket& ); }; -// offset a bucket specified by dlon, dlat by the specified tile units -// in the X & Y direction +/** + * \relates SGBucket + * Return the bucket which is offset from the specified dlon, dlat by + * the specified tile units in the X & Y direction. + * @param dlon starting lon in degrees + * @param dlat starting lat in degrees + * @param x number of bucket units to offset in x (lon) direction + * @param y number of bucket units to offset in y (lat) direction + * @return offset bucket + */ SGBucket sgBucketOffset( double dlon, double dlat, int x, int y ); -// calculate the offset between two buckets +/** + * \relates SGBucket + * Calculate the offset between two buckets (in quantity of buckets). + * @param b1 bucket 1 + * @param b2 bucket 2 + * @param dx offset distance (lon) in tile units + * @param dy offset distance (lat) in tile units + */ void sgBucketDiff( const SGBucket& b1, const SGBucket& b2, int *dx, int *dy ); +/** + * Write the bucket lon, lat, x, and y to the output stream. + * @param out output stream + * @param b bucket + */ inline ostream& operator<< ( ostream& out, const SGBucket& b ) { @@ -218,6 +320,12 @@ operator<< ( ostream& out, const SGBucket& b ) } +/** + * Compare two bucket structures for equality. + * @param b1 bucket 1 + * @param b2 bucket 2 + * @return comparison result + */ inline bool operator== ( const SGBucket& b1, const SGBucket& b2 ) {