1[/============================================================================ 2 Boost.Geometry (aka GGL, Generic Geometry Library) 3 4 Copyright (c) 2007-2013 Barend Gehrels, Amsterdam, the Netherlands. 5 Copyright (c) 2008-2013 Bruno Lalande, Paris, France. 6 Copyright (c) 2009-2013 Mateusz Loskot, London, UK. 7 8 Use, modification and distribution is subject to the Boost Software License, 9 Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at 10 http://www.boost.org/LICENSE_1_0.txt) 11=============================================================================/] 12 13 14[/ Generated by doxygen_xml2qbk 1.1.1, don't change, will be overwritten automatically] 15[/ Generated from doxy/doxygen_output/xml/group__get.xml] 16[section:get_1 get] 17 18'''<indexterm><primary>get</primary></indexterm>''' 19Get coordinate value of a geometry (usually a point) 20 21[heading Description] 22The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere. 23 24[heading Synopsis] 25``template<std::size_t Dimension, typename Geometry> 26coordinate_type<Geometry>::type get(Geometry const & geometry)`` 27 28[heading Parameters] 29 30[table 31[[Type] [Concept] [Name] [Description] ] 32[[Dimension] [Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry ] [ - ] [Must be specified]] 33[[Geometry const &] [Any type fulfilling a Geometry Concept (usually a Point Concept) ] [geometry] [A model of the specified concept (usually a point) ]] 34] 35 36 37[heading Returns] 38The coordinate value of specified dimension of specified geometry 39 40[heading Header] 41Either 42 43`#include <boost/geometry.hpp>` 44 45 46Or 47 48`#include <boost/geometry/core/access.hpp>` 49 50[include reference/core/get_point.qbk] 51 52 53[endsect] 54 55[section:get_1_with_index get (with index)] 56 57'''<indexterm><primary>get</primary></indexterm>''' 58get coordinate value of a Box or Segment 59 60[heading Description] 61The free functions [*get] and [*set] are two of the most important functions of Boost.Geometry, both within the library, as also for the library user. With these two functions you normally get and set coordinate values from and for a point, box, segment or sphere. 62 63[heading Synopsis] 64``template<std::size_t Index, std::size_t Dimension, typename Geometry> 65coordinate_type<Geometry>::type get(Geometry const & geometry)`` 66 67[heading Parameters] 68 69[table 70[[Type] [Concept] [Name] [Description] ] 71[[Index] [Index, this template parameter is required. For a Box: either min_corner or max_corner. For a Segment: either 0 or 1 for first or last point. ] [ - ] [Must be specified]] 72[[Dimension] [Dimension, this template parameter is required. Should contain \[0 .. n-1\] for an n-dimensional geometry ] [ - ] [Must be specified]] 73[[Geometry const &] [Any type fulfilling a Box Concept or a Segment Concept ] [geometry] [A model of the specified concept ]] 74] 75 76 77[heading Returns] 78coordinate value 79 80[heading Header] 81Either 82 83`#include <boost/geometry.hpp>` 84 85 86Or 87 88`#include <boost/geometry/core/access.hpp>` 89 90[include reference/core/get_box.qbk] 91 92 93[endsect] 94 95[section:get_as_radian_1 get_as_radian] 96 97'''<indexterm><primary>get_as_radian</primary></indexterm>''' 98get coordinate value of a point, result is in Radian 99 100[heading Description] 101Result is in Radian, even if source coordinate system is in Degrees 102 103[heading Synopsis] 104``template<std::size_t Dimension, typename Geometry> 105fp_coordinate_type<Geometry>::type get_as_radian(Geometry const & geometry)`` 106 107[heading Parameters] 108 109[table 110[[Type] [Concept] [Name] [Description] ] 111[[Dimension] [dimension ] [ - ] [Must be specified]] 112[[Geometry const &] [geometry ] [geometry] [geometry to get coordinate value from ]] 113] 114 115 116[heading Returns] 117coordinate value 118 119[heading Header] 120Either 121 122`#include <boost/geometry.hpp>` 123 124 125Or 126 127`#include <boost/geometry/core/radian_access.hpp>` 128 129 130[endsect] 131 132[section:get_as_radian_1 get_as_radian] 133 134'''<indexterm><primary>get_as_radian</primary></indexterm>''' 135get coordinate value of a segment or box, result is in Radian 136 137[heading Description] 138Result is in Radian, even if source coordinate system is in Degrees 139 140[heading Synopsis] 141``template<std::size_t Index, std::size_t Dimension, typename Geometry> 142fp_coordinate_type<Geometry>::type get_as_radian(Geometry const & geometry)`` 143 144[heading Parameters] 145 146[table 147[[Type] [Concept] [Name] [Description] ] 148[[Index] [index ] [ - ] [Must be specified]] 149[[Dimension] [dimension ] [ - ] [Must be specified]] 150[[Geometry const &] [geometry ] [geometry] [geometry to get coordinate value from ]] 151] 152 153 154[heading Returns] 155coordinate value 156 157[heading Header] 158Either 159 160`#include <boost/geometry.hpp>` 161 162 163Or 164 165`#include <boost/geometry/core/radian_access.hpp>` 166 167 168[endsect] 169 170