#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 std::vector< KICAD_T > &aScanTypes={ SCH_LOCATE_ANY_T })

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

INSPECT_RESULT	Inspect (EDA_ITEM aItem, void aTestData) override

void	Collect (SCH_SCREEN *aScreen, const std::vector< KICAD_T > &aScanTypes, const VECTOR2I &aPos, int aUnit=0, int aConvert=0)
	Scan a EDA_ITEM using this class's Inspector method which does the collection. More...

void	Collect (LIB_ITEMS_CONTAINER &aItems, const std::vector< KICAD_T > &aScanTypes, const VECTOR2I &aPos, int aUnit=0, int aConvert=0)
	Scan an EDA_ITEM using this class's Inspector method which does the collection. More...

bool	IsCorner () const
	Test if the collected items form a 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 std::vector< KICAD_T > &aTypes)
	Record the list of KICAD_T types to consider for collection by the Inspect() function. More...

void	SetRefPos (const VECTOR2I &aRefPos)

int	CountType (KICAD_T aType)
	Count the number of items matching aType. More...

Public Attributes
int	m_Unit

int	m_Convert

bool	m_ShowPinElectricalTypes

int	m_Threshold

wxString	m_MenuTitle

bool	m_MenuCancelled

Static Public Attributes
static const std::vector< KICAD_T >	EditableItems

static const std::vector< KICAD_T >	MovableItems

static const std::vector< KICAD_T >	FieldOwners

Protected Attributes
std::vector< EDA_ITEM * >	m_list

std::vector< EDA_ITEM * >	m_backupList

std::vector< KICAD_T >	m_scanTypes

INSPECTOR_FUNC	m_inspector

VECTOR2I	m_refPos

Detailed Description

Definition at line 39 of file ee_collectors.h.

Member Typedef Documentation

◆ CITER

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

inherited

Definition at line 71 of file collector.h.

◆ ITER

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

inherited

Definition at line 70 of file collector.h.

Constructor & Destructor Documentation

◆ EE_COLLECTOR()

EE_COLLECTOR::EE_COLLECTOR ( const std::vector< KICAD_T > & aScanTypes = { SCH_LOCATE_ANY_T } )

inline

Definition at line 46 of file ee_collectors.h.

References SCH_LOCATE_ANY_T.

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

References COLLECTOR::m_list.

Referenced by GENERAL_COLLECTOR::Collect(), EE_SELECTION_TOOL::CollectHits(), SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), Inspect(), GERBER_COLLECTOR::Inspect(), GENERAL_COLLECTOR::Inspect(), PCB_TYPE_COLLECTOR::Inspect(), PCB_LAYER_COLLECTOR::Inspect(), ROUTER_TOOL::NeighboringSegmentFilter(), PCB_SELECTION_TOOL::RequestSelection(), PCB_SELECTION_TOOL::SelectAll(), PCB_SELECTION_TOOL::selectMultiple(), and PL_SELECTION_TOOL::SelectPoint().

◆ begin() [1/2]

ITER COLLECTOR::begin ( )

inlineinherited

Definition at line 73 of file collector.h.

References COLLECTOR::m_list.

◆ begin() [2/2]

CITER COLLECTOR::begin ( ) const

inlineinherited

Definition at line 75 of file collector.h.

References COLLECTOR::m_list.

◆ Collect() [1/2]

void EE_COLLECTOR::Collect	(	LIB_ITEMS_CONTAINER &	aItems,
		const std::vector< KICAD_T > &	aScanTypes,
		const VECTOR2I &	aPos,
		int	aUnit = `0`,
		int	aConvert = `0`
	)

Scan an EDA_ITEM using this class's Inspector method which does the collection.

Parameters

aItems	is a LIB_SYMBOL multivector holding the symbol items.
aScanTypes	is a list of KICAD_T types that determines what is to be collected and the priority order of the resulting collection.
aPos	are the coordinates to use in hit testing.
aUnit	is the symbol unit filter (for symbol editor).
aConvert	is the DeMorgan filter (for symbol editor).

Definition at line 139 of file ee_collectors.cpp.

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

◆ Collect() [2/2]

void EE_COLLECTOR::Collect	(	SCH_SCREEN *	aScreen,
		const std::vector< KICAD_T > &	aScanTypes,
		const VECTOR2I &	aPos,
		int	aUnit = `0`,
		int	aConvert = `0`
	)

Scan a EDA_ITEM using this class's Inspector method which does the collection.

Parameters

aScreen	The eeschema screen to use for scanning
aScanTypes	A list of KICAD_T types that determines what is to be collected and the priority order of the resulting collection.
aPos	are the coordinates to use in hit testing.
aUnit	is the symbol unit filter (for symbol editor).
aConvert	is the DeMorgan filter (for symbol editor)

Definition at line 119 of file ee_collectors.cpp.

References COLLECTOR::Empty(), SCH_SCREEN::Items(), m_Convert, COLLECTOR::m_inspector, COLLECTOR::m_scanTypes, COLLECTOR::m_Threshold, m_Unit, EE_RTREE::Overlapping(), SCH_LOCATE_ANY_T, COLLECTOR::SetRefPos(), and COLLECTOR::SetScanTypes().

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

◆ Combine()

void COLLECTOR::Combine ( )

inlineinherited

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

Definition at line 140 of file collector.h.

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

Referenced by 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 221 of file collector.h.

References COLLECTOR::m_list.

Referenced by ROUTER_TOOL::NeighboringSegmentFilter().

◆ Empty()

void COLLECTOR::Empty ( )

inlineinherited

Clear the list.

Definition at line 89 of file collector.h.

References COLLECTOR::m_list.

Referenced by PCB_TYPE_COLLECTOR::Collect(), PCB_LAYER_COLLECTOR::Collect(), GENERAL_COLLECTOR::Collect(), GERBER_COLLECTOR::Collect(), Collect(), SELECTION_TOOL::doSelectionMenu(), PAD_TOOL::EnumeratePads(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), and ROUTER_TOOL::NeighboringSegmentFilter().

◆ end() [1/2]

ITER COLLECTOR::end ( )

inlineinherited

Definition at line 74 of file collector.h.

References COLLECTOR::m_list.

◆ end() [2/2]

CITER COLLECTOR::end ( ) const

inlineinherited

Definition at line 76 of file collector.h.

References COLLECTOR::m_list.

◆ GetCount()

int COLLECTOR::GetCount ( ) const

inlineinherited

Return the number of objects in the list.

Definition at line 81 of file collector.h.

References COLLECTOR::m_list.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), BuildBoardPolygonOutlines(), BuildFootprintPolygonOutlines(), EDIT_TOOL::ChangeTrackWidth(), EE_SELECTION_TOOL::CollectHits(), connectedItemFilter(), EDIT_TOOL::copyToClipboard(), FOOTPRINT::CoverageRatio(), CONVERT_TOOL::CreateLines(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), BOARD_INSPECTION_TOOL::DiffFootprint(), ALIGN_DISTRIBUTE_TOOL::DistributeHorizontally(), ALIGN_DISTRIBUTE_TOOL::DistributeVertically(), SELECTION_TOOL::doSelectionMenu(), EDIT_TOOL::Drag(), PAD_TOOL::EnumeratePads(), EDIT_TOOL::FilletLines(), EDIT_TOOL::FilletTracks(), PCB_SELECTION_TOOL::FilterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), EDIT_TOOL::FootprintFilter(), 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(), EE_SELECTION_TOOL::GuessSelectionCandidates(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), BOARD_INSPECTION_TOOL::highlightNet(), PCB_EDIT_FRAME::inferLegacyEdgeClearance(), IsCorner(), EE_SELECTION_TOOL::Main(), DSN::SPECCTRA_DB::makeIMAGE(), EE_SELECTION_TOOL::narrowSelection(), ROUTER_TOOL::NeighboringSegmentFilter(), COLLECTOR::operator[](), operator[](), GERBER_COLLECTOR::operator[](), PCB_COLLECTOR::operator[](), EDIT_TOOL::PackAndMoveFootprints(), EDIT_TOOL::PadFilter(), CONVERT_TOOL::SegmentToArc(), PCB_SELECTION_TOOL::selectMultiple(), GERBVIEW_SELECTION_TOOL::selectPoint(), PL_SELECTION_TOOL::SelectPoint(), PCB_SELECTION_TOOL::selectPoint(), EE_SELECTION_TOOL::selectPoint(), SCH_EDITOR_CONTROL::SimProbe(), SCH_EDITOR_CONTROL::SimTune(), EDIT_TOOL::Swap(), 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 132 of file collector.h.

References COLLECTOR::m_backupList.

Referenced by 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 195 of file collector.h.

References COLLECTOR::m_list.

Referenced by EE_SELECTION_TOOL::CollectHits(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), and PCB_SELECTION_TOOL::FilterCollectorForHierarchy().

◆ Inspect()

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

overridevirtual

Reimplemented from COLLECTOR.

Definition at line 88 of file ee_collectors.cpp.

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

◆ IsCorner()

bool EE_COLLECTOR::IsCorner ( ) const

Test if the collected items form a corner of two line segments.

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

Definition at line 159 of file ee_collectors.cpp.

References COLLECTOR::GetCount(), COLLECTOR::m_list, 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 60 of file ee_collectors.h.

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

◆ Remove() [1/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 119 of file collector.h.

References alg::delete_if(), and COLLECTOR::m_list.

◆ Remove() [2/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 109 of file collector.h.

References COLLECTOR::m_list.

Referenced by BOARD_EDITOR_CONTROL::AssignNetclass(), connectedItemFilter(), PCB_CONTROL::DeleteItemCursor(), EDIT_TOOL::Drag(), EDIT_TOOL::FilletLines(), PCB_SELECTION_TOOL::FilterCollectedItems(), PCB_SELECTION_TOOL::FilterCollectorForFreePads(), PCB_SELECTION_TOOL::FilterCollectorForHierarchy(), PCB_SELECTION_TOOL::FilterCollectorForMarkers(), EDIT_TOOL::FootprintFilter(), GROUP_TOOL::Group(), EE_SELECTION_TOOL::narrowSelection(), EDIT_TOOL::PadFilter(), GERBVIEW_SELECTION_TOOL::selectPoint(), and PCB_SELECTION_TOOL::selectPoint().

◆ SetRefPos()

void COLLECTOR::SetRefPos ( const VECTOR2I & aRefPos )

inlineinherited

Definition at line 213 of file collector.h.

References COLLECTOR::m_refPos.

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

◆ SetScanTypes()

void COLLECTOR::SetScanTypes ( const std::vector< KICAD_T > & aTypes )

inlineinherited

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

Parameters

aScanTypes A list of KICAD_Ts.

Definition at line 211 of file collector.h.

References COLLECTOR::m_scanTypes.

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

◆ Transfer() [1/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 162 of file collector.h.

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

◆ Transfer() [2/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 151 of file collector.h.

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

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

Member Data Documentation

◆ EditableItems

const std::vector< KICAD_T > EE_COLLECTOR::EditableItems

static

Initial value:

= {
 SCH_SHAPE_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T,
 SCH_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_FIELD_T,
 SCH_SYMBOL_T,
 SCH_SHEET_PIN_T,
 SCH_SHEET_T,
 SCH_BITMAP_T,
 SCH_LINE_T,
 SCH_BUS_WIRE_ENTRY_T,
 SCH_JUNCTION_T
}

Definition at line 42 of file ee_collectors.h.

Referenced by SCH_EDIT_TOOL::Properties().

◆ FieldOwners

const std::vector< KICAD_T > EE_COLLECTOR::FieldOwners

static

Initial value:

= {
 SCH_SYMBOL_T,
 SCH_SHEET_T,
 SCH_LABEL_LOCATE_ANY_T
}

Definition at line 44 of file ee_collectors.h.

Referenced by SCH_EDIT_TOOL::AutoplaceFields(), and SCH_EDIT_TOOL::Init().

◆ m_backupList

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

protectedinherited

Definition at line 241 of file collector.h.

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

◆ m_Convert

int EE_COLLECTOR::m_Convert

Definition at line 105 of file ee_collectors.h.

Referenced by Collect(), and Inspect().

◆ m_inspector

INSPECTOR_FUNC COLLECTOR::m_inspector

protectedinherited

Definition at line 244 of file collector.h.

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

◆ m_list

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

protectedinherited

Definition at line 240 of file collector.h.

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

◆ m_MenuCancelled

bool COLLECTOR::m_MenuCancelled

inherited

Definition at line 237 of file collector.h.

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

◆ m_MenuTitle

wxString COLLECTOR::m_MenuTitle

inherited

Definition at line 236 of file collector.h.

Referenced by SELECTION_TOOL::doSelectionMenu().

◆ m_refPos

VECTOR2I COLLECTOR::m_refPos

protectedinherited

Definition at line 246 of file collector.h.

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

◆ m_scanTypes

std::vector<KICAD_T> COLLECTOR::m_scanTypes

protectedinherited

Definition at line 243 of file collector.h.

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

◆ m_ShowPinElectricalTypes

bool EE_COLLECTOR::m_ShowPinElectricalTypes

Definition at line 107 of file ee_collectors.h.

Referenced by EE_SELECTION_TOOL::CollectHits(), and Inspect().

◆ m_Threshold

int COLLECTOR::m_Threshold

inherited

Definition at line 234 of file collector.h.

Referenced by Collect(), EE_SELECTION_TOOL::CollectHits(), SCH_EDIT_TOOL::DeleteItemCursor(), PCB_CONTROL::DeleteItemCursor(), EE_SELECTION_TOOL::GetNode(), EE_SELECTION_TOOL::GuessSelectionCandidates(), Inspect(), EE_SELECTION_TOOL::selectPoint(), SCH_EDITOR_CONTROL::SimProbe(), and SCH_EDITOR_CONTROL::SimTune().

◆ m_Unit

int EE_COLLECTOR::m_Unit

Definition at line 104 of file ee_collectors.h.

Referenced by Collect(), and Inspect().

◆ MovableItems

const std::vector< KICAD_T > EE_COLLECTOR::MovableItems

static

Initial value:

=
{
 SCH_MARKER_T,
 SCH_JUNCTION_T,
 SCH_NO_CONNECT_T,
 SCH_BUS_BUS_ENTRY_T,
 SCH_BUS_WIRE_ENTRY_T,
 SCH_LINE_T,
 SCH_BITMAP_T,
 SCH_SHAPE_T,
 SCH_TEXT_T,
 SCH_TEXTBOX_T,
 SCH_LABEL_T,
 SCH_GLOBAL_LABEL_T,
 SCH_HIER_LABEL_T,
 SCH_DIRECTIVE_LABEL_T,
 SCH_FIELD_T,
 SCH_SYMBOL_T,
 SCH_SHEET_PIN_T,
 SCH_SHEET_T
}

Definition at line 43 of file ee_collectors.h.

Referenced by SCH_MOVE_TOOL::AlignElements(), EE_SELECTION_TOOL::Main(), and SCH_MOVE_TOOL::Main().

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]

◆ GetCount()

◆ HasAdditionalItems()

◆ HasItem()

◆ Inspect()

◆ IsCorner()

◆ operator[]()

◆ Remove() [1/2]

◆ Remove() [2/2]

◆ SetRefPos()

◆ SetScanTypes()

◆ Transfer() [1/2]

◆ Transfer() [2/2]

Member Data Documentation

◆ EditableItems

◆ FieldOwners

◆ m_backupList

◆ m_Convert

◆ m_inspector

◆ m_list

◆ m_MenuCancelled

◆ m_MenuTitle

◆ m_refPos

◆ m_scanTypes

◆ m_ShowPinElectricalTypes

◆ m_Threshold

◆ m_Unit

◆ MovableItems