Imported Upstream version 1.72.0
[platform/upstream/boost.git] / boost / geometry / srs / projections / proj / latlong.hpp
1 // Boost.Geometry - gis-projections (based on PROJ4)
2
3 // Copyright (c) 2008-2015 Barend Gehrels, Amsterdam, the Netherlands.
4
5 // This file was modified by Oracle on 2017, 2018, 2019.
6 // Modifications copyright (c) 2017-2019, Oracle and/or its affiliates.
7 // Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle.
8
9 // Use, modification and distribution is subject to the Boost Software License,
10 // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
11 // http://www.boost.org/LICENSE_1_0.txt)
12
13 // This file is converted from PROJ4, http://trac.osgeo.org/proj
14 // PROJ4 is originally written by Gerald Evenden (then of the USGS)
15 // PROJ4 is maintained by Frank Warmerdam
16 // PROJ4 is converted to Boost.Geometry by Barend Gehrels
17
18 // Last updated version of proj: 5.0.0
19
20 // Original copyright notice:
21
22 // Purpose:  Stub projection implementation for lat/long coordinates. We
23 //           don't actually change the coordinates, but we want proj=latlong
24 //           to act sort of like a projection.
25 // Author:   Frank Warmerdam, warmerdam@pobox.com
26 // Copyright (c) 2000, Frank Warmerdam
27
28 // Permission is hereby granted, free of charge, to any person obtaining a
29 // copy of this software and associated documentation files (the "Software"),
30 // to deal in the Software without restriction, including without limitation
31 // the rights to use, copy, modify, merge, publish, distribute, sublicense,
32 // and/or sell copies of the Software, and to permit persons to whom the
33 // Software is furnished to do so, subject to the following conditions:
34
35 // The above copyright notice and this permission notice shall be included
36 // in all copies or substantial portions of the Software.
37
38 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
39 // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
40 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
41 // THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
42 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
43 // FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
44 // DEALINGS IN THE SOFTWARE.
45
46 #ifndef BOOST_GEOMETRY_PROJECTIONS_LATLONG_HPP
47 #define BOOST_GEOMETRY_PROJECTIONS_LATLONG_HPP
48
49 #include <boost/geometry/srs/projections/impl/base_static.hpp>
50 #include <boost/geometry/srs/projections/impl/base_dynamic.hpp>
51 #include <boost/geometry/srs/projections/impl/projects.hpp>
52 #include <boost/geometry/srs/projections/impl/factory_entry.hpp>
53
54
55 namespace boost { namespace geometry
56 {
57
58 namespace projections
59 {
60     #ifndef DOXYGEN_NO_DETAIL
61     namespace detail { namespace latlong
62     {
63
64             /* very loosely based upon DMA code by Bradford W. Drew */
65
66             template <typename T, typename Parameters>
67             struct base_latlong_other
68             {
69                 // FORWARD(forward)
70                 // Project coordinates from geographic (lon, lat) to cartesian (x, y)
71                 inline void fwd(Parameters const& par, T const& lp_lon, T const& lp_lat, T& xy_x, T& xy_y) const
72                 {
73                     // TODO: in the original code a is not used
74                     // different mechanism is probably used instead
75                     xy_x = lp_lon / par.a;
76                     xy_y = lp_lat / par.a;
77                 }
78
79                 // INVERSE(inverse)
80                 // Project coordinates from cartesian (x, y) to geographic (lon, lat)
81                 inline void inv(Parameters const& par, T const& xy_x, T const& xy_y, T& lp_lon, T& lp_lat) const
82                 {
83                     // TODO: in the original code a is not used
84                     // different mechanism is probably used instead
85                     lp_lat = xy_y * par.a;
86                     lp_lon = xy_x * par.a;
87                 }
88
89                 static inline std::string get_name()
90                 {
91                     return "latlong_other";
92                 }
93
94             };
95
96             // Lat/long (Geodetic)
97             template <typename Parameters>
98             inline void setup_latlong(Parameters& par)
99             {
100                     par.is_latlong = 1;
101                     par.x0 = 0.0;
102                     par.y0 = 0.0;
103             }
104
105     }} // namespace detail::latlong
106     #endif // doxygen
107
108     /*!
109         \brief Lat/long (Geodetic) projection
110         \ingroup projections
111         \tparam Geographic latlong point type
112         \tparam Cartesian xy point type
113         \tparam Parameters parameter type
114         \par Example
115         \image html ex_latlong.gif
116     */
117     template <typename T, typename Parameters>
118     struct latlong_other : public detail::latlong::base_latlong_other<T, Parameters>
119     {
120         template <typename Params>
121         inline latlong_other(Params const& , Parameters & par)
122         {
123             detail::latlong::setup_latlong(par);
124         }
125     };
126
127     #ifndef DOXYGEN_NO_DETAIL
128     namespace detail
129     {
130
131         // Static projection
132         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_lonlat, latlong_other)
133         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_latlon, latlong_other)
134         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_latlong, latlong_other)
135         BOOST_GEOMETRY_PROJECTIONS_DETAIL_STATIC_PROJECTION_FI(srs::spar::proj_longlat, latlong_other)
136
137         // Factory entry(s)
138         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_ENTRY_FI(latlong_entry, latlong_other)
139         
140         BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_BEGIN(latlong_init)
141         {
142             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(lonlat, latlong_entry)
143             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(latlon, latlong_entry)
144             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(latlong, latlong_entry)
145             BOOST_GEOMETRY_PROJECTIONS_DETAIL_FACTORY_INIT_ENTRY(longlat, latlong_entry)
146         }
147
148     } // namespace detail
149     #endif // doxygen
150
151 } // namespace projections
152
153 }} // namespace boost::geometry
154
155 #endif // BOOST_GEOMETRY_PROJECTIONS_LATLONG_HPP
156