135 lines
2.7 KiB
Plaintext
135 lines
2.7 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/classboost_1_1geometry_1_1model_1_1d3_1_1point__xyz.xml]
|
|
[section:model_d3_point_xyz model::d3::point_xyz]
|
|
|
|
'''<indexterm><primary>model</primary></indexterm><indexterm><primary>d3</primary></indexterm><indexterm><primary>point_xyz</primary></indexterm>'''
|
|
3D point in Cartesian coordinate system
|
|
|
|
[heading Model of]
|
|
[link geometry.reference.concepts.concept_point Point Concept]
|
|
|
|
[heading Synopsis]
|
|
``template<typename CoordinateType, typename CoordinateSystem>
|
|
class model::d3::point_xyz
|
|
: public model::point< CoordinateType, 3, CoordinateSystem >
|
|
{
|
|
// ...
|
|
};
|
|
``
|
|
|
|
[heading Template parameter(s)]
|
|
[table
|
|
[[Parameter] [Default] [Description]]
|
|
[[typename CoordinateType] [] [numeric type, for example, double, float, int ]]
|
|
[[typename CoordinateSystem] [cs::cartesian] [coordinate system, defaults to cs::cartesian]]
|
|
]
|
|
|
|
[heading Constructor(s)]
|
|
[table
|
|
[[Function] [Description] [Parameters] ]
|
|
[[``point_xyz()``
|
|
|
|
] [Default constructor, no initialization. ] [
|
|
|
|
]]
|
|
[[``point_xyz(CoordinateType const & x, CoordinateType const & y, CoordinateType const & z)``
|
|
|
|
] [Constructor with x/y/z values. ] [[* CoordinateType const &]: ['x]:
|
|
|
|
[* CoordinateType const &]: ['y]:
|
|
|
|
[* CoordinateType const &]: ['z]:
|
|
|
|
|
|
|
|
]]
|
|
]
|
|
|
|
[heading Member Function(s)]
|
|
[table
|
|
[[Function] [Description] [Parameters] [Returns]]
|
|
[[``constexpr CoordinateType const & x()``
|
|
|
|
] [Get x-value. ] [
|
|
|
|
][
|
|
|
|
]
|
|
]
|
|
[[``constexpr CoordinateType const & y()``
|
|
|
|
] [Get y-value. ] [
|
|
|
|
][
|
|
|
|
]
|
|
]
|
|
[[``constexpr CoordinateType const & z()``
|
|
|
|
] [Get z-value. ] [
|
|
|
|
][
|
|
|
|
]
|
|
]
|
|
[[``void x(CoordinateType const & v)``
|
|
|
|
] [Set x-value. ] [[* CoordinateType const &]: ['v]:
|
|
|
|
|
|
|
|
][
|
|
|
|
]
|
|
]
|
|
[[``void y(CoordinateType const & v)``
|
|
|
|
] [Set y-value. ] [[* CoordinateType const &]: ['v]:
|
|
|
|
|
|
|
|
][
|
|
|
|
]
|
|
]
|
|
[[``void z(CoordinateType const & v)``
|
|
|
|
] [Set z-value. ] [[* CoordinateType const &]: ['v]:
|
|
|
|
|
|
|
|
][
|
|
|
|
]
|
|
]
|
|
]
|
|
|
|
[heading Header]
|
|
Either
|
|
|
|
`#include <boost/geometry/geometries/geometries.hpp>`
|
|
|
|
|
|
Or
|
|
|
|
`#include <boost/geometry/geometries/point_xyz.hpp>`
|
|
|
|
[include reference/geometries/point_xyz.qbk]
|
|
[include reference/geometries/point_assign_warning.qbk]
|
|
|
|
[endsect]
|
|
|