src/vikviewport.h

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #ifndef _VIKING_VIEWPORT_H
  23 #define _VIKING_VIEWPORT_H
  24 /* Requires <gtk/gtk.h> or glib, and coords.h*/
  25
  26 #include <glib.h>
  27 #include <glib-object.h>
  28 #include <gtk/gtk.h>
  29
  30 #include "vikcoord.h"
  31
  32
  33 G_BEGIN_DECLS
  34
  35
  36 #define VIK_VIEWPORT_TYPE            (vik_viewport_get_type ())
  37 #define VIK_VIEWPORT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_VIEWPORT_TYPE, VikViewport))
  38 #define VIK_VIEWPORT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_VIEWPORT_TYPE, VikViewportClass))
  39 #define VIK_IS_VIEWPORT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_VIEWPORT_TYPE))
  40 #define VIK_IS_VIEWPORT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_VIEWPORT_TYPE))
  41
  42 #define VIK_VIEWPORT_MAX_ZOOM 32768.0
  43 #define VIK_VIEWPORT_MIN_ZOOM (1 / 32.0)
  44
  45 /* used for coord to screen etc, screen to coord */
  46 #define VIK_VIEWPORT_UTM_WRONG_ZONE -9999999
  47 #define VIK_VIEWPORT_OFF_SCREEN_DOUBLE -9999999.9
  48
  49
  50 /* Glib type inheritance and initialization */
  51 typedef struct _VikViewport VikViewport;
  52 typedef struct _VikViewportClass VikViewportClass;
  53
  54 struct _VikViewportClass
  55 {
  56   GtkDrawingAreaClass drawing_area_class;
  57   void (*updated_center) (VikViewport *vw);
  58 };
  59 GType vik_viewport_get_type ();
  60
  61
  62 /* Viking initialization */
  63 VikViewport *vik_viewport_new ();
  64 void vik_viewport_configure_manually ( VikViewport *vvp, gint width, guint height ); /* for off-screen viewports */
  65 gboolean vik_viewport_configure ( VikViewport *vp );
  66
  67
  68 /* coordinate transformations */
  69 void vik_viewport_screen_to_coord ( VikViewport *vvp, int x, int y, VikCoord *coord );
  70 void vik_viewport_coord_to_screen ( VikViewport *vvp, const VikCoord *coord, int *x, int *y );
  71
  72
  73 /* viewport scale */
  74 void vik_viewport_set_ympp ( VikViewport *vvp, gdouble ympp );
  75 void vik_viewport_set_xmpp ( VikViewport *vvp, gdouble xmpp );
  76 gdouble vik_viewport_get_ympp ( VikViewport *vvp );
  77 gdouble vik_viewport_get_xmpp ( VikViewport *vvp );
  78 void vik_viewport_set_zoom ( VikViewport *vvp, gdouble mpp );
  79 gdouble vik_viewport_get_zoom ( VikViewport *vvp );
  80 void vik_viewport_zoom_in ( VikViewport *vvp );
  81 void vik_viewport_zoom_out ( VikViewport *vvp );
  82
  83
  84 /* viewport position */
  85 const VikCoord *vik_viewport_get_center ( VikViewport *vvp );
  86 void vik_viewport_set_center_coord ( VikViewport *vvp, const VikCoord *coord, gboolean save_position );
  87 void vik_viewport_set_center_screen ( VikViewport *vvp, int x, int y );
  88 void vik_viewport_center_for_zonen ( VikViewport *vvp, struct UTM *center, int zone);
  89 gchar vik_viewport_leftmost_zone ( VikViewport *vvp );
  90 gchar vik_viewport_rightmost_zone ( VikViewport *vvp );
  91 void vik_viewport_set_center_utm ( VikViewport *vvp, const struct UTM *utm, gboolean save_position );
  92 void vik_viewport_set_center_latlon ( VikViewport *vvp, const struct LatLon *ll, gboolean save_position );
  93 void vik_viewport_corners_for_zonen ( VikViewport *vvp, int zone, VikCoord *ul, VikCoord *br );
  94 void vik_viewport_get_min_max_lat_lon ( VikViewport *vp, gdouble *min_lat, gdouble *max_lat, gdouble *min_lon, gdouble *max_lon );
  95
  96 gboolean vik_viewport_go_back ( VikViewport *vvp );
  97 gboolean vik_viewport_go_forward ( VikViewport *vvp );
  98 gboolean vik_viewport_back_available ( const VikViewport *vvp );
  99 gboolean vik_viewport_forward_available ( const VikViewport *vvp );
 100
 101 /* drawmode management */
 102 typedef enum {
 103   VIK_VIEWPORT_DRAWMODE_UTM=0,
 104   VIK_VIEWPORT_DRAWMODE_EXPEDIA,
 105   VIK_VIEWPORT_DRAWMODE_MERCATOR,
 106   VIK_VIEWPORT_DRAWMODE_LATLON,
 107   VIK_VIEWPORT_NUM_DRAWMODES      /*< skip >*/
 108 } VikViewportDrawMode;
 109
 110 VikCoordMode vik_viewport_get_coord_mode ( const VikViewport *vvp );
 111 gboolean vik_viewport_is_one_zone ( VikViewport *vvp );
 112 const gchar *vik_viewport_get_drawmode_name(VikViewport *vv, VikViewportDrawMode mode);
 113 void vik_viewport_set_drawmode ( VikViewport *vvp, VikViewportDrawMode drawmode );
 114 VikViewportDrawMode vik_viewport_get_drawmode ( VikViewport *vvp );
 115    /* Do not forget to update vik_viewport_get_drawmode_name() if you modify VikViewportDrawMode */
 116
 117
 118 /* Triggers */
 119 void vik_viewport_set_trigger ( VikViewport *vp, gpointer trigger );
 120 gpointer vik_viewport_get_trigger ( VikViewport *vp );
 121 void vik_viewport_snapshot_save ( VikViewport *vp );
 122 void vik_viewport_snapshot_load ( VikViewport *vp );
 123 void vik_viewport_set_half_drawn(VikViewport *vp, gboolean half_drawn);
 124 gboolean vik_viewport_get_half_drawn( VikViewport *vp );
 125
 126
 127 /***************************************************************************************************
 128  *  Drawing-related operations
 129  ***************************************************************************************************/
 130
 131 /* Viewport buffer management/drawing to screen */
 132 GdkPixmap *vik_viewport_get_pixmap ( VikViewport *vvp ); /* get pointer to drawing buffer */
 133 void vik_viewport_sync ( VikViewport *vvp );             /* draw buffer to window */
 134 void vik_viewport_pan_sync ( VikViewport *vvp, gint x_off, gint y_off );
 135 void vik_viewport_clear ( VikViewport *vvp );
 136 void vik_viewport_draw_pixbuf_with_alpha ( VikViewport *vvp, GdkPixbuf *pixbuf, gint alpha,
 137                                            gint src_x, gint src_y, gint dest_x, gint dest_y, gint w, gint h );
 138 void vik_viewport_draw_pixbuf ( VikViewport *vvp, GdkPixbuf *pixbuf, gint src_x, gint src_y,
 139                               gint dest_x, gint dest_y, gint w, gint h );
 140 gint vik_viewport_get_width ( VikViewport *vvp );
 141 gint vik_viewport_get_height ( VikViewport *vvp );
 142
 143 void vik_viewport_reset_copyrights ( VikViewport *vp );
 144 void vik_viewport_add_copyright ( VikViewport *vp, const gchar *copyright );
 145
 146 void vik_viewport_reset_logos ( VikViewport *vp );
 147 void vik_viewport_add_logo ( VikViewport *vp, const GdkPixbuf *logo );
 148
 149 /* Viewport features */
 150 void vik_viewport_draw_scale ( VikViewport *vvp );
 151 void vik_viewport_set_draw_scale ( VikViewport *vvp, gboolean draw_scale );
 152 gboolean vik_viewport_get_draw_scale ( VikViewport *vvp );
 153 void vik_viewport_draw_copyright ( VikViewport *vvp );
 154 void vik_viewport_draw_centermark ( VikViewport *vvp );
 155 void vik_viewport_set_draw_centermark ( VikViewport *vvp, gboolean draw_centermark );
 156 gboolean vik_viewport_get_draw_centermark ( VikViewport *vvp );
 157 void vik_viewport_draw_logo ( VikViewport *vvp );
 158 void vik_viewport_set_draw_highlight ( VikViewport *vvp, gboolean draw_highlight );
 159 gboolean vik_viewport_get_draw_highlight ( VikViewport *vvp );
 160
 161 /* Color/graphics context management */
 162 void vik_viewport_set_background_color ( VikViewport *vvp, const gchar *color );
 163 const gchar *vik_viewport_get_background_color ( VikViewport *vvp );
 164 GdkColor *vik_viewport_get_background_gdkcolor ( VikViewport *vvp );
 165 void vik_viewport_set_background_gdkcolor ( VikViewport *vvp, GdkColor * );
 166 void vik_gc_get_fg_color ( GdkGC *gc, GdkColor *dest ); /* warning: could be slow, don't use obsessively */
 167 GdkGC *vik_viewport_new_gc ( VikViewport *vvp, const gchar *colorname, gint thickness );
 168 GdkGC *vik_viewport_new_gc_from_color ( VikViewport *vvp, GdkColor *color, gint thickness );
 169 GdkFunction vik_gc_get_function ( GdkGC *gc );
 170
 171 void vik_viewport_set_highlight_color ( VikViewport *vvp, const gchar *color );
 172 const gchar *vik_viewport_get_highlight_color ( VikViewport *vvp );
 173 GdkColor *vik_viewport_get_highlight_gdkcolor ( VikViewport *vvp );
 174 void vik_viewport_set_highlight_gdkcolor ( VikViewport *vvp, GdkColor * );
 175 GdkGC* vik_viewport_get_gc_highlight ( VikViewport *vvp );
 176 void vik_viewport_set_highlight_thickness ( VikViewport *vvp, gint thickness );
 177
 178 /* Drawing primitives */
 179 void a_viewport_clip_line ( gint *x1, gint *y1, gint *x2, gint *y2 ); /* run this before drawing a line. vik_viewport_draw_line runs it for you */
 180 void vik_viewport_draw_line ( VikViewport *vvp, GdkGC *gc, gint x1, gint y1, gint x2, gint y2 );
 181 void vik_viewport_draw_rectangle ( VikViewport *vvp, GdkGC *gc, gboolean filled, gint x1, gint y1, gint x2, gint y2 );
 182 void vik_viewport_draw_string ( VikViewport *vvp, GdkFont *font, GdkGC *gc, gint x1, gint y1, const gchar *string );
 183 void vik_viewport_draw_arc ( VikViewport *vvp, GdkGC *gc, gboolean filled, gint x, gint y, gint width, gint height, gint angle1, gint angle2 );
 184 void vik_viewport_draw_polygon ( VikViewport *vvp, GdkGC *gc, gboolean filled, GdkPoint *points, gint npoints );
 185 void vik_viewport_draw_layout ( VikViewport *vvp, GdkGC *gc, gint x, gint y, PangoLayout *layout );
 186
 187 /* Utilities */
 188 void vik_viewport_compute_bearing ( VikViewport *vp, gint x1, gint y1, gint x2, gint y2, gdouble *angle, gdouble *baseangle );
 189
 190 G_END_DECLS
 191
 192 #endif