KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Private Attributes | Friends | List of all members
SHAPE_POLY_SET::ITERATOR_TEMPLATE< T > Class Template Reference

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

#include <shape_poly_set.h>

Public Member Functions

bool IsEndContour () const
 
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.
 
void operator++ (int dummy)
 
void operator++ ()
 
const T & Get ()
 
const T & operator* ()
 
const T * operator-> ()
 
VERTEX_INDEX GetIndex ()
 

Private Attributes

SHAPE_POLY_SET * m_poly
 
int m_currentPolygon
 
int m_currentContour
 
int m_currentVertex
 
int m_lastPolygon
 
bool m_iterateHoles
 

Friends

class SHAPE_POLY_SET
 

Detailed Description

template<class T>
class SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >

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

Definition at line 233 of file shape_poly_set.h.

Member Function Documentation

◆ Advance()

template<class T >
void SHAPE_POLY_SET::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 273 of file shape_poly_set.h.

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

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

◆ Get()

template<class T >
const T & SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Get ( )
inline

Definition at line 321 of file shape_poly_set.h.

References SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentVertex, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_poly, and SHAPE_POLY_SET::Polygon().

Referenced by SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator*(), and SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator->().

◆ GetIndex()

template<class T >
VERTEX_INDEX SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::GetIndex ( )
inline
Returns
the indices of the current polygon, contour and vertex.

Definition at line 339 of file shape_poly_set.h.

References SHAPE_POLY_SET::VERTEX_INDEX::m_contour, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentVertex, SHAPE_POLY_SET::VERTEX_INDEX::m_polygon, and SHAPE_POLY_SET::VERTEX_INDEX::m_vertex.

Referenced by SHAPE_POLY_SET::RemoveNullSegments().

◆ IsEndContour()

template<class T >
bool SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsEndContour ( ) const
inline
Returns
true if the current vertex is the last one of the current contour (outline or hole); false otherwise.

Definition at line 241 of file shape_poly_set.h.

References SHAPE_POLY_SET::CPolygon(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentVertex, and SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_poly.

Referenced by PCB_POINT_EDITOR::addCorner(), DSN::SPECCTRA_DB::FromBOARD(), DSN::SPECCTRA_DB::makeIMAGE(), and SHAPE_POLY_SET::RemoveNullSegments().

◆ IsLastPolygon()

template<class T >
bool SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsLastPolygon ( ) const
inline
Returns
true if the current outline is the last one; false otherwise.

Definition at line 250 of file shape_poly_set.h.

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

◆ operator bool()

template<class T >
SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator bool ( ) const
inline

Definition at line 255 of file shape_poly_set.h.

References SHAPE_POLY_SET::CPolygon(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentContour, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentPolygon, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentVertex, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_lastPolygon, SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_poly, and SHAPE_POLY_SET::OutlineCount().

◆ operator*()

template<class T >
const T & SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator* ( )
inline

Definition at line 326 of file shape_poly_set.h.

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

◆ operator++() [1/2]

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

Definition at line 316 of file shape_poly_set.h.

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

◆ operator++() [2/2]

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

Definition at line 311 of file shape_poly_set.h.

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

◆ operator->()

template<class T >
const T * SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator-> ( )
inline

Definition at line 331 of file shape_poly_set.h.

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

Friends And Related Function Documentation

◆ SHAPE_POLY_SET

template<class T >
friend class SHAPE_POLY_SET
friend

Definition at line 351 of file shape_poly_set.h.

Member Data Documentation

◆ m_currentContour

template<class T >
int SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentContour
private

Definition at line 355 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::GetIndex(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsEndContour(), SHAPE_POLY_SET::Iterate(), SHAPE_POLY_SET::IterateFromVertexWithHoles(), and SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator bool().

◆ m_currentPolygon

template<class T >
int SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentPolygon
private

Definition at line 354 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::GetIndex(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsEndContour(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsLastPolygon(), SHAPE_POLY_SET::Iterate(), SHAPE_POLY_SET::IterateFromVertexWithHoles(), and SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator bool().

◆ m_currentVertex

template<class T >
int SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_currentVertex
private

Definition at line 356 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::GetIndex(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsEndContour(), SHAPE_POLY_SET::Iterate(), SHAPE_POLY_SET::IterateFromVertexWithHoles(), and SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator bool().

◆ m_iterateHoles

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

Definition at line 358 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterate(), and SHAPE_POLY_SET::Iterate().

◆ m_lastPolygon

template<class T >
int SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_lastPolygon
private

Definition at line 357 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsLastPolygon(), SHAPE_POLY_SET::Iterate(), and SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator bool().

◆ m_poly

template<class T >
SHAPE_POLY_SET* SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::m_poly
private

Definition at line 353 of file shape_poly_set.h.

Referenced by SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Advance(), SHAPE_POLY_SET::CIterate(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::Get(), SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::IsEndContour(), SHAPE_POLY_SET::Iterate(), and SHAPE_POLY_SET::ITERATOR_TEMPLATE< T >::operator bool().

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