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/gtkdrawingarea.h>
  29
  30 #include "vikcoord.h"
  31
  32 G_BEGIN_DECLS
  33
  34 #define VIK_VIEWPORT_TYPE            (vik_viewport_get_type ())
  35 #define VIK_VIEWPORT(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), VIK_VIEWPORT_TYPE, VikViewport))
  36 #define VIK_VIEWPORT_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), VIK_VIEWPORT_TYPE, VikViewportClass))
  37 #define IS_VIK_VIEWPORT(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), VIK_VIEWPORT_TYPE))
  38 #define IS_VIK_VIEWPORT_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), VIK_VIEWPORT_TYPE))
  39
  40 #define VIK_VIEWPORT_MAX_ZOOM 8192.0
  41 #define VIK_VIEWPORT_MIN_ZOOM 0.125
  42
  43 /* used for coord to screen etc, screen to coord */
  44 #define VIK_VIEWPORT_UTM_WRONG_ZONE -9999999
  45 #define VIK_VIEWPORT_OFF_SCREEN_DOUBLE -9999999.9
  46
  47 typedef struct _VikViewport VikViewport;
  48 typedef struct _VikViewportClass VikViewportClass;
  49
  50 struct _VikViewportClass
  51 {
  52   GtkDrawingAreaClass drawing_area_class;
  53 };
  54
  55 GType vik_viewport_get_type ();
  56
  57 VikViewport *vik_viewport_new ();
  58
  59 void vik_viewport_configure_manually ( VikViewport *vvp, gint width, guint height );
  60 /* for off-screen viewports */
  61 gboolean vik_viewport_configure ( VikViewport *vp );
  62
  63
  64 void vik_viewport_clear ( VikViewport *vvp );
  65 void vik_viewport_draw_scale ( VikViewport *vvp );
  66 void vik_viewport_set_draw_scale ( VikViewport *vvp, gboolean draw_scale );
  67 gboolean vik_viewport_get_draw_scale ( VikViewport *vvp );
  68
  69
  70 GdkPixmap *vik_viewport_get_pixmap ( VikViewport *vvp );
  71
  72 void vik_viewport_sync ( VikViewport *vvp );
  73
  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
  79
  80 void vik_viewport_set_zoom ( VikViewport *vvp, gdouble mpp );
  81 gdouble vik_viewport_get_zoom ( VikViewport *vvp );
  82 void vik_viewport_zoom_in ( VikViewport *vvp );
  83 void vik_viewport_zoom_out ( VikViewport *vvp );
  84
  85 const VikCoord *vik_viewport_get_center ( VikViewport *vvp );
  86
  87 void vik_viewport_set_center_coord ( VikViewport *vvp, const VikCoord *coord );
  88 void vik_viewport_set_center_screen ( VikViewport *vvp, int x, int y );
  89 void vik_viewport_center_for_zonen ( VikViewport *vvp, struct UTM *center, int zone);
  90 gchar vik_viewport_leftmost_zone ( VikViewport *vvp );
  91 gchar vik_viewport_rightmost_zone ( VikViewport *vvp );
  92
  93 void vik_viewport_screen_to_coord ( VikViewport *vvp, int x, int y, VikCoord *coord );
  94 void vik_viewport_coord_to_screen ( VikViewport *vvp, const VikCoord *coord, int *x, int *y );
  95
  96 void vik_viewport_draw_pixbuf_with_alpha ( VikViewport *vvp, GdkPixbuf *pixbuf, gint alpha,
  97                                            gint src_x, gint src_y, gint dest_x, gint dest_y, gint w, gint h );
  98 void vik_viewport_draw_pixbuf ( VikViewport *vvp, GdkPixbuf *pixbuf, gint src_x, gint src_y,
  99                               gint dest_x, gint dest_y, gint w, gint h );
 100
 101
 102 gint vik_viewport_get_width ( VikViewport *vvp );
 103 gint vik_viewport_get_height ( VikViewport *vvp );
 104
 105 GdkGC *vik_viewport_new_gc ( VikViewport *vvp, const gchar *colorname, gint thickness );
 106
 107 /* run this before drawing a line. vik_viewport_draw_line runs it for you */
 108 void a_viewport_clip_line ( gint *x1, gint *y1, gint *x2, gint *y2 );
 109
 110 void vik_viewport_draw_line ( VikViewport *vvp, GdkGC *gc, gint x1, gint y1, gint x2, gint y2 );
 111 void vik_viewport_draw_rectangle ( VikViewport *vvp, GdkGC *gc, gboolean filled, gint x1, gint y1, gint x2, gint y2 );
 112 void vik_viewport_draw_string ( VikViewport *vvp, GdkFont *font, GdkGC *gc, gint x1, gint y1, const gchar *string );
 113 GdkGC *vik_viewport_new_gc_from_color ( VikViewport *vvp, GdkColor *color, gint thickness );
 114 void vik_viewport_draw_arc ( VikViewport *vvp, GdkGC *gc, gboolean filled, gint x, gint y, gint width, gint height, gint angle1, gint angle2 );
 115 void vik_viewport_draw_polygon ( VikViewport *vvp, GdkGC *gc, gboolean filled, GdkPoint *points, gint npoints );
 116
 117 void vik_viewport_set_center_utm ( VikViewport *vvp, const struct UTM *utm );
 118 void vik_viewport_set_center_latlon ( VikViewport *vvp, const struct LatLon *ll );
 119
 120 /* you must set drawmode to set coord_mode */
 121 VikCoordMode vik_viewport_get_coord_mode ( const VikViewport *vvp );
 122
 123 gboolean vik_viewport_is_one_zone ( VikViewport *vvp );
 124
 125 void vik_viewport_set_background_color ( VikViewport *vvp, const gchar *color );
 126 /* pointer to static storage -- may change -- use quickly! */
 127 const gchar *vik_viewport_get_background_color ( VikViewport *vvp );
 128 GdkColor *vik_viewport_get_background_gdkcolor ( VikViewport *vvp );
 129 void vik_viewport_set_background_gdkcolor ( VikViewport *vvp, GdkColor * );
 130
 131 void vik_viewport_draw_layout ( VikViewport *vvp, GdkGC *gc, gint x, gint y, PangoLayout *layout );
 132
 133 /* warning: could be slow, don't obsessively use following function. */
 134 void vik_gc_get_fg_color ( GdkGC *gc, GdkColor *dest );
 135
 136 GdkFunction vik_gc_get_function ( GdkGC *gc );
 137
 138 void vik_viewport_pan_sync ( VikViewport *vvp, gint x_off, gint y_off );
 139
 140 typedef enum { VIK_VIEWPORT_DRAWMODE_UTM=0, VIK_VIEWPORT_DRAWMODE_EXPEDIA,
 141   VIK_VIEWPORT_DRAWMODE_GOOGLE, VIK_VIEWPORT_DRAWMODE_KH, VIK_VIEWPORT_DRAWMODE_MERCATOR } VikViewportDrawMode;
 142
 143
 144 void vik_viewport_set_drawmode ( VikViewport *vvp, VikViewportDrawMode drawmode );
 145 VikViewportDrawMode vik_viewport_get_drawmode ( VikViewport *vvp );
 146 void vik_viewport_corners_for_zonen ( VikViewport *vvp, int zone, VikCoord *ul, VikCoord *br );
 147
 148
 149 G_END_DECLS
 150
 151 #endif