KiCad PCB EDA Suite
Loading...
Searching...
No Matches
GENERAL_COLLECTORS_GUIDE Class Reference

A general implementation of a COLLECTORS_GUIDE. More...

#include <collectors.h>

Inheritance diagram for GENERAL_COLLECTORS_GUIDE:
COLLECTORS_GUIDE

Public Member Functions

 GENERAL_COLLECTORS_GUIDE (LSET aVisibleLayerMask, PCB_LAYER_ID aPreferredLayer, KIGFX::VIEW *aView)
 Grab stuff from global preferences and uses reasonable defaults.
 
bool IsLayerVisible (PCB_LAYER_ID aLayerId) const override
 
void SetLayerVisible (PCB_LAYER_ID aLayerId, bool isVisible)
 
void SetLayerVisibleBits (LSET aLayerBits)
 
PCB_LAYER_ID GetPreferredLayer () const override
 
void SetPreferredLayer (PCB_LAYER_ID aLayer)
 
bool IgnoreLockedItems () const override
 
void SetIgnoreLockedItems (bool ignore)
 
bool IncludeSecondary () const override
 Determine if the secondary criteria, or 2nd choice items should be included.
 
void SetIncludeSecondary (bool include)
 
bool IgnoreFPTextOnBack () const override
 
void SetIgnoreFPTextOnBack (bool ignore)
 
bool IgnoreFPTextOnFront () const override
 
void SetIgnoreFPTextOnFront (bool ignore)
 
bool IgnoreFootprintsOnBack () const override
 
void SetIgnoreFootprintsOnBack (bool ignore)
 
bool IgnoreFootprintsOnFront () const override
 
void SetIgnoreFootprintsOnFront (bool ignore)
 
bool IgnorePadsOnBack () const override
 
void SetIgnorePadsOnBack (bool ignore)
 
bool IgnorePadsOnFront () const override
 
void SetIgnorePadsOnFront (bool ignore)
 
bool IgnoreThroughHolePads () const override
 
void SetIgnoreThroughHolePads (bool ignore)
 
bool IgnoreFPValues () const override
 
void SetIgnoreFPValues (bool ignore)
 
bool IgnoreFPReferences () const override
 
void SetIgnoreFPReferences (bool ignore)
 
bool IgnoreThroughVias () const override
 
void SetIgnoreThroughVias (bool ignore)
 
bool IgnoreBlindBuriedVias () const override
 
void SetIgnoreBlindBuriedVias (bool ignore)
 
bool IgnoreMicroVias () const override
 
void SetIgnoreMicroVias (bool ignore)
 
bool IgnoreTracks () const override
 
void SetIgnoreTracks (bool ignore)
 
bool IgnoreZoneFills () const override
 
void SetIgnoreZoneFills (bool ignore)
 
int Accuracy () const override
 
void SetAccuracy (int aValue)
 
double OnePixelInIU () const override
 
virtual bool IgnorePads () const
 

Private Attributes

PCB_LAYER_ID m_preferredLayer
 
LSET m_visibleLayers
 bit-mapped layer visible bits
 
bool m_ignoreLockedItems
 
bool m_includeSecondary
 
bool m_ignoreFPTextOnBack
 
bool m_ignoreFPTextOnFront
 
bool m_ignoreFootprintsOnBack
 
bool m_ignoreFootprintsOnFront
 
bool m_ignorePadsOnFront
 
bool m_ignorePadsOnBack
 
bool m_ignoreThroughHolePads
 
bool m_ignoreFPValues
 
bool m_ignoreFPReferences
 
bool m_ignoreThroughVias
 
bool m_ignoreBlindBuriedVias
 
bool m_ignoreMicroVias
 
bool m_ignoreTracks
 
bool m_ignoreZoneFills
 
double m_onePixelInIU
 
int m_accuracy
 

Detailed Description

A general implementation of a COLLECTORS_GUIDE.

One of its constructors is entitled to grab information from the program's global preferences.

Definition at line 318 of file collectors.h.

Constructor & Destructor Documentation

◆ GENERAL_COLLECTORS_GUIDE()

GENERAL_COLLECTORS_GUIDE::GENERAL_COLLECTORS_GUIDE ( LSET  aVisibleLayerMask,
PCB_LAYER_ID  aPreferredLayer,
KIGFX::VIEW aView 
)
inline

Grab stuff from global preferences and uses reasonable defaults.

Add more constructors as needed.

Parameters
aVisibleLayerMaskis the current visible layers (bit mask).
aPreferredLayeris the layer to search first.

Definition at line 330 of file collectors.h.

References KiROUND(), m_accuracy, m_ignoreBlindBuriedVias, m_ignoreFootprintsOnBack, m_ignoreFootprintsOnFront, m_ignoreFPReferences, m_ignoreFPTextOnBack, m_ignoreFPTextOnFront, m_ignoreFPValues, m_ignoreLockedItems, m_ignoreMicroVias, m_ignorePadsOnBack, m_ignorePadsOnFront, m_ignoreThroughHolePads, m_ignoreThroughVias, m_ignoreTracks, m_ignoreZoneFills, m_includeSecondary, m_onePixelInIU, m_preferredLayer, m_visibleLayers, KIGFX::VIEW::ToWorld(), and VECTOR2< T >::x.

Member Function Documentation

◆ Accuracy()

int GENERAL_COLLECTORS_GUIDE::Accuracy ( ) const
inlineoverridevirtual

Implements COLLECTORS_GUIDE.

Definition at line 469 of file collectors.h.

References m_accuracy.

◆ GetPreferredLayer()

PCB_LAYER_ID GENERAL_COLLECTORS_GUIDE::GetPreferredLayer ( ) const
inlineoverridevirtual
Returns
int - the preferred layer for HitTest()ing.

Implements COLLECTORS_GUIDE.

Definition at line 383 of file collectors.h.

References m_preferredLayer.

◆ IgnoreBlindBuriedVias()

bool GENERAL_COLLECTORS_GUIDE::IgnoreBlindBuriedVias ( ) const
inlineoverridevirtual
Returns
true if should ignore blind/buried vias

Implements COLLECTORS_GUIDE.

Definition at line 457 of file collectors.h.

References m_ignoreBlindBuriedVias.

◆ IgnoreFootprintsOnBack()

bool GENERAL_COLLECTORS_GUIDE::IgnoreFootprintsOnBack ( ) const
inlineoverridevirtual
Returns
true if should ignore Footprints on the back side.

Implements COLLECTORS_GUIDE.

Definition at line 415 of file collectors.h.

References m_ignoreFootprintsOnBack.

◆ IgnoreFootprintsOnFront()

bool GENERAL_COLLECTORS_GUIDE::IgnoreFootprintsOnFront ( ) const
inlineoverridevirtual
Returns
true if should ignore Footprints on the front side.

Implements COLLECTORS_GUIDE.

Definition at line 421 of file collectors.h.

References m_ignoreFootprintsOnFront.

◆ IgnoreFPReferences()

bool GENERAL_COLLECTORS_GUIDE::IgnoreFPReferences ( ) const
inlineoverridevirtual
Returns
true if should ignore footprints references.

Implements COLLECTORS_GUIDE.

Definition at line 451 of file collectors.h.

References m_ignoreFPReferences.

◆ IgnoreFPTextOnBack()

bool GENERAL_COLLECTORS_GUIDE::IgnoreFPTextOnBack ( ) const
inlineoverridevirtual
Returns
true if should ignore Footprint Text on back layers

Implements COLLECTORS_GUIDE.

Definition at line 403 of file collectors.h.

References m_ignoreFPTextOnBack.

◆ IgnoreFPTextOnFront()

bool GENERAL_COLLECTORS_GUIDE::IgnoreFPTextOnFront ( ) const
inlineoverridevirtual
Returns
true if should ignore Footprint Text on front layers

Implements COLLECTORS_GUIDE.

Definition at line 409 of file collectors.h.

References m_ignoreFPTextOnFront.

◆ IgnoreFPValues()

bool GENERAL_COLLECTORS_GUIDE::IgnoreFPValues ( ) const
inlineoverridevirtual
Returns
true if should ignore footprints values.

Implements COLLECTORS_GUIDE.

Definition at line 445 of file collectors.h.

References m_ignoreFPValues.

◆ IgnoreLockedItems()

bool GENERAL_COLLECTORS_GUIDE::IgnoreLockedItems ( ) const
inlineoverridevirtual
Returns
true if should ignore locked items, else false.

Implements COLLECTORS_GUIDE.

Definition at line 389 of file collectors.h.

References m_ignoreLockedItems.

◆ IgnoreMicroVias()

bool GENERAL_COLLECTORS_GUIDE::IgnoreMicroVias ( ) const
inlineoverridevirtual
Returns
true if should ignore micro vias

Implements COLLECTORS_GUIDE.

Definition at line 460 of file collectors.h.

References m_ignoreMicroVias.

◆ IgnorePads()

virtual bool COLLECTORS_GUIDE::IgnorePads ( ) const
inlinevirtualinherited
Returns
true if should ignore PADSs on Front side and Back side.

Definition at line 118 of file collectors.h.

References COLLECTORS_GUIDE::IgnorePadsOnBack(), COLLECTORS_GUIDE::IgnorePadsOnFront(), and COLLECTORS_GUIDE::IgnoreThroughHolePads().

Referenced by GENERAL_COLLECTOR::Inspect().

◆ IgnorePadsOnBack()

bool GENERAL_COLLECTORS_GUIDE::IgnorePadsOnBack ( ) const
inlineoverridevirtual
Returns
true if should ignore pads on back side.

Implements COLLECTORS_GUIDE.

Definition at line 427 of file collectors.h.

References m_ignorePadsOnBack.

◆ IgnorePadsOnFront()

bool GENERAL_COLLECTORS_GUIDE::IgnorePadsOnFront ( ) const
inlineoverridevirtual
Returns
true if should ignore pads on front side.

Implements COLLECTORS_GUIDE.

Definition at line 433 of file collectors.h.

References m_ignorePadsOnFront.

◆ IgnoreThroughHolePads()

bool GENERAL_COLLECTORS_GUIDE::IgnoreThroughHolePads ( ) const
inlineoverridevirtual
Returns
true if should ignore through-hole pads.

Implements COLLECTORS_GUIDE.

Definition at line 439 of file collectors.h.

References m_ignoreThroughHolePads.

◆ IgnoreThroughVias()

bool GENERAL_COLLECTORS_GUIDE::IgnoreThroughVias ( ) const
inlineoverridevirtual
Returns
true if should ignore through-hole vias

Implements COLLECTORS_GUIDE.

Definition at line 454 of file collectors.h.

References m_ignoreThroughVias.

◆ IgnoreTracks()

bool GENERAL_COLLECTORS_GUIDE::IgnoreTracks ( ) const
inlineoverridevirtual
Returns
true if should ignore tracks

Implements COLLECTORS_GUIDE.

Definition at line 463 of file collectors.h.

References m_ignoreTracks.

◆ IgnoreZoneFills()

bool GENERAL_COLLECTORS_GUIDE::IgnoreZoneFills ( ) const
inlineoverridevirtual
Returns
true if should ignore the interiors of zones

Implements COLLECTORS_GUIDE.

Definition at line 466 of file collectors.h.

References m_ignoreZoneFills.

◆ IncludeSecondary()

bool GENERAL_COLLECTORS_GUIDE::IncludeSecondary ( ) const
inlineoverridevirtual

Determine if the secondary criteria, or 2nd choice items should be included.

Returns
true if should include, else false.

Implements COLLECTORS_GUIDE.

Definition at line 397 of file collectors.h.

References m_includeSecondary.

◆ IsLayerVisible()

bool GENERAL_COLLECTORS_GUIDE::IsLayerVisible ( PCB_LAYER_ID  aLayerId) const
inlineoverridevirtual
Returns
true if the given layer is visible, else false.

Implements COLLECTORS_GUIDE.

Definition at line 370 of file collectors.h.

References m_visibleLayers.

◆ OnePixelInIU()

double GENERAL_COLLECTORS_GUIDE::OnePixelInIU ( ) const
inlineoverridevirtual

Implements COLLECTORS_GUIDE.

Definition at line 472 of file collectors.h.

References m_onePixelInIU.

◆ SetAccuracy()

void GENERAL_COLLECTORS_GUIDE::SetAccuracy ( int  aValue)
inline

Definition at line 470 of file collectors.h.

References m_accuracy.

◆ SetIgnoreBlindBuriedVias()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreBlindBuriedVias ( bool  ignore)
inline

◆ SetIgnoreFootprintsOnBack()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreFootprintsOnBack ( bool  ignore)
inline

◆ SetIgnoreFootprintsOnFront()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreFootprintsOnFront ( bool  ignore)
inline

◆ SetIgnoreFPReferences()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreFPReferences ( bool  ignore)
inline

◆ SetIgnoreFPTextOnBack()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreFPTextOnBack ( bool  ignore)
inline

◆ SetIgnoreFPTextOnFront()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreFPTextOnFront ( bool  ignore)
inline

◆ SetIgnoreFPValues()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreFPValues ( bool  ignore)
inline

◆ SetIgnoreLockedItems()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreLockedItems ( bool  ignore)
inline

Definition at line 390 of file collectors.h.

References m_ignoreLockedItems.

◆ SetIgnoreMicroVias()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreMicroVias ( bool  ignore)
inline

◆ SetIgnorePadsOnBack()

void GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnBack ( bool  ignore)
inline

◆ SetIgnorePadsOnFront()

void GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnFront ( bool  ignore)
inline

◆ SetIgnoreThroughHolePads()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughHolePads ( bool  ignore)
inline

◆ SetIgnoreThroughVias()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughVias ( bool  ignore)
inline

◆ SetIgnoreTracks()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreTracks ( bool  ignore)
inline

◆ SetIgnoreZoneFills()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreZoneFills ( bool  ignore)
inline

◆ SetIncludeSecondary()

void GENERAL_COLLECTORS_GUIDE::SetIncludeSecondary ( bool  include)
inline

Definition at line 398 of file collectors.h.

References m_includeSecondary.

◆ SetLayerVisible()

void GENERAL_COLLECTORS_GUIDE::SetLayerVisible ( PCB_LAYER_ID  aLayerId,
bool  isVisible 
)
inline

Definition at line 374 of file collectors.h.

References m_visibleLayers, and BASE_SET::set().

◆ SetLayerVisibleBits()

void GENERAL_COLLECTORS_GUIDE::SetLayerVisibleBits ( LSET  aLayerBits)
inline

Definition at line 378 of file collectors.h.

References m_visibleLayers.

Referenced by PCB_SELECTION_TOOL::selectAllConnectedShapes().

◆ SetPreferredLayer()

void GENERAL_COLLECTORS_GUIDE::SetPreferredLayer ( PCB_LAYER_ID  aLayer)
inline

Definition at line 384 of file collectors.h.

References m_preferredLayer.

Referenced by BOARD_INSPECTION_TOOL::highlightNet().

Member Data Documentation

◆ m_accuracy

int GENERAL_COLLECTORS_GUIDE::m_accuracy
private

Definition at line 501 of file collectors.h.

Referenced by Accuracy(), GENERAL_COLLECTORS_GUIDE(), and SetAccuracy().

◆ m_ignoreBlindBuriedVias

bool GENERAL_COLLECTORS_GUIDE::m_ignoreBlindBuriedVias
private

◆ m_ignoreFootprintsOnBack

bool GENERAL_COLLECTORS_GUIDE::m_ignoreFootprintsOnBack
private

◆ m_ignoreFootprintsOnFront

bool GENERAL_COLLECTORS_GUIDE::m_ignoreFootprintsOnFront
private

◆ m_ignoreFPReferences

bool GENERAL_COLLECTORS_GUIDE::m_ignoreFPReferences
private

◆ m_ignoreFPTextOnBack

bool GENERAL_COLLECTORS_GUIDE::m_ignoreFPTextOnBack
private

◆ m_ignoreFPTextOnFront

bool GENERAL_COLLECTORS_GUIDE::m_ignoreFPTextOnFront
private

◆ m_ignoreFPValues

bool GENERAL_COLLECTORS_GUIDE::m_ignoreFPValues
private

Definition at line 492 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnoreFPValues(), and SetIgnoreFPValues().

◆ m_ignoreLockedItems

bool GENERAL_COLLECTORS_GUIDE::m_ignoreLockedItems
private

Definition at line 482 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnoreLockedItems(), and SetIgnoreLockedItems().

◆ m_ignoreMicroVias

bool GENERAL_COLLECTORS_GUIDE::m_ignoreMicroVias
private

Definition at line 496 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnoreMicroVias(), and SetIgnoreMicroVias().

◆ m_ignorePadsOnBack

bool GENERAL_COLLECTORS_GUIDE::m_ignorePadsOnBack
private

Definition at line 490 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnorePadsOnBack(), and SetIgnorePadsOnBack().

◆ m_ignorePadsOnFront

bool GENERAL_COLLECTORS_GUIDE::m_ignorePadsOnFront
private

Definition at line 489 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnorePadsOnFront(), and SetIgnorePadsOnFront().

◆ m_ignoreThroughHolePads

bool GENERAL_COLLECTORS_GUIDE::m_ignoreThroughHolePads
private

◆ m_ignoreThroughVias

bool GENERAL_COLLECTORS_GUIDE::m_ignoreThroughVias
private

Definition at line 494 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnoreThroughVias(), and SetIgnoreThroughVias().

◆ m_ignoreTracks

bool GENERAL_COLLECTORS_GUIDE::m_ignoreTracks
private

Definition at line 497 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnoreTracks(), and SetIgnoreTracks().

◆ m_ignoreZoneFills

bool GENERAL_COLLECTORS_GUIDE::m_ignoreZoneFills
private

Definition at line 498 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IgnoreZoneFills(), and SetIgnoreZoneFills().

◆ m_includeSecondary

bool GENERAL_COLLECTORS_GUIDE::m_includeSecondary
private

Definition at line 483 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IncludeSecondary(), and SetIncludeSecondary().

◆ m_onePixelInIU

double GENERAL_COLLECTORS_GUIDE::m_onePixelInIU
private

Definition at line 500 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), and OnePixelInIU().

◆ m_preferredLayer

PCB_LAYER_ID GENERAL_COLLECTORS_GUIDE::m_preferredLayer
private

Definition at line 478 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), GetPreferredLayer(), and SetPreferredLayer().

◆ m_visibleLayers

LSET GENERAL_COLLECTORS_GUIDE::m_visibleLayers
private

bit-mapped layer visible bits

Definition at line 480 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), IsLayerVisible(), SetLayerVisible(), and SetLayerVisibleBits().


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