Chris@16: // Boost.Geometry (aka GGL, Generic Geometry Library)
Chris@16: 
Chris@16: // Copyright (c) 2007-2012 Barend Gehrels, Amsterdam, the Netherlands.
Chris@16: // Copyright (c) 2008-2012 Bruno Lalande, Paris, France.
Chris@16: // Copyright (c) 2009-2012 Mateusz Loskot, London, UK.
Chris@101: // Copyright (c) 2014 Adam Wulkiewicz, Lodz, Poland.
Chris@16: 
Chris@16: // Parts of Boost.Geometry are redesigned from Geodan's Geographic Library
Chris@16: // (geolib/GGL), copyright (c) 1995-2010 Geodan, Amsterdam, the Netherlands.
Chris@16: 
Chris@16: // Use, modification and distribution is subject to the Boost Software License,
Chris@16: // Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@16: #ifndef BOOST_GEOMETRY_GEOMETRIES_POLYGON_HPP
Chris@16: #define BOOST_GEOMETRY_GEOMETRIES_POLYGON_HPP
Chris@16: 
Chris@16: #include <memory>
Chris@16: #include <vector>
Chris@16: 
Chris@16: #include <boost/concept/assert.hpp>
Chris@16: 
Chris@16: #include <boost/geometry/core/exterior_ring.hpp>
Chris@16: #include <boost/geometry/core/interior_rings.hpp>
Chris@16: #include <boost/geometry/core/point_type.hpp>
Chris@16: #include <boost/geometry/core/ring_type.hpp>
Chris@16: #include <boost/geometry/geometries/concepts/point_concept.hpp>
Chris@16: #include <boost/geometry/geometries/ring.hpp>
Chris@16: 
Chris@101: #ifdef BOOST_GEOMETRY_EXPERIMENTAL_ENABLE_INITIALIZER_LIST
Chris@101: #include <boost/config.hpp>
Chris@101: #ifndef BOOST_NO_CXX11_HDR_INITIALIZER_LIST
Chris@101: #include <initializer_list>
Chris@101: #endif
Chris@101: #endif
Chris@101: 
Chris@16: namespace boost { namespace geometry
Chris@16: {
Chris@16: 
Chris@16: namespace model
Chris@16: {
Chris@16: 
Chris@16: /*!
Chris@16: \brief The polygon contains an outer ring and zero or more inner rings.
Chris@16: \ingroup geometries
Chris@16: \tparam Point point type
Chris@16: \tparam ClockWise true for clockwise direction,
Chris@16:             false for CounterClockWise direction
Chris@16: \tparam Closed true for closed polygons (last point == first point),
Chris@16:             false open points
Chris@16: \tparam PointList container type for points,
Chris@16:             for example std::vector, std::list, std::deque
Chris@16: \tparam RingList container type for inner rings,
Chris@16:             for example std::vector, std::list, std::deque
Chris@16: \tparam PointAlloc container-allocator-type, for the points
Chris@16: \tparam RingAlloc container-allocator-type, for the rings
Chris@16: \note The container collecting the points in the rings can be different
Chris@16:     from the container collecting the inner rings. They all default to vector.
Chris@16: 
Chris@16: \qbk{before.synopsis,
Chris@16: [heading Model of]
Chris@16: [link geometry.reference.concepts.concept_polygon Polygon Concept]
Chris@16: }
Chris@16: 
Chris@16: 
Chris@16: */
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise = true,
Chris@16:     bool Closed = true,
Chris@16:     template<typename, typename> class PointList = std::vector,
Chris@16:     template<typename, typename> class RingList = std::vector,
Chris@16:     template<typename> class PointAlloc = std::allocator,
Chris@16:     template<typename> class RingAlloc = std::allocator
Chris@16: >
Chris@16: class polygon
Chris@16: {
Chris@16:     BOOST_CONCEPT_ASSERT( (concept::Point<Point>) );
Chris@16: 
Chris@16: public:
Chris@16: 
Chris@16:     // Member types
Chris@16:     typedef Point point_type;
Chris@16:     typedef ring<Point, ClockWise, Closed, PointList, PointAlloc> ring_type;
Chris@16:     typedef RingList<ring_type , RingAlloc<ring_type > > inner_container_type;
Chris@16: 
Chris@16:     inline ring_type const& outer() const { return m_outer; }
Chris@16:     inline inner_container_type const& inners() const { return m_inners; }
Chris@16: 
Chris@16:     inline ring_type& outer() { return m_outer; }
Chris@16:     inline inner_container_type & inners() { return m_inners; }
Chris@16: 
Chris@101: #ifdef BOOST_GEOMETRY_EXPERIMENTAL_ENABLE_INITIALIZER_LIST
Chris@101: 
Chris@101:     /// \constructor_default{polygon}
Chris@101:     inline polygon()
Chris@101:         : m_outer()
Chris@101:         , m_inners()
Chris@101:     {}
Chris@101: 
Chris@101: #ifndef BOOST_NO_CXX11_HDR_INITIALIZER_LIST
Chris@101:     /// \constructor_initializer_list{polygon}
Chris@101:     inline polygon(std::initializer_list<ring_type> l)
Chris@101:         : m_outer(l.size() > 0 ? *l.begin() : ring_type())
Chris@101:         , m_inners(l.size() > 0 ? l.begin() + 1 : l.begin(), l.end())
Chris@101:     {}
Chris@101: 
Chris@101: // Commented out for now in order to support Boost.Assign
Chris@101: // Without this assignment operator first the object should be created
Chris@101: //   from initializer list, then it shoudl be moved.
Chris@101: //// Without this workaround in MSVC the assignment operator is ambiguous
Chris@101: //#ifndef BOOST_MSVC
Chris@101: //    /// \assignment_initializer_list{polygon}
Chris@101: //    inline polygon & operator=(std::initializer_list<ring_type> l)
Chris@101: //    {
Chris@101: //        if ( l.size() > 0 )
Chris@101: //        {
Chris@101: //            m_outer = *l.begin();
Chris@101: //            m_inners.assign(l.begin() + 1, l.end());
Chris@101: //        }
Chris@101: //        else
Chris@101: //        {
Chris@101: //            m_outer.clear();
Chris@101: //            m_inners.clear();
Chris@101: //        }
Chris@101: //        return *this;
Chris@101: //    }
Chris@101: //#endif
Chris@101: 
Chris@101: #endif
Chris@101: #endif
Chris@101: 
Chris@16:     /// Utility method, clears outer and inner rings
Chris@16:     inline void clear()
Chris@16:     {
Chris@16:         m_outer.clear();
Chris@16:         m_inners.clear();
Chris@16:     }
Chris@16: 
Chris@16: private:
Chris@16: 
Chris@16:     ring_type m_outer;
Chris@16:     inner_container_type m_inners;
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: } // namespace model
Chris@16: 
Chris@16: 
Chris@16: #ifndef DOXYGEN_NO_TRAITS_SPECIALIZATIONS
Chris@16: namespace traits
Chris@16: {
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise, bool Closed,
Chris@16:     template<typename, typename> class PointList,
Chris@16:     template<typename, typename> class RingList,
Chris@16:     template<typename> class PointAlloc,
Chris@16:     template<typename> class RingAlloc
Chris@16: >
Chris@16: struct tag
Chris@16: <
Chris@16:     model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList, PointAlloc, RingAlloc
Chris@16:         >
Chris@16: >
Chris@16: {
Chris@16:     typedef polygon_tag type;
Chris@16: };
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise, bool Closed,
Chris@16:     template<typename, typename> class PointList,
Chris@16:     template<typename, typename> class RingList,
Chris@16:     template<typename> class PointAlloc,
Chris@16:     template<typename> class RingAlloc
Chris@16: >
Chris@16: struct ring_const_type
Chris@16: <
Chris@16:     model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList, PointAlloc, RingAlloc
Chris@16:         >
Chris@16: >
Chris@16: {
Chris@16:     typedef typename model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         >::ring_type const& type;
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise, bool Closed,
Chris@16:     template<typename, typename> class PointList,
Chris@16:     template<typename, typename> class RingList,
Chris@16:     template<typename> class PointAlloc,
Chris@16:     template<typename> class RingAlloc
Chris@16: >
Chris@16: struct ring_mutable_type
Chris@16: <
Chris@16:     model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList, PointAlloc, RingAlloc
Chris@16:         >
Chris@16: >
Chris@16: {
Chris@16:     typedef typename model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         >::ring_type& type;
Chris@16: };
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise, bool Closed,
Chris@16:     template<typename, typename> class PointList,
Chris@16:     template<typename, typename> class RingList,
Chris@16:     template<typename> class PointAlloc,
Chris@16:     template<typename> class RingAlloc
Chris@16: >
Chris@16: struct interior_const_type
Chris@16: <
Chris@16:     model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         >
Chris@16: >
Chris@16: {
Chris@16:     typedef typename model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         >::inner_container_type const& type;
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise, bool Closed,
Chris@16:     template<typename, typename> class PointList,
Chris@16:     template<typename, typename> class RingList,
Chris@16:     template<typename> class PointAlloc,
Chris@16:     template<typename> class RingAlloc
Chris@16: >
Chris@16: struct interior_mutable_type
Chris@16: <
Chris@16:     model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         >
Chris@16: >
Chris@16: {
Chris@16:     typedef typename model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         >::inner_container_type& type;
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise, bool Closed,
Chris@16:     template<typename, typename> class PointList,
Chris@16:     template<typename, typename> class RingList,
Chris@16:     template<typename> class PointAlloc,
Chris@16:     template<typename> class RingAlloc
Chris@16: >
Chris@16: struct exterior_ring
Chris@16: <
Chris@16:     model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList, PointAlloc, RingAlloc
Chris@16:         >
Chris@16: >
Chris@16: {
Chris@16:     typedef model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         > polygon_type;
Chris@16: 
Chris@16:     static inline typename polygon_type::ring_type& get(polygon_type& p)
Chris@16:     {
Chris@16:         return p.outer();
Chris@16:     }
Chris@16: 
Chris@16:     static inline typename polygon_type::ring_type const& get(
Chris@16:                     polygon_type const& p)
Chris@16:     {
Chris@16:         return p.outer();
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: template
Chris@16: <
Chris@16:     typename Point,
Chris@16:     bool ClockWise, bool Closed,
Chris@16:     template<typename, typename> class PointList,
Chris@16:     template<typename, typename> class RingList,
Chris@16:     template<typename> class PointAlloc,
Chris@16:     template<typename> class RingAlloc
Chris@16: >
Chris@16: struct interior_rings
Chris@16: <
Chris@16:     model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed,
Chris@16:             PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         >
Chris@16: >
Chris@16: {
Chris@16:     typedef model::polygon
Chris@16:         <
Chris@16:             Point, ClockWise, Closed, PointList, RingList,
Chris@16:             PointAlloc, RingAlloc
Chris@16:         > polygon_type;
Chris@16: 
Chris@16:     static inline typename polygon_type::inner_container_type& get(
Chris@16:                     polygon_type& p)
Chris@16:     {
Chris@16:         return p.inners();
Chris@16:     }
Chris@16: 
Chris@16:     static inline typename polygon_type::inner_container_type const& get(
Chris@16:                     polygon_type const& p)
Chris@16:     {
Chris@16:         return p.inners();
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: } // namespace traits
Chris@16: #endif // DOXYGEN_NO_TRAITS_SPECIALIZATIONS
Chris@16: 
Chris@16: 
Chris@16: 
Chris@16: }} // namespace boost::geometry
Chris@16: 
Chris@16: #endif // BOOST_GEOMETRY_GEOMETRIES_POLYGON_HPP