polygon_fill.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_FILL_H
36 #define NAV_GRID_ITERATORS_POLYGON_FILL_H
37 
40 #include <nav_2d_msgs/Polygon2D.h>
41 #include <memory>
42 
43 namespace nav_grid_iterators
44 {
49 class PolygonFill : public BaseIterator<PolygonFill>
50 {
51 public:
57  PolygonFill(const nav_grid::NavGridInfo* info, nav_2d_msgs::Polygon2D polygon);
58 
63  PolygonFill(const PolygonFill& other);
64 
69  PolygonFill& operator=(const PolygonFill& other);
70 
73  PolygonFill begin() const override;
74  PolygonFill end() const override;
75  void increment() override;
76  bool fieldsEqual(const PolygonFill& other) override;
79 protected:
91  PolygonFill(const nav_grid::NavGridInfo* info, const nav_grid::Index& index, nav_2d_msgs::Polygon2D polygon,
92  unsigned int min_x, unsigned int min_y, unsigned int width, unsigned int height,
93  const nav_grid::Index& start_index);
94 
95 
100  bool isInside(unsigned int x, unsigned int y) const;
101 
102  nav_2d_msgs::Polygon2D polygon_;
103  unsigned int min_x_, min_y_, width_, height_;
105  std::unique_ptr<SubGrid> internal_iterator_;
106 };
107 } // namespace nav_grid_iterators
108 
109 #endif // NAV_GRID_ITERATORS_POLYGON_FILL_H
PolygonFill(const nav_grid::NavGridInfo *info, nav_2d_msgs::Polygon2D polygon)
Public Constructor.
nav_2d_msgs::Polygon2D polygon_
Definition: polygon_fill.h:102
TFSIMD_FORCE_INLINE const tfScalar & y() const
void increment() override
Increase the iterator to the next element.
TFSIMD_FORCE_INLINE const tfScalar & x() const
PolygonFill end() const override
Helper function for range-style iteration.
bool fieldsEqual(const PolygonFill &other) override
Additional check for whether fields of derived iterators are equal.
Iterates over all of the valid indexes that lie within an arbitrary polygon in row major order...
Definition: polygon_fill.h:49
PolygonFill begin() const override
Helper function for range-style iteration Equivalent to the above constructor.
bool isInside(unsigned int x, unsigned int y) const
Check if given index is inside the polygon.
PolygonFill & operator=(const PolygonFill &other)
Assignment Operator Required to ensure unique_ptr is set properly.
std::unique_ptr< SubGrid > internal_iterator_
Definition: polygon_fill.h:105


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