• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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__make.xml]
16[section:make_2_2_coordinate_values make (2 coordinate values)]
17
18'''<indexterm><primary>make</primary></indexterm>'''
19Construct a geometry.
20
21[heading Synopsis]
22``template<typename Geometry, typename Type>
23Geometry make(Type const & c1, Type const & c2)``
24
25[heading Parameters]
26
27[table
28[[Type] [Concept] [Name] [Description] ]
29[[Geometry] [Any type fulfilling a Geometry Concept ] [ - ] [Must be specified]]
30[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c1] [First coordinate (usually x-coordinate) ]]
31[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c2] [Second coordinate (usually y-coordinate) ]]
32]
33
34
35[heading Returns]
36The constructed geometry, here: a 2D point
37
38[heading Header]
39Either
40
41`#include <boost/geometry.hpp>`
42
43
44Or
45
46`#include <boost/geometry/algorithms/make.hpp>`
47
48[heading Example]
49[make_2d_point] [make_2d_point_output]
50
51[heading See also]
52* [link geometry.reference.algorithms.assign.assign_values_3_2_coordinate_values assign]
53
54
55[endsect]
56
57[section:make_3_3_coordinate_values make (3 coordinate values)]
58
59'''<indexterm><primary>make</primary></indexterm>'''
60Construct a geometry.
61
62[heading Synopsis]
63``template<typename Geometry, typename Type>
64Geometry make(Type const & c1, Type const & c2, Type const & c3)``
65
66[heading Parameters]
67
68[table
69[[Type] [Concept] [Name] [Description] ]
70[[Geometry] [Any type fulfilling a Geometry Concept ] [ - ] [Must be specified]]
71[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c1] [First coordinate (usually x-coordinate) ]]
72[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c2] [Second coordinate (usually y-coordinate) ]]
73[[Type const &] [numerical type (int, double, ttmath, ...) to specify the coordinates ] [c3] [Third coordinate (usually z-coordinate) ]]
74]
75
76
77[heading Returns]
78The constructed geometry, here: a 3D point
79
80[heading Header]
81Either
82
83`#include <boost/geometry.hpp>`
84
85
86Or
87
88`#include <boost/geometry/algorithms/make.hpp>`
89
90[heading Example]
91[make_3d_point] [make_3d_point_output]
92
93[heading See also]
94* [link geometry.reference.algorithms.assign.assign_values_4_3_coordinate_values assign]
95
96
97[endsect]
98
99[section:make_inverse make_inverse]
100
101'''<indexterm><primary>make_inverse</primary></indexterm>'''
102Construct a box with inverse infinite coordinates.
103
104[heading Description]
105The make\u005finverse function initializes a 2D or 3D box with large coordinates, the min corner is very large, the max corner is very small. This is useful e.g. in combination with the expand function, to determine the bounding box of a series of geometries.
106
107[heading Synopsis]
108``template<typename Geometry>
109Geometry make_inverse()``
110
111[heading Parameters]
112
113[table
114[[Type] [Concept] [Name] [Description] ]
115[[Geometry] [Any type fulfilling a Geometry Concept ] [ - ] [Must be specified]]
116]
117
118
119[heading Returns]
120The constructed geometry, here: a box
121
122[heading Header]
123Either
124
125`#include <boost/geometry.hpp>`
126
127
128Or
129
130`#include <boost/geometry/algorithms/make.hpp>`
131
132[heading Example]
133[make_inverse] [make_inverse_output]
134
135[heading See also]
136* [link geometry.reference.algorithms.assign.assign_inverse assign_inverse]
137
138
139[endsect]
140
141[section:make_zero make_zero]
142
143'''<indexterm><primary>make_zero</primary></indexterm>'''
144Construct a geometry with its coordinates initialized to zero.
145
146[heading Description]
147The make\u005fzero function initializes a 2D or 3D point or box with coordinates of zero
148
149[heading Synopsis]
150``template<typename Geometry>
151Geometry make_zero()``
152
153[heading Parameters]
154
155[table
156[[Type] [Concept] [Name] [Description] ]
157[[Geometry] [Any type fulfilling a Geometry Concept ] [ - ] [Must be specified]]
158]
159
160
161[heading Returns]
162The constructed and zero-initialized geometry
163
164[heading Header]
165Either
166
167`#include <boost/geometry.hpp>`
168
169
170Or
171
172`#include <boost/geometry/algorithms/make.hpp>`
173
174
175[endsect]
176
177