#include <ee_collectors.h>

Inheritance diagram for EE_COLLECTOR:

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

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

Public Member Functions
	EE_COLLECTOR (const KICAD_T *aScanTypes=EE_COLLECTOR::AllItems)

SCH_ITEM *	operator[] (int aIndex) const override
	Overload COLLECTOR::operator[](int) to return a SCH_ITEM instead of an EDA_ITEM. More...

SEARCH_RESULT	Inspect (EDA_ITEM aItem, void aTestData) override

void	Collect (SCH_SCREEN *aScreen, const KICAD_T aFilterList[], const wxPoint &aPos, int aUnit=0, int aConvert=0)
	Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection. More...

void	Collect (LIB_ITEMS_CONTAINER &aItems, const KICAD_T aFilterList[], const wxPoint &aPos, int aUnit=0, int aConvert=0)
	Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection. More...

bool	IsCorner () const
	Function IsCorner tests if the collected items forms as corner of two line segments. 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_Unit

int	m_Convert

int	m_Threshold

wxString	m_MenuTitle

bool	m_MenuCancelled

Static Public Attributes
static const KICAD_T	AllItems []

static const KICAD_T	EditableItems []

static const KICAD_T	ComponentsOnly []

static const KICAD_T	SheetsOnly []

static const KICAD_T	FieldOwners []

Protected Attributes
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

EE_COLLECTOR.

Definition at line 42 of file ee_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

◆ EE_COLLECTOR()

EE_COLLECTOR::EE_COLLECTOR ( const KICAD_T * aScanTypes = EE_COLLECTOR::AllItems )

inline

Definition at line 51 of file ee_collectors.h.

                                                                      :
         m_Unit( 0 ),
         m_Convert( 0 )
     {
         SetScanTypes( aScanTypes );
     }

References 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 GENERAL_COLLECTOR::Collect(), EDIT_TOOL::CreateArray(), EDIT_TOOL::doMoveSelection(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForGroups(), EDIT_TOOL::Flip(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_TYPE_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), ROUTER_TOOL::NeighboringSegmentFilter(), POSITION_RELATIVE_TOOL::PositionRelative(), PCB_SELECTION_TOOL::RequestSelection(), EDIT_TOOL::Rotate(), PCB_SELECTION_TOOL::selectMultiple(), PL_SELECTION_TOOL::SelectPoint(), and GERBVIEW_SELECTION_TOOL::selectPoint().

◆ begin() [1/2]

ITER COLLECTOR::begin ( )

inlineinherited

Definition at line 79 of file collector.h.

79 { return m_list.begin(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:254

References COLLECTOR::m_list.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const

inlineinherited

Definition at line 81 of file collector.h.

81 { return m_list.cbegin(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:254

References COLLECTOR::m_list.

◆ Collect() [1/2]

void EE_COLLECTOR::Collect	(	SCH_SCREEN *	aScreen,
		const KICAD_T	aFilterList[],
		const wxPoint &	aPos,
		int	aUnit = `0`,
		int	aConvert = `0`
	)

Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection.

Parameters

aScreen	The eeschema screen to use for scanning
aFilterList	A list of KICAD_T types with a terminating EOT, that determines what is to be collected and the priority order of the resulting collection.
aPos	A wxPoint to use in hit-testing.
aUnit	A symbol unit filter (for symbol editor)
aConvert	A DeMorgan filter (for symbol editor)

Definition at line 108 of file ee_collectors.cpp.

 {
     Empty(); // empty the collection just in case
 
     SetScanTypes( aFilterList );
     m_Unit    = aUnit;
     m_Convert = aConvert;
 
     // remember where the snapshot was taken from and pass refPos to the Inspect() function.
     SetRefPos( aPos );
 
     if( aScreen )
     {
         // Components and sheets own their own children so have to be visited even if
         // they're not in the filter list
         bool componentsVisited = false;
         bool sheetsVisited = false;
         bool globalLabelsVisited = false;
 
         for( const KICAD_T* filter = aFilterList; *filter != EOT; ++filter )
         {
             for( SCH_ITEM* item : aScreen->Items().OfType( *filter ) )
             {
                 if( *filter == SCH_COMPONENT_T || *filter == SCH_LOCATE_ANY_T )
                     componentsVisited = true;
 
                 if( *filter == SCH_SHEET_T || *filter == SCH_LOCATE_ANY_T )
                     sheetsVisited = true;
 
                 if( *filter == SCH_GLOBAL_LABEL_T || *filter == SCH_LOCATE_ANY_T )
                     globalLabelsVisited = true;
 
                 item->Visit( m_inspector, nullptr, m_scanTypes );
             }
         }
 
         if( !componentsVisited )
         {
             for( SCH_ITEM* item : aScreen->Items().OfType( SCH_COMPONENT_T ) )
                 item->Visit( m_inspector, nullptr, m_scanTypes );
         }
 
         if( !sheetsVisited )
         {
             for( SCH_ITEM* item : aScreen->Items().OfType( SCH_SHEET_T ) )
                 item->Visit( m_inspector, nullptr, m_scanTypes );
         }
 
         if( !globalLabelsVisited )
         {
             for( SCH_ITEM* item : aScreen->Items().OfType( SCH_GLOBAL_LABEL_T ) )
                 item->Visit( m_inspector, nullptr, m_scanTypes );
         }
     }
 }

References COLLECTOR::Empty(), EOT, SCH_SCREEN::Items(), m_Convert, COLLECTOR::m_inspector, COLLECTOR::m_scanTypes, m_Unit, EE_RTREE::OfType(), SCH_COMPONENT_T, SCH_GLOBAL_LABEL_T, SCH_LOCATE_ANY_T, SCH_SHEET_T, COLLECTOR::SetRefPos(), and COLLECTOR::SetScanTypes().

Referenced by EE_SELECTION_TOOL::CollectHits(), SCH_EDIT_TOOL::DeleteItemCursor(), and EE_SELECTION_TOOL::GetNode().

◆ Collect() [2/2]

void EE_COLLECTOR::Collect	(	LIB_ITEMS_CONTAINER &	aItems,
		const KICAD_T	aFilterList[],
		const wxPoint &	aPos,
		int	aUnit = `0`,
		int	aConvert = `0`
	)

Function Collect scans a EDA_ITEM using this class's Inspector method, which does the collection.

Parameters

aItems	The LIB_PART multivector holding the part components
aFilterList	A list of KICAD_T types with a terminating EOT, that determines what is to be collected and the priority order of the resulting collection.
aPos	A wxPoint to use in hit-testing.
aUnit	A symbol unit filter (for symbol editor)
aConvert	A DeMorgan filter (for symbol editor)

Definition at line 166 of file ee_collectors.cpp.

 {
     Empty();        // empty the collection just in case
 
     SetScanTypes( aFilterList );
     m_Unit = aUnit;
     m_Convert = aConvert;
 
     // remember where the snapshot was taken from and pass refPos to the Inspect() function.
     SetRefPos( aPos );
 
     for( LIB_ITEM& item : aItems )
     {
         if( item.Visit( m_inspector, nullptr, m_scanTypes ) == SEARCH_RESULT::QUIT )
             break;
     }
 }

References COLLECTOR::Empty(), m_Convert, COLLECTOR::m_inspector, COLLECTOR::m_scanTypes, m_Unit, QUIT, COLLECTOR::SetRefPos(), and COLLECTOR::SetScanTypes().

◆ 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 Collect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::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().

◆ end() [1/2]

ITER COLLECTOR::end ( )

inlineinherited

Definition at line 80 of file collector.h.

80 { return m_list.end(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:254

References COLLECTOR::m_list.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const

inlineinherited

Definition at line 82 of file collector.h.

82 { return m_list.cend(); }

COLLECTOR::m_list

std::vector< EDA_ITEM * > m_list

Definition: collector.h:254

References COLLECTOR::m_list.

◆ GetBoundingBox()

const EDA_RECT& COLLECTOR::GetBoundingBox ( ) const

inlineinherited

Definition at line 227 of file collector.h.

227 { return m_refBox; }

COLLECTOR::m_refBox

EDA_RECT m_refBox

Definition: collector.h:260

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(), FOOTPRINT::CoverageRatio(), EDIT_TOOL::CreateArray(), 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::FilterCollectorForGroups(), EDIT_TOOL::Flip(), 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(), PL_SELECTION_TOOL::guessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), EE_SELECTION_TOOL::GuessSelectionCandidates(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), IsCorner(), CONVERT_TOOL::LinesToPoly(), EE_SELECTION_TOOL::Main(), DSN::SPECCTRA_DB::makeIMAGE(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), EE_SELECTION_TOOL::narrowSelection(), ROUTER_TOOL::NeighboringSegmentFilter(), operator[](), GERBER_COLLECTOR::operator[](), COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PadFilter(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Rotate(), 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().

◆ 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::CreateArray(), EDIT_TOOL::doMoveSelection(), EDIT_TOOL::Drag(), EDIT_TOOL::Duplicate(), PCB_SELECTION_TOOL::FilterCollectorForGroups(), EDIT_TOOL::Flip(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), POSITION_RELATIVE_TOOL::PositionRelative(), and EDIT_TOOL::Rotate().

◆ Inspect()

SEARCH_RESULT EE_COLLECTOR::Inspect	(	EDA_ITEM *	aItem,
		void *	aTestData
	)

overridevirtual

Reimplemented from COLLECTOR.

Definition at line 82 of file ee_collectors.cpp.

 {
     if( aItem->Type() == LIB_PIN_T )
     {
         // Special selection rules apply to pins of different units when edited in
         // synchronized pins mode.  Leave it to EE_SELECTION_TOOL::Selectable() to
         // decide what to do with them.
     }
     else if( m_Unit || m_Convert )
     {
         LIB_ITEM* lib_item = dynamic_cast<LIB_ITEM*>( aItem );
 
         if( m_Unit && lib_item && lib_item->GetUnit() && lib_item->GetUnit() != m_Unit )
             return SEARCH_RESULT::CONTINUE;
 
         if( m_Convert && lib_item && lib_item->GetConvert() && lib_item->GetConvert() != m_Convert )
             return SEARCH_RESULT::CONTINUE;
     }
 
     if( aItem->HitTest( m_refPos, m_Threshold ) )
         Append( aItem );
 
     return SEARCH_RESULT::CONTINUE;
 }

References COLLECTOR::Append(), CONTINUE, LIB_ITEM::GetConvert(), LIB_ITEM::GetUnit(), EDA_ITEM::HitTest(), LIB_PIN_T, m_Convert, COLLECTOR::m_refPos, COLLECTOR::m_Threshold, m_Unit, and EDA_ITEM::Type().

◆ IsCorner()

bool EE_COLLECTOR::IsCorner ( ) const

Function IsCorner tests if the collected items forms as corner of two line segments.

Returns: True if the collected items form a corner of two line segments.

Definition at line 186 of file ee_collectors.cpp.

 {
     if( GetCount() != 2 )
         return false;
 
     bool is_busentry0 = ( dynamic_cast<SCH_BUS_ENTRY_BASE*>( m_list[0] ) != NULL);
     bool is_busentry1 = ( dynamic_cast<SCH_BUS_ENTRY_BASE*>( m_list[1] ) != NULL);
 
     if(( m_list[0]->Type() == SCH_LINE_T) && ( m_list[1]->Type() == SCH_LINE_T) )
         return ( ( SCH_LINE* ) m_list[0])->GetLayer() == ( ( SCH_LINE* ) m_list[1])->GetLayer();
 
     if(( m_list[0]->Type() == SCH_LINE_T) && is_busentry1 )
         return true;
 
     if( is_busentry0 && ( m_list[1]->Type() == SCH_LINE_T) )
         return true;
 
     return false;
 }

References COLLECTOR::GetCount(), GetLayer(), COLLECTOR::m_list, NULL, and SCH_LINE_T.

◆ operator[]()

SCH_ITEM* EE_COLLECTOR::operator[] ( int aIndex ) const

inlineoverridevirtual

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

Parameters

aIndex The index into the list.

Returns: SCH_ITEM* at aIndex or NULL.

Reimplemented from COLLECTOR.

Definition at line 64 of file ee_collectors.h.

     {
         if( (unsigned)aIndex < (unsigned)GetCount() )
             return (SCH_ITEM*) m_list[ aIndex ];
 
         return NULL;
     }

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

◆ 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::CreateArray(), 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::FilterCollectorForGroups(), EDIT_TOOL::Flip(), EDIT_TOOL::FootprintFilter(), ALIGN_DISTRIBUTE_TOOL::GetSelections(), BOARD_INSPECTION_TOOL::highlightNet(), CONVERT_TOOL::LinesToPoly(), EDIT_TOOL::Mirror(), EDIT_TOOL::MoveExact(), EE_SELECTION_TOOL::narrowSelection(), EDIT_TOOL::PadFilter(), CONVERT_TOOL::PolyToLines(), POSITION_RELATIVE_TOOL::PositionRelative(), EDIT_TOOL::Rotate(), 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.

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const wxPoint & aRefPos )

inlineinherited

Definition at line 225 of file collector.h.

225 { m_refPos = aRefPos; }

COLLECTOR::m_refPos

wxPoint m_refPos

Definition: collector.h:259

References COLLECTOR::m_refPos.

Referenced by Collect(), GERBER_COLLECTOR::Collect(), and GENERAL_COLLECTOR::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 Collect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), EE_COLLECTOR(), GENERAL_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

◆ AllItems

const KICAD_T EE_COLLECTOR::AllItems

static

Initial value:

= {
    SCH_LOCATE_ANY_T,
    EOT
}

Definition at line 45 of file ee_collectors.h.

Referenced by EE_SELECTION_TOOL::Main().

◆ ComponentsOnly

const KICAD_T EE_COLLECTOR::ComponentsOnly

static

Initial value:

= {
    SCH_COMPONENT_T,
    EOT
}

Definition at line 47 of file ee_collectors.h.

Referenced by SCH_EDIT_TOOL::ChangeSymbols(), SCH_EDIT_TOOL::ConvertDeMorgan(), SCH_EDITOR_CONTROL::EditWithLibEdit(), EE_INSPECTION_TOOL::ShowDatasheet(), and SCH_EDIT_FRAME::UpdateSymbolFromEditor().

◆ EditableItems

const KICAD_T EE_COLLECTOR::EditableItems

static

Initial value:

= {
    SCH_TEXT_T,
    SCH_LABEL_T,
    SCH_GLOBAL_LABEL_T,
    SCH_HIER_LABEL_T,
    SCH_FIELD_T,
    SCH_COMPONENT_T,
    SCH_SHEET_PIN_T,
    SCH_SHEET_T,
    SCH_BITMAP_T,
    SCH_LINE_T,
    SCH_BUS_WIRE_ENTRY_T,
    SCH_JUNCTION_T,
    EOT
}

Definition at line 46 of file ee_collectors.h.

Referenced by SCH_EDIT_TOOL::Properties().

◆ FieldOwners

const KICAD_T EE_COLLECTOR::FieldOwners

static

Initial value:

= {
    SCH_COMPONENT_T,
    SCH_SHEET_T,
    SCH_GLOBAL_LABEL_T,
    EOT
}

Definition at line 49 of file ee_collectors.h.

Referenced by SCH_EDIT_TOOL::AutoplaceFields().

◆ 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_Convert

int EE_COLLECTOR::m_Convert

Definition at line 111 of file ee_collectors.h.

Referenced by Collect(), and Inspect().

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector

protectedinherited

Definition at line 258 of file collector.h.

Referenced by Collect(), GERBER_COLLECTOR::Collect(), GENERAL_COLLECTOR::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(), GENERAL_COLLECTOR::Collect(), COLLECTOR::Combine(), COLLECTOR::CountType(), COLLECTOR::Empty(), COLLECTOR::end(), COLLECTOR::GetCount(), COLLECTOR::HasItem(), IsCorner(), operator[](), GERBER_COLLECTOR::operator[](), COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), COLLECTOR::Remove(), and COLLECTOR::Transfer().

◆ 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_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 Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), and COLLECTOR::SetRefPos().

◆ m_scanTypes

const KICAD_T* COLLECTOR::m_scanTypes

protectedinherited

Definition at line 257 of file collector.h.

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

◆ m_Threshold

int COLLECTOR::m_Threshold

inherited

Definition at line 248 of file collector.h.

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

◆ m_Unit

int EE_COLLECTOR::m_Unit

Definition at line 110 of file ee_collectors.h.

Referenced by Collect(), and Inspect().

◆ SheetsOnly

const KICAD_T EE_COLLECTOR::SheetsOnly

static

Initial value:

= {
    SCH_SHEET_T,
    EOT
}

Definition at line 48 of file ee_collectors.h.

Referenced by SCH_EDIT_TOOL::CleanupSheetPins(), SCH_EDIT_TOOL::EditPageNumber(), SCH_NAVIGATE_TOOL::EnterSheet(), SCH_EDITOR_CONTROL::EnterSheet(), and SCH_DRAWING_TOOLS::TwoClickPlace().

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

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ CITER

◆ ITER

Constructor & Destructor Documentation

◆ EE_COLLECTOR()

Member Function Documentation

◆ Append()

◆ begin() [1/2]

◆ begin() [2/2]

◆ Collect() [1/2]

◆ Collect() [2/2]

◆ Combine()

◆ CountType()

◆ Empty()

◆ end() [1/2]

◆ end() [2/2]

◆ GetBoundingBox()

◆ GetCount()

◆ HasAdditionalItems()

◆ HasItem()

◆ Inspect()

◆ IsCorner()

◆ operator[]()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ SetRefPos()

◆ SetScanTypes()

◆ Transfer() [1/2]

◆ Transfer() [2/2]

Member Data Documentation

◆ AllItems

◆ ComponentsOnly

◆ EditableItems

◆ FieldOwners

◆ m_backupList

◆ m_Convert

◆ m_inspector

◆ m_list

◆ m_MenuCancelled

◆ m_MenuTitle

◆ m_refBox

◆ m_refPos

◆ m_scanTypes

◆ m_Threshold

◆ m_Unit

◆ SheetsOnly