polygon_outline.h
Go to the documentation of this file.
1 /*
2  * Software License Agreement (BSD License)
3  *
4  * Copyright (c) 2018, Locus Robotics
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  * notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above
14  * copyright notice, this list of conditions and the following
15  * disclaimer in the documentation and/or other materials provided
16  * with the distribution.
17  * * Neither the name of the copyright holder nor the names of its
18  * contributors may be used to endorse or promote products derived
19  * from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  */
34 
35 #ifndef NAV_GRID_ITERATORS_POLYGON_OUTLINE_H
36 #define NAV_GRID_ITERATORS_POLYGON_OUTLINE_H
37 
40 #include <nav_2d_msgs/Polygon2D.h>
41 #include <memory>
42 
43 namespace nav_grid_iterators
44 {
49 class PolygonOutline : public BaseIterator<PolygonOutline>
50 {
51 public:
57  PolygonOutline(const nav_grid::NavGridInfo* info, nav_2d_msgs::Polygon2D polygon, bool bresenham = true);
58 
63  PolygonOutline(const PolygonOutline& other);
64 
70 
73  PolygonOutline begin() const override;
74  PolygonOutline end() const override;
75  void increment() override;
76  bool fieldsEqual(const PolygonOutline& other) override;
79 protected:
87  PolygonOutline(const nav_grid::NavGridInfo* info, const nav_grid::Index& index, nav_2d_msgs::Polygon2D polygon,
88  bool bresenham, unsigned int side_index);
89 
94  void loadSide();
95 
96  std::unique_ptr<Line> internal_iterator_;
97  nav_2d_msgs::Polygon2D polygon_;
99  bool bresenham_;
100  unsigned int side_index_;
101 };
102 } // namespace nav_grid_iterators
103 
104 #endif // NAV_GRID_ITERATORS_POLYGON_OUTLINE_H
std::unique_ptr< Line > internal_iterator_
void loadSide()
Given a new side index, loads the internal iterator. If there are no valid values in the internal ite...
Iterates over all of the valid indexes on the outline of a polygon.
bool fieldsEqual(const PolygonOutline &other) override
Additional check for whether fields of derived iterators are equal.
PolygonOutline(const nav_grid::NavGridInfo *info, nav_2d_msgs::Polygon2D polygon, bool bresenham=true)
Public Constructor.
nav_2d_msgs::Polygon2D polygon_
void increment() override
Increase the iterator to the next element.
PolygonOutline begin() const override
Helper function for range-style iteration Equivalent to the above constructor.
PolygonOutline & operator=(const PolygonOutline &other)
Assignment Operator Required to ensure unique_ptr is set properly.
PolygonOutline end() const override
Helper function for range-style iteration.


nav_grid_iterators
Author(s):
autogenerated on Sun Jan 10 2021 04:08:42