• 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/classboost_1_1geometry_1_1model_1_1d3_1_1point__xyz.xml]
16[section:model_d3_point_xyz model::d3::point_xyz]
17
18'''<indexterm><primary>model</primary></indexterm><indexterm><primary>d3</primary></indexterm><indexterm><primary>point_xyz</primary></indexterm>'''
193D point in Cartesian coordinate system
20
21[heading Model of]
22[link geometry.reference.concepts.concept_point Point Concept]
23
24[heading Synopsis]
25``template<typename CoordinateType, typename CoordinateSystem>
26class model::d3::point_xyz
27      : public model::point< CoordinateType, 3, CoordinateSystem >
28{
29  // ...
30};
31``
32
33[heading Template parameter(s)]
34[table
35[[Parameter] [Default] [Description]]
36[[typename CoordinateType] [] [numeric type, for example, double, float, int ]]
37[[typename CoordinateSystem] [cs::cartesian] [coordinate system, defaults to cs::cartesian]]
38]
39
40[heading Constructor(s)]
41[table
42[[Function] [Description] [Parameters] ]
43[[``point_xyz()``
44
45] [Default constructor, no initialization. ] [
46
47]]
48[[``point_xyz(CoordinateType const & x, CoordinateType const & y, CoordinateType const & z)``
49
50] [Constructor with x/y/z values. ] [[* CoordinateType const &]: ['x]:
51
52[* CoordinateType const &]: ['y]:
53
54[* CoordinateType const &]: ['z]:
55
56
57
58]]
59]
60
61[heading Member Function(s)]
62[table
63[[Function] [Description] [Parameters]  [Returns]]
64[[``CoordinateType const  & x()``
65
66] [Get x-value. ] [
67
68][
69
70]
71]
72[[``CoordinateType const  & y()``
73
74] [Get y-value. ] [
75
76][
77
78]
79]
80[[``CoordinateType const  & z()``
81
82] [Get z-value. ] [
83
84][
85
86]
87]
88[[``void x(CoordinateType const & v)``
89
90] [Set x-value. ] [[* CoordinateType const &]: ['v]:
91
92
93
94][
95
96]
97]
98[[``void y(CoordinateType const & v)``
99
100] [Set y-value. ] [[* CoordinateType const &]: ['v]:
101
102
103
104][
105
106]
107]
108[[``void z(CoordinateType const & v)``
109
110] [Set z-value. ] [[* CoordinateType const &]: ['v]:
111
112
113
114][
115
116]
117]
118]
119
120[heading Header]
121`#include <boost/geometry/geometries/point_xyz.hpp>`
122
123[include reference/geometries/point_xyz.qbk]
124[include reference/geometries/point_assign_warning.qbk]
125
126[endsect]
127
128