KiCad PCB EDA Suite
GENERAL_COLLECTOR Class Reference

Used when the right click button is pressed, or when the select tool is in effect. More...

#include <collectors.h>

Inheritance diagram for GENERAL_COLLECTOR:
PCB_COLLECTOR COLLECTOR

Public Types

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

Public Member Functions

 GENERAL_COLLECTOR ()
 Constructor GENERALCOLLECTOR. More...
 
void Empty2nd ()
 
void Append2nd (BOARD_ITEM *item)
 
void SetGuide (const COLLECTORS_GUIDE *aGuide)
 Record which COLLECTORS_GUIDE to use. More...
 
const COLLECTORS_GUIDEGetGuide ()
 
int GetPrimaryCount ()
 
SEARCH_RESULT Inspect (EDA_ITEM *testItem, void *testData) override
 The examining function within the INSPECTOR which is passed to the Iterate function. More...
 
void Collect (BOARD_ITEM *aItem, const KICAD_T aScanList[], const wxPoint &aRefPos, const COLLECTORS_GUIDE &aGuide)
 Scan a BOARD_ITEM using this class's Inspector method, which does the collection. More...
 
BOARD_ITEMoperator[] (int ndx) const override
 Overload the COLLECTOR::operator[](int) to return a BOARD_ITEM instead of an EDA_ITEM. More...
 
ITER begin ()
 
CITER begin () const
 
ITER end ()
 
CITER end () const
 
bool IsValidIndex (int aIndex)
 Function IsValidIndex tests if aIndex is with the limits of the list of collected items. More...
 
int GetCount () const
 Function GetCount returns the number of objects in the list. More...
 
void Empty ()
 Function Empty sets the list to empty. More...
 
void Append (EDA_ITEM *item)
 Function Append adds an item to the end of the list. More...
 
void Remove (int aIndex)
 Function Remove removes the item at aIndex (first position is 0);. More...
 
void Remove (const EDA_ITEM *aItem)
 Function Remove removes the item aItem (if exists in the collector). More...
 
EDA_ITEM *const * BasePtr () const
 Function BasePtr returns the address of the first element in the array. More...
 
bool HasItem (const EDA_ITEM *aItem) const
 Function HasItem tests if aItem has already been collected. More...
 
void SetScanTypes (const KICAD_T *scanTypes)
 Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() function. More...
 
void SetTimeNow ()
 
timestamp_t GetTime ()
 
void SetRefPos (const wxPoint &aRefPos)
 
const wxPoint & GetRefPos () const
 
void SetBoundingBox (const EDA_RECT &aRefBox)
 
const EDA_RECTGetBoundingBox () const
 
bool IsSimilarPointAndTime (const wxPoint &aRefPos)
 Function IsSimilarPointAndTime returns true if the given reference point is "similar" (defined here) to the internal reference point and the current time is within a few seconds of the internal m_TimeAtCollection. More...
 
int CountType (KICAD_T aType)
 Function CountType counts 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 AllBoardItems []
 A scan list for all editable board items. More...
 
static const KICAD_T AllButZones []
 A scan list for all editable board items, except zones. More...
 
static const KICAD_T Zones []
 A scan list for zones outlines only. More...
 
static const KICAD_T BoardLevelItems []
 A scan list for all primary board items, omitting items which are subordinate to a MODULE, such as D_PAD and TEXTEMODULE. More...
 
static const KICAD_T Modules []
 A scan list for only MODULEs. More...
 
static const KICAD_T PadsOrModules []
 A scan list for PADs or MODULEs. More...
 
static const KICAD_T PadsOrTracks []
 A scan list for PADs, TRACKs, or VIAs. More...
 
static const KICAD_T ModulesAndTheirItems []
 A scan list for MODULEs and their items (for Modedit) More...
 
static const KICAD_T ModuleItems []
 A scan list for primary module items. More...
 
static const KICAD_T Tracks []
 A scan list for only TRACKS. More...
 
static const KICAD_T LockableItems []
 A scan list for TRACKS, VIAS, MODULES. More...
 

Protected Attributes

std::vector< BOARD_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...
 
const COLLECTORS_GUIDEm_Guide
 Determines which items are to be collected by Inspect() More...
 
int m_PrimaryLength
 The number of items that were originally in the primary list before the m_List2nd was concatenated onto the end of it. More...
 
std::vector< EDA_ITEM * > m_List
 
const KICAD_Tm_ScanTypes
 
INSPECTOR_FUNC m_inspector
 
wxPoint m_RefPos
 
EDA_RECT m_RefBox
 
timestamp_t m_TimeAtCollection
 

Detailed Description

Used when the right click button is pressed, or when the select tool is in effect.

This class can be used by window classes such as PCB_EDIT_FRAME.

Philosophy: this class knows nothing of the context in which a BOARD is used and that means it knows nothing about which layers are visible or current, but can handle those concerns by the SetPreferredLayer() function and the SetLayerSet() function.

Definition at line 240 of file collectors.h.

Member Typedef Documentation

◆ CITER

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

Definition at line 89 of file collector.h.

◆ ITER

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

Definition at line 88 of file collector.h.

Constructor & Destructor Documentation

◆ GENERAL_COLLECTOR()

GENERAL_COLLECTOR::GENERAL_COLLECTOR ( )
inline

Constructor GENERALCOLLECTOR.

Definition at line 323 of file collectors.h.

324  {
325  m_Guide = NULL;
326  m_PrimaryLength = 0;
328  }
static const KICAD_T AllBoardItems[]
A scan list for all editable board items.
Definition: collectors.h:267
void SetScanTypes(const KICAD_T *scanTypes)
Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() f...
Definition: collector.h:214
int m_PrimaryLength
The number of items that were originally in the primary list before the m_List2nd was concatenated on...
Definition: collectors.h:260
const COLLECTORS_GUIDE * m_Guide
Determines which items are to be collected by Inspect()
Definition: collectors.h:254

References AllBoardItems, m_Guide, m_PrimaryLength, and COLLECTOR::SetScanTypes().

Member Function Documentation

◆ Append()

◆ Append2nd()

void GENERAL_COLLECTOR::Append2nd ( BOARD_ITEM item)
inline

Definition at line 335 of file collectors.h.

336  {
337  m_List2nd.push_back( item );
338  }
std::vector< BOARD_ITEM * > m_List2nd
A place to hold collected objects which don't match precisely the search criteria,...
Definition: collectors.h:249

References m_List2nd.

Referenced by Inspect().

◆ BasePtr()

EDA_ITEM* const* COLLECTOR::BasePtr ( ) const
inlineinherited

Function BasePtr returns the address of the first element in the array.

Only call this if there is at least one element in the vector m_List, otherwise a C++ exception should get thrown.

Definition at line 184 of file collector.h.

185  {
186  return &m_List[0];
187  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

◆ begin() [1/2]

ITER COLLECTOR::begin ( )
inlineinherited

Definition at line 91 of file collector.h.

91 { return m_List.begin(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

Referenced by SELECTION_TOOL::RequestSelection().

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const
inlineinherited

Definition at line 93 of file collector.h.

93 { return m_List.cbegin(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

◆ Collect()

void GENERAL_COLLECTOR::Collect ( BOARD_ITEM aItem,
const KICAD_T  aScanList[],
const wxPoint &  aRefPos,
const COLLECTORS_GUIDE aGuide 
)

Scan a BOARD_ITEM using this class's Inspector method, which does the collection.

Parameters
aItemA BOARD_ITEM to scan, may be a BOARD or MODULE, or whatever.
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 474 of file collectors.cpp.

476 {
477  Empty(); // empty the collection, primary criteria list
478  Empty2nd(); // empty the collection, secondary criteria list
479 
480  // remember guide, pass it to Inspect()
481  SetGuide( &aGuide );
482 
483  SetScanTypes( aScanList );
484 
485  // remember where the snapshot was taken from and pass refPos to
486  // the Inspect() function.
487  SetRefPos( aRefPos );
488 
489  aItem->Visit( m_inspector, NULL, m_ScanTypes );
490 
491  SetTimeNow(); // when snapshot was taken
492 
493  // record the length of the primary list before concatenating on to it.
494  m_PrimaryLength = m_List.size();
495 
496  // append 2nd list onto end of the first list
497  for( unsigned i = 0; i<m_List2nd.size(); ++i )
498  Append( m_List2nd[i] );
499 
500  Empty2nd();
501 }
void Empty()
Function Empty sets the list to empty.
Definition: collector.h:122
virtual SEARCH_RESULT Visit(INSPECTOR inspector, void *testData, const KICAD_T scanTypes[])
Function Visit may be re-implemented for each derived class in order to handle all the types given by...
void SetScanTypes(const KICAD_T *scanTypes)
Function SetScanTypes records the list of KICAD_T types to consider for collection by the Inspect() f...
Definition: collector.h:214
std::vector< BOARD_ITEM * > m_List2nd
A place to hold collected objects which don't match precisely the search criteria,...
Definition: collectors.h:249
int m_PrimaryLength
The number of items that were originally in the primary list before the m_List2nd was concatenated on...
Definition: collectors.h:260
void Append(EDA_ITEM *item)
Function Append adds an item to the end of the list.
Definition: collector.h:132
void SetGuide(const COLLECTORS_GUIDE *aGuide)
Record which COLLECTORS_GUIDE to use.
Definition: collectors.h:345
INSPECTOR_FUNC m_inspector
Definition: collector.h:61
void SetRefPos(const wxPoint &aRefPos)
Definition: collector.h:229
void SetTimeNow()
Definition: collector.h:219
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58
const KICAD_T * m_ScanTypes
Definition: collector.h:60

References COLLECTOR::Append(), COLLECTOR::Empty(), Empty2nd(), i, COLLECTOR::m_inspector, COLLECTOR::m_List, m_List2nd, m_PrimaryLength, COLLECTOR::m_ScanTypes, SetGuide(), COLLECTOR::SetRefPos(), COLLECTOR::SetScanTypes(), COLLECTOR::SetTimeNow(), and EDA_ITEM::Visit().

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), PCB_INSPECTION_TOOL::highlightNet(), and SELECTION_TOOL::selectPoint().

◆ CountType()

int COLLECTOR::CountType ( KICAD_T  aType)
inlineinherited

Function CountType counts the number of items matching aType.

Parameters
aTypetype we are interested in
Returns
number of occurences

Definition at line 264 of file collector.h.

265  {
266  int cnt = 0;
267  for( size_t i = 0; i < m_List.size(); i++ )
268  {
269  if( m_List[i]->Type() == aType )
270  cnt++;
271  }
272  return cnt;
273  }
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References i, and COLLECTOR::m_List.

Referenced by SELECTION_TOOL::GuessSelectionCandidates(), and ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

◆ Empty2nd()

void GENERAL_COLLECTOR::Empty2nd ( )
inline

Definition at line 330 of file collectors.h.

331  {
332  m_List2nd.clear();
333  }
std::vector< BOARD_ITEM * > m_List2nd
A place to hold collected objects which don't match precisely the search criteria,...
Definition: collectors.h:249

References m_List2nd.

Referenced by Collect().

◆ end() [1/2]

ITER COLLECTOR::end ( )
inlineinherited

Definition at line 92 of file collector.h.

92 { return m_List.end(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

Referenced by SELECTION_TOOL::RequestSelection().

◆ end() [2/2]

CITER COLLECTOR::end ( ) const
inlineinherited

Definition at line 94 of file collector.h.

94 { return m_List.cend(); }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const
inlineinherited

Definition at line 233 of file collector.h.

233 { return m_RefBox; }
EDA_RECT m_RefBox
Definition: collector.h:63

References COLLECTOR::m_RefBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const
inlineinherited

Function GetCount returns the number of objects in the list.

Definition at line 113 of file collector.h.

114  {
115  return (int) m_List.size();
116  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

Referenced by BuildBoardPolygonOutlines(), calcMaxArea(), connectedItemFilter(), connectedTrackFilter(), MODULE::CoverageRatio(), SCH_EDIT_TOOL::DeleteItemCursor(), PCBNEW_CONTROL::DeleteItemCursor(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), DIALOG_DRC_CONTROL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), SELECTION_TOOL::doSelectionMenu(), EditToolSelectionFilter(), PAD_TOOL::EnumeratePads(), EDIT_TOOL::FootprintFilter(), DSN::SPECCTRA_DB::FromBOARD(), EE_SELECTION_TOOL::GetNode(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), GENDRILL_WRITER_BASE::getUniqueLayerPairs(), SELECTION_TOOL::GuessSelectionCandidates(), PL_SELECTION_TOOL::guessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_INSPECTION_TOOL::highlightNet(), SCH_EDIT_FRAME::importFile(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), EE_COLLECTOR::IsCorner(), SCH_EDIT_FRAME::LoadSheetFromFile(), DSN::SPECCTRA_DB::makeIMAGE(), ROUTER_TOOL::NeighboringSegmentFilter(), EE_COLLECTOR::operator[](), GERBER_COLLECTOR::operator[](), COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PadFilter(), SELECTION_TOOL::pickSmallestComponent(), SCH_COMPONENT::ResolveAll(), PL_SELECTION_TOOL::SelectPoint(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::SelectPoint(), SELECTION_TOOL::selectPoint(), PANEL_SETUP_LAYERS::TransferDataFromWindow(), and SCH_COMPONENT::UpdatePins().

◆ GetGuide()

const COLLECTORS_GUIDE* GENERAL_COLLECTOR::GetGuide ( )
inline

Definition at line 347 of file collectors.h.

347 { return m_Guide; }
const COLLECTORS_GUIDE * m_Guide
Determines which items are to be collected by Inspect()
Definition: collectors.h:254

References m_Guide.

Referenced by SELECTION_TOOL::GuessSelectionCandidates().

◆ GetPrimaryCount()

int GENERAL_COLLECTOR::GetPrimaryCount ( )
inline
Returns
int - The number if items which met the primary search criteria

Definition at line 352 of file collectors.h.

352 { return m_PrimaryLength; }
int m_PrimaryLength
The number of items that were originally in the primary list before the m_List2nd was concatenated on...
Definition: collectors.h:260

References m_PrimaryLength.

Referenced by SELECTION_TOOL::pickSmallestComponent().

◆ GetRefPos()

const wxPoint& COLLECTOR::GetRefPos ( ) const
inlineinherited

Definition at line 230 of file collector.h.

230 { return m_RefPos; }
wxPoint m_RefPos
Definition: collector.h:62

References COLLECTOR::m_RefPos.

◆ GetTime()

timestamp_t COLLECTOR::GetTime ( )
inlineinherited

Definition at line 224 of file collector.h.

225  {
226  return m_TimeAtCollection;
227  }
timestamp_t m_TimeAtCollection
Definition: collector.h:65

References COLLECTOR::m_TimeAtCollection.

◆ HasItem()

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

Function HasItem tests if aItem has already been collected.

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

Definition at line 196 of file collector.h.

197  {
198  for( size_t i = 0; i < m_List.size(); i++ )
199  {
200  if( m_List[i] == aItem )
201  return true;
202  }
203 
204  return false;
205  }
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References i, and COLLECTOR::m_List.

Referenced by EditToolSelectionFilter().

◆ Inspect()

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

The examining function within the INSPECTOR which is passed to the Iterate function.

Searches and collects all the objects which match the test data.

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;

Reimplemented from COLLECTOR.

Definition at line 149 of file collectors.cpp.

150 {
151  BOARD_ITEM* item = (BOARD_ITEM*) testItem;
152  MODULE* module = NULL;
153  D_PAD* pad = NULL;
154  bool pad_through = false;
155  VIA* via = NULL;
156  MARKER_PCB* marker = NULL;
157  ZONE_CONTAINER* zone = NULL;
158 
159 #if 0 // debugging
160  static int breakhere = 0;
161 
162  switch( item->Type() )
163  {
164  case PCB_PAD_T:
165  {
166  MODULE* m = (MODULE*) item->GetParent();
167 
168  if( m->GetReference() == wxT( "Y2" ) )
169  {
170  breakhere++;
171  }
172  }
173  break;
174 
175  case PCB_VIA_T:
176  breakhere++;
177  break;
178 
179  case PCB_TRACE_T:
180  breakhere++;
181  break;
182 
183  case PCB_TEXT_T:
184  breakhere++;
185  break;
186 
187  case PCB_LINE_T:
188  breakhere++;
189  break;
190 
191  case PCB_DIMENSION_T:
192  breakhere++;
193  break;
194 
195  case PCB_MODULE_TEXT_T:
196  {
197  TEXTE_MODULE* tm = (TEXTE_MODULE*) item;
198 
199  if( tm->GetText() == wxT( "10uH" ) )
200  {
201  breakhere++;
202  }
203  }
204  break;
205 
206  case PCB_MODULE_T:
207  {
208  MODULE* m = (MODULE*) item;
209 
210  if( m->GetReference() == wxT( "C98" ) )
211  {
212  breakhere++;
213  }
214  }
215  break;
216 
217  case PCB_MARKER_T:
218  breakhere++;
219  break;
220 
221  default:
222  breakhere++;
223  break;
224  }
225 
226 #endif
227 
228 
229  switch( item->Type() )
230  {
231  case PCB_PAD_T:
232  // there are pad specific visibility controls.
233  // Criterias to select a pad is:
234  // for smd pads: the module parent must be seen, and pads on the corresponding
235  // board side must be seen
236  // if pad is a thru hole, then it can be visible when its parent module is not.
237  // for through pads: pads on Front or Back board sides must be seen
238  pad = (D_PAD*) item;
239 
240  if( (pad->GetAttribute() != PAD_ATTRIB_SMD) &&
241  (pad->GetAttribute() != PAD_ATTRIB_CONN) ) // a hole is present, so multiple layers
242  {
243  // proceed to the common tests below, but without the parent module test,
244  // by leaving module==NULL, but having pad != null
245  pad_through = true;
246  }
247  else // smd, so use pads test after module test
248  {
249  module = static_cast<MODULE*>( item->GetParent() );
250  }
251 
252  break;
253 
254  case PCB_VIA_T: // vias are on many layers, so layer test is specific
255  via = static_cast<VIA*>( item );
256  break;
257 
258  case PCB_TRACE_T:
259  if( m_Guide->IgnoreTracks() )
260  goto exit;
261  break;
262 
263  case PCB_ZONE_AREA_T:
264  zone = static_cast<ZONE_CONTAINER*>( item );
265  break;
266 
267  case PCB_TEXT_T:
268  break;
269 
270  case PCB_LINE_T:
271  break;
272 
273  case PCB_DIMENSION_T:
274  break;
275 
276  case PCB_TARGET_T:
277  break;
278 
279  case PCB_MODULE_TEXT_T:
280  {
281  TEXTE_MODULE *text = static_cast<TEXTE_MODULE*>( item );
282  if( m_Guide->IgnoreMTextsMarkedNoShow() && !text->IsVisible() )
283  goto exit;
284 
285  if( m_Guide->IgnoreMTextsOnBack() && IsBackLayer( text->GetLayer() ) )
286  goto exit;
287 
288  if( m_Guide->IgnoreMTextsOnFront() && IsFrontLayer( text->GetLayer() ) )
289  goto exit;
290 
291  /* The three text types have different criteria: reference
292  * and value have their own ignore flags; user text instead
293  * follows their layer visibility. Checking this here is
294  * simpler than later (when layer visibility is checked for
295  * other entities) */
296 
297  switch( text->GetType() )
298  {
300  if( m_Guide->IgnoreModulesRefs() )
301  goto exit;
302  break;
303 
305  if( m_Guide->IgnoreModulesVals() )
306  goto exit;
307  break;
308 
310  if( !m_Guide->IsLayerVisible( text->GetLayer() )
312  goto exit;
313  break;
314  }
315 
316  // Extract the module since it could be hidden
317  module = static_cast<MODULE*>( item->GetParent() );
318  }
319  break;
320 
321  case PCB_MODULE_T:
322  module = static_cast<MODULE*>( item );
323  break;
324 
325  case PCB_MARKER_T:
326  marker = static_cast<MARKER_PCB*>( item );
327  break;
328 
329  default:
330  break;
331  }
332 
333  // common tests:
334 
335  if( module ) // true from case PCB_PAD_T, PCB_MODULE_TEXT_T, or PCB_MODULE_T
336  {
337  if( m_Guide->IgnoreModulesOnBack() && (module->GetLayer() == B_Cu) )
338  goto exit;
339 
340  if( m_Guide->IgnoreModulesOnFront() && (module->GetLayer() == F_Cu) )
341  goto exit;
342  }
343 
344  // Pads are not sensitive to the layer visibility controls.
345  // They all have their own separate visibility controls
346  // skip them if not visible
347  if( pad )
348  {
349  if( m_Guide->IgnorePads() )
350  goto exit;
351 
352  if( ! pad_through )
353  {
354  if( m_Guide->IgnorePadsOnFront() && pad->IsOnLayer(F_Cu ) )
355  goto exit;
356 
357  if( m_Guide->IgnorePadsOnBack() && pad->IsOnLayer(B_Cu ) )
358  goto exit;
359  }
360  }
361 
362  if( marker )
363  {
364  // Markers are not sensitive to the layer
365  if( marker->HitTest( m_RefPos ) )
366  Append( item );
367 
368  goto exit;
369  }
370 
371  if( via )
372  {
373  auto type = via->GetViaType();
374 
375  if( ( m_Guide->IgnoreThroughVias() && type == VIA_THROUGH ) ||
376  ( m_Guide->IgnoreBlindBuriedVias() && type == VIA_BLIND_BURIED ) ||
377  ( m_Guide->IgnoreMicroVias() && type == VIA_MICROVIA ) )
378  {
379  goto exit;
380  }
381  }
382 
384  {
385  PCB_LAYER_ID layer = item->GetLayer();
386 
387  // Modules and their subcomponents: reference, value and pads are not sensitive
388  // to the layer visibility controls. They all have their own separate visibility
389  // controls for vias, GetLayer() has no meaning, but IsOnLayer() works fine. User
390  // text in module *is* sensitive to layer visibility but that was already handled.
391 
392  if( via || module || pad || m_Guide->IsLayerVisible( layer )
394  {
395  if( !m_Guide->IsLayerLocked( layer ) || !m_Guide->IgnoreLockedLayers() )
396  {
397  if( !item->IsLocked() || !m_Guide->IgnoreLockedItems() )
398  {
399  if( zone )
400  {
401  bool testFill = !m_Guide->IgnoreZoneFills();
402  int accuracy = KiROUND( 5 * m_Guide->OnePixelInIU() );
403 
404  if( zone->HitTestForCorner( m_RefPos, accuracy * 2 )
405  || zone->HitTestForEdge( m_RefPos, accuracy )
406  || ( testFill && zone->HitTestFilledArea( m_RefPos ) ) )
407  {
408  Append( item );
409  goto exit;
410  }
411  }
412  else if( item->HitTest( m_RefPos ) )
413  {
414  if( !module || module->HitTestAccurate( m_RefPos ) )
415  {
416  Append( item );
417  goto exit;
418  }
419  }
420  }
421  }
422  }
423  }
424 
425 
426  if( m_Guide->IncludeSecondary() )
427  {
428  // for now, "secondary" means "tolerate any layer". It has
429  // no effect on other criteria, since there is a separate "ignore" control for
430  // those in the COLLECTORS_GUIDE
431 
432  PCB_LAYER_ID layer = item->GetLayer();
433 
434  // Modules and their subcomponents: reference, value and pads are not sensitive
435  // to the layer visibility controls. They all have their own separate visibility
436  // controls for vias, GetLayer() has no meaning, but IsOnLayer() works fine. User
437  // text in module *is* sensitive to layer visibility but that was already handled.
438 
439  if( via || module || pad || m_Guide->IsLayerVisible( layer )
441  {
442  if( !m_Guide->IsLayerLocked( layer ) || !m_Guide->IgnoreLockedLayers() )
443  {
444  if( !item->IsLocked() || !m_Guide->IgnoreLockedItems() )
445  {
446  if( zone )
447  {
448  bool testFill = !m_Guide->IgnoreZoneFills();
449  int accuracy = KiROUND( 5 * m_Guide->OnePixelInIU() );
450 
451  if( zone->HitTestForCorner( m_RefPos, accuracy * 2 )
452  || zone->HitTestForEdge( m_RefPos, accuracy )
453  || ( testFill && zone->HitTestFilledArea( m_RefPos ) ) )
454  {
455  Append2nd( item );
456  goto exit;
457  }
458  }
459  else if( item->HitTest( m_RefPos ) )
460  {
461  Append2nd( item );
462  goto exit;
463  }
464  }
465  }
466  }
467  }
468 
469 exit:
470  return SEARCH_CONTINUE; // always when collecting
471 }
virtual bool IsLayerLocked(PCB_LAYER_ID layer) const =0
Class ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:57
virtual bool IgnoreBlindBuriedVias() const =0
virtual bool IgnoreModulesOnFront() const =0
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
virtual double OnePixelInIU() const =0
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
bool IsVisible() const
Definition: eda_text.h:170
bool HitTestForCorner(const wxPoint &refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX &aCornerHit) const
Function HitTestForCorner tests if the given wxPoint is near a corner.
Definition: class_zone.cpp:554
virtual bool IgnoreZoneFills() const =0
virtual bool IgnoreNonVisibleLayers() const =0
Smd pad, appears on the solder paste layer (default)
Definition: pad_shapes.h:62
class ZONE_CONTAINER, a zone area
Definition: typeinfo.h:100
void Append2nd(BOARD_ITEM *item)
Definition: collectors.h:335
class TEXTE_PCB, text on a layer
Definition: typeinfo.h:92
virtual PCB_LAYER_ID GetPreferredLayer() const =0
bool HitTestFilledArea(const wxPoint &aRefPos) const
Function HitTestFilledArea tests if the given wxPoint is within the bounds of a filled area of this z...
Definition: class_zone.cpp:655
virtual bool IgnoreTracks() const =0
class D_PAD, a pad in a footprint
Definition: typeinfo.h:90
virtual bool IgnoreMicroVias() const =0
virtual bool IgnoreModulesVals() const =0
virtual bool IgnorePreferredLayer() const =0
Provide wildcard behavior regarding the preferred layer.
PAD_ATTR_T GetAttribute() const
Definition: class_pad.h:429
class TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
const wxString GetReference() const
Function GetReference.
Definition: class_module.h:416
virtual bool IgnorePadsOnFront() const =0
void Append(EDA_ITEM *item)
Function Append adds an item to the end of the list.
Definition: collector.h:132
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: base_struct.h:340
class MODULE, a footprint
Definition: typeinfo.h:89
PCB_LAYER_ID
A quick note on layer IDs:
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Function IsOnLayer tests to see if this object is on the given layer.
virtual bool IgnoreMTextsOnBack() const =0
TEXT_TYPE GetType() const
VIATYPE_T GetViaType() const
Definition: class_track.h:346
const COLLECTORS_GUIDE * m_Guide
Determines which items are to be collected by Inspect()
Definition: collectors.h:254
virtual bool IgnoreMTextsMarkedNoShow() const =0
Like smd, does not appear on the solder paste layer (default) note also has a special attribute in Ge...
Definition: pad_shapes.h:63
class DIMENSION, a dimension (graphic item)
Definition: typeinfo.h:98
virtual bool IgnoreThroughVias() const =0
class PCB_TARGET, a target (graphic item)
Definition: typeinfo.h:99
virtual bool IgnoreModulesRefs() const =0
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
bool IsFrontLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a front layer.
bool HitTestAccurate(const wxPoint &aPosition, int aAccuracy=0) const
Tests if a point is inside the bounding polygon of the module.
virtual bool IsLocked() const
Function IsLocked.
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
class MARKER_PCB, a marker used to show something
Definition: typeinfo.h:97
virtual bool IgnorePads() const
Definition: collectors.h:152
virtual bool IsLayerVisible(PCB_LAYER_ID layer) const =0
bool HitTestForEdge(const wxPoint &refPos, int aAccuracy, SHAPE_POLY_SET::VERTEX_INDEX &aCornerHit) const
Function HitTestForEdge tests if the given wxPoint is near a segment defined by 2 corners.
Definition: class_zone.cpp:568
class VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
virtual bool IgnorePadsOnBack() const =0
wxPoint m_RefPos
Definition: collector.h:62
virtual bool IgnoreLockedItems() const =0
virtual bool IgnoreLockedLayers() const =0
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Function IsOnLayer tests to see if this object is on the given layer.
Definition: class_pad.h:715
virtual bool IgnoreModulesOnBack() const =0
virtual bool IgnoreMTextsOnFront() const =0
class DRAWSEGMENT, a segment not on copper layers
Definition: typeinfo.h:91
virtual bool IncludeSecondary() const =0
Determine if the secondary criteria or 2nd choice items should be included.
BOARD_ITEM_CONTAINER * GetParent() const
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
virtual const wxString & GetText() const
Function GetText returns the string associated with the text object.
Definition: eda_text.h:124
KICAD_T Type() const
Function Type()
Definition: base_struct.h:210
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:114

References COLLECTOR::Append(), Append2nd(), B_Cu, F_Cu, D_PAD::GetAttribute(), BOARD_ITEM::GetLayer(), BOARD_ITEM::GetParent(), COLLECTORS_GUIDE::GetPreferredLayer(), MODULE::GetReference(), EDA_TEXT::GetText(), TEXTE_MODULE::GetType(), VIA::GetViaType(), MARKER_PCB::HitTest(), EDA_ITEM::HitTest(), MODULE::HitTestAccurate(), ZONE_CONTAINER::HitTestFilledArea(), ZONE_CONTAINER::HitTestForCorner(), ZONE_CONTAINER::HitTestForEdge(), COLLECTORS_GUIDE::IgnoreBlindBuriedVias(), COLLECTORS_GUIDE::IgnoreLockedItems(), COLLECTORS_GUIDE::IgnoreLockedLayers(), COLLECTORS_GUIDE::IgnoreMicroVias(), COLLECTORS_GUIDE::IgnoreModulesOnBack(), COLLECTORS_GUIDE::IgnoreModulesOnFront(), COLLECTORS_GUIDE::IgnoreModulesRefs(), COLLECTORS_GUIDE::IgnoreModulesVals(), COLLECTORS_GUIDE::IgnoreMTextsMarkedNoShow(), COLLECTORS_GUIDE::IgnoreMTextsOnBack(), COLLECTORS_GUIDE::IgnoreMTextsOnFront(), COLLECTORS_GUIDE::IgnoreNonVisibleLayers(), COLLECTORS_GUIDE::IgnorePads(), COLLECTORS_GUIDE::IgnorePadsOnBack(), COLLECTORS_GUIDE::IgnorePadsOnFront(), COLLECTORS_GUIDE::IgnorePreferredLayer(), COLLECTORS_GUIDE::IgnoreThroughVias(), COLLECTORS_GUIDE::IgnoreTracks(), COLLECTORS_GUIDE::IgnoreZoneFills(), COLLECTORS_GUIDE::IncludeSecondary(), IsBackLayer(), IsFrontLayer(), COLLECTORS_GUIDE::IsLayerLocked(), COLLECTORS_GUIDE::IsLayerVisible(), BOARD_ITEM::IsLocked(), BOARD_ITEM::IsOnLayer(), D_PAD::IsOnLayer(), EDA_TEXT::IsVisible(), KiROUND(), m_Guide, COLLECTOR::m_RefPos, COLLECTORS_GUIDE::OnePixelInIU(), PAD_ATTRIB_CONN, PAD_ATTRIB_SMD, PCB_DIMENSION_T, PCB_LINE_T, PCB_MARKER_T, PCB_MODULE_T, PCB_MODULE_TEXT_T, PCB_PAD_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, SEARCH_CONTINUE, TEXTE_MODULE::TEXT_is_DIVERS, TEXTE_MODULE::TEXT_is_REFERENCE, TEXTE_MODULE::TEXT_is_VALUE, EDA_ITEM::Type(), VIA_BLIND_BURIED, VIA_MICROVIA, and VIA_THROUGH.

◆ IsSimilarPointAndTime()

bool COLLECTOR::IsSimilarPointAndTime ( const wxPoint &  aRefPos)
inlineinherited

Function IsSimilarPointAndTime returns true if the given reference point is "similar" (defined here) to the internal reference point and the current time is within a few seconds of the internal m_TimeAtCollection.

Parameters
aRefPosA wxPoint to compare to.
Returns
bool - true if the point and time are similar, else false.

Definition at line 244 of file collector.h.

245  {
246  const int distMax = 2; // adjust these here
247  const timestamp_t timeMax = 3; // seconds
248 
249  int dx = abs( aRefPos.x - m_RefPos.x );
250  int dy = abs( aRefPos.y - m_RefPos.y );
251 
252  if( dx <= distMax && dy <= distMax &&
253  GetNewTimeStamp() - m_TimeAtCollection <= timeMax )
254  return true;
255  else
256  return false;
257  }
#define abs(a)
Definition: auxiliary.h:84
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
wxPoint m_RefPos
Definition: collector.h:62
uint32_t timestamp_t
timestamp_t is our type to represent unique IDs for all kinds of elements; historically simply the ti...
Definition: common.h:53
timestamp_t m_TimeAtCollection
Definition: collector.h:65

References abs, GetNewTimeStamp(), COLLECTOR::m_RefPos, and COLLECTOR::m_TimeAtCollection.

◆ IsValidIndex()

bool COLLECTOR::IsValidIndex ( int  aIndex)
inlineinherited

Function IsValidIndex tests if aIndex is with the limits of the list of collected items.

Parameters
aIndexThe index to test.
Returns
True if aIndex is with the limits of the list of collected items, otherwise false.

Definition at line 104 of file collector.h.

105  {
106  return ( (unsigned) aIndex < m_List.size() );
107  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

◆ operator[]()

BOARD_ITEM* PCB_COLLECTOR::operator[] ( int  ndx) const
inlineoverridevirtualinherited

Overload the COLLECTOR::operator[](int) to return a BOARD_ITEM instead of an EDA_ITEM.

Parameters
ndxThe index into the list.
Returns
BOARD_ITEM* - or something derived from it, or NULL.

Reimplemented from COLLECTOR.

Definition at line 221 of file collectors.h.

222  {
223  if( (unsigned)ndx < (unsigned)GetCount() )
224  return (BOARD_ITEM*) m_List[ ndx ];
225 
226  return NULL;
227  }
Class BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
int GetCount() const
Function GetCount returns the number of objects in the list.
Definition: collector.h:113
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::GetCount(), and COLLECTOR::m_List.

◆ Remove() [1/2]

void COLLECTOR::Remove ( int  aIndex)
inlineinherited

◆ Remove() [2/2]

void COLLECTOR::Remove ( const EDA_ITEM aItem)
inlineinherited

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

Parameters
aItemthe item to be removed.

Definition at line 152 of file collector.h.

153  {
154  for( size_t i = 0; i < m_List.size(); i++ )
155  {
156  if( m_List[i] == aItem )
157  {
158  m_List.erase( m_List.begin() + i);
159  return;
160  }
161  }
162  }
size_t i
Definition: json11.cpp:597
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References i, and COLLECTOR::m_List.

◆ SetBoundingBox()

void COLLECTOR::SetBoundingBox ( const EDA_RECT aRefBox)
inlineinherited

Definition at line 232 of file collector.h.

232 { m_RefBox = aRefBox; }
EDA_RECT m_RefBox
Definition: collector.h:63

References COLLECTOR::m_RefBox.

◆ SetGuide()

void GENERAL_COLLECTOR::SetGuide ( const COLLECTORS_GUIDE aGuide)
inline

Record which COLLECTORS_GUIDE to use.

Parameters
aGuideWhich guide to use in the collection.

Definition at line 345 of file collectors.h.

345 { m_Guide = aGuide; }
const COLLECTORS_GUIDE * m_Guide
Determines which items are to be collected by Inspect()
Definition: collectors.h:254

References m_Guide.

Referenced by Collect().

◆ SetRefPos()

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

Definition at line 229 of file collector.h.

229 { m_RefPos = aRefPos; }
wxPoint m_RefPos
Definition: collector.h:62

References COLLECTOR::m_RefPos.

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

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const KICAD_T scanTypes)
inlineinherited

Function SetScanTypes records 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 214 of file collector.h.

215  {
216  m_ScanTypes = scanTypes;
217  }
const KICAD_T * m_ScanTypes
Definition: collector.h:60

References COLLECTOR::m_ScanTypes.

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

◆ SetTimeNow()

void COLLECTOR::SetTimeNow ( )
inlineinherited

Definition at line 219 of file collector.h.

220  {
222  }
timestamp_t GetNewTimeStamp()
Definition: common.cpp:217
timestamp_t m_TimeAtCollection
Definition: collector.h:65

References GetNewTimeStamp(), and COLLECTOR::m_TimeAtCollection.

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

Member Data Documentation

◆ AllBoardItems

const KICAD_T GENERAL_COLLECTOR::AllBoardItems
static

◆ AllButZones

const KICAD_T GENERAL_COLLECTOR::AllButZones
static
Initial value:

A scan list for all editable board items, except zones.

Definition at line 272 of file collectors.h.

◆ BoardLevelItems

const KICAD_T GENERAL_COLLECTOR::BoardLevelItems
static
Initial value:

A scan list for all primary board items, omitting items which are subordinate to a MODULE, such as D_PAD and TEXTEMODULE.

Definition at line 283 of file collectors.h.

Referenced by PCBNEW_CONTROL::DeleteItemCursor(), PANEL_SETUP_LAYERS::getRemovedLayersWithItems(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ LockableItems

const KICAD_T GENERAL_COLLECTOR::LockableItems
static
Initial value:

A scan list for TRACKS, VIAS, MODULES.

Definition at line 318 of file collectors.h.

Referenced by PCB_EDITOR_CONTROL::Init().

◆ m_Guide

const COLLECTORS_GUIDE* GENERAL_COLLECTOR::m_Guide
protected

Determines which items are to be collected by Inspect()

Definition at line 254 of file collectors.h.

Referenced by GENERAL_COLLECTOR(), GetGuide(), Inspect(), and SetGuide().

◆ m_inspector

◆ m_List

◆ m_List2nd

std::vector<BOARD_ITEM*> GENERAL_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 249 of file collectors.h.

Referenced by Append2nd(), Collect(), and Empty2nd().

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled
inherited

◆ m_MenuTitle

◆ m_PrimaryLength

int GENERAL_COLLECTOR::m_PrimaryLength
protected

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 260 of file collectors.h.

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

◆ m_RefBox

EDA_RECT COLLECTOR::m_RefBox
protectedinherited

Definition at line 63 of file collector.h.

Referenced by COLLECTOR::GetBoundingBox(), and COLLECTOR::SetBoundingBox().

◆ m_RefPos

wxPoint COLLECTOR::m_RefPos
protectedinherited

◆ m_ScanTypes

const KICAD_T* COLLECTOR::m_ScanTypes
protectedinherited

◆ m_Threshold

◆ m_TimeAtCollection

timestamp_t COLLECTOR::m_TimeAtCollection
protectedinherited

◆ ModuleItems

const KICAD_T GENERAL_COLLECTOR::ModuleItems
static

◆ Modules

const KICAD_T GENERAL_COLLECTOR::Modules
static
Initial value:

A scan list for only MODULEs.

Definition at line 288 of file collectors.h.

◆ ModulesAndTheirItems

const KICAD_T GENERAL_COLLECTOR::ModulesAndTheirItems
static
Initial value:

A scan list for MODULEs and their items (for Modedit)

Definition at line 303 of file collectors.h.

◆ PadsOrModules

const KICAD_T GENERAL_COLLECTOR::PadsOrModules
static
Initial value:

A scan list for PADs or MODULEs.

Definition at line 293 of file collectors.h.

◆ PadsOrTracks

const KICAD_T GENERAL_COLLECTOR::PadsOrTracks
static
Initial value:

A scan list for PADs, TRACKs, or VIAs.

Definition at line 298 of file collectors.h.

Referenced by PCB_INSPECTION_TOOL::highlightNet().

◆ Tracks

const KICAD_T GENERAL_COLLECTOR::Tracks
static
Initial value:

A scan list for only TRACKS.

Definition at line 313 of file collectors.h.

Referenced by EDIT_TOOL::Init(), EDIT_TOOL::Properties(), BOARD::TracksInNet(), and SELECT_MENU::update().

◆ Zones

const KICAD_T GENERAL_COLLECTOR::Zones
static
Initial value:

A scan list for zones outlines only.

Definition at line 277 of file collectors.h.

Referenced by PCB_INSPECTION_TOOL::highlightNet().


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