src/kml.cc

   1 /* kml.cc
   2  * Export from Aven as KML.
   3  */
   4 /* Copyright (C) 2012 Olaf Kähler
   5  * Copyright (C) 2012,2013,2014,2015,2016,2017,2018 Olly Betts
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301 USA
  20  */
  21
  22 #ifdef HAVE_CONFIG_H
  23 # include <config.h>
  24 #endif
  25
  26 #include "kml.h"
  27
  28 #include "export.h" // For LABELS, etc
  29
  30 #include <stdio.h>
  31 #include <string>
  32 #include <math.h>
  33
  34 #include "useful.h"
  35 #include <proj_api.h>
  36
  37 #include "aven.h"
  38 #include "message.h"
  39
  40 using namespace std;
  41
  42 #define WGS84_DATUM_STRING "+proj=longlat +ellps=WGS84 +datum=WGS84"
  43
  44 static void
  45 html_escape(FILE *fh, const char *s)
  46 {
  47     while (*s) {
  48         switch (*s) {
  49             case '<':
  50                 fputs("&lt;", fh);
  51                 break;
  52             case '>':
  53                 fputs("&gt;", fh);
  54                 break;
  55             case '&':
  56                 fputs("&amp;", fh);
  57                 break;
  58             default:
  59                 PUTC(*s, fh);
  60         }
  61         ++s;
  62     }
  63 }
  64
  65 KML::KML(const char * input_datum, bool clamp_to_ground_)
  66     : clamp_to_ground(clamp_to_ground_)
  67 {
  68     if (!(pj_input = pj_init_plus(input_datum))) {
  69         wxString m = wmsg(/*Failed to initialise input coordinate system “%s”*/287);
  70         m = wxString::Format(m.c_str(), input_datum);
  71         throw m;
  72     }
  73     if (!(pj_output = pj_init_plus(WGS84_DATUM_STRING))) {
  74         wxString m = wmsg(/*Failed to initialise output coordinate system “%s”*/288);
  75         m = wxString::Format(m.c_str(), WGS84_DATUM_STRING);
  76         throw m;
  77     }
  78 }
  79
  80 KML::~KML()
  81 {
  82     if (pj_input)
  83         pj_free(pj_input);
  84     if (pj_output)
  85         pj_free(pj_output);
  86 }
  87
  88 const int *
  89 KML::passes() const
  90 {
  91     static const int default_passes[] = {
  92         PASG, XSECT, WALL1, WALL2, LEGS|SURF, LABELS|ENTS|FIXES|EXPORTS, 0
  93     };
  94     return default_passes;
  95 }
  96
  97 /* Initialise KML routines. */
  98 void KML::header(const char * title, const char *, time_t,
  99                  double, double, double, double, double, double)
 100 {
 101     fputs(
 102 "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
 103 "<kml xmlns=\"http://www.opengis.net/kml/2.2\">\n", fh);
 104     fputs("<Document><name>", fh);
 105     html_escape(fh, title);
 106     fputs("</name>\n", fh);
 107     // Set up styles for the icons to reduce the file size.
 108     fputs("<Style id=\"fix\"><IconStyle>"
 109           "<Icon><href>http://maps.google.com/mapfiles/kml/paddle/red-blank.png</href></Icon>"
 110           "</IconStyle></Style>\n", fh);
 111     fputs("<Style id=\"exp\"><IconStyle>"
 112           "<Icon><href>http://maps.google.com/mapfiles/kml/paddle/blu-blank.png</href></Icon>"
 113           "</IconStyle></Style>\n", fh);
 114     fputs("<Style id=\"ent\"><IconStyle>"
 115           "<Icon><href>http://maps.google.com/mapfiles/kml/paddle/grn-blank.png</href></Icon>"
 116           "</IconStyle></Style>\n", fh);
 117     // FIXME: does KML allow bounds?
 118     // NB Lat+long bounds are not necessarily the same as the bounds in survex
 119     // coords translated to WGS84 lat+long...
 120 }
 121
 122 void
 123 KML::start_pass(int)
 124 {
 125     if (in_linestring) {
 126         fputs("</coordinates></LineString></MultiGeometry></Placemark>\n", fh);
 127         in_linestring = false;
 128     }
 129 }
 130
 131 void
 132 KML::line(const img_point *p1, const img_point *p, unsigned /*flags*/, bool fPendingMove)
 133 {
 134     if (fPendingMove) {
 135         if (!in_linestring) {
 136             in_linestring = true;
 137             fputs("<Placemark><MultiGeometry>\n", fh);
 138         } else {
 139             fputs("</coordinates></LineString>\n", fh);
 140         }
 141         if (clamp_to_ground) {
 142             fputs("<LineString><coordinates>\n", fh);
 143         } else {
 144             fputs("<LineString><altitudeMode>absolute</altitudeMode><coordinates>\n", fh);
 145         }
 146         double X = p1->x, Y = p1->y, Z = p1->z;
 147         pj_transform(pj_input, pj_output, 1, 1, &X, &Y, &Z);
 148         X = deg(X);
 149         Y = deg(Y);
 150         // %.8f is at worst just over 1mm.
 151         fprintf(fh, "%.8f,%.8f,%.2f\n", X, Y, Z);
 152     }
 153     double X = p->x, Y = p->y, Z = p->z;
 154     pj_transform(pj_input, pj_output, 1, 1, &X, &Y, &Z);
 155     X = deg(X);
 156     Y = deg(Y);
 157     // %.8f is at worst just over 1mm.
 158     fprintf(fh, "%.8f,%.8f,%.2f\n", X, Y, Z);
 159 }
 160
 161 void
 162 KML::xsect(const img_point *p, double angle, double d1, double d2)
 163 {
 164     double s = sin(rad(angle));
 165     double c = cos(rad(angle));
 166
 167     double x1 = p->x + c * d1;
 168     double y1 = p->y + s * d1;
 169     double z1 = p->z;
 170     pj_transform(pj_input, pj_output, 1, 1, &x1, &y1, &z1);
 171     x1 = deg(x1);
 172     y1 = deg(y1);
 173
 174     double x2 = p->x - c * d2;
 175     double y2 = p->y - s * d2;
 176     double z2 = p->z;
 177     pj_transform(pj_input, pj_output, 1, 1, &x2, &y2, &z2);
 178     x2 = deg(x2);
 179     y2 = deg(y2);
 180
 181     if (clamp_to_ground) {
 182         fputs("<Placemark><name></name><LineString><coordinates>", fh);
 183     } else {
 184         fputs("<Placemark><name></name><LineString><altitudeMode>absolute</altitudeMode><coordinates>", fh);
 185     }
 186     fprintf(fh, "%.8f,%.8f,%.2f %.8f,%.8f,%.2f", x1, y1, z1, x2, y2, z2);
 187     fputs("</coordinates></LineString></Placemark>\n", fh);
 188 }
 189
 190 void
 191 KML::wall(const img_point *p, double angle, double d)
 192 {
 193     double s = sin(rad(angle));
 194     double c = cos(rad(angle));
 195
 196     double x = p->x + c * d;
 197     double y = p->y + s * d;
 198     double z = p->z;
 199     pj_transform(pj_input, pj_output, 1, 1, &x, &y, &z);
 200     x = deg(x);
 201     y = deg(y);
 202
 203     if (!in_wall) {
 204         wall_start=Vector3(x,y,z);
 205         if (clamp_to_ground) {
 206             fputs("<Placemark><name></name><LineString><coordinates>", fh);
 207         } else {
 208             fputs("<Placemark><name></name><LineString><altitudeMode>absolute</altitudeMode><coordinates>", fh);
 209         }
 210         in_wall = true;
 211     }
 212     fprintf(fh, "%.8f,%.8f,%.2f\n", x, y, z);
 213 }
 214
 215 void
 216 KML::passage(const img_point *p, double angle, double d1, double d2)
 217 {
 218     double s = sin(rad(angle));
 219     double c = cos(rad(angle));
 220
 221     double x1 = p->x + c * d1;
 222     double y1 = p->y + s * d1;
 223     double z1 = p->z;
 224     pj_transform(pj_input, pj_output, 1, 1, &x1, &y1, &z1);
 225     x1 = deg(x1);
 226     y1 = deg(y1);
 227
 228     double x2 = p->x - c * d2;
 229     double y2 = p->y - s * d2;
 230     double z2 = p->z;
 231     pj_transform(pj_input, pj_output, 1, 1, &x2, &y2, &z2);
 232     x2 = deg(x2);
 233     y2 = deg(y2);
 234
 235     //Define each passage as a multigeometry comprising of one rectangular
 236     //polygon per section. This prevents invalid geometry (such as
 237     //self-intersecting polygons) being created.
 238
 239     if (!in_passage){
 240         in_passage = true;
 241         fputs("<Placemark><name></name><MultiGeometry>\n", fh);
 242     }
 243
 244     else {
 245         if (clamp_to_ground) {
 246             fputs("<Polygon>"
 247               "<outerBoundaryIs><LinearRing><coordinates>\n", fh);
 248         }
 249         else {
 250             fputs("<Polygon><altitudeMode>absolute</altitudeMode>"
 251               "<outerBoundaryIs><LinearRing><coordinates>\n", fh);
 252         }
 253
 254         //draw anti-clockwise around the ring
 255         fprintf(fh, "%.8f,%.8f,%.2f\n", v2.GetX(), v2.GetY(), v2.GetZ());
 256         fprintf(fh, "%.8f,%.8f,%.2f\n", v1.GetX(), v1.GetY(), v1.GetZ());
 257
 258         fprintf(fh, "%.8f,%.8f,%.2f\n", x1, y1, z1);
 259         fprintf(fh, "%.8f,%.8f,%.2f\n", x2, y2, z2);
 260
 261         //close the ring
 262         fprintf(fh, "%.8f,%.8f,%.2f\n", v2.GetX(), v2.GetY(), v2.GetZ());
 263
 264         fputs("</coordinates></LinearRing></outerBoundaryIs>"
 265           "</Polygon>\n", fh);
 266     }
 267
 268     v2=Vector3(x2, y2, z2);
 269     v1=Vector3(x1, y1, z1);
 270 }
 271
 272 void
 273 KML::tube_end()
 274 {
 275     if (in_passage){
 276         fputs("</MultiGeometry></Placemark>\n", fh);
 277         in_passage = false;
 278     }
 279     if (in_wall) {
 280         //draw back to the starting position
 281         fprintf(fh, "%.8f,%.8f,%.2f\n", wall_start.GetX(), wall_start.GetY(), wall_start.GetZ());
 282         fputs("</coordinates></LineString></Placemark>\n", fh);
 283         in_wall = false;
 284     }
 285 }
 286
 287 void
 288 KML::label(const img_point *p, const char *s, bool /*fSurface*/, int type)
 289 {
 290     double X = p->x, Y = p->y, Z = p->z;
 291     pj_transform(pj_input, pj_output, 1, 1, &X, &Y, &Z);
 292     X = deg(X);
 293     Y = deg(Y);
 294     // %.8f is at worst just over 1mm.
 295     fprintf(fh, "<Placemark><Point><coordinates>%.8f,%.8f,%.2f</coordinates></Point><name>", X, Y, Z);
 296     html_escape(fh, s);
 297     fputs("</name>", fh);
 298     // Add a "pin" symbol with colour matching what aven shows.
 299     switch (type) {
 300         case FIXES:
 301             fputs("<styleUrl>#fix</styleUrl>", fh);
 302             break;
 303         case EXPORTS:
 304             fputs("<styleUrl>#exp</styleUrl>", fh);
 305             break;
 306         case ENTS:
 307             fputs("<styleUrl>#ent</styleUrl>", fh);
 308             break;
 309     }
 310     fputs("</Placemark>\n", fh);
 311 }
 312
 313 void
 314 KML::footer()
 315 {
 316     if (in_linestring)
 317         fputs("</coordinates></LineString></MultiGeometry></Placemark>\n", fh);
 318     fputs("</Document></kml>\n", fh);
 319 }