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 wxPointGetRefPos () 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 92 of file collector.h.

◆ ITER

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

Definition at line 91 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:217
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
#define NULL
const COLLECTORS_GUIDE * m_Guide
Determines which items are to be collected by Inspect()
Definition: collectors.h:254

References AllBoardItems, m_Guide, m_PrimaryLength, NULL, 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 187 of file collector.h.

188  {
189  return &m_List[0];
190  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

◆ begin() [1/2]

ITER COLLECTOR::begin ( )
inlineinherited

Definition at line 94 of file collector.h.

94 { 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 96 of file collector.h.

96 { 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 480 of file collectors.cpp.

482 {
483  Empty(); // empty the collection, primary criteria list
484  Empty2nd(); // empty the collection, secondary criteria list
485 
486  // remember guide, pass it to Inspect()
487  SetGuide( &aGuide );
488 
489  SetScanTypes( aScanList );
490 
491  // remember where the snapshot was taken from and pass refPos to
492  // the Inspect() function.
493  SetRefPos( aRefPos );
494 
495  aItem->Visit( m_inspector, NULL, m_ScanTypes );
496 
497  SetTimeNow(); // when snapshot was taken
498 
499  // record the length of the primary list before concatenating on to it.
500  m_PrimaryLength = m_List.size();
501 
502  // append 2nd list onto end of the first list
503  for( unsigned i = 0; i<m_List2nd.size(); ++i )
504  Append( m_List2nd[i] );
505 
506  Empty2nd();
507 }
void Empty()
Function Empty sets the list to empty.
Definition: collector.h:125
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:217
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:135
void SetGuide(const COLLECTORS_GUIDE *aGuide)
Record which COLLECTORS_GUIDE to use.
Definition: collectors.h:345
INSPECTOR_FUNC m_inspector
Definition: collector.h:61
#define NULL
void SetRefPos(const wxPoint &aRefPos)
Definition: collector.h:232
void SetTimeNow()
Definition: collector.h:222
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(), COLLECTOR::m_inspector, COLLECTOR::m_List, m_List2nd, m_PrimaryLength, COLLECTOR::m_ScanTypes, NULL, 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 267 of file collector.h.

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

References 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 95 of file collector.h.

95 { 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 97 of file collector.h.

97 { 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 236 of file collector.h.

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

References COLLECTOR::m_RefBox.

◆ GetCount()

int COLLECTOR::GetCount ( ) const
inlineinherited

◆ 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 233 of file collector.h.

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

References COLLECTOR::m_RefPos.

◆ GetTime()

timestamp_t COLLECTOR::GetTime ( )
inlineinherited

Definition at line 227 of file collector.h.

228  {
229  return m_TimeAtCollection;
230  }
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 199 of file collector.h.

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

References 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 153 of file collectors.cpp.

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

References COLLECTOR::Append(), Append2nd(), B_Cu, BLIND_BURIED, CONTINUE, 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, MICROVIA, NULL, 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_MODULE_ZONE_AREA_T, PCB_PAD_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_AREA_T, TEXTE_MODULE::TEXT_is_DIVERS, TEXTE_MODULE::TEXT_is_REFERENCE, TEXTE_MODULE::TEXT_is_VALUE, THROUGH, and EDA_ITEM::Type().

◆ 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 247 of file collector.h.

248  {
249  const int distMax = 2; // adjust these here
250  const timestamp_t timeMax = 3; // seconds
251 
252  int dx = abs( aRefPos.x - m_RefPos.x );
253  int dy = abs( aRefPos.y - m_RefPos.y );
254 
255  if( dx <= distMax && dy <= distMax &&
256  GetNewTimeStamp() - m_TimeAtCollection <= timeMax )
257  return true;
258  else
259  return false;
260  }
timestamp_t GetNewTimeStamp()
Definition: common.cpp:215
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:52
timestamp_t m_TimeAtCollection
Definition: collector.h:65

References GetNewTimeStamp(), COLLECTOR::m_RefPos, COLLECTOR::m_TimeAtCollection, wxPoint::x, and wxPoint::y.

◆ 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 107 of file collector.h.

108  {
109  return ( (unsigned) aIndex < m_List.size() );
110  }
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  }
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:116
#define NULL
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

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

◆ Remove() [1/2]

void COLLECTOR::Remove ( int  aIndex)
inlineinherited

Function Remove removes the item at aIndex (first position is 0);.

Parameters
aIndexThe index into the list.

Definition at line 145 of file collector.h.

146  {
147  m_List.erase( m_List.begin() + aIndex );
148  }
std::vector< EDA_ITEM * > m_List
Definition: collector.h:58

References COLLECTOR::m_List.

Referenced by connectedItemFilter(), PCBNEW_CONTROL::DeleteItemCursor(), EditToolSelectionFilter(), EDIT_TOOL::FootprintFilter(), SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_INSPECTION_TOOL::highlightNet(), EDIT_TOOL::PadFilter(), GERBVIEW_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::SelectPoint(), and SELECTION_TOOL::selectPoint().

◆ 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 155 of file collector.h.

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

References COLLECTOR::m_List.

◆ SetBoundingBox()

void COLLECTOR::SetBoundingBox ( const EDA_RECT aRefBox)
inlineinherited

Definition at line 235 of file collector.h.

235 { 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 232 of file collector.h.

232 { 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 217 of file collector.h.

218  {
219  m_ScanTypes = scanTypes;
220  }
const KICAD_T * m_ScanTypes
Definition: collector.h:60

References COLLECTOR::m_ScanTypes.

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

◆ SetTimeNow()

void COLLECTOR::SetTimeNow ( )
inlineinherited

Definition at line 222 of file collector.h.

223  {
225  }
timestamp_t GetNewTimeStamp()
Definition: common.cpp:215
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

INSPECTOR_FUNC COLLECTOR::m_inspector
protectedinherited

◆ 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

Definition at line 71 of file collector.h.

Referenced by EE_SELECTION_TOOL::SelectionMenu(), and EE_SELECTION_TOOL::SelectPoint().

◆ m_MenuTitle

wxString COLLECTOR::m_MenuTitle
inherited

◆ 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

◆ 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(), and ZONE_CONTEXT_MENU::update().


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