Some spelling fixes in a comment

[andy/viking.git] / src / vikcoord.h

/*
 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
 *
 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 */

#ifndef _VIKING_VIKCOORD_H
#define _VIKING_VIKCOORD_H

#include "coords.h"

G_BEGIN_DECLS

typedef gshort VikCoordMode;
#define VIK_COORD_UTM 0
#define VIK_COORD_LATLON 1

#define VIK_UTM(x) ((struct UTM *)(x))
#define VIK_LATLON(x) ((struct LatLon *)(x))

typedef struct {
  gdouble north_south; /* northing or lat */
  gdouble east_west;   /* easting or lon */
  gchar utm_zone;
  gchar utm_letter;

  VikCoordMode mode;
} VikCoord;
/* notice we can cast to either UTM or LatLon */
/* possible more modes to come? xy? we'll leave that as an option */

void vik_coord_convert(VikCoord *coord, VikCoordMode dest_mode);
void vik_coord_copy_convert(const VikCoord *coord, VikCoordMode dest_mode, VikCoord *dest);
gdouble vik_coord_diff(const VikCoord *c1, const VikCoord *c2);

void vik_coord_load_from_latlon ( VikCoord *coord, VikCoordMode mode, const struct LatLon *ll );
void vik_coord_load_from_utm ( VikCoord *coord, VikCoordMode mode, const struct UTM *utm );

void vik_coord_to_latlon ( const VikCoord *coord, struct LatLon *dest );
void vik_coord_to_utm ( const VikCoord *coord, struct UTM *dest );

gboolean vik_coord_equals ( const VikCoord *coord1, const VikCoord *coord2 );

void vik_coord_set_area(const VikCoord *coord, const struct LatLon *wh, VikCoord *tl, VikCoord *br);
gboolean vik_coord_inside(const VikCoord *coord, const VikCoord *tl, const VikCoord *br);
/* all coord operations MUST BE ABSTRACTED!!! */

G_END_DECLS

#endif