Boost  v1.57.0
doxygen for www.boost.org
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem > Class Template Reference

Basic point class, having coordinates defined in a neutral way. More...

#include <point.hpp>

Inheritance diagram for boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >:

Public Member Functions

 point ()
 Default constructor, no initialization. More...
 
 point (CoordinateType const &v0, CoordinateType const &v1=0, CoordinateType const &v2=0)
 Constructor to set one, two or three values. More...
 
template<std::size_t K>
CoordinateType const & get () const
 Get a coordinate. More...
 
template<std::size_t K>
void set (CoordinateType const &value)
 Set a coordinate. More...
 

Detailed Description

template<typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem>
class boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >

Basic point class, having coordinates defined in a neutral way.

Defines a neutral point class, fulfilling the Point Concept. Library users can use this point class, or use their own point classes. This point class is used in most of the samples and tests of Boost.Geometry This point class is used occasionally within the library, where a temporary point class is necessary.

Template Parameters
CoordinateType
DimensionCountnumber of coordinates, usually 2 or 3
CoordinateSystemcoordinate system, for example cs::cartesian

{[include reference/geometries/point.qbk]} {before.synopsis, [heading Model of]} {before.synopsis, [link geometry.reference.concepts.concept_point Point Concept]}

Constructor & Destructor Documentation

template<typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem>
boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >::point ( )
inline

Default constructor, no initialization.

template<typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem>
boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >::point ( CoordinateType const &  v0,
CoordinateType const &  v1 = 0,
CoordinateType const &  v2 = 0 
)
inlineexplicit

Constructor to set one, two or three values.

Member Function Documentation

template<typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem>
template<std::size_t K>
CoordinateType const& boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >::get ( ) const
inline

Get a coordinate.

Template Parameters
Kcoordinate to get
Returns
the coordinate
template<typename CoordinateType, std::size_t DimensionCount, typename CoordinateSystem>
template<std::size_t K>
void boost::geometry::model::point< CoordinateType, DimensionCount, CoordinateSystem >::set ( CoordinateType const &  value)
inline

Set a coordinate.

Template Parameters
Kcoordinate to set
Parameters
valuevalue to set

The documentation for this class was generated from the following file: