#include <SpiralIterator.hpp>
|
| static int | signum (const int val) |
| |
Iterator class to iterate through a circular area of the map with a spiral.
Definition at line 22 of file SpiralIterator.hpp.
◆ SpiralIterator()
| grid_map::SpiralIterator::SpiralIterator |
( |
const grid_map::GridMap & |
gridMap, |
|
|
Eigen::Vector2d |
center, |
|
|
double |
radius |
|
) |
| |
Constructor.
- Parameters
-
| gridMap | the grid map to iterate on. |
| center | the position of the circle center. |
| radius | the radius of the circle. |
Definition at line 18 of file SpiralIterator.cpp.
◆ generateRing()
| void grid_map::SpiralIterator::generateRing |
( |
| ) |
|
|
private |
Uses the current distance to get the points of a ring around the center.
Definition at line 72 of file SpiralIterator.cpp.
◆ getCurrentRadius()
| double grid_map::SpiralIterator::getCurrentRadius |
( |
| ) |
const |
Gets the radius of current ring that is iterated through.
- Returns
- radius of the current ring that is used for iteration.
Definition at line 103 of file SpiralIterator.cpp.
◆ isInside()
| bool grid_map::SpiralIterator::isInside |
( |
const Index & |
index | ) |
const |
|
private |
Check if index is inside the circle.
- Returns
- true if inside, false otherwise.
Definition at line 64 of file SpiralIterator.cpp.
◆ isPastEnd()
| bool grid_map::SpiralIterator::isPastEnd |
( |
| ) |
const |
Indicates if iterator is past end.
- Returns
- true if iterator is out of scope, false if end has not been reached.
Definition at line 59 of file SpiralIterator.cpp.
◆ operator!=()
| bool grid_map::SpiralIterator::operator!= |
( |
const SpiralIterator & |
other | ) |
const |
Compare to another iterator.
- Returns
- whether the current iterator points to a different address than the other one.
Definition at line 40 of file SpiralIterator.cpp.
◆ operator*()
| const Eigen::Array2i & grid_map::SpiralIterator::operator* |
( |
| ) |
const |
Dereference the iterator with const.
- Returns
- the value to which the iterator is pointing.
Definition at line 45 of file SpiralIterator.cpp.
◆ operator++()
Increase the iterator to the next element.
- Returns
- a reference to the updated iterator.
Definition at line 50 of file SpiralIterator.cpp.
◆ signum()
| static int grid_map::SpiralIterator::signum |
( |
const int |
val | ) |
|
|
inlinestaticprivate |
◆ bufferSize_
| Size grid_map::SpiralIterator::bufferSize_ |
|
private |
◆ center_
| Position grid_map::SpiralIterator::center_ |
|
private |
◆ distance_
| unsigned int grid_map::SpiralIterator::distance_ |
|
private |
◆ indexCenter_
| Index grid_map::SpiralIterator::indexCenter_ |
|
private |
◆ mapLength_
| Length grid_map::SpiralIterator::mapLength_ |
|
private |
Map information needed to get position from iterator.
Definition at line 99 of file SpiralIterator.hpp.
◆ mapPosition_
| Position grid_map::SpiralIterator::mapPosition_ |
|
private |
◆ nRings_
| unsigned int grid_map::SpiralIterator::nRings_ |
|
private |
◆ pointsRing_
| std::vector<Index> grid_map::SpiralIterator::pointsRing_ |
|
private |
◆ radius_
| double grid_map::SpiralIterator::radius_ |
|
private |
◆ radiusSquare_
| double grid_map::SpiralIterator::radiusSquare_ |
|
private |
◆ resolution_
| double grid_map::SpiralIterator::resolution_ |
|
private |
The documentation for this class was generated from the following files: