maszyna/editor/editorNmt.hpp

/*
This Source Code Form is subject to the
terms of the Mozilla Public License, v.
2.0. If a copy of the MPL was not
distributed with this file, You can
obtain one at
http://mozilla.org/MPL/2.0/.
*/

#pragma once

#include <condition_variable>
#include <cstdint>
#include <deque>
#include <map>
#include <memory>
#include <mutex>
#include <set>
#include <string>
#include <thread>
#include <utility>
#include <vector>

#include <glm/glm.hpp>

// heights of the ground from the digital terrain model of GUGiK (NMT, the WCS service of geoportal.gov.pl): squares of the
// EPSG:2180 grid fetched in the background at 1 m, kept on the disk and sampled in the coordinates of the scenery. the
// scenery is placed on the grid by the PUWG 1992 coordinates of its point (0,0,0), as the orthophoto is: easting = east - x,
// northing = north + z. the heights are those of the model, metres over the sea
class editor_nmt
{
  public:
	editor_nmt();
	~editor_nmt();
	editor_nmt(editor_nmt const &) = delete;
	editor_nmt &operator=(editor_nmt const &) = delete;

	// where the point (0,0,0) of the scenery lies in PUWG 1992; the squares fetched stay, only the mapping changes
	void place(double const North, double const East);
	// a scenery at (0,0) isn't placed anywhere
	bool placed() const;
	// the height of the model at the point of the scenery; false where its square isn't in yet or the model has no data
	bool height(double const X, double const Z, double &Height) const;
	// the squares under the rectangle of the scenery (x, z) asked for in the background, the ones nearest its middle first;
	// true if all of them are in already, those the service couldn't give included
	bool request(glm::dvec2 const &Min, glm::dvec2 const &Max);
	// squares asked for and not in yet
	std::size_t waiting() const;
	// a square under the rectangle the service didn't give, which is asked for again after a while
	bool retrying(glm::dvec2 const &Min, glm::dvec2 const &Max) const;
	// the squares the service didn't give asked for again at once
	void retry();
	// the squares waiting aren't fetched; those in stay
	void cancel();
	// why squares in memory have no data, empty when all came; a place outside of the model is told first. Again: whether
	// some of them are asked for again
	std::string error(bool *Again = nullptr) const;
	// the squares dropped from the memory, and those waiting; the files on the disk stay
	void clear();
	// whether this build can fetch from the service at all
	static bool can_download();
	// the squares touching the polygon of PUWG 1992 (easting, northing) put into the disk cache in the background, while no
	// square is asked for; none of them kept in the memory. Empty: none
	void prefetch(std::vector<glm::dvec2> const &Polygon);
	void prefetch_paused(bool const Paused);
	// of the squares of the polygon: in the disk cache, all of them, failed
	struct prefetch_state
	{
		int cached{0};
		int total{0};
		int failed{0};
	};
	prefetch_state prefetched() const;

	// side of a square of the grid, m
	static double constexpr square_size{500.0};

  private:
	using key = std::pair<int, int>; // easting and northing index of the square on the grid
	struct square
	{
		double east{0.0}; // of the outer edge of the first column
		double north{0.0}; // of the outer edge of the first row, the northernmost
		double pixel{1.0};
		int width{0};
		int height{0};
		std::vector<float> heights; // rows from the north, columns from the west
		bool failed{false}; // the service gave nothing usable: the square has no data
		bool outside{false}; // failed for it lies outside of the model: asked again, it gives nothing either
		double failed_at{0.0}; // s
		std::string error;
	};

	key key_of(double const East, double const North) const;
	void work();
	std::shared_ptr<square const> fetch(key const &Key, std::string &Error);

	mutable std::mutex m_mutex;
	std::condition_variable m_wake;
	std::vector<std::thread> m_workers;
	std::deque<key> m_queue;
	std::set<key> m_queued;
	std::map<key, std::shared_ptr<square const>> m_squares;
	std::string m_coverage; // the name of the model in the service, read from its capabilities once
	double m_north{0.0};
	double m_east{0.0};
	bool m_stop{false};
	// the squares of the download area for the disk cache
	std::vector<key> m_prefetch;
	std::size_t m_prefetch_next{0};
	std::set<key> m_prefetch_cached;
	std::set<key> m_prefetch_failed;
	std::uint32_t m_prefetch_generation{0};
	bool m_prefetch_paused{false};
	void start_workers(); // under the lock
	std::string file_of(key const &Key) const;
};