spiral.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_SPIRAL_H
36 #define NAV_GRID_ITERATORS_SPIRAL_H
37 
40 #include <memory>
41 
42 namespace nav_grid_iterators
43 {
48 class Spiral : public BaseIterator<Spiral>
49 {
50 public:
58  Spiral(const nav_grid::NavGridInfo* info, double center_x, double center_y, double radius);
59 
64  Spiral(const Spiral& other);
65 
70  Spiral& operator=(const Spiral& other);
71 
74  Spiral begin() const override;
75  Spiral end() const override;
76  void increment() override;
77  bool fieldsEqual(const Spiral& other) override;
80 protected:
92  Spiral(const nav_grid::NavGridInfo* info, const nav_grid::Index& index, double center_x, double center_y,
93  double radius_sq, unsigned int distance, unsigned int max_distance,
94  const nav_grid::Index& start_index);
95 
100  void loadRing();
101 
106  bool isInside(unsigned int x, unsigned int y) const;
107 
109  unsigned int distance_, max_distance_;
111  std::unique_ptr<CircleOutline> internal_iterator_;
112 };
113 } // namespace nav_grid_iterators
114 
115 
116 #endif // NAV_GRID_ITERATORS_SPIRAL_H
std::unique_ptr< CircleOutline > internal_iterator_
Definition: spiral.h:111
nav_grid::Index start_index_
Definition: spiral.h:110
TFSIMD_FORCE_INLINE tfScalar distance(const Vector3 &v) const
void increment() override
Increase the iterator to the next element.
Definition: spiral.cpp:100
TFSIMD_FORCE_INLINE const tfScalar & y() const
unsigned int max_distance_
Definition: spiral.h:109
Iterates over all of the valid indexes that lie within a circle from the center out.
Definition: spiral.h:48
Spiral(const nav_grid::NavGridInfo *info, double center_x, double center_y, double radius)
Public Constructor.
Definition: spiral.cpp:40
bool fieldsEqual(const Spiral &other) override
Additional check for whether fields of derived iterators are equal.
Definition: spiral.cpp:127
bool isInside(unsigned int x, unsigned int y) const
Check if the center of the given index is within the circle.
Definition: spiral.cpp:145
unsigned int distance_
Definition: spiral.h:109
Spiral end() const override
Helper function for range-style iteration.
Definition: spiral.cpp:94
void loadRing()
Given a new distance value, loads the internal iterator. If there are no valid values in the internal...
Definition: spiral.cpp:133
TFSIMD_FORCE_INLINE const tfScalar & x() const
Spiral & operator=(const Spiral &other)
Assignment Operator Required to ensure unique_ptr is set properly.
Definition: spiral.cpp:70
Spiral begin() const override
Helper function for range-style iteration Equivalent to the above constructor.
Definition: spiral.cpp:89


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