Adding man pages
[viking/gosmore.git] / src / vikcoord.h
bloba3d0cf5fe1083bfb8a84d12559d421906d22a282
1 /*
2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
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.
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.
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
22 #ifndef _VIKING_VIKCOORD_H
23 #define _VIKING_VIKCOORD_H
25 #include "coords.h"
27 typedef gshort VikCoordMode;
28 #define VIK_COORD_UTM 0
29 #define VIK_COORD_LATLON 1
31 #define VIK_UTM(x) ((struct UTM *)(x))
32 #define VIK_LATLON(x) ((struct LatLon *)(x))
34 typedef struct {
35 gdouble north_south; /* northing or lat */
36 gdouble east_west; /* easting or lon */
37 gchar utm_zone;
38 gchar utm_letter;
40 VikCoordMode mode;
41 } VikCoord;
42 /* notice we can cast to either UTM or LatLon */
43 /* possible more modes to come? xy? we'll leave that as an option */
45 VikCoord *vik_coord_new();
46 void vik_coord_free(VikCoord *coord);
48 void vik_coord_convert(VikCoord *coord, VikCoordMode dest_mode);
49 void vik_coord_copy_convert(const VikCoord *coord, VikCoordMode dest_mode, VikCoord *dest);
50 gdouble vik_coord_diff(const VikCoord *c1, const VikCoord *c2);
52 void vik_coord_load_from_latlon ( VikCoord *coord, VikCoordMode mode, const struct LatLon *ll );
53 void vik_coord_load_from_utm ( VikCoord *coord, VikCoordMode mode, const struct UTM *utm );
55 void vik_coord_to_latlon ( const VikCoord *coord, struct LatLon *dest );
56 void vik_coord_to_utm ( const VikCoord *coord, struct UTM *dest );
58 gboolean vik_coord_equals ( const VikCoord *coord1, const VikCoord *coord2 );
60 /* all coord operations MUST BE ABSTRACTED!!! */
62 #endif