boost_mirror/geometry
1
0
Fork 0
mirror of https://github.com/boostorg/geometry.git synced 2025-05-11 13:34:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

[doc][srs][strategies] Add/improve docs of geographic strategies and spheroid.

Browse Source
This commit is contained in:
Adam Wulkiewicz 2018-03-02 23:22:36 +01:00
parent ff427c0366
commit 2a2e0ac41e
12 changed files with 53 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
doc/doxy/Doxyfile
View File

@ -207,6 +207,7 @@ INPUT = . .. ../../../../boost/geometry/core \
../../../../boost/geometry/io/svg \
../../../../boost/geometry/policies \
../../../../boost/geometry/policies/relate \
../../../../boost/geometry/srs \
../../../../boost/geometry/strategies \
../../../../boost/geometry/strategies/concepts \
../../../../boost/geometry/strategies/agnostic \

1
doc/doxy/doxygen_input/groups/groups.hpp
View File

@ -67,6 +67,7 @@
\defgroup selected selection: check if a geometry is "selected" by a point
\defgroup set set: set geometries
\defgroup simplify simplify: remove points from a geometry, keeping shape (simplification or generalization)
\defgroup srs srs: Spatial Reference System definition
\defgroup strategies strategies: strategies
\defgroup svg svg: Stream SVG (Scalable Vector Graphics)
\defgroup sym_difference sym_difference: sym_difference of two geometries

3
doc/html/index.html
View File

@ -83,6 +83,7 @@
<dt><span class="section"><a href="geometry/reference/iterators.html">Iterators</a></span></dt>
<dt><span class="section"><a href="geometry/reference/models.html">Models</a></span></dt>
<dt><span class="section"><a href="geometry/reference/spatial_indexes.html">Spatial Indexes</a></span></dt>
<dt><span class="section"><a href="geometry/reference/srs.html">SRS</a></span></dt>
<dt><span class="section"><a href="geometry/reference/strategies.html">Strategies</a></span></dt>
<dt><span class="section"><a href="geometry/reference/views.html">Views</a></span></dt>
</dl></dd>
@ -137,7 +138,7 @@
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"><p><small>Last revised: February 26, 2017 at 00:30:21 GMT</small></p></td>
<td align="left"><p><small>Last revised: March 02, 2018 at 22:11:06 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>

10
doc/make_qbk.py
View File

@ -78,6 +78,9 @@ def class_to_quickbook(section):
def class_to_quickbook2(classname, section):
run_command(cmd % ("classboost_1_1geometry_1_1" + classname, section))
def srs_class_to_quickbook(section):
run_command(cmd % ("classboost_1_1geometry_1_1srs_1_1" + section.replace("_", "__"), "srs_" + section))
def strategy_to_quickbook(section):
p = section.find("::")
ns = section[:p]
@ -122,6 +125,7 @@ models = ["point", "linestring", "box"
, "polygon", "segment", "ring"
, "multi_linestring", "multi_point", "multi_polygon", "referring_segment"]
srs = ["spheroid"]
strategies = ["area::cartesian", "area::spherical", "area::geographic"
, "buffer::point_circle", "buffer::point_square"
@ -138,7 +142,8 @@ strategies = ["area::cartesian", "area::spherical", "area::geographic"
, "distance::projected_point"
, "within::winding", "within::franklin", "within::crossings_multiply"
, "simplify::douglas_peucker"
, "side::side_by_triangle", "side::side_by_cross_track", "side::spherical_side_formula"
, "side::side_by_triangle", "side::side_by_cross_track"
, "side::spherical_side_formula", "side::geographic"
, "transform::inverse_transformer", "transform::map_transformer"
, "transform::rotate_transformer", "transform::scale_transformer"
, "transform::translate_transformer", "transform::matrix_transformer"
@ -170,6 +175,9 @@ for i in iterators:
for i in models:
model_to_quickbook(i)
for i in srs:
srs_class_to_quickbook(i)
for i in strategies:
strategy_to_quickbook(i)

1
doc/quickref.xml
View File

@ -584,6 +584,7 @@
<member><link linkend="geometry.reference.strategies.strategy_side_side_by_triangle">strategy::side::side_by_triangle</link></member>
<member><link linkend="geometry.reference.strategies.strategy_side_side_by_cross_track">strategy::side::side_by_cross_track</link></member>
<member><link linkend="geometry.reference.strategies.strategy_side_spherical_side_formula">strategy::side::spherical_side_formula</link></member>
<member><link linkend="geometry.reference.strategies.strategy_side_geographic">strategy::side::geographic</link></member>
</simplelist>
</entry>
<entry valign="top">

4
doc/reference.qbk
View File

@ -335,6 +335,9 @@
[endsect]
[section:srs SRS]
[include generated/srs_spheroid.qbk]
[endsect]
[section:strategies Strategies]
[include generated/area_cartesian.qbk]
@ -365,6 +368,7 @@
[include generated/side_side_by_triangle.qbk]
[include generated/side_side_by_cross_track.qbk]
[include generated/side_spherical_side_formula.qbk]
[include generated/side_geographic.qbk]
[include generated/simplify_douglas_peucker.qbk]
[include generated/transform_inverse_transformer.qbk]
[include generated/transform_map_transformer.qbk]

6
include/boost/geometry/srs/sphere.hpp
View File

@ -4,8 +4,8 @@
// Copyright (c) 2008-2012 Bruno Lalande, Paris, France.
// Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
// This file was modified by Oracle on 2014, 2016, 2017.
// Modifications copyright (c) 2014-2017 Oracle and/or its affiliates.
// This file was modified by Oracle on 2014, 2016, 2018.
// Modifications copyright (c) 2014-2018 Oracle and/or its affiliates.
// Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
@ -37,6 +37,8 @@ namespace srs
/*!
\brief Defines sphere radius value for use in spherical CS calculations
\ingroup srs
\tparam RadiusType tparam_radius
*/
template <typename RadiusType>
class sphere

6
include/boost/geometry/srs/spheroid.hpp
View File

@ -4,8 +4,8 @@
// Copyright (c) 2008-2012 Bruno Lalande, Paris, France.
// Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
// This file was modified by Oracle on 2014, 2016, 2017.
// Modifications copyright (c) 2014-2017 Oracle and/or its affiliates.
// This file was modified by Oracle on 2014, 2016, 2017, 2018.
// Modifications copyright (c) 2014-2018 Oracle and/or its affiliates.
// Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
@ -37,8 +37,10 @@ namespace srs
/*!
\brief Defines spheroid radius values for use in geographical CS calculations
\ingroup srs
\note See http://en.wikipedia.org/wiki/Figure_of_the_Earth
and http://en.wikipedia.org/wiki/World_Geodetic_System#A_new_World_Geodetic_System:_WGS84
\tparam RadiusType tparam_radius
*/
template <typename RadiusType>
class spheroid

5
include/boost/geometry/strategies/geographic/area.hpp
View File

@ -2,7 +2,7 @@
// Copyright (c) 2017 Adam Wulkiewicz, Lodz, Poland.
// Copyright (c) 2016-2017 Oracle and/or its affiliates.
// Copyright (c) 2016-2018 Oracle and/or its affiliates.
// Contributed and/or modified by Vissarion Fisikopoulos, on behalf of Oracle
// Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
@ -44,7 +44,8 @@ namespace strategy { namespace area
\qbk{
[heading See also]
[link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]
\* [link geometry.reference.algorithms.area.area_2_with_strategy area (with strategy)]
\* [link geometry.reference.srs.srs_spheroid srs::spheroid]
}
*/
template

3
include/boost/geometry/strategies/geographic/densify.hpp
View File

@ -39,7 +39,8 @@ namespace strategy { namespace densify
\qbk{
[heading See also]
[link geometry.reference.algorithms.densify.densify_4_with_strategy densify (with strategy)]
\* [link geometry.reference.algorithms.densify.densify_4_with_strategy densify (with strategy)]
\* [link geometry.reference.srs.srs_spheroid srs::spheroid]
}
*/
template

17
include/boost/geometry/strategies/geographic/distance.hpp
View File

@ -2,8 +2,8 @@
// Copyright (c) 2007-2016 Barend Gehrels, Amsterdam, the Netherlands.
// This file was modified by Oracle on 2014-2017.
// Modifications copyright (c) 2014-2017 Oracle and/or its affiliates.
// This file was modified by Oracle on 2014-2018.
// Modifications copyright (c) 2014-2018 Oracle and/or its affiliates.
// Contributed and/or modified by Vissarion Fysikopoulos, on behalf of Oracle
// Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
@ -43,6 +43,19 @@ namespace boost { namespace geometry
namespace strategy { namespace distance
{
/*!
\brief Distance calculation for geographic coordinates on a spheroid
\ingroup strategies
\tparam FormulaPolicy Formula used to calculate azimuths
\tparam Spheroid The spheroid model
\tparam CalculationType \tparam_calculation
\qbk{
[heading See also]
\* [link geometry.reference.algorithms.distance.distance_3_with_strategy distance (with strategy)]
\* [link geometry.reference.srs.srs_spheroid srs::spheroid]
}
*/
template
<
typename FormulaPolicy = strategy::andoyer,

9
include/boost/geometry/strategies/geographic/side.hpp
View File

@ -2,8 +2,8 @@
// Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands.
// This file was modified by Oracle on 2014-2017.
// Modifications copyright (c) 2014-2017 Oracle and/or its affiliates.
// This file was modified by Oracle on 2014-2018.
// Modifications copyright (c) 2014-2018 Oracle and/or its affiliates.
// Contributed and/or modified by Adam Wulkiewicz, on behalf of Oracle
@ -49,6 +49,11 @@ namespace strategy { namespace side
\tparam FormulaPolicy Geodesic solution formula policy.
\tparam Spheroid Reference model of coordinate system.
\tparam CalculationType \tparam_calculation
\qbk{
[heading See also]
[link geometry.reference.srs.srs_spheroid srs::spheroid]
}
*/
template
<