Line Iterator using Bresenham's algorithm (no subpixel precision) More...

#include <bresenham.h>

Inheritance diagram for nav_grid_iterators::Bresenham:

Public Member Functions
Bresenham	begin () const
	Helper function for range-style iteration.
	Bresenham (int x0, int y0, int x1, int y1, bool include_last_index=true)
	Public constructor.
Bresenham	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 Bresenham &other)
	Test if two iterators are not equivalent - required for testing if iterator is at the end.
Bresenham &	operator++ ()
	Increase the iterator to the next element.
bool	operator== (const Bresenham &other)
	Test if two iterators are equivalent.
Protected Member Functions
	Bresenham (const nav_grid::SignedIndex &index, int x0, int y0, int x1, int y1, bool include_last_index, int error_inc_x, int loop_inc_x, int error_inc_y, int loop_inc_y, int denominator, int numerator, int numerator_inc)
	Protected constructor that takes in an arbitrary index and other internal parameters.
Protected Attributes
int	denominator_
int	error_inc_x_
int	error_inc_y_
bool	include_last_index_
int	loop_inc_x_
int	loop_inc_y_
int	numerator_
int	numerator_inc_
int	x0_
int	x1_
int	y0_
int	y1_

Detailed Description

Line Iterator using Bresenham's algorithm (no subpixel precision)

Definition at line 46 of file bresenham.h.

Constructor & Destructor Documentation

nav_grid_iterators::Bresenham::Bresenham	(	int	x0,
		int	y0,
		int	x1,
		int	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 bresenham.cpp.

nav_grid_iterators::Bresenham::Bresenham	(	const nav_grid::SignedIndex &	index,
		int	x0,
		int	y0,
		int	x1,
		int	y1,
		bool	include_last_index,
		int	error_inc_x,
		int	loop_inc_x,
		int	error_inc_y,
		int	loop_inc_y,
		int	denominator,
		int	numerator,
		int	numerator_inc
	)		`[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.
error_inc_x
loop_inc_x
error_inc_y
loop_inc_y
denominator
numerator
numerator_inc