Pileus Git - grits/blob - src/objects/gis-tile.h

   1 /*
   2  * Copyright (C) 2009-2010 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 #ifndef __GIS_TILE_H__
  19 #define __GIS_TILE_H__
  20
  21 #include <glib.h>
  22 #include <glib-object.h>
  23 #include "gis-object.h"
  24
  25 #define GIS_TYPE_TILE            (gis_tile_get_type())
  26 #define GIS_TILE(obj)            (G_TYPE_CHECK_INSTANCE_CAST((obj),   GIS_TYPE_TILE, GisTile))
  27 #define GIS_IS_TILE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE((obj),   GIS_TYPE_TILE))
  28 #define GIS_TILE_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST   ((klass), GIS_TYPE_TILE, GisTileClass))
  29 #define GIS_IS_TILE_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE   ((klass), GIS_TYPE_TILE))
  30 #define GIS_TILE_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj),   GIS_TYPE_TILE, GisTileClass))
  31
  32 typedef struct _GisTile      GisTile;
  33 typedef struct _GisTileClass GisTileClass;
  34
  35 struct _GisTile {
  36         GisObject  parent_instance;
  37
  38         /* Pointer to the tile data */
  39         gpointer data;
  40
  41         /* North,South,East,West limits */
  42         struct {
  43                 gdouble n,s,e,w;
  44         } edge;
  45
  46         /* Pointers to parent/child nodes */
  47         GisTile *parent;
  48         GisTile *children[2][2];
  49
  50         /* Last access time (for garbage collection) */
  51         time_t atime;
  52 };
  53
  54 struct _GisTileClass {
  55         GisObjectClass parent_class;
  56 };
  57
  58 /**
  59  * GisTileLoadFunc:
  60  * @tile:      the tile to load
  61  * @user_data: data paseed to the function
  62  *
  63  * Used to load the image data associated with a tile. For GisOpenGL, this
  64  * function should store the OpenGL texture number in the tiles data field.
  65  */
  66 typedef void (*GisTileLoadFunc)(GisTile *tile, gpointer user_data);
  67
  68 /**
  69  * GisTileFreeFunc:
  70  * @tile:      the tile to free
  71  * @user_data: data paseed to the function
  72  *
  73  * Used to free the image data associated with a tile
  74  */
  75 typedef void (*GisTileFreeFunc)(GisTile *tile, gpointer user_data);
  76
  77 /* Forech functions */
  78 /**
  79  * gis_tile_foreach:
  80  * @parent: the #GisTile to iterate over
  81  * @child:  a pointer to a #GisTile to store the current subtile
  82  *
  83  * Iterate over each imediate subtile of @parent.
  84  */
  85 #define gis_tile_foreach(parent, child) \
  86         for (int _x = 0; _x < G_N_ELEMENTS(parent->children); _x++) \
  87         for (int _y = 0; child = parent->children[_x][_y], \
  88                 _y < G_N_ELEMENTS(parent->children[_x]); _y++)
  89
  90 /**
  91  * gis_tile_foreach_index:
  92  * @parent: the #GisTile to iterate over
  93  * @x:      integer to store the x index of the current subtile
  94  * @y:      integer to store the y index of the current subtile
  95  *
  96  * Iterate over each imediate subtile of @parent.
  97  */
  98 #define gis_tile_foreach_index(parent, x, y) \
  99         for (x = 0; x < G_N_ELEMENTS(parent->children); x++) \
 100         for (y = 0; y < G_N_ELEMENTS(parent->children[x]); y++)
 101
 102 /* Path to string table, keep in sync with tile->children */
 103 extern gchar *gis_tile_path_table[2][2];
 104
 105 GType gis_tile_get_type(void);
 106
 107 /* Allocate a new Tile */
 108 GisTile *gis_tile_new(GisTile *parent,
 109         gdouble n, gdouble s, gdouble e, gdouble w);
 110
 111 /* Return a string representation of the tile's path */
 112 gchar *gis_tile_get_path(GisTile *child);
 113
 114 /* Update a root tile */
 115 /* Based on eye distance (lat,lon,elev) */
 116 void gis_tile_update(GisTile *root,
 117                 gdouble res, gint width, gint height,
 118                 gdouble lat, gdouble lon, gdouble elev,
 119                 GisTileLoadFunc load_func, gpointer user_data);
 120
 121 /* Find the leaf tile containing lat-lon */
 122 GisTile *gis_tile_find(GisTile *root, gdouble lat, gdouble lon);
 123
 124 /* Delete nodes that haven't been accessed since atime */
 125 GisTile *gis_tile_gc(GisTile *root, time_t atime,
 126                 GisTileFreeFunc free_func, gpointer user_data);
 127
 128 /* Free a tile and all it's children */
 129 void gis_tile_free(GisTile *root,
 130                 GisTileFreeFunc free_func, gpointer user_data);
 131
 132 #endif