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

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 >

SEGMENT_ITERATOR_TEMPLATE.

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

Definition at line 290 of file shape_poly_set.h.

Member Function Documentation

◆ Advance()

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 312 of file shape_poly_set.h.

313  {
314  // Advance vertex index
316  int last;
317 
318  // Check whether the user wants to iterate through the vertices of the holes
319  // and behave accordingly
320  if( m_iterateHoles )
321  {
322  last = m_poly->CPolygon( m_currentPolygon )[m_currentContour].SegmentCount();
323 
324  // If the last vertex of the contour was reached, advance the contour index
325  if( m_currentSegment >= last )
326  {
327  m_currentSegment = 0;
329 
330  // If the last contour of the current polygon was reached, advance the
331  // outline index
332  int totalContours = m_poly->CPolygon( m_currentPolygon ).size();
333 
334  if( m_currentContour >= totalContours )
335  {
336  m_currentContour = 0;
338  }
339  }
340  }
341  else
342  {
343  last = m_poly->CPolygon( m_currentPolygon )[0].SegmentCount();
344  // If the last vertex of the outline was reached, advance to the following
345  // polygon
346  if( m_currentSegment >= last )
347  {
348  m_currentSegment = 0;
350  }
351  }
352  }
const POLYGON & CPolygon(int aIndex) const

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

◆ GetIndex()

◆ IsAdjacent()

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 396 of file shape_poly_set.h.

397  {
398  // Check that both iterators point to the same contour of the same polygon of the
399  // same polygon set
400  if( m_poly == aOther.m_poly && m_currentPolygon == aOther.m_currentPolygon &&
401  m_currentContour == aOther.m_currentContour )
402  {
403  // Compute the total number of segments
404  int numSeg;
405  numSeg = m_poly->CPolygon( m_currentPolygon )[m_currentContour].SegmentCount();
406 
407  // Compute the difference of the segment indices. If it is exactly one, they
408  // are adjacent. The only missing case where they also are adjacent is when
409  // the segments are the first and last one, in which case the difference
410  // always equals the total number of segments minus one.
411  int indexDiff = abs( m_currentSegment - aOther.m_currentSegment );
412 
413  return ( indexDiff == 1 ) || ( indexDiff == (numSeg - 1) );
414  }
415 
416  return false;
417  }
const POLYGON & CPolygon(int aIndex) const

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, and SHAPE_POLY_SET::SEGMENT_ITERATOR_TEMPLATE< T >::m_poly.

Referenced by SHAPE_POLY_SET::IsPolygonSelfIntersecting().

◆ IsLastPolygon()

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

◆ operator *()

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

Definition at line 369 of file shape_poly_set.h.

370  {
371  return Get();
372  }

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

◆ operator bool()

◆ operator++() [1/2]

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

Definition at line 354 of file shape_poly_set.h.

355  {
356  Advance();
357  }
void Advance()
Function Advance advances the indices of the current vertex/outline/contour, checking whether the ver...

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

◆ operator++() [2/2]

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

Definition at line 359 of file shape_poly_set.h.

360  {
361  Advance();
362  }
void Advance()
Function Advance advances the indices of the current vertex/outline/contour, checking whether the ver...

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 420 of file shape_poly_set.h.

Member Data Documentation

◆ m_currentContour

◆ m_currentPolygon

◆ m_currentSegment

◆ m_iterateHoles

◆ m_lastPolygon

◆ m_poly


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