2 * Copyright (C) 2009-2010 Andy Spencer <andy753421@gmail.com>
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.
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.
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/>.
18 #ifndef __GIS_TILE_H__
19 #define __GIS_TILE_H__
22 #include <glib-object.h>
23 #include "gis-object.h"
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))
32 typedef struct _GisTile GisTile;
33 typedef struct _GisTileClass GisTileClass;
36 GisObject parent_instance;
38 /* Pointer to the tile data */
41 /* North,South,East,West limits */
44 /* Pointers to parent/child nodes */
46 GisTile *children[2][2];
48 /* Last access time (for garbage collection) */
52 struct _GisTileClass {
53 GisObjectClass parent_class;
58 * @tile: the tile to load
59 * @user_data: data paseed to the function
61 * Used to load the image data associated with a tile. For GisOpenGL, this
62 * function should store the OpenGL texture number in the tiles data field.
64 typedef void (*GisTileLoadFunc)(GisTile *tile, gpointer user_data);
68 * @tile: the tile to free
69 * @user_data: data paseed to the function
71 * Used to free the image data associated with a tile
73 typedef void (*GisTileFreeFunc)(GisTile *tile, gpointer user_data);
75 /* Forech functions */
78 * @parent: the #GisTile to iterate over
79 * @child: a pointer to a #GisTile to store the current subtile
81 * Iterate over each imediate subtile of @parent.
83 #define gis_tile_foreach(parent, child) \
84 for (int _x = 0; _x < G_N_ELEMENTS(parent->children); _x++) \
85 for (int _y = 0; child = parent->children[_x][_y], \
86 _y < G_N_ELEMENTS(parent->children[_x]); _y++)
89 * gis_tile_foreach_index:
90 * @parent: the #GisTile to iterate over
91 * @x: integer to store the x index of the current subtile
92 * @y: integer to store the y index of the current subtile
94 * Iterate over each imediate subtile of @parent.
96 #define gis_tile_foreach_index(parent, x, y) \
97 for (x = 0; x < G_N_ELEMENTS(parent->children); x++) \
98 for (y = 0; y < G_N_ELEMENTS(parent->children[x]); y++)
100 /* Path to string table, keep in sync with tile->children */
101 extern gchar *gis_tile_path_table[2][2];
103 GType gis_tile_get_type(void);
105 /* Allocate a new Tile */
106 GisTile *gis_tile_new(GisTile *parent,
107 gdouble n, gdouble s, gdouble e, gdouble w);
109 /* Return a string representation of the tile's path */
110 gchar *gis_tile_get_path(GisTile *child);
112 /* Update a root tile */
113 /* Based on eye distance */
114 void gis_tile_update(GisTile *root, GisPoint *eye,
115 gdouble res, gint width, gint height,
116 GisTileLoadFunc load_func, gpointer user_data);
118 /* Find the leaf tile containing lat-lon */
119 GisTile *gis_tile_find(GisTile *root, gdouble lat, gdouble lon);
121 /* Delete nodes that haven't been accessed since atime */
122 GisTile *gis_tile_gc(GisTile *root, time_t atime,
123 GisTileFreeFunc free_func, gpointer user_data);
125 /* Free a tile and all it's children */
126 void gis_tile_free(GisTile *root,
127 GisTileFreeFunc free_func, gpointer user_data);