95 lines
2.5 KiB
Plaintext
95 lines
2.5 KiB
Plaintext
|
[/============================================================================
|
||
|
|
Boost.Geometry (aka GGL, Generic Geometry Library)
|
||
|
|
|
||
|
|
Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands.
|
||
|
|
Copyright (c) 2008-2013 Bruno Lalande, Paris, France.
|
||
|
|
Copyright (c) 2009-2013 Mateusz Loskot, London, UK.
|
||
|
|
|
||
|
|
Use, modification and distribution is subject to the Boost Software License,
|
||
|
|
Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||
|
|
http://www.boost.org/LICENSE_1_0.txt)
|
||
|
|
=============================================================================/]
|
||
|
|
|
||
|
|
|
||
|
|
[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically]
|
||
|
|
[/ Generated from doxy/doxygen_output/xml/group__azimuth.xml]
|
||
|
|
[section:azimuth_2 azimuth]
|
||
|
|
|
||
|
|
'''<indexterm><primary>azimuth</primary></indexterm>'''
|
||
|
|
Calculate azimuth of a segment defined by a pair of points.
|
||
|
|
|
||
|
|
[heading Synopsis]
|
||
|
|
``template<typename Point1, typename Point2>
|
||
|
|
auto azimuth(Point1 const & point1, Point2 const & point2)``
|
||
|
|
|
||
|
|
[heading Parameters]
|
||
|
|
|
||
|
|
[table
|
||
|
|
[[Type] [Concept] [Name] [Description] ]
|
||
|
|
[[Point1 const &] [Type of the first point of a segment. ] [point1] [First point of a segment. ]]
|
||
|
|
[[Point2 const &] [Type of the second point of a segment. ] [point2] [Second point of a segment. ]]
|
||
|
|
]
|
||
|
|
|
||
|
|
|
||
|
|
[heading Returns]
|
||
|
|
Azimuth in radians.
|
||
|
|
|
||
|
|
[heading Header]
|
||
|
|
Either
|
||
|
|
|
||
|
|
`#include <boost/geometry.hpp>`
|
||
|
|
|
||
|
|
|
||
|
|
Or
|
||
|
|
|
||
|
|
`#include <boost/geometry/algorithms/azimuth.hpp>`
|
||
|
|
|
||
|
|
[include reference/algorithms/azimuth.qbk]
|
||
|
|
[heading Example]
|
||
|
|
[azimuth]
|
||
|
|
[azimuth_output]
|
||
|
|
|
||
|
|
|
||
|
|
[endsect]
|
||
|
|
|
||
|
|
[section:azimuth_3_with_strategy azimuth (with strategy)]
|
||
|
|
|
||
|
|
'''<indexterm><primary>azimuth</primary></indexterm>'''
|
||
|
|
Calculate azimuth of a segment defined by a pair of points.
|
||
|
|
|
||
|
|
[heading Synopsis]
|
||
|
|
``template<typename Point1, typename Point2, typename Strategy>
|
||
|
|
auto azimuth(Point1 const & point1, Point2 const & point2, Strategy const & strategy)``
|
||
|
|
|
||
|
|
[heading Parameters]
|
||
|
|
|
||
|
|
[table
|
||
|
|
[[Type] [Concept] [Name] [Description] ]
|
||
|
|
[[Point1 const &] [Type of the first point of a segment. ] [point1] [First point of a segment. ]]
|
||
|
|
[[Point2 const &] [Type of the second point of a segment. ] [point2] [Second point of a segment. ]]
|
||
|
|
[[Strategy const &] [Type of an umbrella strategy defining azimuth strategy. ] [strategy] [Umbrella strategy defining azimuth strategy. ]]
|
||
|
|
]
|
||
|
|
|
||
|
|
|
||
|
|
[heading Returns]
|
||
|
|
Azimuth in radians.
|
||
|
|
|
||
|
|
[heading Header]
|
||
|
|
Either
|
||
|
|
|
||
|
|
`#include <boost/geometry.hpp>`
|
||
|
|
|
||
|
|
|
||
|
|
Or
|
||
|
|
|
||
|
|
`#include <boost/geometry/algorithms/azimuth.hpp>`
|
||
|
|
|
||
|
|
[include reference/algorithms/azimuth.qbk]
|
||
|
|
[heading Example]
|
||
|
|
[azimuth_strategy]
|
||
|
|
[azimuth_strategy_output]
|
||
|
|
|
||
|
|
|
||
|
|
[endsect]
|
||
|
|
|