KiCad PCB EDA Suite
GERBER_COLLECTOR Class Reference

GERBER_COLLECTOR is intended for use when the right click button is pressed, or when the plain "arrow" tool is in effect. More...

#include <gerber_collectors.h>

Inheritance diagram for GERBER_COLLECTOR:
COLLECTOR

Public Types

using ITER = std::vector< EDA_ITEM * >::iterator
 
using CITER = std::vector< EDA_ITEM * >::const_iterator
 

Public Member Functions

 GERBER_COLLECTOR ()
 
void Empty2nd ()
 
EDA_ITEMoperator[] (int ndx) const override
 Function SetGuide records which COLLECTORS_GUIDE to use. More...
 
int GetPrimaryCount ()
 Function GetPrimaryCount. More...
 
SEARCH_RESULT Inspect (EDA_ITEM *testItem, void *testData) override
 Function Inspect is the examining function within the INSPECTOR which is passed to the Iterate function. More...
 
void Collect (EDA_ITEM *aItem, const KICAD_T aScanList[], const wxPoint &aRefPos)
 Function Collect scans an EDA_ITEM using this class's Inspector method, which does the collection. More...
 
ITER begin ()
 
CITER begin () const
 
ITER end ()
 
CITER end () const
 
int GetCount () const
 Return the number of objects in the list. More...
 
void Empty ()
 Clear the list. More...
 
void Append (EDA_ITEM *item)
 Add an item to the end of the list. More...
 
void Remove (int aIndex)
 Remove the item at aIndex (first position is 0). More...
 
void Remove (const EDA_ITEM *aItem)
 Remove the item aItem (if exists in the collector). More...
 
bool HasAdditionalItems ()
 Test if the collector has heuristic backup items. More...
 
void Combine ()
 Re-combine the backup list into the main list of the collector. More...
 
void Transfer (int aIndex)
 Move the item at aIndex (first position is 0) to the backup list. More...
 
void Transfer (EDA_ITEM *aItem)
 Move aItem (if exists in the collector) to the backup list. More...
 
bool HasItem (const EDA_ITEM *aItem) const
 Tests if aItem has already been collected. More...
 
void SetScanTypes (const KICAD_T *scanTypes)
 Record the list of KICAD_T types to consider for collection by the Inspect() function. More...
 
void SetRefPos (const wxPoint &aRefPos)
 
const EDA_RECTGetBoundingBox () const
 
int CountType (KICAD_T aType)
 Count the number of items matching aType. More...
 

Public Attributes

int m_Threshold
 
wxString m_MenuTitle
 
bool m_MenuCancelled
 

Static Public Attributes

static const KICAD_T AllItems []
 A scan list for all selectable gerber items. More...
 

Protected Attributes

std::vector< EDA_ITEM * > m_List2nd
 A place to hold collected objects which don't match precisely the search criteria, but would be acceptable if nothing else is found. More...
 
int m_PrimaryLength
 Determines which items are to be collected by Inspect() More...
 
std::vector< EDA_ITEM * > m_list
 
std::vector< EDA_ITEM * > m_backupList
 
const KICAD_Tm_scanTypes
 
INSPECTOR_FUNC m_inspector
 
wxPoint m_refPos
 
EDA_RECT m_refBox
 

Detailed Description

GERBER_COLLECTOR is intended for use when the right click button is pressed, or when the plain "arrow" tool is in effect.

Definition at line 30 of file gerber_collectors.h.

Member Typedef Documentation

◆ CITER

using COLLECTOR::CITER = std::vector<EDA_ITEM*>::const_iterator
inherited

Definition at line 77 of file collector.h.

◆ ITER

using COLLECTOR::ITER = std::vector<EDA_ITEM*>::iterator
inherited

Definition at line 76 of file collector.h.

Constructor & Destructor Documentation

◆ GERBER_COLLECTOR()

GERBER_COLLECTOR::GERBER_COLLECTOR ( )
inline

Definition at line 62 of file gerber_collectors.h.

63  {
64  //m_Guide = NULL;
65  m_PrimaryLength = 0;
67  }
void SetScanTypes(const KICAD_T *scanTypes)
Record the list of KICAD_T types to consider for collection by the Inspect() function.
Definition: collector.h:220
int m_PrimaryLength
Determines which items are to be collected by Inspect()
static const KICAD_T AllItems[]
A scan list for all selectable gerber items.

References AllItems, m_PrimaryLength, and COLLECTOR::SetScanTypes().

Member Function Documentation

◆ Append()

◆ begin() [1/2]

ITER COLLECTOR::begin ( )
inlineinherited

Definition at line 79 of file collector.h.

79 { return m_list.begin(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254

References COLLECTOR::m_list.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const
inlineinherited

Definition at line 81 of file collector.h.

81 { return m_list.cbegin(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254

References COLLECTOR::m_list.

◆ Collect()

void GERBER_COLLECTOR::Collect ( EDA_ITEM aItem,
const KICAD_T  aScanList[],
const wxPoint &  aRefPos 
)

Function Collect scans an EDA_ITEM using this class's Inspector method, which does the collection.

Parameters
aItemAn EDA_ITEM to scan
aScanListA list of KICAD_Ts with a terminating EOT, that specs what is to be collected and the priority order of the resultant collection in "m_list".
aRefPosA wxPoint to use in hit-testing.
aGuideThe COLLECTORS_GUIDE to use in collecting items.

Definition at line 49 of file gerber_collectors.cpp.

51 {
52  Empty(); // empty the collection, primary criteria list
53 
54  // remember guide, pass it to Inspect()
55  //SetGuide( &aGuide );
56 
57  SetScanTypes( aScanList );
58 
59  // remember where the snapshot was taken from and pass refPos to
60  // the Inspect() function.
61  SetRefPos( aRefPos );
62 
63  aItem->Visit( m_inspector, NULL, m_scanTypes );
64 
65  // record the length of the primary list before concatenating on to it.
66  m_PrimaryLength = m_list.size();
67 }
void Empty()
Clear the list.
Definition: collector.h:95
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:107
void SetScanTypes(const KICAD_T *scanTypes)
Record the list of KICAD_T types to consider for collection by the Inspect() function.
Definition: collector.h:220
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254
int m_PrimaryLength
Determines which items are to be collected by Inspect()
INSPECTOR_FUNC m_inspector
Definition: collector.h:258
#define NULL
void SetRefPos(const wxPoint &aRefPos)
Definition: collector.h:225
const KICAD_T * m_scanTypes
Definition: collector.h:257

References COLLECTOR::Empty(), COLLECTOR::m_inspector, COLLECTOR::m_list, m_PrimaryLength, COLLECTOR::m_scanTypes, NULL, COLLECTOR::SetRefPos(), COLLECTOR::SetScanTypes(), and EDA_ITEM::Visit().

Referenced by GERBVIEW_SELECTION_TOOL::selectPoint().

◆ Combine()

void COLLECTOR::Combine ( )
inlineinherited

Re-combine the backup list into the main list of the collector.

Definition at line 148 of file collector.h.

149  {
150  std::copy( m_backupList.begin(), m_backupList.end(), std::back_inserter( m_list ) );
151  m_backupList.clear();
152  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:255

References COLLECTOR::m_backupList, and COLLECTOR::m_list.

Referenced by EE_SELECTION_TOOL::doSelectionMenu(), and PCB_SELECTION_TOOL::doSelectionMenu().

◆ CountType()

int COLLECTOR::CountType ( KICAD_T  aType)
inlineinherited

Count the number of items matching aType.

Parameters
aTypetype we are interested in.
Returns
number of occurrences.

Definition at line 235 of file collector.h.

236  {
237  int cnt = 0;
238 
239  for( size_t i = 0; i < m_list.size(); i++ )
240  {
241  if( m_list[i]->Type() == aType )
242  cnt++;
243  }
244 
245  return cnt;
246  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254

References COLLECTOR::m_list.

Referenced by ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

◆ Empty2nd()

void GERBER_COLLECTOR::Empty2nd ( )
inline

Definition at line 69 of file gerber_collectors.h.

70  {
71  m_List2nd.clear();
72  }
std::vector< EDA_ITEM * > m_List2nd
A place to hold collected objects which don't match precisely the search criteria,...

References m_List2nd.

◆ end() [1/2]

ITER COLLECTOR::end ( )
inlineinherited

Definition at line 80 of file collector.h.

80 { return m_list.end(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254

References COLLECTOR::m_list.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const
inlineinherited

Definition at line 82 of file collector.h.

82 { return m_list.cend(); }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254

References COLLECTOR::m_list.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const
inlineinherited

Definition at line 227 of file collector.h.

227 { return m_refBox; }
EDA_RECT m_refBox
Definition: collector.h:260

References COLLECTOR::m_refBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const
inlineinherited

Return the number of objects in the list.

Definition at line 87 of file collector.h.

88  {
89  return (int) m_list.size();
90  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254

References COLLECTOR::m_list.

Referenced by BuildBoardPolygonOutlines(), BuildFootprintPolygonOutlines(), EDIT_TOOL::ChangeTrackWidth(), EE_SELECTION_TOOL::CollectHits(), connectedItemFilter(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), EDIT_TOOL::CreateArray(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), EDIT_TOOL::doMoveSelection(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), PAD_TOOL::EnumeratePads(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForGroups(), EDIT_TOOL::Flip(), EDIT_TOOL::FootprintFilter(), DSN::SPECCTRA_DB::FromBOARD(), EE_SELECTION_TOOL::GetNode(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), GROUP_TOOL::Group(), PL_SELECTION_TOOL::guessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), EE_COLLECTOR::IsCorner(), CONVERT_TOOL::LinesToPoly(), EE_SELECTION_TOOL::Main(), DSN::SPECCTRA_DB::makeIMAGE(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), EE_SELECTION_TOOL::narrowSelection(), ROUTER_TOOL::NeighboringSegmentFilter(), EE_COLLECTOR::operator[](), operator[](), COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PadFilter(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Rotate(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::selectionContains(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), PCB_SELECTION_TOOL::selectPoint(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ GetPrimaryCount()

int GERBER_COLLECTOR::GetPrimaryCount ( )
inline

Function GetPrimaryCount.

Returns
int - The number if items which met the primary search criteria

Definition at line 106 of file gerber_collectors.h.

106 { return m_PrimaryLength; }
int m_PrimaryLength
Determines which items are to be collected by Inspect()

References m_PrimaryLength.

◆ HasAdditionalItems()

bool COLLECTOR::HasAdditionalItems ( )
inlineinherited

Test if the collector has heuristic backup items.

Returns
true if Combine() can run to bring secondary items into the list.

Definition at line 140 of file collector.h.

141  {
142  return !m_backupList.empty();
143  }
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:255

References COLLECTOR::m_backupList.

Referenced by EE_SELECTION_TOOL::doSelectionMenu(), and PCB_SELECTION_TOOL::doSelectionMenu().

◆ HasItem()

bool COLLECTOR::HasItem ( const EDA_ITEM aItem) const
inlineinherited

Tests if aItem has already been collected.

Parameters
aItemThe EDA_ITEM* to be tested.
Returns
True if aItem is already collected.

Definition at line 203 of file collector.h.

204  {
205  for( size_t i = 0; i < m_list.size(); i++ )
206  {
207  if( m_list[i] == aItem )
208  return true;
209  }
210 
211  return false;
212  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254

References COLLECTOR::m_list.

Referenced by EDIT_TOOL::copyToClipboard(), EDIT_TOOL::CreateArray(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForGroups(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), POSITION_RELATIVE_TOOL::PositionRelative(), and EDIT_TOOL::Rotate().

◆ Inspect()

SEARCH_RESULT GERBER_COLLECTOR::Inspect ( EDA_ITEM testItem,
void *  testData 
)
overridevirtual

Function Inspect is the examining function within the INSPECTOR which is passed to the Iterate function.

Parameters
testItemAn EDA_ITEM to examine.
testDatais not used in this class.
Returns
SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE;
Parameters
testItemAn EDA_ITEM to examine.
testDatanot used here.
Returns
SEARCH_RESULT - SEARCH_QUIT if the Iterator is to stop the scan, else SCAN_CONTINUE;

Reimplemented from COLLECTOR.

Definition at line 40 of file gerber_collectors.cpp.

41 {
42  if( testItem->HitTest( m_refPos ) )
43  Append( testItem );
44 
46 }
void Append(EDA_ITEM *item)
Add an item to the end of the list.
Definition: collector.h:105
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Test if aPosition is contained within or on the bounding box of an item.
Definition: eda_item.h:274
wxPoint m_refPos
Definition: collector.h:259

References COLLECTOR::Append(), CONTINUE, EDA_ITEM::HitTest(), and COLLECTOR::m_refPos.

◆ operator[]()

EDA_ITEM* GERBER_COLLECTOR::operator[] ( int  ndx) const
inlineoverridevirtual

Function SetGuide records which COLLECTORS_GUIDE to use.

Parameters
aGuideWhich guide to use in the collection.Function operator[int] overloads COLLECTOR::operator[](int) to return a EDA_ITEM* instead of an EDA_ITEM* type.
ndxThe index into the list.
Returns
EDA_ITEM* - or something derived from it, or NULL.

Reimplemented from COLLECTOR.

Definition at line 95 of file gerber_collectors.h.

96  {
97  if( (unsigned)ndx < (unsigned)GetCount() )
98  return (EDA_ITEM*) m_list[ ndx ];
99  return NULL;
100  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254
int GetCount() const
Return the number of objects in the list.
Definition: collector.h:87
#define NULL
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:149

References COLLECTOR::GetCount(), COLLECTOR::m_list, and NULL.

◆ Remove() [1/2]

◆ Remove() [2/2]

void COLLECTOR::Remove ( const EDA_ITEM aItem)
inlineinherited

Remove the item aItem (if exists in the collector).

Parameters
aItemthe item to be removed.

Definition at line 125 of file collector.h.

126  {
127  m_list.erase( std::remove_if( m_list.begin(), m_list.end(),
128  [&aItem]( const EDA_ITEM* aCandidate )
129  {
130  return aCandidate == aItem;
131  } ),
132  m_list.end() );
133  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:149

References COLLECTOR::m_list.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint &  aRefPos)
inlineinherited

Definition at line 225 of file collector.h.

225 { m_refPos = aRefPos; }
wxPoint m_refPos
Definition: collector.h:259

References COLLECTOR::m_refPos.

Referenced by EE_COLLECTOR::Collect(), Collect(), and GENERAL_COLLECTOR::Collect().

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const KICAD_T scanTypes)
inlineinherited

Record the list of KICAD_T types to consider for collection by the Inspect() function.

Parameters
scanTypesAn array of KICAD_T, terminated by EOT. No copy is is made of this array (so cannot come from caller's stack).

Definition at line 220 of file collector.h.

221  {
222  m_scanTypes = scanTypes;
223  }
const KICAD_T * m_scanTypes
Definition: collector.h:257

References COLLECTOR::m_scanTypes.

Referenced by EE_COLLECTOR::Collect(), Collect(), GENERAL_COLLECTOR::Collect(), EE_COLLECTOR::EE_COLLECTOR(), GENERAL_COLLECTOR::GENERAL_COLLECTOR(), and GERBER_COLLECTOR().

◆ Transfer() [1/2]

void COLLECTOR::Transfer ( int  aIndex)
inlineinherited

Move the item at aIndex (first position is 0) to the backup list.

Parameters
aIndexThe index into the list.

Definition at line 159 of file collector.h.

160  {
161  m_backupList.push_back( m_list[aIndex] );
162  m_list.erase( m_list.begin() + aIndex );
163  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:255

References COLLECTOR::m_backupList, and COLLECTOR::m_list.

Referenced by PL_SELECTION_TOOL::guessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), and EE_SELECTION_TOOL::GuessSelectionCandidates().

◆ Transfer() [2/2]

void COLLECTOR::Transfer ( EDA_ITEM aItem)
inlineinherited

Move aItem (if exists in the collector) to the backup list.

Parameters
aItemthe item to be moved.

Definition at line 170 of file collector.h.

171  {
172  for( size_t i = 0; i < m_list.size(); i++ )
173  {
174  if( m_list[i] == aItem )
175  {
176  m_list.erase( m_list.begin() + i );
177  m_backupList.push_back( aItem );
178  return;
179  }
180  }
181  }
std::vector< EDA_ITEM * > m_list
Definition: collector.h:254
std::vector< EDA_ITEM * > m_backupList
Definition: collector.h:255

References COLLECTOR::m_backupList, and COLLECTOR::m_list.

Member Data Documentation

◆ AllItems

const KICAD_T GERBER_COLLECTOR::AllItems
static
Initial value:

A scan list for all selectable gerber items.

Definition at line 60 of file gerber_collectors.h.

Referenced by GERBER_COLLECTOR(), and GERBVIEW_SELECTION_TOOL::selectPoint().

◆ m_backupList

std::vector<EDA_ITEM*> COLLECTOR::m_backupList
protectedinherited

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector
protectedinherited

◆ m_list

◆ m_List2nd

std::vector<EDA_ITEM*> GERBER_COLLECTOR::m_List2nd
protected

A place to hold collected objects which don't match precisely the search criteria, but would be acceptable if nothing else is found.

"2nd" choice, which will be appended to the end of COLLECTOR's prime "list" at the end of the search.

Definition at line 39 of file gerber_collectors.h.

Referenced by Empty2nd().

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled
inherited

◆ m_MenuTitle

◆ m_PrimaryLength

int GERBER_COLLECTOR::m_PrimaryLength
protected

Determines which items are to be collected by Inspect()

The number of items that were originally in the primary list before the m_List2nd was concatenated onto the end of it.

Definition at line 52 of file gerber_collectors.h.

Referenced by Collect(), GERBER_COLLECTOR(), and GetPrimaryCount().

◆ m_refBox

EDA_RECT COLLECTOR::m_refBox
protectedinherited

Definition at line 260 of file collector.h.

Referenced by COLLECTOR::GetBoundingBox().

◆ m_refPos

wxPoint COLLECTOR::m_refPos
protectedinherited

◆ m_scanTypes

const KICAD_T* COLLECTOR::m_scanTypes
protectedinherited

◆ m_Threshold


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