aerofly-missions/src/Export/KeyholeMarkupLanguage.ts

The Aerofly Missionsgerät converts simulator flight plan files for Aerofly FS 4, Microsoft Flight Simulator, X-Plane, GeoFS, and Garmin / Infinite Flight flight plan files. It also imports SimBrief flight plans.

import { Mission } from "../Aerofly/Mission.js";
import { MissionCheckpoint, MissionCheckpointTypeExtended } from "../Aerofly/MissionCheckpoint.js";
import { GeoJson, GeoJsonFeature } from "./GeoJson.js";

type KeyholeMarkupLanguageRouteStyle = {
  id: MissionCheckpointTypeExtended | "aircraft" | "flightplan" | "taxi";
  iconHref: string;
};

export class KeyholeMarkupLanguage extends GeoJson {
  protected _mission: Mission | undefined;

  fromMission(mission: Mission, forExport?: boolean): this {
    this._mission = mission;
    return super.fromMission(mission, forExport);
  }

  toString(): string {
    const routeColor = "9314ff";

    const styles: KeyholeMarkupLanguageRouteStyle[] = [
      { id: MissionCheckpoint.TYPE_ORIGIN, iconHref: "https://maps.google.com/mapfiles/kml/shapes/airports.png" },
      {
        id: MissionCheckpoint.TYPE_DEPARTURE_RUNWAY,
        iconHref: "https://maps.google.com/mapfiles/kml/shapes/target.png",
      },
      { id: MissionCheckpoint.TYPE_DEPARTURE, iconHref: "https://maps.google.com/mapfiles/kml/shapes/square.png" },
      { id: MissionCheckpoint.TYPE_WAYPOINT, iconHref: "http://maps.google.com/mapfiles/kml/shapes/triangle.png" },
      { id: MissionCheckpoint.TYPE_ARRIVAL, iconHref: "https://maps.google.com/mapfiles/kml/shapes/square.png" },
      { id: MissionCheckpoint.TYPE_APPROACH, iconHref: "https://maps.google.com/mapfiles/kml/shapes/square.png" },
      {
        id: MissionCheckpoint.TYPE_DESTINATION_RUNWAY,
        iconHref: "https://maps.google.com/mapfiles/kml/shapes/target.png",
      },
      { id: MissionCheckpoint.TYPE_DESTINATION, iconHref: "https://maps.google.com/mapfiles/kml/shapes/airports.png" },
      { id: MissionCheckpoint.TYPE_VOR, iconHref: "https://maps.google.com/mapfiles/kml/shapes/polygon.png" },
      { id: MissionCheckpoint.TYPE_NDB, iconHref: "https://maps.google.com/mapfiles/kml/shapes/donut.png" },
      { id: MissionCheckpoint.TYPE_FIX, iconHref: "http://maps.google.com/mapfiles/kml/shapes/triangle.png" },
      { id: MissionCheckpoint.TYPE_INTERSECTION, iconHref: "https://maps.google.com/mapfiles/kml/shapes/diamond.png" },
      { id: MissionCheckpoint.TYPE_AIRPORT, iconHref: "https://maps.google.com/mapfiles/kml/shapes/star.png" },
      { id: "aircraft", iconHref: "https://maps.google.com/mapfiles/kml/shapes/airports.png" },
    ];

    return `<?xml version="1.0" encoding="UTF-8"?>
<kml xmlns="http://www.opengis.net/kml/2.2">
  <Document>
    <name>${this._mission?.title ?? "Route"}</name>
    <description>${this._mission?.description ?? ""}</description>
    <Style id="flightplan">
      <LineStyle>
        <color>ff${routeColor}</color>
        <width>6</width>
      </LineStyle>
      <PolyStyle>
        <color>44${routeColor}</color>
      </PolyStyle>
    </Style>
    <Style id="taxi">
      <LineStyle>
        <color>cc${routeColor}</color>
        <width>2</width>
      </LineStyle>
      <PolyStyle>
        <color>22${routeColor}</color>
      </PolyStyle>
    </Style>
${styles
  .map((style) => {
    return `\
    <Style id="${style.id}">
      <IconStyle>
        <Icon>
          <href>${style.iconHref}</href>
        </Icon>
      </IconStyle>
      <color>ffffffff</color>
    </Style>`;
  })
  .join("\n")}
${this.features
  .map((feature) => {
    return `\
    <Placemark>
      <name>${feature.properties.title}</name>
      <description>${feature.properties.frequency ?? ""}</description>
      <styleUrl>#${feature.properties.type}</styleUrl>
${this.getPlacemarkFeatures(feature)}\
      <${feature.geometry.type}>
${this.getGeometryFeatures(feature)}\
        <altitudeMode>${feature.geometry.coordinates[2] !== undefined ? "absolute" : "relativeToGround"}</altitudeMode>
        <coordinates>${this.coordinatesToString(feature)}</coordinates>
      </${feature.geometry.type}>
    </Placemark>`;
  })
  .join("\n")}
  </Document>
</kml>
`;
  }

  protected getPlacemarkFeatures(feature: GeoJsonFeature) {
    return feature.geometry.type === "Point"
      ? `\
        <LookAt>
          <longitude>${feature.geometry.coordinates[0]}</longitude>
          <latitude>${feature.geometry.coordinates[1]}</latitude>
          <altitude>${feature.geometry.coordinates[2]}</altitude>
          <range>10000</range>
          <tilt>70</tilt>
          <heading>${((feature.properties.direction ?? 0) + 15) % 360}</heading>
          <altitudeMode>${feature.geometry.coordinates[2] !== 0 ? "absolute" : "relativeToGround"}</altitudeMode>
        </LookAt>
`
      : "";
  }

  protected getGeometryFeatures(feature: GeoJsonFeature) {
    return feature.geometry.type === "LineString"
      ? `\
        <tessellate>1</tessellate>
        <extrude>1</extrude>
`
      : "";
  }

  protected coordinatesToString(feature: GeoJsonFeature) {
    if (feature.geometry.type === "LineString") {
      return feature.geometry.coordinates
        .map((c) => {
          return c.join(",");
        })
        .join("\n");
    }
    return feature.geometry.coordinates.join(",");
  }
}