Aleph::Polygon::Vertex_Iterator Struct Reference

Iterator over the vertices of a polygon. More...

#include <polygon.H>

Inheritance diagram for Aleph::Polygon::Vertex_Iterator:

Collaboration diagram for Aleph::Polygon::Vertex_Iterator:

Public Member Functions
	Vertex_Iterator (const Polygon &poly)
	Construct iterator from a polygon.
Vertex &	get_current_vertex () const
	Get the current vertex.
Public Member Functions inherited from Aleph::Dlink::Iterator
	Iterator (Dlink *head_ptr) noexcept
	Initialize an iterator on the first item of the list pointed by head_ptr.
	Iterator (const Dlink &list) noexcept
	Initialize an iterator on the first item of list.
void	set (Dlink *new_curr) noexcept
	Set the current node .
	Iterator () noexcept
void	reset_first () noexcept
	Reset the iterator to the first item of list.
void	reset_last () noexcept
	Reset the iterator to the last item of list.
void	end () noexcept
	Put the iterator out of range.
bool	has_curr () const noexcept
	Return true if the iterator has current item.
bool	is_last () const noexcept
Dlink *	get_curr_ne () const noexcept
	Return the current link guaranteeing no exception. Be careful.
Dlink *	get_curr () const
	Return the current node of iterator.
constexpr bool	is_in_first () const noexcept
	Return true if the iterator is positiones on the first item.
bool	is_in_last () const noexcept
	Return true if the iterator is positiones on the last item.
void	prev_ne () noexcept
	Move the iterator one position backward guaranteeing no exception.
void	prev ()
	Move the iterator one position backward.
void	next_ne () noexcept
	Move the iterator one position backward guaranteeing no exception.
void	next ()
	Move the iterator one position forward.
constexpr bool	operator== (const Iterator &it) const noexcept
	Return true if this and it are positioned on the same item.
constexpr bool	operator!= (const Iterator &it) const noexcept
	Return true if this and it hace different states.
Dlink *	del ()
	Remove from the list the current node and move the iterator one position forward.
Dlink *	del_ne () noexcept
constexpr bool	verify (Dlink *l) const noexcept
	Return true if the iterator is on the list pointed by l
constexpr bool	verify (const Iterator &it) const noexcept
	Return true if this and it are on the same list.

Additional Inherited Members
Public Types inherited from Aleph::Dlink::Iterator
using	Set_Type = Dlink
	The set type.
using	Item_Type = Dlink *
	The type of elements of container.

Detailed Description

Iterator over the vertices of a polygon.

Provides sequential access to all vertices in the polygon.

for (Polygon::Vertex_Iterator it(poly); it.has_curr(); it.next())
  std::cout << it.get_current_vertex().to_string() << "\n";

Definition at line 488 of file polygon.H.

Constructor & Destructor Documentation

Vertex_Iterator()

Aleph::Polygon::Vertex_Iterator::Vertex_Iterator ( const Polygon &  poly )

inline

Construct iterator from a polygon.

Parameters

poly	The polygon to iterate over.

Exceptions

std::domain_error

If the polygon has no vertices.

Definition at line 493 of file polygon.H.

References ah_domain_error_if, Aleph::Dlink::is_empty(), and Aleph::Polygon::vertex_list_.

Member Function Documentation

get_current_vertex()

Vertex & Aleph::Polygon::Vertex_Iterator::get_current_vertex ( ) const

inline

Get the current vertex.

Returns

Reference to the current vertex.

Definition at line 500 of file polygon.H.

References Aleph::Vertex::dlink_to_vertex(), and Aleph::Dlink::Iterator::get_curr().

Referenced by TEST_F().

---

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

• polygon.H