mazes::distance_grid Class Reference

A grid that can calculate distances between cells. More...

#include <distance_grid.h>

Inheritance diagram for mazes::distance_grid:

Collaboration diagram for mazes::distance_grid:

Public Member Functions
	distance_grid (unsigned int width, unsigned int length, unsigned int height=1u)
virtual std::optional< std::string >	contents_of (const std::shared_ptr< cell > &c) const noexcept override
	Get detailed information of a cell in the grid.
virtual std::optional< std::uint32_t >	background_color_for (const std::shared_ptr< cell > &c) const noexcept override
	Get the background color for a cell in the grid.
std::shared_ptr< distances >	get_distances () const noexcept
Public Member Functions inherited from mazes::grid
	grid (unsigned int rows, unsigned int columns, unsigned int height=1u)
	Constructor for grid.
	grid (std::tuple< unsigned int, unsigned int, unsigned int > dimensions)
	Constructor for grid.
	grid (const grid &other)
	Copy constructor.
grid &	operator= (const grid &other)
	Assignment operator.
	grid (grid &&other) noexcept
	Move constructor.
grid &	operator= (grid &&other) noexcept
	Move assignment operator.
virtual	~grid ()
	Destructor.
virtual std::tuple< unsigned int, unsigned int, unsigned int >	get_dimensions () const noexcept override
	Provides dimensions of grid in no assumed ordering.
virtual void	to_vec (std::vector< std::shared_ptr< cell > > &cells) const noexcept override
	Convert a 2D grid to a vector of cells (sorted by row then column)
virtual void	to_vec2 (std::vector< std::vector< std::shared_ptr< cell > > > &cells) const noexcept override
	Convert a 2D grid to a vector of vectors of cells (sorted by row then column)
virtual void	append (std::shared_ptr< grid_interface > const &other_grid) noexcept
virtual void	insert (std::shared_ptr< cell > const &parent, int index) noexcept
virtual bool	update (std::shared_ptr< cell > &parent, int old_index, int new_index) noexcept
virtual std::shared_ptr< cell >	search (std::shared_ptr< cell > const &start, int index) const noexcept
virtual void	del (std::shared_ptr< cell > parent, int index) noexcept
Public Member Functions inherited from mazes::grid_interface

Friends
class	binary_tree
class	dfs
class	sidewinder

Additional Inherited Members
Static Public Member Functions inherited from mazes::grid
template<typename G = std::unique_ptr<grid_interface>>
static std::optional< std::unique_ptr< grid > >	make_opt (const G g) noexcept
Protected Attributes inherited from mazes::grid
std::shared_ptr< cell >	m_binary_search_tree_root

Detailed Description

A grid that can calculate distances between cells.

Member Function Documentation

background_color_for()

virtual std::optional< std::uint32_t > mazes::distance_grid::background_color_for ( const std::shared_ptr< cell > & c ) const

overridevirtualnoexcept

Get the background color for a cell in the grid.

Parameters

c

Returns

Reimplemented from mazes::grid.

contents_of()

virtual std::optional< std::string > mazes::distance_grid::contents_of ( const std::shared_ptr< cell > & c ) const

overridevirtualnoexcept

Get detailed information of a cell in the grid.

Parameters

c

Returns

Reimplemented from mazes::grid.

---

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

• distance_grid.h