Iterator for looping through every index within an aligned rectangular portion of the grid. More...

#include <sub_grid.h>

Inheritance diagram for nav_grid_iterators::SubGrid:

Public Member Functions
	SubGrid (const nav_grid::NavGridInfo *info, unsigned int min_x, unsigned int min_y, unsigned int width, unsigned int height)
	Public Constructor.
	SubGrid (const nav_grid::NavGridInfo *info, const nav_core2::UIntBounds &bounds)
	Public Constructor using UIntBounds object.
	SubGrid (const nav_grid::NavGridInfo *info, const nav_grid::Index &index, unsigned int min_x, unsigned int min_y, unsigned int width, unsigned int height)
	Public constructor that takes in an arbitrary index.
Standard BaseIterator Interface
SubGrid	begin () const override
	Helper function for range-style iteration Equivalent to the above constructor.
SubGrid	end () const override
	Helper function for range-style iteration.
void	increment () override
	Increase the iterator to the next element.
bool	fieldsEqual (const SubGrid &other) override
	Additional check for whether fields of derived iterators are equal.
Protected Attributes
unsigned int	height_
unsigned int	min_x_
unsigned int	min_y_
unsigned int	width_

Detailed Description

Iterator for looping through every index within an aligned rectangular portion of the grid.

Definition at line 47 of file sub_grid.h.

Constructor & Destructor Documentation

nav_grid_iterators::SubGrid::SubGrid	(	const nav_grid::NavGridInfo *	info,
		unsigned int	min_x,
		unsigned int	min_y,
		unsigned int	width,
		unsigned int	height
	)		`[inline]`

Public Constructor.

Parameters:

info	NavGridInfo for the grid to iterate over
min_x	Minimum index (x coordinate)
min_y	Minimum index (y coordinate)
width	Number of indexes in the x direction
height	Number of indexes in the y direction

Note:: No bounds checking is done for any of the coordinates. Assumes (min_x, min_y) and (min_x + width - 1, min_y + height - 1) are valid in the grid.

Definition at line 61 of file sub_grid.h.

nav_grid_iterators::SubGrid::SubGrid	(	const nav_grid::NavGridInfo *	info,
		const nav_core2::UIntBounds &	bounds
	)		`[inline]`

Public Constructor using UIntBounds object.

Parameters:

info	NavGridInfo for the grid to iterate over
bounds	UIntBounds

Definition at line 70 of file sub_grid.h.

nav_grid_iterators::SubGrid::SubGrid	(	const nav_grid::NavGridInfo *	info,
		const nav_grid::Index &	index,
		unsigned int	min_x,
		unsigned int	min_y,
		unsigned int	width,
		unsigned int	height
	)		`[inline]`

Public constructor that takes in an arbitrary index.

Parameters:

info	NavGridInfo for the grid to iterate over
index	Initial index
min_x	Minimum index (x coordinate)
min_y	Minimum index (y coordinate)
width	Number of indexes in the x direction
height	Number of indexes in the y direction

Note:: No bounds checking is done for any of the coordinates. Assumes (min_x, min_y) and (min_x + width - 1, min_y + height - 1) are valid in the grid.

Definition at line 85 of file sub_grid.h.