Boost.Geometry    Boost C++ Libraries
Functions
assign: assign values to geometries

Functions

template<typename Geometry1 , typename Geometry2 >
void boost::geometry::assign (Geometry1 &geometry1, Geometry2 const &geometry2)
 Assigns one geometry to another geometry.
template<typename Geometry >
void boost::geometry::assign_inverse (Geometry &geometry)
 assign to a box inverse infinite
template<typename Geometry , typename Range >
void boost::geometry::assign_points (Geometry &geometry, Range const &range)
 Assign a range of points to a linestring, ring or polygon.
template<typename Geometry , typename Type >
void boost::geometry::assign_values (Geometry &geometry, Type const &c1, Type const &c2)
 Assign two coordinates to a geometry (usually a 2D point)
template<typename Geometry , typename Type >
void boost::geometry::assign_values (Geometry &geometry, Type const &c1, Type const &c2, Type const &c3)
 Assign three values to a geometry (usually a 3D point)
template<typename Geometry , typename Type >
void boost::geometry::assign_values (Geometry &geometry, Type const &c1, Type const &c2, Type const &c3, Type const &c4)
 Assign four values to a geometry (usually a box or segment)
template<typename Geometry >
void boost::geometry::assign_zero (Geometry &geometry)
 assign zero values to a box, point

Function Documentation

template<typename Geometry , typename Range >
void boost::geometry::assign_points ( Geometry &  geometry,
Range const &  range 
)

Assign a range of points to a linestring, ring or polygon.

Note:
The point-type of the range might be different from the point-type of the geometry
Template Parameters:
GeometryAny type fulfilling a Geometry Concept
RangeAny type fulfilling a Range Concept where it range_value type fulfills the Point Concept
Parameters:
geometryA model of the specified concept
rangeA range containg points fulfilling range and point concepts
Examples:
03_polygon_example.cpp, and 06_a_transformation_example.cpp.
template<typename Geometry >
void boost::geometry::assign_inverse ( Geometry &  geometry)

assign to a box inverse infinite

The assign_inverse function initialize a 2D or 3D box with large coordinates, the min corner is very large, the max corner is very small. This is a convenient starting point to collect the minimum bounding box of a geometry.

Template Parameters:
GeometryAny type fulfilling a Geometry Concept
Parameters:
geometryA model of the specified concept
Examples:
07_a_graph_route_example.cpp, and 07_b_graph_route_example.cpp.
template<typename Geometry >
void boost::geometry::assign_zero ( Geometry &  geometry)

assign zero values to a box, point

The assign_zero function initializes a 2D or 3D point or box with coordinates of zero

Template Parameters:
GeometryAny type fulfilling a Geometry Concept
Parameters:
geometryA model of the specified concept
Examples:
07_a_graph_route_example.cpp, and 07_b_graph_route_example.cpp.
template<typename Geometry , typename Type >
void boost::geometry::assign_values ( Geometry &  geometry,
Type const &  c1,
Type const &  c2 
)

Assign two coordinates to a geometry (usually a 2D point)

Template Parameters:
GeometryAny type fulfilling a Geometry Concept
Typenumerical type (int, double, ttmath, ...) to specify the coordinates
Parameters:
geometryA model of the specified concept
c1First coordinate (usually x-coordinate)
c2Second coordinate (usually y-coordinate)
Examples:
01_point_example.cpp, 02_linestring_example.cpp, and c01_custom_point_example.cpp.
template<typename Geometry , typename Type >
void boost::geometry::assign_values ( Geometry &  geometry,
Type const &  c1,
Type const &  c2,
Type const &  c3 
)

Assign three values to a geometry (usually a 3D point)

Template Parameters:
GeometryAny type fulfilling a Geometry Concept
Typenumerical type (int, double, ttmath, ...) to specify the coordinates
Parameters:
geometryA model of the specified concept
c1First coordinate (usually x-coordinate)
c2Second coordinate (usually y-coordinate)
c3Third coordinate (usually z-coordinate)
template<typename Geometry , typename Type >
void boost::geometry::assign_values ( Geometry &  geometry,
Type const &  c1,
Type const &  c2,
Type const &  c3,
Type const &  c4 
)

Assign four values to a geometry (usually a box or segment)

Template Parameters:
GeometryAny type fulfilling a Geometry Concept
Typenumerical type (int, double, ttmath, ...) to specify the coordinates
Parameters:
geometryA model of the specified concept
c1First coordinate (usually x1)
c2Second coordinate (usually y1)
c3Third coordinate (usually x2)
c4Fourth coordinate (usually y2)
template<typename Geometry1 , typename Geometry2 >
void boost::geometry::assign ( Geometry1 &  geometry1,
Geometry2 const &  geometry2 
)

Assigns one geometry to another geometry.

The assign algorithm assigns one geometry, e.g. a BOX, to another geometry, e.g. a RING. This only works if it is possible and applicable.

Template Parameters:
Geometry1Any type fulfilling a Geometry Concept
Geometry2Any type fulfilling a Geometry Concept
Parameters:
geometry1A model of the specified concept (target)
geometry2A model of the specified concept (source)

April 2, 2011

Copyright © 2007-2011 Barend Gehrels, Amsterdam, the Netherlands
Copyright © 2008-2011 Bruno Lalande, Paris, France
Copyright © 2009-2010 Mateusz Loskot, London, UK
Documentation is generated by Doxygen