Line Iterator with Ray Tracing (subpixel accuracy) More...
#include <ray_trace.h>
Public Member Functions | |
| RayTrace | begin () const |
| Helper function for range-style iteration. | |
| RayTrace | end () const |
| Helper function for range-style iteration. | |
| nav_grid::SignedIndex | getFinalIndex () const override |
| void | increment () override |
| Increase the iterator to the next element. | |
| bool | operator!= (const RayTrace &other) |
| Test if two iterators are not equivalent - required for testing if iterator is at the end. | |
| RayTrace & | operator++ () |
| Increase the iterator to the next element. | |
| bool | operator== (const RayTrace &other) |
| Test if two iterators are equivalent. | |
| RayTrace (double x0, double y0, double x1, double y1, bool include_last_index=true) | |
| Public constructor. | |
Protected Member Functions | |
| RayTrace (const nav_grid::SignedIndex &index, double x0, double y0, double x1, double y1, bool include_last_index, double dx, double dy, double initial_error, int loop_inc_x, int loop_inc_y) | |
| Protected constructor that takes in an arbitrary index and other internal parameters. | |
Protected Attributes | |
| double | dx_ |
| double | dy_ |
| double | error_ |
| bool | include_last_index_ |
| double | initial_error_ |
| int | loop_inc_x_ |
| int | loop_inc_y_ |
| double | x0_ |
| double | x1_ |
| double | y0_ |
| double | y1_ |
Detailed Description
Line Iterator with Ray Tracing (subpixel accuracy)
Definition at line 46 of file ray_trace.h.
Constructor & Destructor Documentation
| nav_grid_iterators::RayTrace::RayTrace | ( | double | x0, |
| double | y0, | ||
| double | x1, | ||
| double | y1, | ||
| bool | include_last_index = true |
||
| ) |
Public constructor.
- Parameters:
-
x0 Start x coordinate y0 Start y coordinate x1 End x coordinate y1 End y coordinate include_last_index If true, will include the end coordinates.
Definition at line 41 of file ray_trace.cpp.
| nav_grid_iterators::RayTrace::RayTrace | ( | const nav_grid::SignedIndex & | index, |
| double | x0, | ||
| double | y0, | ||
| double | x1, | ||
| double | y1, | ||
| bool | include_last_index, | ||
| double | dx, | ||
| double | dy, | ||
| double | initial_error, | ||
| int | loop_inc_x, | ||
| int | loop_inc_y | ||
| ) | [protected] |
Protected constructor that takes in an arbitrary index and other internal parameters.
- Parameters:
-
index Initial index x0 Start x coordinate y0 Start y coordinate x1 End x coordinate y1 End y coordinate include_last_index If true, will include the end coordinates. dx dy initial_error loop_inc_x loop_inc_y
Definition at line 99 of file ray_trace.cpp.
Member Function Documentation
| RayTrace nav_grid_iterators::RayTrace::begin | ( | ) | const |
Helper function for range-style iteration.
- Returns:
- Iterator representing beginning of the iteration
Definition at line 108 of file ray_trace.cpp.
| RayTrace nav_grid_iterators::RayTrace::end | ( | ) | const |
Helper function for range-style iteration.
- Returns:
- Iterator representing end of the iteration, with an invalid index
Definition at line 114 of file ray_trace.cpp.
| nav_grid::SignedIndex nav_grid_iterators::RayTrace::getFinalIndex | ( | ) | const [override, virtual] |
Implements nav_grid_iterators::AbstractLineIterator.
Definition at line 142 of file ray_trace.cpp.
| void nav_grid_iterators::RayTrace::increment | ( | ) | [override, virtual] |
Increase the iterator to the next element.
Implements nav_grid_iterators::AbstractLineIterator.
Definition at line 128 of file ray_trace.cpp.
| bool nav_grid_iterators::RayTrace::operator!= | ( | const RayTrace & | other | ) | [inline] |
Test if two iterators are not equivalent - required for testing if iterator is at the end.
Definition at line 70 of file ray_trace.h.
| RayTrace& nav_grid_iterators::RayTrace::operator++ | ( | ) | [inline] |
Increase the iterator to the next element.
- Returns:
- a reference to the updated iterator.
Definition at line 91 of file ray_trace.h.
| bool nav_grid_iterators::RayTrace::operator== | ( | const RayTrace & | other | ) | [inline] |
Test if two iterators are equivalent.
Definition at line 62 of file ray_trace.h.
Member Data Documentation
double nav_grid_iterators::RayTrace::dx_ [protected] |
Definition at line 126 of file ray_trace.h.
double nav_grid_iterators::RayTrace::dy_ [protected] |
Definition at line 126 of file ray_trace.h.
double nav_grid_iterators::RayTrace::error_ [protected] |
Definition at line 126 of file ray_trace.h.
bool nav_grid_iterators::RayTrace::include_last_index_ [protected] |
Definition at line 125 of file ray_trace.h.
double nav_grid_iterators::RayTrace::initial_error_ [protected] |
Definition at line 126 of file ray_trace.h.
int nav_grid_iterators::RayTrace::loop_inc_x_ [protected] |
Definition at line 127 of file ray_trace.h.
int nav_grid_iterators::RayTrace::loop_inc_y_ [protected] |
Definition at line 127 of file ray_trace.h.
double nav_grid_iterators::RayTrace::x0_ [protected] |
Definition at line 124 of file ray_trace.h.
double nav_grid_iterators::RayTrace::x1_ [protected] |
Definition at line 124 of file ray_trace.h.
double nav_grid_iterators::RayTrace::y0_ [protected] |
Definition at line 124 of file ray_trace.h.
double nav_grid_iterators::RayTrace::y1_ [protected] |
Definition at line 124 of file ray_trace.h.
The documentation for this class was generated from the following files: