KiCad PCB EDA Suite
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. More...
 
bool IsLayerLocked (PCB_LAYER_ID aLayerId) const override
 
void SetLayerLocked (PCB_LAYER_ID aLayerId, bool isLocked)
 
bool IsLayerVisible (PCB_LAYER_ID aLayerId) const override
 
void SetLayerVisible (PCB_LAYER_ID aLayerId, bool isVisible)
 
void SetLayerVisibleBits (LSET aLayerBits)
 
bool IgnoreLockedLayers () const override
 
void SetIgnoreLockedLayers (bool ignore)
 
bool IgnoreNonVisibleLayers () const override
 
void SetIgnoreNonVisibleLayers (bool ignore)
 
PCB_LAYER_ID GetPreferredLayer () const override
 
void SetPreferredLayer (PCB_LAYER_ID aLayer)
 
bool IgnorePreferredLayer () const override
 Provide wildcard behavior regarding the preferred layer. More...
 
void SetIgnorePreferredLayer (bool ignore)
 
bool IgnoreLockedItems () const override
 
void SetIgnoreLockedItems (bool ignore)
 
bool IncludeSecondary () const override
 Determine if the secondary criteria, or 2nd choice items should be included. More...
 
void SetIncludeSecondary (bool include)
 
bool IgnoreHiddenFPText () const override
 
void SetIgnoreMTextsMarkedNoShow (bool ignore)
 
bool IgnoreFPTextOnBack () const override
 
void SetIgnoreMTextsOnBack (bool ignore)
 
bool IgnoreFPTextOnFront () const override
 
void SetIgnoreMTextsOnFront (bool ignore)
 
bool IgnoreFootprintsOnBack () const override
 
void SetIgnoreModulesOnBack (bool ignore)
 
bool IgnoreFootprintsOnFront () const override
 
void SetIgnoreModulesOnFront (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 SetIgnoreModulesVals (bool ignore)
 
bool IgnoreFPReferences () const override
 
void SetIgnoreModulesRefs (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)
 
double OnePixelInIU () const override
 
void SetOnePixelInIU (double aValue)
 
virtual bool IgnorePads () const
 

Private Attributes

PCB_LAYER_ID m_preferredLayer
 
bool m_ignorePreferredLayer
 
LSET m_lockedLayers
 bit-mapped layer locked bits More...
 
bool m_ignoreLockedLayers
 
LSET m_visibleLayers
 bit-mapped layer visible bits More...
 
bool m_ignoreNonVisibleLayers
 
bool m_ignoreLockedItems
 
bool m_includeSecondary
 
bool m_ignoreHiddenFPText
 
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
 

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 381 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
aVisibleLayerMask= current visible layers (bit mask)
aPreferredLayer= the layer to search first

Definition at line 427 of file collectors.h.

429  {
430  VECTOR2I one( 1, 1 );
431 
432  m_preferredLayer = aPreferredLayer;
433  m_ignorePreferredLayer = false;
434  m_visibleLayers = aVisibleLayerMask;
435  m_ignoreLockedLayers = true;
437  m_ignoreLockedItems = false;
438 
439 #if defined(USE_MATCH_LAYER)
440  m_IncludeSecondary = false;
441 #else
442  m_includeSecondary = true;
443 #endif
444 
445  m_ignoreHiddenFPText = true; // g_ModuleTextNOVColor;
446  m_ignoreFPTextOnBack = true;
447  m_ignoreFPTextOnFront = false;
448  m_ignoreFootprintsOnBack = true; // !Show_footprints_Cmp;
450 
451  m_ignorePadsOnFront = false;
452  m_ignorePadsOnBack = false;
453  m_ignoreThroughHolePads = false;
454 
455  m_ignoreFPValues = false;
456  m_ignoreFPReferences = false;
457 
458  m_ignoreThroughVias = false;
459  m_ignoreBlindBuriedVias = false;
460  m_ignoreMicroVias = false;
461  m_ignoreTracks = false;
462  m_ignoreZoneFills = true;
463 
464  m_onePixelInIU = abs( aView->ToWorld( one, false ).x );
465  }
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:451
LSET m_visibleLayers
bit-mapped layer visible bits
Definition: collectors.h:393
PCB_LAYER_ID m_preferredLayer
Definition: collectors.h:387

References m_ignoreBlindBuriedVias, m_ignoreFootprintsOnBack, m_ignoreFootprintsOnFront, m_ignoreFPReferences, m_ignoreFPTextOnBack, m_ignoreFPTextOnFront, m_ignoreFPValues, m_ignoreHiddenFPText, m_ignoreLockedItems, m_ignoreLockedLayers, m_ignoreMicroVias, m_ignoreNonVisibleLayers, m_ignorePadsOnBack, m_ignorePadsOnFront, m_ignorePreferredLayer, 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

◆ GetPreferredLayer()

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

Implements COLLECTORS_GUIDE.

Definition at line 508 of file collectors.h.

508 { return m_preferredLayer; }
PCB_LAYER_ID m_preferredLayer
Definition: collectors.h:387

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

596 { return m_ignoreBlindBuriedVias; }

References m_ignoreBlindBuriedVias.

◆ IgnoreFootprintsOnBack()

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

Implements COLLECTORS_GUIDE.

Definition at line 554 of file collectors.h.

554 { return m_ignoreFootprintsOnBack; }

References m_ignoreFootprintsOnBack.

◆ IgnoreFootprintsOnFront()

bool GENERAL_COLLECTORS_GUIDE::IgnoreFootprintsOnFront ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore MODULEs on component layer.

Implements COLLECTORS_GUIDE.

Definition at line 560 of file collectors.h.

References m_ignoreFootprintsOnFront.

◆ IgnoreFPReferences()

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

Implements COLLECTORS_GUIDE.

Definition at line 590 of file collectors.h.

590 { return m_ignoreFPReferences; }

References m_ignoreFPReferences.

◆ IgnoreFPTextOnBack()

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

Implements COLLECTORS_GUIDE.

Definition at line 542 of file collectors.h.

542 { return m_ignoreFPTextOnBack; }

References m_ignoreFPTextOnBack.

◆ IgnoreFPTextOnFront()

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

Implements COLLECTORS_GUIDE.

Definition at line 548 of file collectors.h.

548 { return m_ignoreFPTextOnFront; }

References m_ignoreFPTextOnFront.

◆ IgnoreFPValues()

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

Implements COLLECTORS_GUIDE.

Definition at line 584 of file collectors.h.

584 { return m_ignoreFPValues; }

References m_ignoreFPValues.

◆ IgnoreHiddenFPText()

bool GENERAL_COLLECTORS_GUIDE::IgnoreHiddenFPText ( ) const
inlineoverridevirtual
Returns
bool - true if MTexts marked as "no show" should be ignored.

Implements COLLECTORS_GUIDE.

Definition at line 536 of file collectors.h.

536 { return m_ignoreHiddenFPText; }

References m_ignoreHiddenFPText.

◆ IgnoreLockedItems()

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

Implements COLLECTORS_GUIDE.

Definition at line 522 of file collectors.h.

522 { return m_ignoreLockedItems; }

References m_ignoreLockedItems.

◆ IgnoreLockedLayers()

bool GENERAL_COLLECTORS_GUIDE::IgnoreLockedLayers ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore locked layers, else false.

Implements COLLECTORS_GUIDE.

Definition at line 496 of file collectors.h.

496 { return m_ignoreLockedLayers; }

References m_ignoreLockedLayers.

◆ IgnoreMicroVias()

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

Implements COLLECTORS_GUIDE.

Definition at line 599 of file collectors.h.

599 { return m_ignoreMicroVias; }

References m_ignoreMicroVias.

◆ IgnoreNonVisibleLayers()

bool GENERAL_COLLECTORS_GUIDE::IgnoreNonVisibleLayers ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore non-visible layers, else false.

Implements COLLECTORS_GUIDE.

Definition at line 502 of file collectors.h.

502 { return m_ignoreNonVisibleLayers; }

References m_ignoreNonVisibleLayers.

◆ IgnorePads()

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

Definition at line 153 of file collectors.h.

154  {
156  }
virtual bool IgnorePadsOnFront() const =0
virtual bool IgnoreThroughHolePads() const =0
virtual bool IgnorePadsOnBack() const =0

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
bool - true if should ignore Pads on Back Side.

Implements COLLECTORS_GUIDE.

Definition at line 566 of file collectors.h.

566 { return m_ignorePadsOnBack; }

References m_ignorePadsOnBack.

◆ IgnorePadsOnFront()

bool GENERAL_COLLECTORS_GUIDE::IgnorePadsOnFront ( ) const
inlineoverridevirtual
Returns
bool - true if should ignore PADSs on Front Side.

Implements COLLECTORS_GUIDE.

Definition at line 572 of file collectors.h.

572 { return m_ignorePadsOnFront; }

References m_ignorePadsOnFront.

◆ IgnorePreferredLayer()

bool GENERAL_COLLECTORS_GUIDE::IgnorePreferredLayer ( ) const
inlineoverridevirtual

Provide wildcard behavior regarding the preferred layer.

Returns
bool - true if should ignore preferred layer, else false.

Implements COLLECTORS_GUIDE.

Definition at line 516 of file collectors.h.

516 { return m_ignorePreferredLayer; }

References m_ignorePreferredLayer.

◆ IgnoreThroughHolePads()

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

Implements COLLECTORS_GUIDE.

Definition at line 578 of file collectors.h.

578 { return m_ignoreThroughHolePads; }

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

593 { return m_ignoreThroughVias; }

References m_ignoreThroughVias.

◆ IgnoreTracks()

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

Implements COLLECTORS_GUIDE.

Definition at line 602 of file collectors.h.

602 { return m_ignoreTracks; }

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

605 { return m_ignoreZoneFills; }

References m_ignoreZoneFills.

◆ IncludeSecondary()

bool GENERAL_COLLECTORS_GUIDE::IncludeSecondary ( ) const
inlineoverridevirtual

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

Returns
bool - true if should include, else false.

Implements COLLECTORS_GUIDE.

Definition at line 530 of file collectors.h.

530 { return m_includeSecondary; }

References m_includeSecondary.

◆ IsLayerLocked()

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

Implements COLLECTORS_GUIDE.

Definition at line 470 of file collectors.h.

471  {
472  return m_lockedLayers[aLayerId];
473  }
LSET m_lockedLayers
bit-mapped layer locked bits
Definition: collectors.h:390

References m_lockedLayers.

◆ IsLayerVisible()

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

Implements COLLECTORS_GUIDE.

Definition at line 483 of file collectors.h.

484  {
485  return m_visibleLayers[aLayerId];
486  }
LSET m_visibleLayers
bit-mapped layer visible bits
Definition: collectors.h:393

References m_visibleLayers.

◆ OnePixelInIU()

double GENERAL_COLLECTORS_GUIDE::OnePixelInIU ( ) const
inlineoverridevirtual

Implements COLLECTORS_GUIDE.

Definition at line 608 of file collectors.h.

608 { return m_onePixelInIU; }

References m_onePixelInIU.

Referenced by PCB_SELECTION_TOOL::selectionContains().

◆ SetIgnoreBlindBuriedVias()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreBlindBuriedVias ( bool  ignore)
inline

Definition at line 597 of file collectors.h.

597 { m_ignoreBlindBuriedVias = ignore; }

References m_ignoreBlindBuriedVias.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreLockedItems()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreLockedItems ( bool  ignore)
inline

Definition at line 523 of file collectors.h.

523 { m_ignoreLockedItems = ignore; }

References m_ignoreLockedItems.

◆ SetIgnoreLockedLayers()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreLockedLayers ( bool  ignore)
inline

Definition at line 497 of file collectors.h.

497 { m_ignoreLockedLayers = ignore; }

References m_ignoreLockedLayers.

◆ SetIgnoreMicroVias()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreMicroVias ( bool  ignore)
inline

Definition at line 600 of file collectors.h.

600 { m_ignoreMicroVias = ignore; }

References m_ignoreMicroVias.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreModulesOnBack()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesOnBack ( bool  ignore)
inline

Definition at line 555 of file collectors.h.

555 { m_ignoreFootprintsOnBack = ignore; }

References m_ignoreFootprintsOnBack.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreModulesOnFront()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesOnFront ( bool  ignore)
inline

Definition at line 561 of file collectors.h.

561 { m_ignoreFootprintsOnFront = ignore; }

References m_ignoreFootprintsOnFront.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreModulesRefs()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesRefs ( bool  ignore)
inline

Definition at line 591 of file collectors.h.

591 { m_ignoreFPReferences = ignore; }

References m_ignoreFPReferences.

Referenced by PAD_TOOL::EnumeratePads(), and PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreModulesVals()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreModulesVals ( bool  ignore)
inline

Definition at line 585 of file collectors.h.

585 { m_ignoreFPValues = ignore; }

References m_ignoreFPValues.

Referenced by PAD_TOOL::EnumeratePads(), and PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreMTextsMarkedNoShow()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsMarkedNoShow ( bool  ignore)
inline

◆ SetIgnoreMTextsOnBack()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsOnBack ( bool  ignore)
inline

Definition at line 543 of file collectors.h.

543 { m_ignoreFPTextOnBack = ignore; }

References m_ignoreFPTextOnBack.

Referenced by PAD_TOOL::EnumeratePads(), and PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreMTextsOnFront()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsOnFront ( bool  ignore)
inline

Definition at line 549 of file collectors.h.

549 { m_ignoreFPTextOnFront = ignore; }

References m_ignoreFPTextOnFront.

Referenced by PAD_TOOL::EnumeratePads(), and PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreNonVisibleLayers()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreNonVisibleLayers ( bool  ignore)
inline

Definition at line 503 of file collectors.h.

503 { m_ignoreLockedLayers = ignore; }

References m_ignoreLockedLayers.

◆ SetIgnorePadsOnBack()

void GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnBack ( bool  ignore)
inline

Definition at line 567 of file collectors.h.

567 { m_ignorePadsOnBack = ignore; }

References m_ignorePadsOnBack.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnorePadsOnFront()

void GENERAL_COLLECTORS_GUIDE::SetIgnorePadsOnFront ( bool  ignore)
inline

Definition at line 573 of file collectors.h.

573 { m_ignorePadsOnFront = ignore; }

References m_ignorePadsOnFront.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnorePreferredLayer()

void GENERAL_COLLECTORS_GUIDE::SetIgnorePreferredLayer ( bool  ignore)
inline

Definition at line 517 of file collectors.h.

517 { m_ignorePreferredLayer = ignore; }

References m_ignorePreferredLayer.

◆ SetIgnoreThroughHolePads()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughHolePads ( bool  ignore)
inline

Definition at line 579 of file collectors.h.

579 { m_ignoreThroughHolePads = ignore; }

References m_ignoreThroughHolePads.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreThroughVias()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreThroughVias ( bool  ignore)
inline

Definition at line 594 of file collectors.h.

594 { m_ignoreThroughVias = ignore; }

References m_ignoreThroughVias.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreTracks()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreTracks ( bool  ignore)
inline

Definition at line 603 of file collectors.h.

603 { m_ignoreTracks = ignore; }

References m_ignoreTracks.

Referenced by PCB_SELECTION_TOOL::getCollectorsGuide().

◆ SetIgnoreZoneFills()

void GENERAL_COLLECTORS_GUIDE::SetIgnoreZoneFills ( bool  ignore)
inline

Definition at line 606 of file collectors.h.

606 { m_ignoreZoneFills = ignore; }

References m_ignoreZoneFills.

Referenced by PCB_SELECTION_TOOL::selectPoint().

◆ SetIncludeSecondary()

void GENERAL_COLLECTORS_GUIDE::SetIncludeSecondary ( bool  include)
inline

Definition at line 531 of file collectors.h.

531 { m_includeSecondary = include; }

References m_includeSecondary.

◆ SetLayerLocked()

void GENERAL_COLLECTORS_GUIDE::SetLayerLocked ( PCB_LAYER_ID  aLayerId,
bool  isLocked 
)
inline

Definition at line 475 of file collectors.h.

476  {
477  m_lockedLayers.set( aLayerId, isLocked );
478  }
LSET m_lockedLayers
bit-mapped layer locked bits
Definition: collectors.h:390

References m_lockedLayers.

◆ SetLayerVisible()

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

Definition at line 487 of file collectors.h.

488  {
489  m_visibleLayers.set( aLayerId, isVisible );
490  }
LSET m_visibleLayers
bit-mapped layer visible bits
Definition: collectors.h:393

References m_visibleLayers.

◆ SetLayerVisibleBits()

void GENERAL_COLLECTORS_GUIDE::SetLayerVisibleBits ( LSET  aLayerBits)
inline

Definition at line 491 of file collectors.h.

491 { m_visibleLayers = aLayerBits; }
LSET m_visibleLayers
bit-mapped layer visible bits
Definition: collectors.h:393

References m_visibleLayers.

◆ SetOnePixelInIU()

void GENERAL_COLLECTORS_GUIDE::SetOnePixelInIU ( double  aValue)
inline

Definition at line 609 of file collectors.h.

609 { m_onePixelInIU = aValue; }

References m_onePixelInIU.

Referenced by PCB_SELECTION_TOOL::selectionContains().

◆ SetPreferredLayer()

void GENERAL_COLLECTORS_GUIDE::SetPreferredLayer ( PCB_LAYER_ID  aLayer)
inline

Definition at line 509 of file collectors.h.

509 { m_preferredLayer = aLayer; }
PCB_LAYER_ID m_preferredLayer
Definition: collectors.h:387

References m_preferredLayer.

Referenced by BOARD_INSPECTION_TOOL::highlightNet().

Member Data Documentation

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

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

◆ m_ignoreHiddenFPText

bool GENERAL_COLLECTORS_GUIDE::m_ignoreHiddenFPText
private

◆ m_ignoreLockedItems

bool GENERAL_COLLECTORS_GUIDE::m_ignoreLockedItems
private

Definition at line 396 of file collectors.h.

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

◆ m_ignoreLockedLayers

bool GENERAL_COLLECTORS_GUIDE::m_ignoreLockedLayers
private

◆ m_ignoreMicroVias

bool GENERAL_COLLECTORS_GUIDE::m_ignoreMicroVias
private

Definition at line 411 of file collectors.h.

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

◆ m_ignoreNonVisibleLayers

bool GENERAL_COLLECTORS_GUIDE::m_ignoreNonVisibleLayers
private

Definition at line 394 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), and IgnoreNonVisibleLayers().

◆ m_ignorePadsOnBack

bool GENERAL_COLLECTORS_GUIDE::m_ignorePadsOnBack
private

Definition at line 405 of file collectors.h.

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

◆ m_ignorePadsOnFront

bool GENERAL_COLLECTORS_GUIDE::m_ignorePadsOnFront
private

Definition at line 404 of file collectors.h.

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

◆ m_ignorePreferredLayer

bool GENERAL_COLLECTORS_GUIDE::m_ignorePreferredLayer
private

◆ m_ignoreThroughHolePads

bool GENERAL_COLLECTORS_GUIDE::m_ignoreThroughHolePads
private

◆ m_ignoreThroughVias

bool GENERAL_COLLECTORS_GUIDE::m_ignoreThroughVias
private

Definition at line 409 of file collectors.h.

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

◆ m_ignoreTracks

bool GENERAL_COLLECTORS_GUIDE::m_ignoreTracks
private

Definition at line 412 of file collectors.h.

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

◆ m_ignoreZoneFills

bool GENERAL_COLLECTORS_GUIDE::m_ignoreZoneFills
private

Definition at line 413 of file collectors.h.

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

◆ m_includeSecondary

bool GENERAL_COLLECTORS_GUIDE::m_includeSecondary
private

Definition at line 397 of file collectors.h.

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

◆ m_lockedLayers

LSET GENERAL_COLLECTORS_GUIDE::m_lockedLayers
private

bit-mapped layer locked bits

Definition at line 390 of file collectors.h.

Referenced by IsLayerLocked(), and SetLayerLocked().

◆ m_onePixelInIU

double GENERAL_COLLECTORS_GUIDE::m_onePixelInIU
private

Definition at line 415 of file collectors.h.

Referenced by GENERAL_COLLECTORS_GUIDE(), OnePixelInIU(), and SetOnePixelInIU().

◆ m_preferredLayer

PCB_LAYER_ID GENERAL_COLLECTORS_GUIDE::m_preferredLayer
private

Definition at line 387 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 393 of file collectors.h.

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


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