Pileus Git - grits/blob - src/objects/grits-tile.c

   1 /*
   2  * Copyright (C) 2009-2010, 2012 Andy Spencer <andy753421@gmail.com>
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 /**
  19  * SECTION:grits-tile
  20  * @short_description: Latitude/longitude overlays
  21  *
  22  * Each #GritsTile corresponds to a latitude/longitude box on the surface of
  23  * the earth. When drawn, the #GritsTile renders an images associated with it
  24  * to the surface of the earth. This is primarily used to draw ground overlays.
  25  *
  26  * Each GritsTile can be split into subtiles in order to draw higher resolution
  27  * overlays. Pointers to subtitles are stored in the parent tile and a parent
  28  * pointer is stored in each child.
  29  *
  30  * Each #GritsTile has a data filed which must be set by the user in order for
  31  * the tile to be drawn. When used with GritsOpenGL the data must be an integer
  32  * representing the OpenGL texture to use when drawing the tile.
  33  */
  34
  35 #include <config.h>
  36 #include <math.h>
  37 #include "gtkgl.h"
  38 #include "grits-tile.h"
  39
  40 guint  grits_tile_mask = 0;
  41
  42 gchar *grits_tile_path_table[2][2] = {
  43         {"00.", "01."},
  44         {"10.", "11."},
  45 };
  46
  47 /**
  48  * grits_tile_new:
  49  * @parent: the parent for the tile, or NULL
  50  * @n:      the northern border of the tile
  51  * @s:      the southern border of the tile
  52  * @e:      the eastern border of the tile
  53  * @w:      the western border of the tile
  54  *
  55  * Create a tile associated with a particular latitude/longitude box.
  56  *
  57  * Returns: the new #GritsTile
  58  */
  59 GritsTile *grits_tile_new(GritsTile *parent,
  60         gdouble n, gdouble s, gdouble e, gdouble w)
  61 {
  62         GritsTile *tile = g_object_new(GRITS_TYPE_TILE, NULL);
  63         tile->parent = parent;
  64         tile->atime  = time(NULL);
  65         grits_bounds_set_bounds(&tile->coords, 0, 1, 1, 0);
  66         grits_bounds_set_bounds(&tile->edge, n, s, e, w);
  67         if (parent) {
  68                 tile->proj   = parent->proj;
  69                 tile->zindex = parent->zindex+1;
  70         }
  71         return tile;
  72 }
  73
  74 /**
  75  * grits_tile_get_path:
  76  * @child: the tile to generate a path for
  77  *
  78  * Generate a string representation of a tiles location in a group of nested
  79  * tiles. The string returned consists of groups of two digits separated by a
  80  * delimiter. Each group of digits the tiles location with respect to it's
  81  * parent tile.
  82  *
  83  * Returns: the path representing the tiles's location
  84  */
  85 gchar *grits_tile_get_path(GritsTile *child)
  86 {
  87         /* This could be easily cached if necessary */
  88         int x, y;
  89         GList *parts = NULL;
  90         for (GritsTile *parent = child->parent; parent; child = parent, parent = child->parent)
  91                 grits_tile_foreach_index(child, x, y)
  92                         if (parent->children[x][y] == child)
  93                                 parts = g_list_prepend(parts, grits_tile_path_table[x][y]);
  94         GString *path = g_string_new("");
  95         for (GList *cur = parts; cur; cur = cur->next)
  96                 g_string_append(path, cur->data);
  97         g_list_free(parts);
  98         return g_string_free(path, FALSE);
  99 }
 100
 101 static gdouble _grits_tile_get_min_dist(GritsPoint *eye, GritsBounds *bounds)
 102 {
 103         GritsPoint pos = {};
 104         pos.lat = eye->lat > bounds->n ? bounds->n :
 105                   eye->lat < bounds->s ? bounds->s : eye->lat;
 106         pos.lon = eye->lon > bounds->e ? bounds->e :
 107                   eye->lon < bounds->w ? bounds->w : eye->lon;
 108         //if (eye->lat == pos.lat && eye->lon == pos.lon)
 109         //      return elev; /* Shortcut? */
 110         gdouble a[3], b[3];
 111         lle2xyz(eye->lat, eye->lon, eye->elev, a+0, a+1, a+2);
 112         lle2xyz(pos.lat,  pos.lon,  pos.elev,  b+0, b+1, b+2);
 113         return distd(a, b);
 114 }
 115
 116 static gboolean _grits_tile_precise(GritsPoint *eye, GritsBounds *bounds,
 117                 gdouble max_res, gint width, gint height)
 118 {
 119         gdouble min_dist  = _grits_tile_get_min_dist(eye, bounds);
 120         gdouble view_res  = MPPX(min_dist);
 121
 122         gdouble lat_point = bounds->n < 0 ? bounds->n :
 123                             bounds->s > 0 ? bounds->s : 0;
 124         gdouble lon_dist  = bounds->e - bounds->w;
 125         gdouble tile_res  = ll2m(lon_dist, lat_point)/width;
 126
 127         /* This isn't really right, but it helps with memory since we don't
 128          * (yet?) test if the tile would be drawn */
 129         gdouble scale = eye->elev / min_dist;
 130         view_res /= scale;
 131         view_res *= 1.8;
 132         //view_res /= 1.4; /* make it a little nicer, not sure why this is needed */
 133         //g_message("tile=(%7.2f %7.2f %7.2f %7.2f) "
 134         //          "eye=(%9.1f %9.1f %9.1f) "
 135         //          "elev=%9.1f / dist=%9.1f = %f",
 136         //              bounds->n, bounds->s, bounds->e, bounds->w,
 137         //              eye->lat, eye->lon, eye->elev,
 138         //              eye->elev, min_dist, scale);
 139
 140         return tile_res < max_res ||
 141                tile_res < view_res;
 142 }
 143
 144 static void _grits_tile_split_latlon(GritsTile *tile)
 145 {
 146         //g_debug("GritsTile: split - %p", tile);
 147         const gdouble rows = G_N_ELEMENTS(tile->children);
 148         const gdouble cols = G_N_ELEMENTS(tile->children[0]);
 149         const gdouble lat_dist = tile->edge.n - tile->edge.s;
 150         const gdouble lon_dist = tile->edge.e - tile->edge.w;
 151         const gdouble lat_step = lat_dist / rows;
 152         const gdouble lon_step = lon_dist / cols;
 153
 154         int row, col;
 155         grits_tile_foreach_index(tile, row, col) {
 156                 if (!tile->children[row][col])
 157                         tile->children[row][col] =
 158                                 grits_tile_new(tile, 0, 0, 0, 0);
 159                 /* Set edges aferwards so that north and south
 160                  * get reset for mercator projections */
 161                 GritsTile *child = tile->children[row][col];
 162                 child->edge.n = tile->edge.n - lat_step*(row+0);
 163                 child->edge.s = tile->edge.n - lat_step*(row+1);
 164                 child->edge.e = tile->edge.w + lon_step*(col+1);
 165                 child->edge.w = tile->edge.w + lon_step*(col+0);
 166         }
 167 }
 168
 169 static void _grits_tile_split_mercator(GritsTile *tile)
 170 {
 171         GritsTile *child = NULL;
 172         GritsBounds tmp = tile->edge;
 173
 174         /* Project */
 175         tile->edge.n = asinh(tan(deg2rad(tile->edge.n)));
 176         tile->edge.s = asinh(tan(deg2rad(tile->edge.s)));
 177
 178         _grits_tile_split_latlon(tile);
 179
 180         /* Convert back to lat-lon */
 181         tile->edge = tmp;
 182         grits_tile_foreach(tile, child) {
 183                 child->edge.n = rad2deg(atan(sinh(child->edge.n)));
 184                 child->edge.s = rad2deg(atan(sinh(child->edge.s)));
 185         }
 186 }
 187
 188 /**
 189  * grits_tile_update:
 190  * @root:      the root tile to split
 191  * @eye:       the point the tile is viewed from, for calculating distances
 192  * @res:       a maximum resolution in meters per pixel to split tiles to
 193  * @width:     width in pixels of the image associated with the tile
 194  * @height:    height in pixels of the image associated with the tile
 195  * @load_func: function used to load the image when a new tile is created
 196  * @user_data: user data to past to the load function
 197  *
 198  * Recursively split a tile into children of appropriate detail. The resolution
 199  * of the tile in pixels per meter is compared to the resolution which the tile
 200  * is being drawn at on the screen. If the screen resolution is insufficient
 201  * the tile is recursively subdivided until a sufficient resolution is
 202  * achieved.
 203  */
 204 void grits_tile_update(GritsTile *tile, GritsPoint *eye,
 205                 gdouble res, gint width, gint height,
 206                 GritsTileLoadFunc load_func, gpointer user_data)
 207 {
 208         GritsTile *child;
 209
 210         if (tile == NULL)
 211                 return;
 212
 213         //g_debug("GritsTile: update - %p->atime = %u",
 214         //              tile, (guint)tile->atime);
 215
 216         /* Is the parent tile's texture high enough
 217          * resolution for this part? */
 218         gint xs = G_N_ELEMENTS(tile->children);
 219         gint ys = G_N_ELEMENTS(tile->children[0]);
 220         if (_grits_tile_precise(eye, &tile->edge, res, width/xs, height/ys)) {
 221                 GRITS_OBJECT(tile)->hidden = TRUE;
 222                 return;
 223         }
 224
 225         /* Load the tile */
 226         if (!tile->load && !tile->data)
 227                 load_func(tile, user_data);
 228         tile->atime = time(NULL);
 229         tile->load  = TRUE;
 230         GRITS_OBJECT(tile)->hidden = FALSE;
 231
 232         /* Split tile if needed */
 233         grits_tile_foreach(tile, child) {
 234                 if (child == NULL) {
 235                         switch (tile->proj) {
 236                         case GRITS_PROJ_LATLON:   _grits_tile_split_latlon(tile);   break;
 237                         case GRITS_PROJ_MERCATOR: _grits_tile_split_mercator(tile); break;
 238                         }
 239                 }
 240         }
 241
 242         /* Update recursively */
 243         grits_tile_foreach(tile, child)
 244                 grits_tile_update(child, eye, res, width, height,
 245                                 load_func, user_data);
 246 }
 247
 248 /**
 249  * grits_tile_find:
 250  * @root: the root tile to search from
 251  * @lat:  target latitude
 252  * @lon:  target longitude
 253  *
 254  * Locate the subtile with the highest resolution which contains the given
 255  * lat/lon point.
 256  *
 257  * Returns: the child tile
 258  */
 259 GritsTile *grits_tile_find(GritsTile *root, gdouble lat, gdouble lon)
 260 {
 261         gint    rows = G_N_ELEMENTS(root->children);
 262         gint    cols = G_N_ELEMENTS(root->children[0]);
 263
 264         gdouble lat_step = (root->edge.n - root->edge.s) / rows;
 265         gdouble lon_step = (root->edge.e - root->edge.w) / cols;
 266
 267         gdouble lat_offset = root->edge.n - lat;;
 268         gdouble lon_offset = lon - root->edge.w;
 269
 270         gint    row = lat_offset / lat_step;
 271         gint    col = lon_offset / lon_step;
 272
 273         if (lon == 180) col--;
 274         if (lat == -90) row--;
 275
 276         //if (lon == 180 || lon == -180)
 277         //      g_message("lat=%f,lon=%f step=%f,%f off=%f,%f row=%d/%d,col=%d/%d",
 278         //              lat,lon, lat_step,lon_step, lat_offset,lon_offset, row,rows,col,cols);
 279
 280         if (row < 0 || row >= rows || col < 0 || col >= cols)
 281                 return NULL;
 282         else if (root->children[row][col] && root->children[row][col]->data)
 283                 return grits_tile_find(root->children[row][col], lat, lon);
 284         else
 285                 return root;
 286 }
 287
 288 /**
 289  * grits_tile_gc:
 290  * @root:      the root tile to start garbage collection at
 291  * @atime:     most recent time at which tiles will be kept
 292  * @free_func: function used to free the image when a new tile is collected
 293  * @user_data: user data to past to the free function
 294  *
 295  * Garbage collect old tiles. This removes and deallocate tiles that have not
 296  * been used since before @atime.
 297  *
 298  * Returns: a pointer to the original tile, or NULL if it was garbage collected
 299  */
 300 GritsTile *grits_tile_gc(GritsTile *root, time_t atime,
 301                 GritsTileFreeFunc free_func, gpointer user_data)
 302 {
 303         if (!root)
 304                 return NULL;
 305         gboolean has_children = FALSE;
 306         int x, y;
 307         grits_tile_foreach_index(root, x, y) {
 308                 root->children[x][y] = grits_tile_gc(
 309                                 root->children[x][y], atime,
 310                                 free_func, user_data);
 311                 if (root->children[x][y])
 312                         has_children = TRUE;
 313         }
 314         //g_debug("GritsTile: gc - %p->atime=%u < atime=%u",
 315         //              root, (guint)root->atime, (guint)atime);
 316         if (!has_children && root->atime < atime &&
 317                         (root->data || !root->load)) {
 318                 //g_debug("GritsTile: gc/free - %p", root);
 319                 if (root->data)
 320                         free_func(root, user_data);
 321                 g_object_unref(root);
 322                 return NULL;
 323         }
 324         return root;
 325 }
 326
 327 /* Use GObject for this */
 328 /**
 329  * grits_tile_free:
 330  * @root:      the root tile to free
 331  * @free_func: function used to free the image when a new tile is collected
 332  * @user_data: user data to past to the free function
 333  *
 334  * Recursively free a tile and all it's children.
 335  */
 336 void grits_tile_free(GritsTile *root, GritsTileFreeFunc free_func, gpointer user_data)
 337 {
 338         if (!root)
 339                 return;
 340         GritsTile *child;
 341         grits_tile_foreach(root, child)
 342                 grits_tile_free(child, free_func, user_data);
 343         if (free_func)
 344                 free_func(root, user_data);
 345         g_object_unref(root);
 346 }
 347
 348 /* Load texture mask so we can draw a texture to just a part of a triangle */
 349 static guint _grits_tile_load_mask(void)
 350 {
 351         guint  tex;
 352         guint8 byte = 0xff;
 353         glGenTextures(1, &tex);
 354         glBindTexture(GL_TEXTURE_2D, tex);
 355
 356         glTexImage2D(GL_TEXTURE_2D, 0, GL_ALPHA, 1, 1, 0,
 357                         GL_ALPHA, GL_UNSIGNED_BYTE, &byte);
 358
 359         glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MAG_FILTER, GL_NEAREST);
 360         glTexParameterf(GL_TEXTURE_2D, GL_TEXTURE_MIN_FILTER, GL_NEAREST);
 361
 362         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_S, GL_CLAMP_TO_BORDER);
 363         glTexParameteri(GL_TEXTURE_2D, GL_TEXTURE_WRAP_T, GL_CLAMP_TO_BORDER);
 364         return tex;
 365 }
 366
 367 /* Draw a single tile */
 368 static void grits_tile_draw_one(GritsTile *tile, GritsOpenGL *opengl, GList *triangles)
 369 {
 370         if (!tile || !tile->data)
 371                 return;
 372         if (!triangles)
 373                 g_warning("GritsOpenGL: _draw_tiles - No triangles to draw: edges=%f,%f,%f,%f",
 374                         tile->edge.n, tile->edge.s, tile->edge.e, tile->edge.w);
 375
 376         //g_message("drawing %4d triangles for tile edges=%7.2f,%7.2f,%7.2f,%7.2f",
 377         //              g_list_length(triangles), tile->edge.n, tile->edge.s, tile->edge.e, tile->edge.w);
 378         tile->atime = time(NULL);
 379
 380         gdouble n = tile->edge.n;
 381         gdouble s = tile->edge.s;
 382         gdouble e = tile->edge.e;
 383         gdouble w = tile->edge.w;
 384
 385         gdouble londist = e - w;
 386         gdouble latdist = n - s;
 387
 388         gdouble xscale = tile->coords.e - tile->coords.w;
 389         gdouble yscale = tile->coords.s - tile->coords.n;
 390
 391         glPolygonOffset(0, -tile->zindex);
 392
 393         for (GList *cur = triangles; cur; cur = cur->next) {
 394                 RoamTriangle *tri = cur->data;
 395
 396                 gdouble lat[3] = {tri->p.r->lat, tri->p.m->lat, tri->p.l->lat};
 397                 gdouble lon[3] = {tri->p.r->lon, tri->p.m->lon, tri->p.l->lon};
 398
 399                 if (lon[0] < -90 || lon[1] < -90 || lon[2] < -90) {
 400                         if (lon[0] > 90) lon[0] -= 360;
 401                         if (lon[1] > 90) lon[1] -= 360;
 402                         if (lon[2] > 90) lon[2] -= 360;
 403                 }
 404
 405                 gdouble xy[3][2] = {
 406                         {(lon[0]-w)/londist, 1-(lat[0]-s)/latdist},
 407                         {(lon[1]-w)/londist, 1-(lat[1]-s)/latdist},
 408                         {(lon[2]-w)/londist, 1-(lat[2]-s)/latdist},
 409                 };
 410
 411                 //if ((lat[0] == 90 && (xy[0][0] < 0 || xy[0][0] > 1)) ||
 412                 //    (lat[1] == 90 && (xy[1][0] < 0 || xy[1][0] > 1)) ||
 413                 //    (lat[2] == 90 && (xy[2][0] < 0 || xy[2][0] > 1)))
 414                 //      g_message("w,e=%4.f,%4.f   "
 415                 //                "lat,lon,x,y="
 416                 //                "%4.1f,%4.0f,%4.2f,%4.2f   "
 417                 //                "%4.1f,%4.0f,%4.2f,%4.2f   "
 418                 //                "%4.1f,%4.0f,%4.2f,%4.2f   ",
 419                 //              w,e,
 420                 //              lat[0], lon[0], xy[0][0], xy[0][1],
 421                 //              lat[1], lon[1], xy[1][0], xy[1][1],
 422                 //              lat[2], lon[2], xy[2][0], xy[2][1]);
 423
 424                 /* Fix poles */
 425                 if (lat[0] == 90 || lat[0] == -90) xy[0][0] = 0.5;
 426                 if (lat[1] == 90 || lat[1] == -90) xy[1][0] = 0.5;
 427                 if (lat[2] == 90 || lat[2] == -90) xy[2][0] = 0.5;
 428
 429                 /* Scale to tile coords */
 430                 for (int i = 0; i < 3; i++) {
 431                         xy[i][0] = tile->coords.w + xy[i][0]*xscale;
 432                         xy[i][1] = tile->coords.n + xy[i][1]*yscale;
 433                 }
 434
 435                 /* Draw triangle */
 436                 glBindTexture(GL_TEXTURE_2D, *(guint*)tile->data);
 437                 glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
 438                 glBegin(GL_TRIANGLES);
 439                 glNormal3dv(tri->p.r->norm); glMultiTexCoord2dv(GL_TEXTURE0, xy[0]); glMultiTexCoord2dv(GL_TEXTURE1, xy[0]); glVertex3dv((double*)tri->p.r);
 440                 glNormal3dv(tri->p.m->norm); glMultiTexCoord2dv(GL_TEXTURE0, xy[1]); glMultiTexCoord2dv(GL_TEXTURE1, xy[1]); glVertex3dv((double*)tri->p.m);
 441                 glNormal3dv(tri->p.l->norm); glMultiTexCoord2dv(GL_TEXTURE0, xy[2]); glMultiTexCoord2dv(GL_TEXTURE1, xy[2]); glVertex3dv((double*)tri->p.l);
 442                 glEnd();
 443         }
 444 }
 445
 446 /* Draw the tile */
 447 static gboolean grits_tile_draw_rec(GritsTile *tile, GritsOpenGL *opengl)
 448 {
 449         //g_debug("GritsTile: draw_rec - tile=%p, data=%d, load=%d, hide=%d", tile,
 450         //              tile ? !!tile->data : 0,
 451         //              tile ? !!tile->load : 0,
 452         //              tile ? !!GRITS_OBJECT(tile)->hidden : 0);
 453
 454         if (!tile || !tile->data || GRITS_OBJECT(tile)->hidden)
 455                 return FALSE;
 456
 457         GritsTile *child = NULL;
 458         gboolean   done  = FALSE;
 459         while (!done) {
 460                 /* Only draw children if possible */
 461                 gboolean draw_parent = FALSE;
 462                 grits_tile_foreach(tile, child)
 463                         if (!child || !child->data || GRITS_OBJECT(child)->hidden)
 464                                 draw_parent = TRUE;
 465
 466                 /* Draw parent tile underneath */
 467                 if (draw_parent) {
 468                         GList *triangles = roam_sphere_get_intersect(opengl->sphere, FALSE,
 469                                         tile->edge.n, tile->edge.s, tile->edge.e, tile->edge.w);
 470                         grits_tile_draw_one(tile, opengl, triangles);
 471                         g_list_free(triangles);
 472                 }
 473
 474                 /* Draw child tiles */
 475                 gboolean drew_all_children = TRUE;
 476                 grits_tile_foreach(tile, child)
 477                         if (!grits_tile_draw_rec(child, opengl))
 478                                 drew_all_children = FALSE;
 479
 480                 /* Check if tiles were hidden by a thread while drawing */
 481                 done = draw_parent || drew_all_children;
 482         }
 483         return TRUE;
 484 }
 485
 486 static void grits_tile_draw(GritsObject *tile, GritsOpenGL *opengl)
 487 {
 488         glEnable(GL_DEPTH_TEST);
 489         glDepthFunc(GL_LESS);
 490         glEnable(GL_ALPHA_TEST);
 491         glAlphaFunc(GL_GREATER, 0.1);
 492         glEnable(GL_POLYGON_OFFSET_FILL);
 493         glEnable(GL_BLEND);
 494
 495         /* Setup texture mask */
 496         if (!grits_tile_mask)
 497                 grits_tile_mask = _grits_tile_load_mask();
 498         glActiveTexture(GL_TEXTURE1);
 499         glEnable(GL_TEXTURE_2D);
 500         glBindTexture(GL_TEXTURE_2D, grits_tile_mask);
 501         glTexEnvi(GL_TEXTURE_ENV, GL_TEXTURE_ENV_MODE, GL_MODULATE);
 502
 503         /* Setup texture */
 504         glActiveTexture(GL_TEXTURE0);
 505         glEnable(GL_TEXTURE_2D);
 506
 507         /* Hack to show maps tiles with better color */
 508         if (GRITS_TILE(tile)->proj == GRITS_PROJ_MERCATOR) {
 509                 float material_emission[] = {0.5, 0.5, 0.5, 1.0};
 510                 glMaterialfv(GL_FRONT_AND_BACK, GL_EMISSION, material_emission);
 511         }
 512
 513         /* Draw all tiles */
 514         grits_tile_draw_rec(GRITS_TILE(tile), opengl);
 515
 516         /* Disable texture mask */
 517         glActiveTexture(GL_TEXTURE1);
 518         glDisable(GL_TEXTURE_2D);
 519         glActiveTexture(GL_TEXTURE0);
 520 }
 521
 522
 523 /* GObject code */
 524 G_DEFINE_TYPE(GritsTile, grits_tile, GRITS_TYPE_OBJECT);
 525 static void grits_tile_init(GritsTile *tile)
 526 {
 527 }
 528
 529 static void grits_tile_class_init(GritsTileClass *klass)
 530 {
 531         g_debug("GritsTile: class_init");
 532         GritsObjectClass *object_class = GRITS_OBJECT_CLASS(klass);
 533         object_class->draw = grits_tile_draw;
 534 }