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:

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

Public Member Functions
	GENERAL_COLLECTOR ()
void	Empty2nd ()
void	Append2nd (BOARD_ITEM *item)
void	SetGuide (const COLLECTORS_GUIDE *aGuide)
	Record which COLLECTORS_GUIDE to use. More...
const COLLECTORS_GUIDE *	GetGuide () const
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_ITEM *	operator[] (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
int	GetCount () const
	Return the number of objects in the list. More...
void	Empty ()
	Clear the list. More...
void	Append (EDA_ITEM *item)
	Add an item to the end of the list. More...
void	Remove (int aIndex)
	Remove the item at aIndex (first position is 0). More...
void	Remove (const EDA_ITEM *aItem)
	Remove the item aItem (if exists in the collector). More...
bool	HasAdditionalItems ()
	Test if the collector has heuristic backup items. More...
void	Combine ()
	Re-combine the backup list into the main list of the collector. More...
void	Transfer (int aIndex)
	Move the item at aIndex (first position is 0) to the backup list. More...
void	Transfer (EDA_ITEM *aItem)
	Move aItem (if exists in the collector) to the backup list. More...
bool	HasItem (const EDA_ITEM *aItem) const
	Tests if aItem has already been collected. More...
void	SetScanTypes (const KICAD_T *scanTypes)
	Record the list of KICAD_T types to consider for collection by the Inspect() function. More...
void	SetRefPos (const wxPoint &aRefPos)
const EDA_RECT &	GetBoundingBox () const
int	CountType (KICAD_T aType)
	Count the number of items matching aType. More...

Public Attributes
int	m_Threshold
wxString	m_MenuTitle
bool	m_MenuCancelled

Static Public Attributes
static const KICAD_T	AllBoardItems []
	A scan list for all editable board items. 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 FOOTPRINT, such as PAD and FP_TEXT. More...
static const KICAD_T	Footprints []
	A scan list for only FOOTPRINTs. More...
static const KICAD_T	PadsOrTracks []
	A scan list for PADs, TRACKs, or VIAs. More...
static const KICAD_T	FootprintItems []
	A scan list for primary footprint 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, FOOTPRINTs. More...
static const KICAD_T	Dimensions []
	A scan list for dimensions. More...
static const KICAD_T	DraggableItems []
	A scan list for items that can be dragged. 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_GUIDE *	m_Guide
	Determine 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
std::vector< EDA_ITEM * >	m_backupList
const KICAD_T *	m_scanTypes
INSPECTOR_FUNC	m_inspector
wxPoint	m_refPos
EDA_RECT	m_refBox

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

ITER

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

inherited

Definition at line 76 of file collector.h.

Constructor & Destructor Documentation

GENERAL_COLLECTOR()

GENERAL_COLLECTOR::GENERAL_COLLECTOR ( )

inline

Definition at line 315 of file collectors.h.

    {
        m_Guide = nullptr;
        m_PrimaryLength = 0;
        SetScanTypes( AllBoardItems );
    }

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

Member Function Documentation

Append()

void COLLECTOR::Append ( EDA_ITEM *  item )

inlineinherited

Add an item to the end of the list.

Parameters

item	An EDA_ITEM* to add.

Definition at line 105 of file collector.h.

    {
        m_list.push_back( item );
    }

References COLLECTOR::m_list.

Referenced by Collect(), EDIT_TOOL::doMoveSelection(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::Drag(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), Inspect(), PCB_TYPE_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ROUTER_TOOL::NeighboringSegmentFilter(), POSITION_RELATIVE_TOOL::PositionRelative(), PCB_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), and GERBVIEW_SELECTION_TOOL::selectPoint().

Append2nd()

void GENERAL_COLLECTOR::Append2nd ( BOARD_ITEM *  item )

inline

Definition at line 327 of file collectors.h.

    {
        m_List2nd.push_back( item );
    }

References m_List2nd.

Referenced by Inspect().

begin() [1/2]

ITER COLLECTOR::begin ( )

inlineinherited

Definition at line 79 of file collector.h.

{ return m_list.begin(); }

References COLLECTOR::m_list.

begin() [2/2]

CITER COLLECTOR::begin ( ) const

inlineinherited

Definition at line 81 of file collector.h.

{ return m_list.cbegin(); }

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

aItem	A BOARD_ITEM to scan, may be a BOARD or FOOTPRINT, or whatever.
aScanList	A 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".
aRefPos	A wxPoint to use in hit-testing.
aGuide	The COLLECTORS_GUIDE to use in collecting items.

Definition at line 571 of file collectors.cpp.

{
    Empty();        // empty the collection, primary criteria list
    Empty2nd();     // empty the collection, secondary criteria list

    // remember guide, pass it to Inspect()
    SetGuide( &aGuide );

    SetScanTypes( aScanList );

    // remember where the snapshot was taken from and pass refPos to
    // the Inspect() function.
    SetRefPos( aRefPos );

    aItem->Visit( m_inspector, nullptr, m_scanTypes );

    // record the length of the primary list before concatenating on to it.
    m_PrimaryLength = m_list.size();

    // append 2nd list onto end of the first list
    for( unsigned i = 0;  i<m_List2nd.size();  ++i )
        Append( m_List2nd[i] );

    Empty2nd();
}

References COLLECTOR::Append(), COLLECTOR::Empty(), Empty2nd(), COLLECTOR::m_inspector, COLLECTOR::m_list, m_List2nd, m_PrimaryLength, COLLECTOR::m_scanTypes, SetGuide(), COLLECTOR::SetRefPos(), COLLECTOR::SetScanTypes(), and EDA_ITEM::Visit().

Referenced by PCB_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectPoint().

Combine()

void COLLECTOR::Combine ( )

inlineinherited

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

Definition at line 148 of file collector.h.

    {
        std::copy( m_backupList.begin(), m_backupList.end(), std::back_inserter( m_list ) );
        m_backupList.clear();
    }

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

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

CountType()

int COLLECTOR::CountType ( KICAD_T  aType )

inlineinherited

Count the number of items matching aType.

Parameters

aType

type we are interested in.

Returns

number of occurrences.

Definition at line 235 of file collector.h.

    {
        int cnt = 0;

        for( size_t i = 0; i < m_list.size(); i++ )
        {
            if( m_list[i]->Type() == aType )
                cnt++;
        }

        return cnt;
    }

References COLLECTOR::m_list.

Referenced by ROUTER_TOOL::NeighboringSegmentFilter().

Empty()

void COLLECTOR::Empty ( )

inlineinherited

Clear the list.

Definition at line 95 of file collector.h.

    {
        m_list.clear();
    }

References COLLECTOR::m_list.

Referenced by EE_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), Collect(), PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), PAD_TOOL::EnumeratePads(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), ROUTER_TOOL::NeighboringSegmentFilter(), and GERBVIEW_SELECTION_TOOL::selectPoint().

Empty2nd()

void GENERAL_COLLECTOR::Empty2nd ( )

inline

Definition at line 322 of file collectors.h.

    {
        m_List2nd.clear();
    }

References m_List2nd.

Referenced by Collect().

end() [1/2]

ITER COLLECTOR::end ( )

inlineinherited

Definition at line 80 of file collector.h.

{ return m_list.end(); }

References COLLECTOR::m_list.

end() [2/2]

CITER COLLECTOR::end ( ) const

inlineinherited

Definition at line 82 of file collector.h.

{ return m_list.cend(); }

References COLLECTOR::m_list.

GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const

inlineinherited

Definition at line 227 of file collector.h.

{  return m_refBox; }

References COLLECTOR::m_refBox.

GetCount()

int COLLECTOR::GetCount ( ) const

inlineinherited

Return the number of objects in the list.

Definition at line 87 of file collector.h.

    {
        return (int) m_list.size();
    }

References COLLECTOR::m_list.

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

GetGuide()

const COLLECTORS_GUIDE* GENERAL_COLLECTOR::GetGuide ( ) const

inline

Definition at line 339 of file collectors.h.

{ return m_Guide; }

References m_Guide.

Referenced by FOOTPRINT::CoverageRatio(), FOOTPRINT::GetCoverageArea(), and PCB_SELECTION_TOOL::GuessSelectionCandidates().

GetPrimaryCount()

int GENERAL_COLLECTOR::GetPrimaryCount ( )

inline

Returns

The number of items which met the primary search criteria

Definition at line 344 of file collectors.h.

{ return m_PrimaryLength; }

References m_PrimaryLength.

HasAdditionalItems()

bool COLLECTOR::HasAdditionalItems ( )

inlineinherited

Test if the collector has heuristic backup items.

Returns

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

Definition at line 140 of file collector.h.

    {
        return !m_backupList.empty();
    }

References COLLECTOR::m_backupList.

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

HasItem()

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

inlineinherited

Tests if aItem has already been collected.

Parameters

aItem

The EDA_ITEM* to be tested.

Returns

True if aItem is already collected.

Definition at line 203 of file collector.h.

    {
        for( size_t i = 0; i < m_list.size(); i++ )
        {
            if( m_list[i] == aItem )
                return true;
        }

        return false;
    }

References COLLECTOR::m_list.

Referenced by EDIT_TOOL::copyToClipboard(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), and POSITION_RELATIVE_TOOL::PositionRelative().

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.

Search and collect all the objects which match the test data.

Parameters

testItem	An EDA_ITEM to examine.
testData	is 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 157 of file collectors.cpp.

{
    BOARD_ITEM*         item        = (BOARD_ITEM*) testItem;
    FOOTPRINT*          footprint   = nullptr;
    PCB_GROUP*          group       = nullptr;
    PAD*                pad         = nullptr;
    bool                pad_through = false;
    PCB_VIA*            via         = nullptr;
    PCB_MARKER*         marker      = nullptr;
    ZONE*               zone        = nullptr;
    PCB_SHAPE*          shape       = nullptr;
    PCB_DIMENSION_BASE* dimension   = nullptr;

#if 0   // debugging
    static int  breakhere = 0;

    switch( item->Type() )
    {
    case PCB_PAD_T:
        {
            FOOTPRINT* footprint = (FOOTPRINT*) item->GetParent();

            if( footprint->GetReference() == wxT( "Y2" ) )
                breakhere++;
        }
        break;

    case PCB_VIA_T:
        breakhere++;
        break;

    case PCB_TRACE_T:
    case PCB_ARC_T:
        breakhere++;
        break;

    case PCB_TEXT_T:
        breakhere++;
        break;

    case PCB_SHAPE_T:
        breakhere++;
        break;

    case PCB_DIM_ALIGNED_T:
        breakhere++;
        break;

    case PCB_FP_TEXT_T:
        {
            FP_TEXT* fpText = (FP_TEXT*) item;

            if( fpText->GetText() == wxT( "10uH" ) )
                breakhere++;
        }
        break;

    case PCB_FOOTPRINT_T:
        {
            FOOTPRINT* footprint = (FOOTPRINT*) item;

            if( footprint->GetReference() == wxT( "C98" ) )
                breakhere++;
        }
        break;

    case PCB_MARKER_T:
        breakhere++;
        break;

    default:
        breakhere++;
        break;
    }

#endif

    switch( item->Type() )
    {
    case PCB_PAD_T:
        // there are pad specific visibility controls.
        // Criteria to select a pad is:
        // for smd pads: the footprint parent must be visible, and pads on the corresponding
        // board side must be visible
        // if pad is a thru hole, then it can be visible when its parent footprint is not.
        // for through pads: pads on Front or Back board sides must be visible
        pad = static_cast<PAD*>( item );

        if( ( pad->GetAttribute() != PAD_ATTRIB::SMD ) &&
            ( pad->GetAttribute() != PAD_ATTRIB::CONN ) )  // a hole is present, so multiple layers
        {
            // proceed to the common tests below, but without the parent footprint test,
            // by leaving footprint==NULL, but having pad != null
            pad_through = true;
        }
        else  // smd, so use pads test after footprint test
        {
            footprint = static_cast<FOOTPRINT*>( item->GetParent() );
        }

        break;

    case PCB_VIA_T:     // vias are on many layers, so layer test is specific
        via = static_cast<PCB_VIA*>( item );
        break;

    case PCB_TRACE_T:
    case PCB_ARC_T:
        if( m_Guide->IgnoreTracks() )
            goto exit;

        break;

    case PCB_FP_ZONE_T:
        footprint = static_cast<FOOTPRINT*>( item->GetParent() );

        // Fallthrough to get the zone as well
        KI_FALLTHROUGH;

    case PCB_ZONE_T:
        zone = static_cast<ZONE*>( item );
        break;

    case PCB_TEXT_T:
        break;

    case PCB_SHAPE_T:
        shape = static_cast<PCB_SHAPE*>( item );
        break;

    case PCB_DIM_ALIGNED_T:
    case PCB_DIM_CENTER_T:
    case PCB_DIM_ORTHOGONAL_T:
    case PCB_DIM_LEADER_T:
        dimension = static_cast<PCB_DIMENSION_BASE*>( item );
        break;

    case PCB_TARGET_T:
        break;

    case PCB_FP_TEXT_T:
    {
        FP_TEXT *text = static_cast<FP_TEXT*>( item );

        if( m_Guide->IgnoreHiddenFPText() && !text->IsVisible() )
            goto exit;

        if( m_Guide->IgnoreFPTextOnBack() && IsBackLayer( text->GetLayer() ) )
            goto exit;

        if( m_Guide->IgnoreFPTextOnFront() && IsFrontLayer( text->GetLayer() ) )
            goto exit;

        /* The three text types have different criteria: reference
         * and value have their own ignore flags; user text instead
         * follows their layer visibility. Checking this here is
         * simpler than later (when layer visibility is checked for
         * other entities) */

        switch( text->GetType() )
        {
        case FP_TEXT::TEXT_is_REFERENCE:
            if( m_Guide->IgnoreFPReferences() )
                goto exit;

            break;

        case FP_TEXT::TEXT_is_VALUE:
            if( m_Guide->IgnoreFPValues() )
                goto exit;

            break;

        case FP_TEXT::TEXT_is_DIVERS:
            if( !m_Guide->IsLayerVisible( text->GetLayer() )
              && m_Guide->IgnoreNonVisibleLayers() )
                goto exit;

            break;
        }

        // Extract the footprint since it could be hidden
        footprint = static_cast<FOOTPRINT*>( item->GetParent() );
        break;
    }

    case PCB_FP_SHAPE_T:
        shape = static_cast<FP_SHAPE*>( item );
        break;

    case PCB_FOOTPRINT_T:
        footprint = static_cast<FOOTPRINT*>( item );
        break;

    case PCB_GROUP_T:
        group = static_cast<PCB_GROUP*>( item );
        break;

    case PCB_MARKER_T:
        marker = static_cast<PCB_MARKER*>( item );
        break;

    default:
        break;
    }

    // common tests:

    if( footprint )    // true from case PCB_PAD_T, PCB_FP_TEXT_T, or PCB_FOOTPRINT_T
    {
        if( m_Guide->IgnoreFootprintsOnBack() && ( footprint->GetLayer() == B_Cu ) )
            goto exit;

        if( m_Guide->IgnoreFootprintsOnFront() && ( footprint->GetLayer() == F_Cu ) )
            goto exit;
    }

    // Pads are not sensitive to the layer visibility controls.
    // They all have their own separate visibility controls
    // skip them if not visible
    if( pad )
    {
        if( m_Guide->IgnorePads() )
            goto exit;

        if( ! pad_through )
        {
            if( m_Guide->IgnorePadsOnFront() && pad->IsOnLayer(F_Cu ) )
                goto exit;

            if( m_Guide->IgnorePadsOnBack() && pad->IsOnLayer(B_Cu ) )
                goto exit;
        }
    }

    if( marker )
    {
        // Markers are not sensitive to the layer
        if( marker->HitTest( m_refPos ) )
            Append( item );

        goto exit;
    }

    if( group )
    {
        // Groups are not sensitive to the layer ... ?
        if( group->HitTest( m_refPos ) )
            Append( item );

        goto exit;
    }

    if( via )
    {
        auto type = via->GetViaType();

        if( ( m_Guide->IgnoreThroughVias() && type == VIATYPE::THROUGH )
                || ( m_Guide->IgnoreBlindBuriedVias() && type == VIATYPE::BLIND_BURIED )
                || ( m_Guide->IgnoreMicroVias() && type == VIATYPE::MICROVIA ) )
        {
            goto exit;
        }
    }

    if( item->IsOnLayer( m_Guide->GetPreferredLayer() ) || m_Guide->IgnorePreferredLayer() )
    {
        PCB_LAYER_ID layer = item->GetLayer();

        // footprints and their subcomponents: reference, value and pads are not sensitive
        // to the layer visibility controls.  They all have their own separate visibility
        // controls for vias, GetLayer() has no meaning, but IsOnLayer() works fine. User
        // text in a footprint *is* sensitive to layer visibility but that was already handled.

        if( via || footprint || pad || m_Guide->IsLayerVisible( layer )
            || !m_Guide->IgnoreNonVisibleLayers() )
        {
            if( !m_Guide->IsLayerLocked( layer ) || !m_Guide->IgnoreLockedLayers() )
            {
                if( !item->IsLocked() || !m_Guide->IgnoreLockedItems() )
                {
                    int  accuracy = KiROUND( 5 * m_Guide->OnePixelInIU() );

                    if( zone )
                    {
                        bool testFill = !m_Guide->IgnoreZoneFills();

                        if( zone->HitTestForCorner( m_refPos, accuracy * 2 )
                            || zone->HitTestForEdge( m_refPos, accuracy )
                            || ( testFill && zone->HitTestFilledArea( layer, m_refPos ) ) )
                        {
                            Append( item );
                            goto exit;
                        }
                    }
                    else if( item->Type() == PCB_FOOTPRINT_T )
                    {
                        if( footprint->HitTest( m_refPos, accuracy )
                            && footprint->HitTestAccurate( m_refPos, accuracy ) )
                        {
                            Append( item );
                            goto exit;
                        }
                    }
                    else if( shape )
                    {
                        if( shape->HitTest( m_refPos, accuracy ) )
                        {
                            Append( shape );
                            goto exit;
                        }
                    }
                    else if( dimension )
                    {
                        // Dimensions feel particularly hard to select, probably due to their
                        // noisy shape making it feel like they should have a larger boundary.
                        if( dimension->HitTest( m_refPos, KiROUND( accuracy * 1.5 ) ) )
                        {
                            Append( dimension );
                            goto exit;
                        }
                    }
                    else
                    {
                        if( item->HitTest( m_refPos, accuracy ) )
                        {
                            Append( item );
                            goto exit;
                        }
                    }
                }
            }
        }
    }

    if( m_Guide->IncludeSecondary() )
    {
        // for now, "secondary" means "tolerate any layer".  It has
        // no effect on other criteria, since there is a separate "ignore" control for
        // those in the COLLECTORS_GUIDE

        PCB_LAYER_ID layer = item->GetLayer();

        // footprints and their subcomponents: reference, value and pads are not sensitive
        // to the layer visibility controls.  They all have their own separate visibility
        // controls for vias, GetLayer() has no meaning, but IsOnLayer() works fine. User
        // text in a footprint *is* sensitive to layer visibility but that was already handled.

        if( via || footprint || pad || zone || m_Guide->IsLayerVisible( layer )
            || !m_Guide->IgnoreNonVisibleLayers() )
        {
            if( !m_Guide->IsLayerLocked( layer ) || !m_Guide->IgnoreLockedLayers() )
            {
                if( !item->IsLocked() || !m_Guide->IgnoreLockedItems() )
                {
                    int  accuracy = KiROUND( 5 * m_Guide->OnePixelInIU() );

                    if( zone )
                    {
                        bool testFill = !m_Guide->IgnoreZoneFills();

                        if( zone->HitTestForCorner( m_refPos, accuracy * 2 )
                            || zone->HitTestForEdge( m_refPos, accuracy )
                            || ( testFill && zone->HitTestFilledArea( layer, m_refPos ) ) )
                        {
                            Append2nd( item );
                            goto exit;
                        }
                    }
                    else if( item->Type() == PCB_FOOTPRINT_T )
                    {
                        if( footprint->HitTest( m_refPos, accuracy )
                            && footprint->HitTestAccurate( m_refPos, accuracy ) )
                        {
                            Append2nd( item );
                            goto exit;
                        }
                    }
                    else if( shape )
                    {
                        if( shape->HitTest( m_refPos, accuracy ) )
                        {
                            Append2nd( shape );
                            goto exit;
                        }
                    }
                    else if( dimension )
                    {
                        // Dimensions feels particularly hard to select, probably due to their
                        // noisy shape making it feel like they should have a larger boundary.
                        if( dimension->HitTest( m_refPos, KiROUND( accuracy * 1.5 ) ) )
                        {
                            Append2nd( dimension );
                            goto exit;
                        }
                    }
                    else
                    {
                        if( item->HitTest( m_refPos, 0 ) )
                        {
                            Append2nd( item );
                            goto exit;
                        }
                    }
                }
            }
        }
    }

exit:
    return SEARCH_RESULT::CONTINUE; // always when collecting
}

References COLLECTOR::Append(), Append2nd(), B_Cu, BLIND_BURIED, CONN, CONTINUE, exit, F_Cu, BOARD_ITEM::GetLayer(), BOARD_ITEM::GetParent(), COLLECTORS_GUIDE::GetPreferredLayer(), FOOTPRINT::GetReference(), EDA_TEXT::GetText(), group, PCB_MARKER::HitTest(), EDA_ITEM::HitTest(), PCB_DIMENSION_BASE::HitTest(), PCB_SHAPE::HitTest(), FOOTPRINT::HitTest(), FOOTPRINT::HitTestAccurate(), ZONE::HitTestFilledArea(), ZONE::HitTestForCorner(), ZONE::HitTestForEdge(), COLLECTORS_GUIDE::IgnoreBlindBuriedVias(), COLLECTORS_GUIDE::IgnoreFootprintsOnBack(), COLLECTORS_GUIDE::IgnoreFootprintsOnFront(), COLLECTORS_GUIDE::IgnoreFPReferences(), COLLECTORS_GUIDE::IgnoreFPTextOnBack(), COLLECTORS_GUIDE::IgnoreFPTextOnFront(), COLLECTORS_GUIDE::IgnoreFPValues(), COLLECTORS_GUIDE::IgnoreHiddenFPText(), COLLECTORS_GUIDE::IgnoreLockedItems(), COLLECTORS_GUIDE::IgnoreLockedLayers(), COLLECTORS_GUIDE::IgnoreMicroVias(), 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(), KI_FALLTHROUGH, KiROUND(), m_Guide, COLLECTOR::m_refPos, MICROVIA, COLLECTORS_GUIDE::OnePixelInIU(), pad, PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TARGET_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, SMD, text, FP_TEXT::TEXT_is_DIVERS, FP_TEXT::TEXT_is_REFERENCE, FP_TEXT::TEXT_is_VALUE, THROUGH, EDA_ITEM::Type(), and via.

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

ndx	The index into the list.

Returns

a board item or NULL.

Reimplemented from COLLECTOR.

Definition at line 221 of file collectors.h.

    {
        if( (unsigned)ndx < (unsigned)GetCount() )
            return (BOARD_ITEM*) m_list[ ndx ];

        return nullptr;
    }

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

Remove() [1/2]

void COLLECTOR::Remove ( int  aIndex )

inlineinherited

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

Parameters

aIndex

The index into the list.

Definition at line 115 of file collector.h.

    {
        m_list.erase( m_list.begin() + aIndex );
    }

References COLLECTOR::m_list.

Referenced by EDIT_TOOL::ChangeTrackWidth(), connectedItemFilter(), EDIT_TOOL::copyToClipboard(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), PCB_CONTROL::DeleteItemCursor(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), EDIT_TOOL::FootprintFilter(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), GROUP_TOOL::Group(), BOARD_INSPECTION_TOOL::highlightNet(), EDIT_TOOL::MoveExact(), EE_SELECTION_TOOL::narrowSelection(), EDIT_TOOL::PadFilter(), POSITION_RELATIVE_TOOL::PositionRelative(), CONVERT_TOOL::SegmentToArc(), GERBVIEW_SELECTION_TOOL::selectPoint(), and PCB_SELECTION_TOOL::selectPoint().

Remove() [2/2]

void COLLECTOR::Remove ( const EDA_ITEM *  aItem )

inlineinherited

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

Parameters

aItem

the item to be removed.

Definition at line 125 of file collector.h.

    {
        m_list.erase( std::remove_if( m_list.begin(), m_list.end(),
                                      [&aItem]( const EDA_ITEM* aCandidate )
                                      {
                                          return aCandidate == aItem;
                                      } ),
                      m_list.end() );
    }

References COLLECTOR::m_list.

SetGuide()

void GENERAL_COLLECTOR::SetGuide ( const COLLECTORS_GUIDE *  aGuide )

inline

Record which COLLECTORS_GUIDE to use.

Parameters

aGuide

Which guide to use in the collection.

Definition at line 337 of file collectors.h.

{ m_Guide = aGuide; }

References m_Guide.

Referenced by Collect().

SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint &  aRefPos )

inlineinherited

Definition at line 225 of file collector.h.

{ m_refPos = aRefPos; }

References COLLECTOR::m_refPos.

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

SetScanTypes()

void COLLECTOR::SetScanTypes ( const KICAD_T *  scanTypes )

inlineinherited

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

Parameters

scanTypes

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

Definition at line 220 of file collector.h.

    {
        m_scanTypes = scanTypes;
    }

References COLLECTOR::m_scanTypes.

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

Transfer() [1/2]

void COLLECTOR::Transfer ( int  aIndex )

inlineinherited

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

Parameters

aIndex

The index into the list.

Definition at line 159 of file collector.h.

    {
        m_backupList.push_back( m_list[aIndex] );
        m_list.erase( m_list.begin() + aIndex );
    }

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

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

Transfer() [2/2]

void COLLECTOR::Transfer ( EDA_ITEM *  aItem )

inlineinherited

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

Parameters

aItem

the item to be moved.

Definition at line 170 of file collector.h.

    {
        for( size_t i = 0; i < m_list.size(); i++ )
        {
            if( m_list[i] == aItem )
            {
                m_list.erase( m_list.begin() + i );
                m_backupList.push_back( aItem );
                return;
            }
        }
    }

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

Member Data Documentation

AllBoardItems

const KICAD_T GENERAL_COLLECTOR::AllBoardItems

static

Initial value:

= {
    
    
    
    PCB_MARKER_T,           
    PCB_TEXT_T,             
    PCB_SHAPE_T,            
    PCB_DIM_ALIGNED_T,      
    PCB_DIM_CENTER_T,       
    PCB_DIM_ORTHOGONAL_T,   
    PCB_DIM_LEADER_T,       
    PCB_TARGET_T,           
    PCB_VIA_T,              
    PCB_TRACE_T,            
    PCB_ARC_T,              
    PCB_PAD_T,              
    PCB_FP_TEXT_T,          
    PCB_FOOTPRINT_T,        
    PCB_GROUP_T,            
    PCB_ZONE_T,             
    EOT
}

A scan list for all editable board items.

Definition at line 267 of file collectors.h.

Referenced by GENERAL_COLLECTOR(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), PCB_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectPoint().

BoardLevelItems

const KICAD_T GENERAL_COLLECTOR::BoardLevelItems

static

Initial value:

= {
    PCB_MARKER_T,
    PCB_TEXT_T,
    PCB_SHAPE_T,
    PCB_DIM_ALIGNED_T,
    PCB_DIM_ORTHOGONAL_T,
    PCB_DIM_CENTER_T,
    PCB_DIM_LEADER_T,
    PCB_TARGET_T,
    PCB_VIA_T,
    PCB_ARC_T,
    PCB_TRACE_T,
    PCB_FOOTPRINT_T,
    PCB_GROUP_T,
    PCB_ZONE_T,
    EOT
}

A scan list for all primary board items, omitting items which are subordinate to a FOOTPRINT, such as PAD and FP_TEXT.

Definition at line 278 of file collectors.h.

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

Dimensions

const KICAD_T GENERAL_COLLECTOR::Dimensions

static

Initial value:

= {
    PCB_DIM_ALIGNED_T,
    PCB_DIM_LEADER_T,
    PCB_DIM_ORTHOGONAL_T,
    PCB_DIM_CENTER_T,
    EOT
}

A scan list for dimensions.

Definition at line 308 of file collectors.h.

Referenced by PCB_BASE_EDIT_FRAME::unitsChangeRefresh().

DraggableItems

const KICAD_T GENERAL_COLLECTOR::DraggableItems

static

Initial value:

= {
    PCB_TRACE_T,
    PCB_VIA_T,
    PCB_FOOTPRINT_T,
    PCB_ARC_T,
    EOT
}

A scan list for items that can be dragged.

Definition at line 313 of file collectors.h.

Referenced by ROUTER_TOOL::CanInlineDrag(), and EDIT_TOOL::Init().

FootprintItems

const KICAD_T GENERAL_COLLECTOR::FootprintItems

static

Initial value:

= {
    PCB_FP_TEXT_T,
    PCB_FP_SHAPE_T,
    PCB_PAD_T,
    PCB_FP_ZONE_T,
    PCB_GROUP_T,
    EOT
    }

A scan list for primary footprint items.

Definition at line 293 of file collectors.h.

Referenced by PCB_CONTROL::DeleteItemCursor(), PANEL_SETUP_LAYERS::getNonRemovableLayers(), PCB_SELECTION_TOOL::RebuildSelection(), PCB_SELECTION_TOOL::selectionContains(), and PCB_SELECTION_TOOL::selectPoint().

Footprints

const KICAD_T GENERAL_COLLECTOR::Footprints

static

Initial value:

= {
    PCB_FOOTPRINT_T,
    EOT
}

A scan list for only FOOTPRINTs.

Definition at line 283 of file collectors.h.

LockableItems

const KICAD_T GENERAL_COLLECTOR::LockableItems

static

Initial value:

= {
    PCB_FOOTPRINT_T,
    PCB_GROUP_T,  
    PCB_TRACE_T,
    PCB_ARC_T,
    PCB_VIA_T,
    EOT
}

A scan list for TRACKs, VIAs, FOOTPRINTs.

Definition at line 303 of file collectors.h.

m_backupList

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

protectedinherited

Definition at line 255 of file collector.h.

Referenced by COLLECTOR::Combine(), COLLECTOR::HasAdditionalItems(), and COLLECTOR::Transfer().

m_Guide

const COLLECTORS_GUIDE* GENERAL_COLLECTOR::m_Guide

protected

Determine 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

Definition at line 258 of file collector.h.

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

m_list

std::vector<EDA_ITEM*> COLLECTOR::m_list

protectedinherited

Definition at line 254 of file collector.h.

Referenced by COLLECTOR::Append(), COLLECTOR::begin(), GERBER_COLLECTOR::Collect(), Collect(), COLLECTOR::Combine(), COLLECTOR::CountType(), COLLECTOR::Empty(), COLLECTOR::end(), COLLECTOR::GetCount(), COLLECTOR::HasItem(), EE_COLLECTOR::IsCorner(), GERBER_COLLECTOR::operator[](), EE_COLLECTOR::operator[](), COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), COLLECTOR::Remove(), and COLLECTOR::Transfer().

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

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

m_MenuTitle

wxString COLLECTOR::m_MenuTitle

inherited

Definition at line 250 of file collector.h.

Referenced by GERBVIEW_SELECTION_TOOL::disambiguationMenu(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), and PCB_SELECTION_TOOL::doSelectionMenu().

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

Referenced by COLLECTOR::GetBoundingBox().

m_refPos

wxPoint COLLECTOR::m_refPos

protectedinherited

Definition at line 259 of file collector.h.

Referenced by EE_COLLECTOR::Inspect(), GERBER_COLLECTOR::Inspect(), Inspect(), and COLLECTOR::SetRefPos().

m_scanTypes

const KICAD_T* COLLECTOR::m_scanTypes

protectedinherited

Definition at line 257 of file collector.h.

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

m_Threshold

int COLLECTOR::m_Threshold

inherited

Definition at line 248 of file collector.h.

Referenced by EE_COLLECTOR::Collect(), EE_SELECTION_TOOL::CollectHits(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EE_SELECTION_TOOL::GetNode(), EE_COLLECTOR::Inspect(), and EE_SELECTION_TOOL::narrowSelection().

PadsOrTracks

const KICAD_T GENERAL_COLLECTOR::PadsOrTracks

static

Initial value:

= {
    PCB_PAD_T,
    PCB_VIA_T,
    PCB_TRACE_T,
    PCB_ARC_T,
    EOT
}

A scan list for PADs, TRACKs, or VIAs.

Definition at line 288 of file collectors.h.

Referenced by BOARD_INSPECTION_TOOL::highlightNet().

Tracks

const KICAD_T GENERAL_COLLECTOR::Tracks

static

Initial value:

= {
    PCB_TRACE_T,
    PCB_ARC_T,
    PCB_VIA_T,
    EOT
}

A scan list for only TRACKs.

Definition at line 298 of file collectors.h.

Referenced by EDIT_TOOL::Init(), EDIT_TOOL::Properties(), PCB_EDIT_FRAME::setupUIConditions(), and BOARD::TracksInNet().

Zones

const KICAD_T GENERAL_COLLECTOR::Zones

static

Initial value:

= {
    PCB_ZONE_T,
    PCB_FP_ZONE_T,
    EOT
}

A scan list for zones outlines only.

Definition at line 272 of file collectors.h.

Referenced by BOARD_INSPECTION_TOOL::highlightNet(), and PCB_EDIT_FRAME::setupUIConditions().

---

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

• collectors.h
• collectors.cpp