1<html> 2<head> 3<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 4<title>model::d3::point_xyz</title> 5<link rel="stylesheet" href="../../../../../../../doc/src/boostbook.css" type="text/css"> 6<meta name="generator" content="DocBook XSL Stylesheets V1.79.1"> 7<link rel="home" href="../../../index.html" title="Chapter 1. Geometry"> 8<link rel="up" href="../models.html" title="Models"> 9<link rel="prev" href="model_d2_point_xy.html" title="model::d2::point_xy"> 10<link rel="next" href="model_linestring.html" title="model::linestring"> 11</head> 12<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> 13<table cellpadding="2" width="100%"><tr> 14<td valign="top"><img alt="Boost C++ Libraries" width="277" height="86" src="../../../../../../../boost.png"></td> 15<td align="center"><a href="../../../../../../../index.html">Home</a></td> 16<td align="center"><a href="../../../../../../../libs/libraries.htm">Libraries</a></td> 17<td align="center"><a href="http://www.boost.org/users/people.html">People</a></td> 18<td align="center"><a href="http://www.boost.org/users/faq.html">FAQ</a></td> 19<td align="center"><a href="../../../../../../../more/index.htm">More</a></td> 20</tr></table> 21<hr> 22<div class="spirit-nav"> 23<a accesskey="p" href="model_d2_point_xy.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../models.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="model_linestring.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 24</div> 25<div class="section"> 26<div class="titlepage"><div><div><h4 class="title"> 27<a name="geometry.reference.models.model_d3_point_xyz"></a><a class="link" href="model_d3_point_xyz.html" title="model::d3::point_xyz">model::d3::point_xyz</a> 28</h4></div></div></div> 29<p> 30 <a class="indexterm" name="idm45635680444608"></a><a class="indexterm" name="idm45635680443920"></a><a class="indexterm" name="idm45635680443216"></a> 313D point in Cartesian coordinate system 32 </p> 33<h6> 34<a name="geometry.reference.models.model_d3_point_xyz.h0"></a> 35 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.model_of"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.model_of">Model of</a> 36 </h6> 37<p> 38 <a class="link" href="../concepts/concept_point.html" title="Point Concept">Point Concept</a> 39 </p> 40<h6> 41<a name="geometry.reference.models.model_d3_point_xyz.h1"></a> 42 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.synopsis"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.synopsis">Synopsis</a> 43 </h6> 44<p> 45</p> 46<pre class="programlisting"><span class="keyword">template</span><span class="special"><</span><span class="keyword">typename</span> <span class="identifier">CoordinateType</span><span class="special">,</span> <span class="keyword">typename</span> <span class="identifier">CoordinateSystem</span><span class="special">></span> 47<span class="keyword">class</span> <span class="identifier">model</span><span class="special">::</span><span class="identifier">d3</span><span class="special">::</span><span class="identifier">point_xyz</span> 48 <span class="special">:</span> <span class="keyword">public</span> <span class="identifier">model</span><span class="special">::</span><span class="identifier">point</span><span class="special"><</span> <span class="identifier">CoordinateType</span><span class="special">,</span> <span class="number">3</span><span class="special">,</span> <span class="identifier">CoordinateSystem</span> <span class="special">></span> 49<span class="special">{</span> 50 <span class="comment">// ...</span> 51<span class="special">};</span> 52</pre> 53<p> 54 </p> 55<h6> 56<a name="geometry.reference.models.model_d3_point_xyz.h2"></a> 57 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.template_parameter_s_"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.template_parameter_s_">Template 58 parameter(s)</a> 59 </h6> 60<div class="informaltable"><table class="table"> 61<colgroup> 62<col> 63<col> 64<col> 65</colgroup> 66<thead><tr> 67<th> 68 <p> 69 Parameter 70 </p> 71 </th> 72<th> 73 <p> 74 Default 75 </p> 76 </th> 77<th> 78 <p> 79 Description 80 </p> 81 </th> 82</tr></thead> 83<tbody> 84<tr> 85<td> 86 <p> 87 typename CoordinateType 88 </p> 89 </td> 90<td> 91 </td> 92<td> 93 <p> 94 numeric type, for example, double, float, int 95 </p> 96 </td> 97</tr> 98<tr> 99<td> 100 <p> 101 typename CoordinateSystem 102 </p> 103 </td> 104<td> 105 <p> 106 cs::cartesian 107 </p> 108 </td> 109<td> 110 <p> 111 coordinate system, defaults to cs::cartesian 112 </p> 113 </td> 114</tr> 115</tbody> 116</table></div> 117<h6> 118<a name="geometry.reference.models.model_d3_point_xyz.h3"></a> 119 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.constructor_s_"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.constructor_s_">Constructor(s)</a> 120 </h6> 121<div class="informaltable"><table class="table"> 122<colgroup> 123<col> 124<col> 125<col> 126</colgroup> 127<thead><tr> 128<th> 129 <p> 130 Function 131 </p> 132 </th> 133<th> 134 <p> 135 Description 136 </p> 137 </th> 138<th> 139 <p> 140 Parameters 141 </p> 142 </th> 143</tr></thead> 144<tbody> 145<tr> 146<td> 147 <p> 148</p> 149<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">point_xyz</span><span class="special">()</span></pre> 150<p> 151 </p> 152 </td> 153<td> 154 <p> 155 Default constructor, no initialization. 156 </p> 157 </td> 158<td> 159 </td> 160</tr> 161<tr> 162<td> 163 <p> 164</p> 165<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">point_xyz</span><span class="special">(</span><span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">x</span><span class="special">,</span> <span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">y</span><span class="special">,</span> <span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">z</span><span class="special">)</span></pre> 166<p> 167 </p> 168 </td> 169<td> 170 <p> 171 Constructor with x/y/z values. 172 </p> 173 </td> 174<td> 175 <p> 176 <span class="bold"><strong>CoordinateType const &</strong></span>: 177 <span class="emphasis"><em>x</em></span>: 178 </p> 179 <p> 180 <span class="bold"><strong>CoordinateType const &</strong></span>: 181 <span class="emphasis"><em>y</em></span>: 182 </p> 183 <p> 184 <span class="bold"><strong>CoordinateType const &</strong></span>: 185 <span class="emphasis"><em>z</em></span>: 186 </p> 187 </td> 188</tr> 189</tbody> 190</table></div> 191<h6> 192<a name="geometry.reference.models.model_d3_point_xyz.h4"></a> 193 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.member_function_s_"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.member_function_s_">Member 194 Function(s)</a> 195 </h6> 196<div class="informaltable"><table class="table"> 197<colgroup> 198<col> 199<col> 200<col> 201<col> 202</colgroup> 203<thead><tr> 204<th> 205 <p> 206 Function 207 </p> 208 </th> 209<th> 210 <p> 211 Description 212 </p> 213 </th> 214<th> 215 <p> 216 Parameters 217 </p> 218 </th> 219<th> 220 <p> 221 Returns 222 </p> 223 </th> 224</tr></thead> 225<tbody> 226<tr> 227<td> 228 <p> 229</p> 230<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">x</span><span class="special">()</span></pre> 231<p> 232 </p> 233 </td> 234<td> 235 <p> 236 Get x-value. 237 </p> 238 </td> 239<td> 240 </td> 241<td> 242 </td> 243</tr> 244<tr> 245<td> 246 <p> 247</p> 248<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">y</span><span class="special">()</span></pre> 249<p> 250 </p> 251 </td> 252<td> 253 <p> 254 Get y-value. 255 </p> 256 </td> 257<td> 258 </td> 259<td> 260 </td> 261</tr> 262<tr> 263<td> 264 <p> 265</p> 266<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">z</span><span class="special">()</span></pre> 267<p> 268 </p> 269 </td> 270<td> 271 <p> 272 Get z-value. 273 </p> 274 </td> 275<td> 276 </td> 277<td> 278 </td> 279</tr> 280<tr> 281<td> 282 <p> 283</p> 284<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">x</span><span class="special">(</span><span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v</span><span class="special">)</span></pre> 285<p> 286 </p> 287 </td> 288<td> 289 <p> 290 Set x-value. 291 </p> 292 </td> 293<td> 294 <p> 295 <span class="bold"><strong>CoordinateType const &</strong></span>: 296 <span class="emphasis"><em>v</em></span>: 297 </p> 298 </td> 299<td> 300 </td> 301</tr> 302<tr> 303<td> 304 <p> 305</p> 306<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">y</span><span class="special">(</span><span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v</span><span class="special">)</span></pre> 307<p> 308 </p> 309 </td> 310<td> 311 <p> 312 Set y-value. 313 </p> 314 </td> 315<td> 316 <p> 317 <span class="bold"><strong>CoordinateType const &</strong></span>: 318 <span class="emphasis"><em>v</em></span>: 319 </p> 320 </td> 321<td> 322 </td> 323</tr> 324<tr> 325<td> 326 <p> 327</p> 328<pre xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" class="table-programlisting"><span class="keyword">void</span> <span class="identifier">z</span><span class="special">(</span><span class="identifier">CoordinateType</span> <span class="keyword">const</span> <span class="special">&</span> <span class="identifier">v</span><span class="special">)</span></pre> 329<p> 330 </p> 331 </td> 332<td> 333 <p> 334 Set z-value. 335 </p> 336 </td> 337<td> 338 <p> 339 <span class="bold"><strong>CoordinateType const &</strong></span>: 340 <span class="emphasis"><em>v</em></span>: 341 </p> 342 </td> 343<td> 344 </td> 345</tr> 346</tbody> 347</table></div> 348<h6> 349<a name="geometry.reference.models.model_d3_point_xyz.h5"></a> 350 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.header"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.header">Header</a> 351 </h6> 352<p> 353 <code class="computeroutput"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point_xyz</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span></code> 354 </p> 355<h6> 356<a name="geometry.reference.models.model_d3_point_xyz.h6"></a> 357 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.examples"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.examples">Examples</a> 358 </h6> 359<p> 360 Declaration and use of the Boost.Geometry model::d3::point_xyz, modelling 361 the Point Concept 362 </p> 363<p> 364</p> 365<pre class="programlisting"><span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">iostream</span><span class="special">></span> 366<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 367<span class="preprocessor">#include</span> <span class="special"><</span><span class="identifier">boost</span><span class="special">/</span><span class="identifier">geometry</span><span class="special">/</span><span class="identifier">geometries</span><span class="special">/</span><span class="identifier">point_xyz</span><span class="special">.</span><span class="identifier">hpp</span><span class="special">></span> 368 369<span class="keyword">namespace</span> <span class="identifier">bg</span> <span class="special">=</span> <span class="identifier">boost</span><span class="special">::</span><span class="identifier">geometry</span><span class="special">;</span> 370 371<span class="keyword">int</span> <span class="identifier">main</span><span class="special">()</span> 372<span class="special">{</span> 373 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d3</span><span class="special">::</span><span class="identifier">point_xyz</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">point1</span><span class="special">;</span> 374 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">model</span><span class="special">::</span><span class="identifier">d3</span><span class="special">::</span><span class="identifier">point_xyz</span><span class="special"><</span><span class="keyword">double</span><span class="special">></span> <span class="identifier">point2</span><span class="special">(</span><span class="number">3</span><span class="special">,</span> <span class="number">4</span><span class="special">,</span> <span class="number">5</span><span class="special">);</span> <a class="co" name="geometry.reference.models.model_d3_point_xyz.c0" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.c1"><img src="../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> 375 376 <span class="identifier">bg</span><span class="special">::</span><span class="identifier">set</span><span class="special"><</span><span class="number">0</span><span class="special">>(</span><span class="identifier">point1</span><span class="special">,</span> <span class="number">1.0</span><span class="special">);</span> <a class="co" name="geometry.reference.models.model_d3_point_xyz.c2" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.c3"><img src="../../../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> 377 <span class="identifier">point1</span><span class="special">.</span><span class="identifier">y</span><span class="special">(</span><span class="number">2.0</span><span class="special">);</span> <a class="co" name="geometry.reference.models.model_d3_point_xyz.c4" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.c5"><img src="../../../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a> 378 <span class="identifier">point1</span><span class="special">.</span><span class="identifier">z</span><span class="special">(</span><span class="number">4.0</span><span class="special">);</span> 379 380 <span class="keyword">double</span> <span class="identifier">x</span> <span class="special">=</span> <span class="identifier">bg</span><span class="special">::</span><span class="identifier">get</span><span class="special"><</span><span class="number">0</span><span class="special">>(</span><span class="identifier">point1</span><span class="special">);</span> <a class="co" name="geometry.reference.models.model_d3_point_xyz.c6" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.c7"><img src="../../../../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a> 381 <span class="keyword">double</span> <span class="identifier">y</span> <span class="special">=</span> <span class="identifier">point1</span><span class="special">.</span><span class="identifier">y</span><span class="special">();</span> <a class="co" name="geometry.reference.models.model_d3_point_xyz.c8" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.c9"><img src="../../../../../../../doc/src/images/callouts/5.png" alt="5" border="0"></a> 382 <span class="keyword">double</span> <span class="identifier">z</span> <span class="special">=</span> <span class="identifier">point1</span><span class="special">.</span><span class="identifier">z</span><span class="special">();</span> 383 384 <span class="identifier">std</span><span class="special">::</span><span class="identifier">cout</span> <span class="special"><<</span> <span class="identifier">x</span> <span class="special"><<</span> <span class="string">", "</span> <span class="special"><<</span> <span class="identifier">y</span> <span class="special"><<</span> <span class="string">", "</span> <span class="special"><<</span> <span class="identifier">z</span> <span class="special"><<</span> <span class="identifier">std</span><span class="special">::</span><span class="identifier">endl</span><span class="special">;</span> 385 <span class="keyword">return</span> <span class="number">0</span><span class="special">;</span> 386<span class="special">}</span> 387</pre> 388<p> 389 </p> 390<div class="calloutlist"><table border="0" summary="Callout list"> 391<tr> 392<td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_d3_point_xyz.c1"></a><a href="#geometry.reference.models.model_d3_point_xyz.c0"><img src="../../../../../../../doc/src/images/callouts/1.png" alt="1" border="0"></a> </p></td> 393<td valign="top" align="left"><p> 394 Construct, assigning coordinates. 395 </p></td> 396</tr> 397<tr> 398<td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_d3_point_xyz.c3"></a><a href="#geometry.reference.models.model_d3_point_xyz.c2"><img src="../../../../../../../doc/src/images/callouts/2.png" alt="2" border="0"></a> </p></td> 399<td valign="top" align="left"><p> 400 Set a coordinate, generic. 401 </p></td> 402</tr> 403<tr> 404<td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_d3_point_xyz.c5"></a><a href="#geometry.reference.models.model_d3_point_xyz.c4"><img src="../../../../../../../doc/src/images/callouts/3.png" alt="3" border="0"></a> </p></td> 405<td valign="top" align="left"><p> 406 Set a coordinate, class-specific (<span class="bold"><strong>Note</strong></span>: 407 prefer <code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">set</span><span class="special">()</span></code>). 408 </p></td> 409</tr> 410<tr> 411<td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_d3_point_xyz.c7"></a><a href="#geometry.reference.models.model_d3_point_xyz.c6"><img src="../../../../../../../doc/src/images/callouts/4.png" alt="4" border="0"></a> </p></td> 412<td valign="top" align="left"><p> 413 Get a coordinate, generic. 414 </p></td> 415</tr> 416<tr> 417<td width="5%" valign="top" align="left"><p><a name="geometry.reference.models.model_d3_point_xyz.c9"></a><a href="#geometry.reference.models.model_d3_point_xyz.c8"><img src="../../../../../../../doc/src/images/callouts/5.png" alt="5" border="0"></a> </p></td> 418<td valign="top" align="left"><p> 419 Get a coordinate, class-specific (<span class="bold"><strong>Note</strong></span>: 420 prefer <code class="computeroutput"><span class="identifier">bg</span><span class="special">::</span><span class="identifier">get</span><span class="special">()</span></code>). 421 </p></td> 422</tr> 423</table></div> 424<p> 425 Output: 426 </p> 427<pre class="programlisting">1, 2, 4 428</pre> 429<h6> 430<a name="geometry.reference.models.model_d3_point_xyz.h7"></a> 431 <span class="phrase"><a name="geometry.reference.models.model_d3_point_xyz.notes"></a></span><a class="link" href="model_d3_point_xyz.html#geometry.reference.models.model_d3_point_xyz.notes">Notes</a> 432 </h6> 433<div class="note"><table border="0" summary="Note"> 434<tr> 435<td rowspan="2" align="center" valign="top" width="25"><img alt="[Note]" src="../../../../../../../doc/src/images/note.png"></td> 436<th align="left">Note</th> 437</tr> 438<tr><td align="left" valign="top"><p> 439 Coordinates are not initialized. If the constructor with parameters is 440 not called and points are not assigned using <code class="computeroutput"><span class="identifier">set</span></code> 441 or <code class="computeroutput"><span class="identifier">assign</span></code> then the coordinate 442 values will contain garbage 443 </p></td></tr> 444</table></div> 445</div> 446<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr> 447<td align="left"></td> 448<td align="right"><div class="copyright-footer">Copyright © 2009-2019 Barend Gehrels, Bruno Lalande, Mateusz Loskot, Adam 449 Wulkiewicz, Oracle and/or its affiliates<p> 450 Distributed under the Boost Software License, Version 1.0. (See accompanying 451 file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>) 452 </p> 453</div></td> 454</tr></table> 455<hr> 456<div class="spirit-nav"> 457<a accesskey="p" href="model_d2_point_xy.html"><img src="../../../../../../../doc/src/images/prev.png" alt="Prev"></a><a accesskey="u" href="../models.html"><img src="../../../../../../../doc/src/images/up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../../../../../doc/src/images/home.png" alt="Home"></a><a accesskey="n" href="model_linestring.html"><img src="../../../../../../../doc/src/images/next.png" alt="Next"></a> 458</div> 459</body> 460</html> 461
