game/devtools/

kml.rs

// TODO Rename -- this is for KML, CSV, GeoJSON

use std::collections::{BTreeMap, HashMap, HashSet};

use abstutil::{prettyprint_usize, Timer};
use geom::{ArrowCap, Circle, Distance, PolyLine, Polygon, Pt2D, QuadTree, Ring};
use kml::{ExtraShape, ExtraShapes};
use map_gui::colors::ColorScheme;
use map_gui::tools::FilePicker;
use map_model::BuildingID;
use widgetry::tools::PopupMsg;
use widgetry::{
    lctrl, Choice, Color, Drawable, EventCtx, GeomBatch, GfxCtx, HorizontalAlignment, Key, Line,
    Outcome, Panel, State, Text, TextBox, TextExt, VerticalAlignment, Widget,
};

use crate::app::{App, Transition};

pub struct ViewKML {
    panel: Panel,
    objects: Vec<Object>,
    draw: Drawable,

    selected: Vec<usize>,
    quadtree: QuadTree<usize>,
    draw_query: Drawable,
}

struct Object {
    polygon: Polygon,
    color: Color,
    attribs: BTreeMap<String, String>,

    osm_bldg: Option<BuildingID>,
}

const RADIUS: Distance = Distance::const_meters(5.0);
const THICKNESS: Distance = Distance::const_meters(2.0);

impl ViewKML {
    pub fn new_state(
        ctx: &mut EventCtx,
        app: &App,
        file: Option<(String, Vec<u8>)>,
    ) -> Box<dyn State<App>> {
        ctx.loading_screen("load kml", |ctx, timer| {
            // Enable to write a smaller .bin only with the shapes matching the bounds.
            let dump_clipped_shapes = false;
            let (dataset_name, objects) = load_objects(app, file, dump_clipped_shapes, timer);

            let mut batch = GeomBatch::new();
            let mut quadtree = QuadTree::builder();
            timer.start_iter("render shapes", objects.len());
            for (idx, obj) in objects.iter().enumerate() {
                timer.next();
                quadtree.add_with_box(idx, obj.polygon.get_bounds());
                batch.push(obj.color, obj.polygon.clone());
            }

            let mut choices = vec![Choice::string("None")];
            if dataset_name == "parcels" {
                choices.push(Choice::string("parcels without buildings"));
                choices.push(Choice::string(
                    "parcels without buildings and trips or parking",
                ));
                choices.push(Choice::string("parcels with multiple buildings"));
                choices.push(Choice::string("parcels with >1 households"));
                choices.push(Choice::string("parcels with parking"));
            }

            Box::new(ViewKML {
                draw: ctx.upload(batch),
                panel: Panel::new_builder(Widget::col(vec![
                    Widget::row(vec![
                        Line("KML viewer").small_heading().into_widget(ctx),
                        ctx.style().btn_close_widget(ctx),
                    ]),
                    format!(
                        "{}: {} objects",
                        dataset_name,
                        prettyprint_usize(objects.len())
                    )
                    .text_widget(ctx),
                    ctx.style()
                        .btn_outline
                        .text("load KML file")
                        .hotkey(lctrl(Key::L))
                        .build_def(ctx),
                    Widget::row(vec![
                        "Query:".text_widget(ctx),
                        Widget::dropdown(ctx, "query", "None".to_string(), choices),
                    ]),
                    Widget::row(vec![
                        "Key=value filter:".text_widget(ctx),
                        TextBox::widget(ctx, "filter", String::new(), false, 10),
                    ]),
                    "Query matches 0 objects".text_widget(ctx).named("matches"),
                    "Mouseover an object to examine it"
                        .text_widget(ctx)
                        .named("mouseover"),
                ]))
                .aligned(HorizontalAlignment::Left, VerticalAlignment::Top)
                .build(ctx),
                objects,
                quadtree: quadtree.build(),
                selected: Vec::new(),
                draw_query: Drawable::empty(ctx),
            })
        })
    }
}

impl State<App> for ViewKML {
    fn event(&mut self, ctx: &mut EventCtx, app: &mut App) -> Transition {
        ctx.canvas_movement();
        if ctx.redo_mouseover() {
            let mut new_selected = Vec::new();
            if let Some(pt) = ctx.canvas.get_cursor_in_map_space() {
                for idx in self
                    .quadtree
                    .query_bbox(Circle::new(pt, Distance::meters(3.0)).get_bounds())
                {
                    if self.objects[idx].polygon.contains_pt(pt) {
                        new_selected.push(idx);
                    }
                }
            }
            if new_selected != self.selected {
                self.selected = new_selected;
                if self.selected.is_empty() {
                    let details = "Mouseover an object to examine it".text_widget(ctx);
                    self.panel.replace(ctx, "mouseover", details);
                } else {
                    let mut txt = Text::new();
                    if self.selected.len() > 1 {
                        txt.add_line(format!("Selecting {} objects", self.selected.len()));
                    }
                    for idx in &self.selected {
                        if self.selected.len() > 1 {
                            txt.add_line(Line("Object").small_heading());
                        }
                        for (k, v) in &self.objects[*idx].attribs {
                            txt.add_line(format!("{} = {}", k, v));
                        }
                    }
                    let details = txt.into_widget(ctx);
                    self.panel.replace(ctx, "mouseover", details);
                }
            }
        }
        if !self.selected.is_empty() && ctx.normal_left_click() {
            let mut lines = Vec::new();
            let title = format!("{} objects", self.selected.len());
            for idx in self.selected.drain(..) {
                lines.push("Object".to_string());
                lines.push(String::new());
                for (k, v) in &self.objects[idx].attribs {
                    lines.push(format!("{} = {}", k, v));
                }
                lines.push(String::new());
            }
            lines.pop();
            return Transition::Push(PopupMsg::new_state(ctx, &title, lines));
        }

        match self.panel.event(ctx) {
            Outcome::Clicked(x) => match x.as_ref() {
                "close" => {
                    return Transition::Pop;
                }
                "load KML file" => {
                    return pick_file(ctx, app);
                }
                _ => unreachable!(),
            },
            Outcome::Changed(_) => {
                let mut query: String = self.panel.dropdown_value("query");
                let filter = self.panel.text_box("filter");
                if query == "None" && !filter.is_empty() {
                    query = filter;
                }
                let (batch, cnt) = make_query(app, &self.objects, &query);
                self.draw_query = ctx.upload(batch);
                self.panel.replace(
                    ctx,
                    "matches",
                    format!("Query matches {} objects", cnt).text_widget(ctx),
                );
            }
            _ => {}
        }

        Transition::Keep
    }

    fn draw(&self, g: &mut GfxCtx, app: &App) {
        g.redraw(&self.draw);
        g.redraw(&self.draw_query);
        self.panel.draw(g);

        for idx in &self.selected {
            let obj = &self.objects[*idx];
            g.draw_polygon(Color::BLUE, obj.polygon.clone());
            if let Some(b) = obj.osm_bldg {
                g.draw_polygon(Color::GREEN, app.primary.map.get_b(b).polygon.clone());
            }
        }
    }
}

/// Loads and clips objects to the current map. Also returns the dataset name.
fn load_objects(
    app: &App,
    file: Option<(String, Vec<u8>)>,
    dump_clipped_shapes: bool,
    timer: &mut Timer,
) -> (String, Vec<Object>) {
    let map = &app.primary.map;
    let bounds = map.get_gps_bounds();

    // TODO Use the bytes; don't re-read here. This is necessary to work on web.
    let path = file.map(|x| x.0);
    let raw_shapes = if let Some(ref path) = path {
        if path.ends_with(".kml") {
            let shapes = kml::load(path.clone(), bounds, true, timer).unwrap();
            // Assuming this is some huge file, conveniently convert the extract to .bin.
            // The new file will show up as untracked in git, so it'll be obvious this
            // happened.
            // Except don't do this for Seattle collisions; that's separately transformed into a
            // different binary format!
            if !path.ends_with("input/us/seattle/collisions.kml") {
                abstio::write_binary(path.replace(".kml", ".bin"), &shapes);
            }
            shapes
        } else if path.ends_with(".csv") {
            let shapes = ExtraShapes::load_csv(path.clone(), bounds, timer).unwrap();
            abstio::write_binary(path.replace(".csv", ".bin"), &shapes);
            shapes
        } else if path.ends_with(".geojson") || path.ends_with(".json") {
            let require_in_bounds = false;
            let shapes =
                ExtraShapes::load_geojson_no_clipping(path.clone(), bounds, require_in_bounds)
                    .unwrap();
            abstio::write_binary(
                path.replace(".geojson", ".bin").replace(".json", ".bin"),
                &shapes,
            );
            shapes
        } else if path.ends_with(".bin") {
            abstio::read_binary::<ExtraShapes>(path.to_string(), timer)
        } else {
            ExtraShapes { shapes: Vec::new() }
        }
    } else {
        ExtraShapes { shapes: Vec::new() }
    };
    let boundary = map.get_boundary_polygon();
    let dataset_name = path
        .as_ref()
        .map(abstutil::basename)
        .unwrap_or_else(|| "no file".to_string());
    let bldg_lookup: HashMap<String, BuildingID> = map
        .all_buildings()
        .iter()
        .map(|b| (b.orig_id.inner_id().to_string(), b.id))
        .collect();
    let cs = &app.cs;

    let pairs: Vec<(Object, ExtraShape)> = timer
        .parallelize(
            "convert shapes",
            raw_shapes.shapes.into_iter().enumerate().collect(),
            |(idx, shape)| {
                let pts = bounds.convert(&shape.points);
                if pts.iter().any(|pt| boundary.contains_pt(*pt)) {
                    Some((
                        make_object(
                            cs,
                            &bldg_lookup,
                            shape.attributes.clone(),
                            pts,
                            &dataset_name,
                            idx,
                        ),
                        shape,
                    ))
                } else {
                    None
                }
            },
        )
        .into_iter()
        .flatten()
        .collect();
    let mut objects = Vec::new();
    let mut clipped_shapes = Vec::new();
    for (obj, shape) in pairs {
        objects.push(obj);
        clipped_shapes.push(shape);
    }
    if path.is_some() && dump_clipped_shapes {
        abstio::write_binary(
            format!("{}_clipped_for_{}.bin", dataset_name, map.get_name().map),
            &clipped_shapes,
        );
    }

    (dataset_name, objects)
}

fn make_object(
    cs: &ColorScheme,
    bldg_lookup: &HashMap<String, BuildingID>,
    attribs: BTreeMap<String, String>,
    pts: Vec<Pt2D>,
    dataset_name: &str,
    obj_idx: usize,
) -> Object {
    let mut color = Color::RED.alpha(0.8);
    let polygon = if pts.len() == 1 {
        Circle::new(pts[0], RADIUS).to_polygon()
    } else if let Ok(ring) = Ring::new(pts.clone()) {
        // TODO If the below isn't true, show it as an outline instead? Can't make that a Polygon,
        // though
        // if attribs.get("spatial_type") == Some(&"Polygon".to_string()) {
        color = cs.rotating_color_plot(obj_idx).alpha(0.8);
        ring.into_polygon()
    } else {
        let backup = pts[0];
        match PolyLine::new(pts) {
            Ok(pl) => pl.make_arrow(THICKNESS, ArrowCap::Triangle),
            Err(err) => {
                println!(
                    "Object with attribs {:?} has messed up geometry: {}",
                    attribs, err
                );
                Circle::new(backup, RADIUS).to_polygon()
            }
        }
    };

    let mut osm_bldg = None;
    if dataset_name == "parcels" {
        if let Some(bldg) = attribs.get("osm_bldg") {
            if let Some(id) = bldg_lookup.get(bldg) {
                osm_bldg = Some(*id);
            }
        }
    }

    Object {
        polygon,
        color,
        attribs,
        osm_bldg,
    }
}

fn make_query(app: &App, objects: &[Object], query: &str) -> (GeomBatch, usize) {
    let mut batch = GeomBatch::new();
    let mut cnt = 0;
    let color = Color::BLUE.alpha(0.8);
    match query {
        "None" => {}
        "parcels without buildings" => {
            for obj in objects {
                if obj.osm_bldg.is_none() {
                    cnt += 1;
                    batch.push(color, obj.polygon.clone());
                }
            }
        }
        "parcels without buildings and trips or parking" => {
            for obj in objects {
                if obj.osm_bldg.is_none()
                    && (obj.attribs.contains_key("households")
                        || obj.attribs.contains_key("parking"))
                {
                    cnt += 1;
                    batch.push(color, obj.polygon.clone());
                }
            }
        }
        "parcels with multiple buildings" => {
            let mut seen = HashSet::new();
            for obj in objects {
                if let Some(b) = obj.osm_bldg {
                    if seen.contains(&b) {
                        cnt += 1;
                        batch.push(color, app.primary.map.get_b(b).polygon.clone());
                    } else {
                        seen.insert(b);
                    }
                }
            }
        }
        "parcels with >1 households" => {
            for obj in objects {
                if let Some(hh) = obj.attribs.get("households") {
                    if hh != "1" {
                        cnt += 1;
                        batch.push(color, obj.polygon.clone());
                    }
                }
            }
        }
        "parcels with parking" => {
            for obj in objects {
                if obj.attribs.contains_key("parking") {
                    cnt += 1;
                    batch.push(color, obj.polygon.clone());
                }
            }
        }
        x => {
            for obj in objects {
                for (k, v) in &obj.attribs {
                    if format!("{}={}", k, v).contains(x) {
                        batch.push(color, obj.polygon.clone());
                        break;
                    }
                }
            }
        }
    }
    (batch, cnt)
}

fn pick_file(ctx: &mut EventCtx, app: &App) -> Transition {
    Transition::Push(FilePicker::new_state(
        ctx,
        Some(app.primary.map.get_city_name().input_path("")),
        Box::new(|ctx, app, maybe_file| {
            if let Ok(Some(file)) = maybe_file {
                Transition::Multi(vec![
                    Transition::Pop,
                    Transition::Replace(ViewKML::new_state(ctx, app, Some(file))),
                ])
            } else {
                Transition::Pop
            }
        }),
    ))
}