KiCad PCB EDA Suite
SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T > Class Template Reference

Class SEGMENT_ITERATOR_TEMPLATE. More...

#include <shape_poly_set.h>

Public Member Functions

bool IsLastPolygon () const
 Function IsLastOutline. More...
 
 operator bool () const
 
void Advance ()
 Function Advance advances 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++ ()
 
Get ()
 
operator* ()
 
VERTEX_INDEX GetIndex ()
 Function GetIndex. More...
 
bool IsAdjacent (SEGMENT_ITERATOR_TEMPLATE< T > aOther)
 Function IsAdjacent. More...
 

Private Attributes

SHAPE_POLY_SETm_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 >

Class SEGMENT_ITERATOR_TEMPLATE.

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

Definition at line 273 of file shape_poly_set.h.

Member Function Documentation

template<class T>
void SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::Advance ( )
inline

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

Definition at line 295 of file shape_poly_set.h.

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++().

296  {
297  // Advance vertex index
299  int last;
300 
301  // Check whether the user wants to iterate through the vertices of the holes
302  // and behave accordingly
303  if( m_iterateHoles )
304  {
305  last = m_poly->CPolygon( m_currentPolygon )[m_currentContour].SegmentCount();
306 
307  // If the last vertex of the contour was reached, advance the contour index
308  if( m_currentSegment >= last )
309  {
310  m_currentSegment = 0;
312 
313  // If the last contour of the current polygon was reached, advance the
314  // outline index
315  int totalContours = m_poly->CPolygon( m_currentPolygon ).size();
316 
317  if( m_currentContour >= totalContours )
318  {
319  m_currentContour = 0;
321  }
322  }
323  }
324  else
325  {
326  last = m_poly->CPolygon( m_currentPolygon )[0].SegmentCount();
327  // If the last vertex of the outline was reached, advance to the following
328  // polygon
329  if( m_currentSegment >= last )
330  {
331  m_currentSegment = 0;
333  }
334  }
335  }
const POLYGON & CPolygon(int aIndex) const
template<class T>
bool SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsAdjacent ( SEGMENT_ITERATOR_TEMPLATE< T >  aOther)
inline

Function IsAdjacent.

Parameters
aOtheris an iterator pointing to another segment.
Returns
bool - 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 379 of file shape_poly_set.h.

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

Referenced by SHAPE_POLY_SET::IsPolygonSelfIntersecting().

380  {
381  // Check that both iterators point to the same contour of the same polygon of the
382  // same polygon set
383  if( m_poly == aOther.m_poly && m_currentPolygon == aOther.m_currentPolygon &&
384  m_currentContour == aOther.m_currentContour )
385  {
386  // Compute the total number of segments
387  int numSeg;
388  numSeg = m_poly->CPolygon( m_currentPolygon )[m_currentContour].SegmentCount();
389 
390  // Compute the difference of the segment indices. If it is exactly one, they
391  // are adjacent. The only missing case where they also are adjacent is when
392  // the segments are the first and last one, in which case the difference
393  // always equals the total number of segments minus one.
394  int indexDiff = abs( m_currentSegment - aOther.m_currentSegment );
395 
396  return ( indexDiff == 1 ) || ( indexDiff == (numSeg - 1) );
397  }
398 
399  return false;
400  }
#define abs(a)
Definition: auxiliary.h:84
const POLYGON & CPolygon(int aIndex) const
template<class T>
bool SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::IsLastPolygon ( ) const
inline

Function IsLastOutline.

Returns
bool - true if the current outline is the last one.

Definition at line 280 of file shape_poly_set.h.

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

template<class T>
T SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator* ( )
inline

Definition at line 352 of file shape_poly_set.h.

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

353  {
354  return Get();
355  }
template<class T>
void SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator++ ( int  dummy)
inline

Definition at line 337 of file shape_poly_set.h.

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

338  {
339  Advance();
340  }
void Advance()
Function Advance advances the indices of the current vertex/outline/contour, checking whether the ver...
template<class T>
void SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::operator++ ( )
inline

Definition at line 342 of file shape_poly_set.h.

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

343  {
344  Advance();
345  }
void Advance()
Function Advance advances the indices of the current vertex/outline/contour, checking whether the ver...

Friends And Related Function Documentation

template<class T>
friend class SHAPE_POLY_SET
friend

Definition at line 403 of file shape_poly_set.h.

Member Data Documentation

template<class T>
bool SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_iterateHoles
private

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