Base class for iterating over all segments in a given SHAPE_POLY_SET. More...

#include <shape_poly_set.h>

Public Member Functions
bool	IsLastPolygon () const

	operator bool () const

void	Advance ()
	Advance the indices of the current vertex/outline/contour, checking whether the vertices in the holes have to be iterated through. More...

void	operator++ (int dummy)

void	operator++ ()

T	Get ()

T	operator* ()

VERTEX_INDEX	GetIndex () const

bool	IsAdjacent (SEGMENT_ITERATOR_TEMPLATE< T > aOther) const

Private Attributes
SHAPE_POLY_SET *	m_poly

int	m_currentPolygon

int	m_currentContour

int	m_currentSegment

int	m_lastPolygon

bool	m_iterateHoles

Friends
class	SHAPE_POLY_SET

Detailed Description

template<class T>
class SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >

Base class for iterating over all segments in a given SHAPE_POLY_SET.

Definition at line 336 of file shape_poly_set.h.

Member Function Documentation

◆ Advance()

template<class T >

void SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance ( )

inline

Advance the indices of the current vertex/outline/contour, checking whether the vertices in the holes have to be iterated through.

Definition at line 356 of file shape_poly_set.h.

 {
 // Advance vertex index
 m_currentSegment++;
 int last;
 
 // Check whether the user wants to iterate through the vertices of the holes
 // and behave accordingly.
 if( m_iterateHoles )
 {
 last = m_poly->CPolygon( m_currentPolygon )[m_currentContour].SegmentCount();
 
 // If the last vertex of the contour was reached, advance the contour index.
 if( m_currentSegment >= last )
 {
 m_currentSegment = 0;
 m_currentContour++;
 
 // If the last contour of the current polygon was reached, advance the
 // outline index.
 int totalContours = m_poly->CPolygon( m_currentPolygon ).size();
 
 if( m_currentContour >= totalContours )
 {
 m_currentContour = 0;
 m_currentPolygon++;
 }
 }
 }
 else
 {
 last = m_poly->CPolygon( m_currentPolygon )[0].SegmentCount();
 // If the last vertex of the outline was reached, advance to the following
 // polygon
 if( m_currentSegment >= last )
 {
 m_currentSegment = 0;
 m_currentPolygon++;
 }
 }
 }

References SHAPE_POLY_SET::CPolygon(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentSegment, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_iterateHoles, and SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_poly.

Referenced by SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator++().

◆ Get()

template<class T >

T SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Get ( )

inline

Definition at line 408 of file shape_poly_set.h.

 {
 return m_poly->Polygon( m_currentPolygon )[m_currentContour].Segment( m_currentSegment );
 }

References SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentSegment, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_poly, and SHAPE_POLY_SET::Polygon().

Referenced by SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator*().

◆ GetIndex()

template<class T >

VERTEX_INDEX SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::GetIndex ( ) const

inline

Returns: the indices of the current polygon, contour and vertex.

Definition at line 421 of file shape_poly_set.h.

 {
 VERTEX_INDEX index;
 
 index.m_polygon = m_currentPolygon;
 index.m_contour = m_currentContour;
 index.m_vertex = m_currentSegment;
 
 return index;
 }

References SHAPE_POLY_SET::VERTEX_INDEX::m_contour, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentSegment, SHAPE_POLY_SET::VERTEX_INDEX::m_polygon, and SHAPE_POLY_SET::VERTEX_INDEX::m_vertex.

◆ IsAdjacent()

template<class T >

bool SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsAdjacent ( SEGMENT_ITERATOR_TEMPLATE< T > aOther ) const

inline

Parameters

aOther is an iterator pointing to another segment.

Returns: true if both iterators point to the same segment of the same contour of the same polygon of the same polygon set; false otherwise.

Definition at line 437 of file shape_poly_set.h.

 {
 // Check that both iterators point to the same contour of the same polygon of the
 // same polygon set.
 if( m_poly == aOther.m_poly && m_currentPolygon == aOther.m_currentPolygon &&
 m_currentContour == aOther.m_currentContour )
 {
 // Compute the total number of segments.
 int numSeg;
 numSeg = m_poly->CPolygon( m_currentPolygon )[m_currentContour].SegmentCount();
 
 // Compute the difference of the segment indices. If it is exactly one, they
 // are adjacent. The only missing case where they also are adjacent is when
 // the segments are the first and last one, in which case the difference
 // always equals the total number of segments minus one.
 int indexDiff = std::abs( m_currentSegment - aOther.m_currentSegment );
 
  return ( indexDiff == 1 ) || ( indexDiff == (numSeg - 1) );
 }
 
 return false;
 }

References std::abs(), SHAPE_POLY_SET::CPolygon(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentSegment, and SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_poly.

◆ IsLastPolygon()

template<class T >

bool SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsLastPolygon ( ) const

inline

Returns: true if the current outline is the last one.

Definition at line 342 of file shape_poly_set.h.

 {
 return m_currentPolygon == m_lastPolygon;
 }

References SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentPolygon, and SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_lastPolygon.

◆ operator bool()

template<class T >

SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator bool ( ) const

inline

Definition at line 347 of file shape_poly_set.h.

 {
 return m_currentPolygon <= m_lastPolygon;
 }

References SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentPolygon, and SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_lastPolygon.

◆ operator*()

template<class T >

T SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator* ( )

inline

Definition at line 413 of file shape_poly_set.h.

 {
 return Get();
 }

References SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Get().

◆ operator++() [1/2]

template<class T >

void SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator++ ( )

inline

Definition at line 403 of file shape_poly_set.h.

 {
 Advance();
 }

References SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance().

◆ operator++() [2/2]

template<class T >

void SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator++ ( int dummy )

inline

Definition at line 398 of file shape_poly_set.h.

 {
 Advance();
 }

References SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance().

Friends And Related Function Documentation

◆ SHAPE_POLY_SET

template<class T >

friend class SHAPE_POLY_SET

friend

Definition at line 461 of file shape_poly_set.h.

Member Data Documentation

◆ m_currentContour

template<class T >

int SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentContour

private

Definition at line 465 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterateSegments(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::GetIndex(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsAdjacent(), and SHAPE_POLY_SET::IterateSegments().

◆ m_currentPolygon

template<class T >

int SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentPolygon

private

Definition at line 464 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterateSegments(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::GetIndex(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsAdjacent(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsLastPolygon(), SHAPE_POLY_SET::IterateSegments(), and SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator bool().

◆ m_currentSegment

template<class T >

int SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_currentSegment

private

Definition at line 466 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterateSegments(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::GetIndex(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsAdjacent(), and SHAPE_POLY_SET::IterateSegments().

◆ m_iterateHoles

template<class T >

bool SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_iterateHoles

private

Definition at line 468 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterateSegments(), and SHAPE_POLY_SET::IterateSegments().

◆ m_lastPolygon

template<class T >

int SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_lastPolygon

private

Definition at line 467 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::CIterateSegments(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsLastPolygon(), SHAPE_POLY_SET::IterateSegments(), and SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator bool().

◆ m_poly

template<class T >

SHAPE_POLY_SET* SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_poly

private

Definition at line 463 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterateSegments(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsAdjacent(), and SHAPE_POLY_SET::IterateSegments().

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

shape_poly_set.h

Public Member Functions

Private Attributes

Friends

Detailed Description

Member Function Documentation

◆ Advance()

◆ Get()

◆ GetIndex()

◆ IsAdjacent()

◆ IsLastPolygon()

◆ operator bool()

◆ operator*()

◆ operator++() [1/2]

◆ operator++() [2/2]

Friends And Related Function Documentation

◆ SHAPE_POLY_SET

Member Data Documentation

◆ m_currentContour

◆ m_currentPolygon

◆ m_currentSegment

◆ m_iterateHoles

◆ m_lastPolygon

◆ m_poly