Iterates over all of the valid indexes that lie within an arbitrary polygon in row major order. More...

Inheritance diagram for nav_grid_iterators::PolygonFill:

Public Member Functions
PolygonFill &	operator= (const PolygonFill &other)
	Assignment Operator Required to ensure unique_ptr is set properly.
	PolygonFill (const nav_grid::NavGridInfo *info, nav_2d_msgs::Polygon2D polygon)
	Public Constructor.
	PolygonFill (const PolygonFill &other)
	Copy Constructor Required to ensure unique_ptr is set properly.
Standard BaseIterator Interface
PolygonFill	begin () const override
	Helper function for range-style iteration Equivalent to the above constructor.
PolygonFill	end () const override
	Helper function for range-style iteration.
void	increment () override
	Increase the iterator to the next element.
bool	fieldsEqual (const PolygonFill &other) override
	Additional check for whether fields of derived iterators are equal.
Protected Member Functions
bool	isInside (unsigned int x, unsigned int y) const
	Check if given index is inside the polygon.
	PolygonFill (const nav_grid::NavGridInfo *info, const nav_grid::Index &index, nav_2d_msgs::Polygon2D polygon, unsigned int min_x, unsigned int min_y, unsigned int width, unsigned int height, const nav_grid::Index &start_index)
	Protected constructor that takes in an arbitrary index and other internal parameters.
Protected Attributes
unsigned int	height_
std::unique_ptr< SubGrid >	internal_iterator_
unsigned int	min_x_
unsigned int	min_y_
nav_2d_msgs::Polygon2D	polygon_
nav_grid::Index	start_index_
unsigned int	width_

Detailed Description

Iterates over all of the valid indexes that lie within an arbitrary polygon in row major order.

Definition at line 48 of file polygon_fill.h.

Constructor & Destructor Documentation

nav_grid_iterators::PolygonFill::PolygonFill	(	const nav_grid::NavGridInfo *	info,
		nav_2d_msgs::Polygon2D	polygon
	)

Public Constructor.

Parameters:

info	NavGridInfo for the grid to iterate over
polygon	Polygon to iterate over

Definition at line 42 of file polygon_fill.cpp.

nav_grid_iterators::PolygonFill::PolygonFill ( const PolygonFill & other )

Copy Constructor Required to ensure unique_ptr is set properly.

Definition at line 86 of file polygon_fill.cpp.

nav_grid_iterators::PolygonFill::PolygonFill	(	const nav_grid::NavGridInfo *	info,
		const nav_grid::Index &	index,
		nav_2d_msgs::Polygon2D	polygon,
		unsigned int	min_x,
		unsigned int	min_y,
		unsigned int	width,
		unsigned int	height,
		const nav_grid::Index &	start_index
	)		`[protected]`

Protected constructor that takes in an arbitrary index and other internal parameters.

Parameters:

info	NavGridInfo for the grid to iterate over
index	Initial index
polygon	Polygon to iterate over
min_x	Minimum valid index that is within the polygon (x coordinate)
min_y	Minimum valid index that is within the polygon (y coordinate)
width	Maximum number of valid indexes in a row of the polygon
height	Maximum number of of valid indexes in a column of the polygon
start_index	The first valid index in the minimum row