Add z-index to tiles
[grits] / 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         /* Pointer to the tile data */
42         gint zindex;
43
44         /* North,South,East,West limits */
45         GisBBox edge;
46
47         /* Pointers to parent/child nodes */
48         GisTile *parent;
49         GisTile *children[2][2];
50
51         /* Last access time (for garbage collection) */
52         time_t atime;
53 };
54
55 struct _GisTileClass {
56         GisObjectClass parent_class;
57 };
58
59 /**
60  * GisTileLoadFunc:
61  * @tile:      the tile to load
62  * @user_data: data paseed to the function
63  *
64  * Used to load the image data associated with a tile. For GisOpenGL, this
65  * function should store the OpenGL texture number in the tiles data field.
66  */
67 typedef void (*GisTileLoadFunc)(GisTile *tile, gpointer user_data);
68
69 /**
70  * GisTileFreeFunc:
71  * @tile:      the tile to free
72  * @user_data: data paseed to the function
73  *
74  * Used to free the image data associated with a tile
75  */
76 typedef void (*GisTileFreeFunc)(GisTile *tile, gpointer user_data);
77
78 /* Forech functions */
79 /**
80  * gis_tile_foreach:
81  * @parent: the #GisTile to iterate over
82  * @child:  a pointer to a #GisTile to store the current subtile 
83  *
84  * Iterate over each imediate subtile of @parent. 
85  */
86 #define gis_tile_foreach(parent, child) \
87         for (int _x = 0; _x < G_N_ELEMENTS(parent->children); _x++) \
88         for (int _y = 0; child = parent->children[_x][_y], \
89                 _y < G_N_ELEMENTS(parent->children[_x]); _y++)
90
91 /**
92  * gis_tile_foreach_index:
93  * @parent: the #GisTile to iterate over
94  * @x:      integer to store the x index of the current subtile
95  * @y:      integer to store the y index of the current subtile
96  *
97  * Iterate over each imediate subtile of @parent. 
98  */
99 #define gis_tile_foreach_index(parent, x, y) \
100         for (x = 0; x < G_N_ELEMENTS(parent->children); x++) \
101         for (y = 0; y < G_N_ELEMENTS(parent->children[x]); y++)
102
103 /* Path to string table, keep in sync with tile->children */
104 extern gchar *gis_tile_path_table[2][2];
105
106 GType gis_tile_get_type(void);
107
108 /* Allocate a new Tile */
109 GisTile *gis_tile_new(GisTile *parent,
110         gdouble n, gdouble s, gdouble e, gdouble w);
111
112 /* Return a string representation of the tile's path */
113 gchar *gis_tile_get_path(GisTile *child);
114
115 /* Update a root tile */
116 /* Based on eye distance */
117 void gis_tile_update(GisTile *root, GisPoint *eye,
118                 gdouble res, gint width, gint height,
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