CoordinateProjectionManager.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: Design
File: CoordinateProjectionManager
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/CoordinateProjection.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/String.h>
#include <NDEVR/Pointer.h>
#include <NDEVR/File.h>
#include <NDEVR/UUID.h>
#include <functional>
namespace NDEVR
{
    template<uint01 t_dims, class t_type, class t_vertex>
    class Polyline;
    class File;
    class CoordinateConverter;
    class UnitOption;
    class CustomUnit;
    class Scanner;
    class JSONNode;
    class UnitManager;
 
    /**--------------------------------------------------------------------------------------------------
    \brief A specific unit that can convert between coordinate projections
    **/
    class NDEVR_DESIGN_API LatLonUnit
    {
    public:
        static DynamicPointer<CustomUnit> CustomLatLonUnit();
        static constexpr const char* LatLonUnitName() { return "LatLonUnit"; }
    };
    template<class t_type>
    class Resource;
 
    /**--------------------------------------------------------------------------------------------------
    \brief Stores Coordinate Projections
        See https://ndevr.org/coordinate-projection/
    **/
    class NDEVR_DESIGN_API CoordinateProjectionManager
    {
    public:
        void setCoordinateFile(File& file);
        void readCoordinateFile(File& file);
        void writeCoordinateFile(File& file) const;
        void readDirectoryStructure(File& top_dir, File& save_as);
        void readDirectoryStructure(File& top_dir);
        void addProjection(const CoordinateProjection& projection);
        void createUTMCoordinateProjections();
        void cleanup();
        void processWKT(CoordinateProjection& projection, Scanner& scan);
        void processJSON(CoordinateProjection& projection, JSONNode& json);
        void setDownloader(std::function<void(const String&, std::function<void(const String&)>)> downloader);
        bool hasDownloader() const;
        void downloadAllProjections();
        bool downloadEPSGProjection(uint04 epsg_code, std::function<void(uint04 code, UUID projection)> finished_callback, bool force_download = false);
        UUID getProjection(const String& name) const;
        UUID wgs84Projection() const;
        Buffer<UUID> getProjections(const String& search_string = String()) const;
        const CoordinateProjection& get(UUID id) const;
        bool hasProjection(UUID projection_id) const;
        UUID bestUTMProjectionLatLon(const Vertex<2, fltp08>& lat_lon) const;
        Buffer<UUID> bestProjectionsLatLon(const Vertex<2, fltp08>& lat_lon) const;
        UUID bestUTMProjectionMeters(const Vertex<2, fltp08>& lat_lon) const;
        CoordinateConverter* wgs84Converter(UUID from_id) const;
        Bounds<2, fltp08> convertToWGS84(UUID from_id, const Bounds<3, fltp08>& bounds) const;
        Bounds<2, fltp08> convertFromWGS84(UUID from_id, const Bounds<2, Angle<fltp08>>& bounds) const;
        Bounds<2, fltp08> convertFromWGS84(UUID from_id, const Bounds<2, fltp08>& bounds) const;
        Bounds<2, fltp08> convertFromWGS84(UUID from_id, const Bounds<3, fltp08>& bounds) const;
        Vertex<3, fltp08> convertToWGS84(UUID from_id, const Vertex<3, fltp08>& location) const;
        Vertex<3, fltp08> convertFromWGS84(UUID from_id, const Vertex<3, fltp08>& location) const;
        Buffer<Vertex<2, fltp08>> convertToWGS84(UUID from_id, const Buffer<Vertex<2, fltp08>>& locations) const;
        LineSegment<2, fltp08> convertToWGS84(UUID from_id, const LineSegment<2, fltp08>& segment) const;
        Polyline<2, fltp08, Vertex<2, fltp08>> convertToWGS84(UUID from_id, const Polyline<2, fltp08, Vertex<2, fltp08>>& segment) const;
        const Dictionary<UUID, CoordinateProjection>& projections() const { return m_projections; }
        static CoordinateProjectionManager& DefaultInstance();
        static bool HasEngine();
        ConstPointer<Unit> wGS84Unit(UUID from_id);
        ConstPointer<UnitOption> wGS84UnitOption();
        String createWKTString(UUID id, const UnitManager& manager) const;
    public:
        static UUID UseBestUTMProjectionID();
        static CoordinateProjection& BestUTMProjectionInfo();
    protected:
        ConstPointer<Unit> unitFromString(const String& unit);
    protected:
        
        mutable Dictionary<UUID, CoordinateConverter*> m_wgs_84_converter;
        Buffer<UUID> m_utm_projections;
        std::function<void(const String&, std::function<void(const String&)>)> m_downloader;
        Dictionary<UUID, CoordinateProjection> m_projections;
        mutable UUID m_wgs84_id = Constant<UUID>::Invalid;
        Dictionary<String, ConstPointer<Unit>> m_units;
        File m_coordinate_file;
    };
}