KiCad PCB EDA Suite
Loading...
Searching...
No Matches
ee_collectors.cpp
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
5 * Copyright (C) 2004-2022 KiCad Developers, see AUTHORS.txt for contributors.
6 * Copyright (C) 2019 CERN
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <macros.h>
27#include <trace_helpers.h>
28#include <ee_collectors.h>
29#include <sch_bus_entry.h>
30#include <sch_symbol.h>
31#include <sch_line.h>
32#include <sch_screen.h>
33#include <sch_sheet_path.h>
34#include <transform.h>
35#include "sch_reference_list.h"
36
37
38const std::vector<KICAD_T> EE_COLLECTOR::EditableItems = {
56};
57
58
59const std::vector<KICAD_T> EE_COLLECTOR::MovableItems =
60{
72 SCH_TABLECELL_T, // will be promoted to parent table(s)
82};
83
84
85const std::vector<KICAD_T> EE_COLLECTOR::FieldOwners = {
89};
90
91
93{
94 if( m_Unit || m_BodyStyle )
95 {
96 SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( aItem );
97
98 // Special selection rules apply to pins of different units when edited in synchronized
99 // pins mode. Leave it to EE_SELECTION_TOOL::Selectable() to decide what to do with them.
100
101 if( schItem && schItem->Type() != SCH_PIN_T )
102 {
103 if( m_Unit && schItem->GetUnit() && schItem->GetUnit() != m_Unit )
104 return INSPECT_RESULT::CONTINUE;
105
106 if( m_BodyStyle && schItem->GetBodyStyle() && schItem->GetBodyStyle() != m_BodyStyle )
107 return INSPECT_RESULT::CONTINUE;
108 }
109 }
110
112 aItem->SetFlags( SHOW_ELEC_TYPE );
113
114 if( aItem->HitTest( m_refPos, m_Threshold ) )
115 Append( aItem );
116
117 aItem->ClearFlags( SHOW_ELEC_TYPE );
118
119 return INSPECT_RESULT::CONTINUE;
120}
121
122
123void EE_COLLECTOR::Collect( SCH_SCREEN* aScreen, const std::vector<KICAD_T>& aFilterList,
124 const VECTOR2I& aPos, int aUnit, int aConvert )
125{
126 Empty(); // empty the collection just in case
127
128 SetScanTypes( aFilterList );
129 m_Unit = aUnit;
130 m_BodyStyle = aConvert;
131
132 // remember where the snapshot was taken from and pass refPos to the Inspect() function.
133 SetRefPos( aPos );
134
135 if( aScreen )
136 {
137 for( SCH_ITEM *item : aScreen->Items().Overlapping( SCH_LOCATE_ANY_T, aPos, m_Threshold ) )
138 item->Visit( m_inspector, nullptr, m_scanTypes );
139 }
140}
141
142
143void EE_COLLECTOR::Collect( LIB_ITEMS_CONTAINER& aItems, const std::vector<KICAD_T>& aFilterList,
144 const VECTOR2I& aPos, int aUnit, int aConvert )
145{
146 Empty(); // empty the collection just in case
147
148 SetScanTypes( aFilterList );
149 m_Unit = aUnit;
150 m_BodyStyle = aConvert;
151
152 // remember where the snapshot was taken from and pass refPos to the Inspect() function.
153 SetRefPos( aPos );
154
155 for( SCH_ITEM& item : aItems )
156 {
157 if( item.Visit( m_inspector, nullptr, m_scanTypes ) == INSPECT_RESULT::QUIT )
158 break;
159 }
160}
161
162
164{
165 if( GetCount() != 2 )
166 return false;
167
168 bool is_busentry0 = ( dynamic_cast<SCH_BUS_ENTRY_BASE*>( m_list[0] ) != nullptr );
169 bool is_busentry1 = ( dynamic_cast<SCH_BUS_ENTRY_BASE*>( m_list[1] ) != nullptr );
170
171 if(( m_list[0]->Type() == SCH_LINE_T) && ( m_list[1]->Type() == SCH_LINE_T) )
172 return ( ( SCH_LINE* ) m_list[0])->GetLayer() == ( ( SCH_LINE* ) m_list[1])->GetLayer();
173
174 if(( m_list[0]->Type() == SCH_LINE_T) && is_busentry1 )
175 return true;
176
177 if( is_busentry0 && ( m_list[1]->Type() == SCH_LINE_T) )
178 return true;
179
180 return false;
181}
182
183
184void CollectOtherUnits( const wxString& aRef, int aUnit, const LIB_ID& aLibId,
185 SCH_SHEET_PATH& aSheet, std::vector<SCH_SYMBOL*>* otherUnits )
186{
187 SCH_REFERENCE_LIST symbols;
188 aSheet.GetSymbols( symbols );
189
190 for( unsigned i = 0; i < symbols.GetCount(); i++ )
191 {
192 SCH_REFERENCE symbol = symbols[i];
193
194 if( symbol.GetRef() == aRef
195 && symbol.GetSymbol()->GetLibId() == aLibId
196 && symbol.GetUnit() != aUnit )
197 {
198 otherUnits->push_back( symbol.GetSymbol() );
199 }
200 }
201}
202
203
INSPECTOR_FUNC m_inspector
Definition: collector.h:244
void Empty()
Clear the list.
Definition: collector.h:89
VECTOR2I m_refPos
Definition: collector.h:246
int GetCount() const
Return the number of objects in the list.
Definition: collector.h:81
void SetScanTypes(const std::vector< KICAD_T > &aTypes)
Record the list of KICAD_T types to consider for collection by the Inspect() function.
Definition: collector.h:211
void SetRefPos(const VECTOR2I &aRefPos)
Definition: collector.h:213
std::vector< KICAD_T > m_scanTypes
Definition: collector.h:243
std::vector< EDA_ITEM * > m_list
Definition: collector.h:240
int m_Threshold
Definition: collector.h:234
void Append(EDA_ITEM *item)
Add an item to the end of the list.
Definition: collector.h:99
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:126
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:100
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:128
virtual bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const
Test if aPosition is inside or on the boundary of this item.
Definition: eda_item.h:215
bool m_ShowPinElectricalTypes
static const std::vector< KICAD_T > MovableItems
Definition: ee_collectors.h:43
bool IsCorner() const
Test if the collected items form a corner of two line segments.
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.
static const std::vector< KICAD_T > EditableItems
Definition: ee_collectors.h:42
static const std::vector< KICAD_T > FieldOwners
Definition: ee_collectors.h:44
EE_TYPE Overlapping(const BOX2I &aRect) const
Definition: sch_rtree.h:243
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:38
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:174
int GetBodyStyle() const
Definition: sch_item.h:240
int GetUnit() const
Definition: sch_item.h:237
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:41
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
size_t GetCount() const
A helper to define a symbol's reference designator in a schematic.
SCH_SYMBOL * GetSymbol() const
wxString GetRef() const
int GetUnit() const
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:108
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, bool aForceIncludeOrphanSymbols=false) const
Adds SCH_REFERENCE object to aReferences for each symbol in the sheet.
const LIB_ID & GetLibId() const override
Definition: sch_symbol.h:194
INSPECT_RESULT
Definition: eda_item.h:43
#define SHOW_ELEC_TYPE
Show pin electrical type. Shared with IS_ROLLOVER.
void CollectOtherUnits(const wxString &aRef, int aUnit, const LIB_ID &aLibId, SCH_SHEET_PATH &aSheet, std::vector< SCH_SYMBOL * > *otherUnits)
This file contains miscellaneous commonly used macros and functions.
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
wxLogTrace helper definitions.
@ SCH_TABLE_T
Definition: typeinfo.h:165
@ SCH_LINE_T
Definition: typeinfo.h:163
@ SCH_NO_CONNECT_T
Definition: typeinfo.h:160
@ SCH_SYMBOL_T
Definition: typeinfo.h:172
@ SCH_TABLECELL_T
Definition: typeinfo.h:166
@ SCH_FIELD_T
Definition: typeinfo.h:150
@ SCH_DIRECTIVE_LABEL_T
Definition: typeinfo.h:171
@ SCH_LABEL_T
Definition: typeinfo.h:167
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:198
@ SCH_SHEET_T
Definition: typeinfo.h:174
@ SCH_MARKER_T
Definition: typeinfo.h:158
@ SCH_SHAPE_T
Definition: typeinfo.h:149
@ SCH_RULE_AREA_T
Definition: typeinfo.h:170
@ SCH_HIER_LABEL_T
Definition: typeinfo.h:169
@ SCH_BUS_BUS_ENTRY_T
Definition: typeinfo.h:162
@ SCH_LABEL_LOCATE_ANY_T
Definition: typeinfo.h:190
@ SCH_SHEET_PIN_T
Definition: typeinfo.h:173
@ SCH_TEXT_T
Definition: typeinfo.h:151
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:161
@ SCH_BITMAP_T
Definition: typeinfo.h:164
@ SCH_TEXTBOX_T
Definition: typeinfo.h:152
@ SCH_GLOBAL_LABEL_T
Definition: typeinfo.h:168
@ SCH_JUNCTION_T
Definition: typeinfo.h:159
@ SCH_PIN_T
Definition: typeinfo.h:153