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

#include <polygon_fill.h>

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. More...

	PolygonFill (const nav_grid::NavGridInfo *info, nav_2d_msgs::Polygon2D polygon)
	Public Constructor. More...

	PolygonFill (const PolygonFill &other)
	Copy Constructor Required to ensure unique_ptr is set properly. More...

Standard BaseIterator Interface
PolygonFill	begin () const override
	Helper function for range-style iteration Equivalent to the above constructor. More...

PolygonFill	end () const override
	Helper function for range-style iteration. More...

void	increment () override
	Increase the iterator to the next element. More...

bool	fieldsEqual (const PolygonFill &other) override
	Additional check for whether fields of derived iterators are equal. More...

Public Member Functions inherited from nav_grid_iterators::BaseIterator< PolygonFill >
	BaseIterator (const nav_grid::NavGridInfo *info)
	Public Constructor. Takes in a pointer to the info and starts at the minimum index. More...

	BaseIterator (const nav_grid::NavGridInfo &info)
	Public Constructor. Takes in a reference to the info and starts at the minimum index. More...

bool	operator!= (const PolygonFill &other)
	Test if two iterators are not equivalent - required for testing if iterator is at the end. More...

const nav_grid::Index &	operator* () const
	Dereference the iterator. More...

PolygonFill &	operator++ ()
	Increase the iterator to the next element. More...

bool	operator== (const PolygonFill &other)
	Test if two iterators are equivalent. More...

virtual	~BaseIterator ()=default
	Destructor. More...

Protected Member Functions
bool	isInside (unsigned int x, unsigned int y) const
	Check if given index is inside the polygon. More...

	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. More...

Protected Member Functions inherited from nav_grid_iterators::BaseIterator< PolygonFill >
	BaseIterator (const nav_grid::NavGridInfo *info, const nav_grid::Index &index)
	Protected constructor that takes in an arbitrary index. More...

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_

Protected Attributes inherited from nav_grid_iterators::BaseIterator< PolygonFill >
nav_grid::Index	index_

const nav_grid::NavGridInfo *	info_

Additional Inherited Members
Public Types inherited from nav_grid_iterators::BaseIterator< PolygonFill >
using	difference_type = int

using	iterator_category = std::input_iterator_tag

using	pointer = nav_grid::Index *

using	reference = nav_grid::Index &

using	self_type = PolygonFill

using	value_type = nav_grid::Index

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

Definition at line 92 of file polygon_fill.cpp.

Member Function Documentation

PolygonFill nav_grid_iterators::PolygonFill::begin ( ) const

overridevirtual

Helper function for range-style iteration Equivalent to the above constructor.

Returns: Iterator representing beginning of the iteration

Implements nav_grid_iterators::BaseIterator< PolygonFill >.

Definition at line 124 of file polygon_fill.cpp.

PolygonFill nav_grid_iterators::PolygonFill::end ( ) const

overridevirtual

Helper function for range-style iteration.

Returns: Iterator representing end of the iteration, with an invalid index

Implements nav_grid_iterators::BaseIterator< PolygonFill >.

Definition at line 129 of file polygon_fill.cpp.

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

overridevirtual

Additional check for whether fields of derived iterators are equal.

Helps make overriding the == operator easy.

Reimplemented from nav_grid_iterators::BaseIterator< PolygonFill >.

Definition at line 148 of file polygon_fill.cpp.

void nav_grid_iterators::PolygonFill::increment ( )

overridevirtual

Increase the iterator to the next element.

Implements nav_grid_iterators::BaseIterator< PolygonFill >.

Definition at line 135 of file polygon_fill.cpp.

bool nav_grid_iterators::PolygonFill::isInside	(	unsigned int	x,
		unsigned int	y
	)		const

protected

Check if given index is inside the polygon.

Returns: true if inside, false otherwise.

Definition at line 116 of file polygon_fill.cpp.

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

Assignment Operator Required to ensure unique_ptr is set properly.

Definition at line 102 of file polygon_fill.cpp.

Member Data Documentation

unsigned int nav_grid_iterators::PolygonFill::height_

protected

Definition at line 102 of file polygon_fill.h.

std::unique_ptr<SubGrid> nav_grid_iterators::PolygonFill::internal_iterator_

protected

Definition at line 104 of file polygon_fill.h.

unsigned int nav_grid_iterators::PolygonFill::min_x_

protected

Definition at line 102 of file polygon_fill.h.

unsigned int nav_grid_iterators::PolygonFill::min_y_

protected

Definition at line 102 of file polygon_fill.h.

nav_2d_msgs::Polygon2D nav_grid_iterators::PolygonFill::polygon_

protected

Definition at line 101 of file polygon_fill.h.

nav_grid::Index nav_grid_iterators::PolygonFill::start_index_

protected

Definition at line 103 of file polygon_fill.h.

unsigned int nav_grid_iterators::PolygonFill::width_

protected

Definition at line 102 of file polygon_fill.h.

The documentation for this class was generated from the following files:

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation