KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_item.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) 2006 Jean-Pierre Charras, [email protected]
5 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#include <pgm_base.h>
27#include <eeschema_settings.h>
28#include <eda_item.h>
29#include <sch_connection.h>
30#include <sch_group.h>
31#include <sch_rule_area.h>
32#include <sch_draw_panel.h>
33#include <sch_edit_frame.h>
34#include <connection_graph.h>
35#include <netclass.h>
39
40
41// Rendering fonts is expensive (particularly when using outline fonts). At small effective
42// sizes (ie: zoomed out) the visual differences between outline and/or stroke fonts and the
43// bitmap font becomes immaterial, and there's often more to draw when zoomed out so the
44// performance gain becomes more significant.
45#define BITMAP_FONT_SIZE_THRESHOLD 3
46
47
48/* Constructor and destructor for SCH_ITEM */
49/* They are not inline because this creates problems with gcc at linking time in debug mode */
50
51SCH_ITEM::SCH_ITEM( EDA_ITEM* aParent, KICAD_T aType, int aUnit, int aBodyStyle ) :
52 EDA_ITEM( aParent, aType, true, false ),
53 m_unit( aUnit ),
54 m_bodyStyle( aBodyStyle ),
55 m_private( false )
56{
57 m_layer = LAYER_WIRE; // It's only a default, in fact
59 m_connectivity_dirty = false; // Item is unconnected until it is placed, so it's clean
60}
61
62
64 EDA_ITEM( aItem )
65{
66 m_layer = aItem.m_layer;
67 m_unit = aItem.m_unit;
69 m_private = aItem.m_private;
72}
73
74
76{
77 m_layer = aItem.m_layer;
78 m_unit = aItem.m_unit;
80 m_private = aItem.m_private;
83
84 return *this;
85}
86
87
89{
90 for( const auto& it : m_connection_map )
91 delete it.second;
92
93 // Do not try to modify SCHEMATIC::ConnectionGraph()
94 // if the schematic does not exist
96 return;
97
98 SCHEMATIC* sch = Schematic();
99
100 if( sch != nullptr )
101 sch->ConnectionGraph()->RemoveItem( this );
102}
103
104
106{
107 switch( Type() )
108 {
109 case SCH_SYMBOL_T:
110 case SCH_PIN_T:
111 case SCH_SHAPE_T:
112 case SCH_BITMAP_T:
113 case SCH_FIELD_T:
114 case SCH_TEXT_T:
115 case SCH_TEXTBOX_T:
116 case SCH_TABLE_T:
117 case SCH_GROUP_T:
118 case SCH_LINE_T:
119 case SCH_JUNCTION_T:
120 case SCH_NO_CONNECT_T:
123 case SCH_LABEL_T:
125 case SCH_HIER_LABEL_T:
126 case SCH_RULE_AREA_T:
128 case SCH_SHEET_PIN_T:
129 case SCH_SHEET_T:
130 return true;
131 default:
132 return false;
133 }
134}
135
136
137SCH_ITEM* SCH_ITEM::Duplicate( bool addToParentGroup, SCH_COMMIT* aCommit, bool doClone ) const
138{
139 SCH_ITEM* newItem = (SCH_ITEM*) Clone();
140
141 if( !doClone )
142 const_cast<KIID&>( newItem->m_Uuid ) = KIID();
143
144 newItem->ClearFlags( SELECTED | BRIGHTENED );
145
146 newItem->RunOnChildren(
147 []( SCH_ITEM* aChild )
148 {
149 aChild->ClearFlags( SELECTED | BRIGHTENED );
150 },
152
153 if( addToParentGroup )
154 {
155 wxCHECK_MSG( aCommit, newItem, "Must supply a commit to update parent group" );
156
157 if( EDA_GROUP* group = newItem->GetParentGroup() )
158 {
159 aCommit->Modify( group->AsEdaItem(), nullptr, RECURSE_MODE::NO_RECURSE );
160 group->AddItem( newItem );
161 }
162 }
163
164 return newItem;
165}
166
167
168wxString SCH_ITEM::GetUnitDisplayName( int aUnit, bool aLabel ) const
169{
170 if( aUnit == 0 )
171 return aLabel ? _( "All units" ) : wxString( _HKI( "All units" ) );
172 else if( const SYMBOL* symbol = GetParentSymbol() )
173 return symbol->GetUnitDisplayName( aUnit, aLabel );
174
175 return wxEmptyString;
176}
177
178
179wxString SCH_ITEM::GetBodyStyleDescription( int aBodyStyle, bool aLabel ) const
180{
181 if( aBodyStyle == 0 )
182 return aLabel ? _( "All body styles" ) : wxString( _HKI( "All body styles" ) );
183 else if( const SYMBOL* symbol = GetParentSymbol() )
184 return symbol->GetBodyStyleDescription( aBodyStyle, aLabel );
185
186 return wxEmptyString;
187}
188
189void SCH_ITEM::SetBodyStyleProp( const wxString& aBodyStyle )
190{
191 if( aBodyStyle == _HKI( "All body styles" ) )
192 {
193 m_bodyStyle = 0;
194 return;
195 }
196
197 if( SYMBOL* symbol = GetParentSymbol() )
198 {
199 for( int bodyStyle : { BODY_STYLE::BASE, BODY_STYLE::DEMORGAN } )
200 {
201 if( symbol->GetBodyStyleDescription( bodyStyle, false ) == aBodyStyle )
202 {
203 m_bodyStyle = bodyStyle;
204 return;
205 }
206 }
207 }
208}
209
210
212{
213 return GetBodyStyleDescription( m_bodyStyle, false );
214}
215
216
218{
219 return static_cast<SCHEMATIC*>( findParent( SCHEMATIC_T ) );
220}
221
222
224{
225 if( SYMBOL* sch_symbol = static_cast<SCH_SYMBOL*>( findParent( SCH_SYMBOL_T ) ) )
226 return sch_symbol;
227
228 if( SYMBOL* lib_symbol = static_cast<LIB_SYMBOL*>( findParent( LIB_SYMBOL_T ) ) )
229 return lib_symbol;
230
231 return nullptr;
232}
233
234
236{
237 if( SYMBOL* sch_symbol = static_cast<SCH_SYMBOL*>( findParent( SCH_SYMBOL_T ) ) )
238 return sch_symbol;
239
240 if( SYMBOL* lib_symbol = static_cast<LIB_SYMBOL*>( findParent( LIB_SYMBOL_T ) ) )
241 return lib_symbol;
242
243 return nullptr;
244}
245
246
248{
249 if( GetExcludedFromSim() )
250 return true;
251
252 for( SCH_RULE_AREA* area : m_rule_areas_cache )
253 {
254 if( area->GetExcludedFromSim() )
255 return true;
256 }
257
258 return false;
259}
260
261
263{
264 if( GetExcludedFromBOM() )
265 return true;
266
267 for( SCH_RULE_AREA* area : m_rule_areas_cache )
268 {
269 if( area->GetExcludedFromBOM() )
270 return true;
271 }
272
273 return false;
274}
275
276
278{
280 return true;
281
282 for( SCH_RULE_AREA* area : m_rule_areas_cache )
283 {
284 if( area->GetExcludedFromBoard() )
285 return true;
286 }
287
288 return false;
289}
290
291
293{
294 if( GetDNP() )
295 return true;
296
297 for( SCH_RULE_AREA* area : m_rule_areas_cache )
298 {
299 if( area->GetDNP() )
300 return true;
301 }
302
303 return false;
304}
305
306
307std::vector<int> SCH_ITEM::ViewGetLayers() const
308{
309 // Basic fallback
311}
312
313
314bool SCH_ITEM::IsConnected( const VECTOR2I& aPosition ) const
315{
316 if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
317 return false;
318
319 return doIsConnected( aPosition );
320}
321
322
324{
325 if( !IsConnectable() )
326 return nullptr;
327
328 if( !aSheet )
329 aSheet = &Schematic()->CurrentSheet();
330
331 auto it = m_connection_map.find( *aSheet );
332
333 if( it == m_connection_map.end() )
334 return nullptr;
335 else
336 return it->second;
337}
338
339
341{
342 for( auto& [path, conn] : m_connection_map )
343 {
344 conn->SetGraph( aGraph );
345
346 for( auto& member : conn->AllMembers() )
347 member->SetGraph( aGraph );
348 }
349}
350
351
352std::shared_ptr<NETCLASS> SCH_ITEM::GetEffectiveNetClass( const SCH_SHEET_PATH* aSheet ) const
353{
354 static std::shared_ptr<NETCLASS> nullNetclass = std::make_shared<NETCLASS>( wxEmptyString );
355
356 SCHEMATIC* schematic = Schematic();
357
358 if( schematic )
359 {
360 std::shared_ptr<NET_SETTINGS>& netSettings = schematic->Project().GetProjectFile().m_NetSettings;
361 SCH_CONNECTION* connection = Connection( aSheet );
362
363 if( connection )
364 return netSettings->GetEffectiveNetClass( connection->Name() );
365 else
366 return netSettings->GetDefaultNetclass();
367 }
368
369 return nullNetclass;
370}
371
372
374{
375 auto it = m_connected_items.find( aSheet );
376
377 if( it != m_connected_items.end() )
378 it->second.clear();
379}
380
381
383{
384 return m_connected_items[ aSheet ];
385}
386
387
389{
390 SCH_ITEM_VEC& vec = m_connected_items[ aSheet ];
391
392 // The vector elements are small, so reserve 1k at a time to prevent re-allocations
393 if( vec.size() == vec.capacity() )
394 vec.reserve( vec.size() + 4096 );
395
396 // Add item to the correct place in the sorted vector if it is not already there
397 auto it = std::lower_bound( vec.begin(), vec.end(), aItem );
398
399 if( it == vec.end() || *it != aItem )
400 vec.insert( it, aItem );
401}
402
403
405 CONNECTION_GRAPH* aGraph )
406{
407 SCH_CONNECTION* connection = Connection( &aSheet );
408
409 // N.B. Do not clear the dirty connectivity flag here because we may need
410 // to create a connection for a different sheet, and we don't want to
411 // skip the connection creation because the flag is cleared.
412 if( connection )
413 {
414 connection->Reset();
415 }
416 else
417 {
418 connection = new SCH_CONNECTION( this );
419 m_connection_map.insert( std::make_pair( aSheet, connection ) );
420 }
421
422 connection->SetGraph( aGraph );
423 connection->SetSheet( aSheet );
424 return connection;
425}
426
427
429 CONNECTION_GRAPH* aGraph )
430{
431 if( !IsConnectable() )
432 return nullptr;
433
434 SCH_CONNECTION* connection = Connection( &aSheet );
435
436 if( connection )
437 return connection;
438 else
439 return InitializeConnection( aSheet, aGraph );
440}
441
442
443const wxString& SCH_ITEM::GetCachedDriverName() const
444{
445 static wxString s_empty;
446 return s_empty;
447}
448
449
451{
453}
454
455
457{
458 if( aImage == nullptr )
459 return;
460
461 EDA_ITEM* parent = GetParent();
462
463 SwapFlags( aImage );
464 std::swap( m_layer, aImage->m_layer );
465 std::swap( m_unit, aImage->m_unit );
466 std::swap( m_bodyStyle, aImage->m_bodyStyle );
467 std::swap( m_private, aImage->m_private );
468 std::swap( m_fieldsAutoplaced, aImage->m_fieldsAutoplaced );
469 std::swap( m_group, aImage->m_group );
470 swapData( aImage );
471
472 SetParent( parent );
473}
474
475
477{
478 EDA_ITEM_FLAGS editFlags = GetEditFlags();
479 EDA_ITEM_FLAGS tempFlags = GetTempFlags();
480 EDA_ITEM_FLAGS aItem_editFlags = aItem->GetEditFlags();
481 EDA_ITEM_FLAGS aItem_tempFlags = aItem->GetTempFlags();
482
483 std::swap( m_flags, aItem->m_flags );
484
486 SetFlags( editFlags );
488 SetFlags( tempFlags );
489
490 aItem->ClearEditFlags();
491 aItem->SetFlags( aItem_editFlags );
492 aItem->ClearTempFlags();
493 aItem->SetFlags( aItem_tempFlags );
494}
495
496
498{
499 auto clearTextCaches =
500 []( SCH_ITEM* aItem )
501 {
502 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( aItem );
503
504 if( text )
505 {
506 text->ClearBoundingBoxCache();
507 text->ClearRenderCache();
508 }
509 };
510
511 clearTextCaches( this );
512
513 RunOnChildren( clearTextCaches, RECURSE_MODE::NO_RECURSE );
514}
515
516
517bool SCH_ITEM::operator==( const SCH_ITEM& aOther ) const
518{
519 if( Type() != aOther.Type() )
520 return false;
521
522 return compare( aOther, SCH_ITEM::COMPARE_FLAGS::EQUALITY ) == 0;
523}
524
525
526bool SCH_ITEM::operator<( const SCH_ITEM& aOther ) const
527{
528 if( Type() != aOther.Type() )
529 return Type() < aOther.Type();
530
531 return ( compare( aOther ) < 0 );
532}
533
534
535bool SCH_ITEM::cmp_items::operator()( const SCH_ITEM* aFirst, const SCH_ITEM* aSecond ) const
536{
537 return aFirst->compare( *aSecond, COMPARE_FLAGS::EQUALITY ) < 0;
538}
539
540
541int SCH_ITEM::compare( const SCH_ITEM& aOther, int aCompareFlags ) const
542{
543 if( Type() != aOther.Type() )
544 return Type() - aOther.Type();
545
546 if( !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::UNIT ) && m_unit != aOther.m_unit )
547 return m_unit - aOther.m_unit;
548
549 if( !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::UNIT ) && m_bodyStyle != aOther.m_bodyStyle )
550 return m_bodyStyle - aOther.m_bodyStyle;
551
552 if( IsPrivate() != aOther.IsPrivate() )
553 return IsPrivate() ? 1 : -1;
554
555 if( !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::SKIP_TST_POS ) )
556 {
557 if( GetPosition().x != aOther.GetPosition().x )
558 return GetPosition().x - aOther.GetPosition().x;
559
560 if( GetPosition().y != aOther.GetPosition().y )
561 return GetPosition().y - aOther.GetPosition().y;
562 }
563
564 if( ( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::EQUALITY )
565 || ( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::ERC ) )
566 {
567 return 0;
568 }
569
570 if( m_Uuid < aOther.m_Uuid )
571 return -1;
572
573 if( m_Uuid > aOther.m_Uuid )
574 return 1;
575
576 return 0;
577}
578
579
580const wxString& SCH_ITEM::GetDefaultFont( const RENDER_SETTINGS* aSettings ) const
581{
582 static wxString defaultName = KICAD_FONT_NAME;
583
584 if( aSettings )
585 return aSettings->GetDefaultFont();
586 else if( EESCHEMA_SETTINGS* cfg = GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" ) )
587 return cfg->m_Appearance.default_font;
588 else
589 return defaultName;
590}
591
592
594{
595 if( SCHEMATIC* schematic = Schematic() )
596 return schematic->Settings().m_FontMetrics;
597
599}
600
601
603{
604 // For historical reasons, a stored value of 0 means "default width" and negative
605 // numbers meant "don't stroke".
606
607 if( GetPenWidth() < 0 )
608 {
609 return 0;
610 }
611 else if( GetPenWidth() == 0 )
612 {
613 if( GetParent() && GetParent()->Type() == LIB_SYMBOL_T )
614 return std::max( aSettings->m_SymbolLineWidth, aSettings->GetMinPenWidth() );
615 else
616 return std::max( aSettings->GetDefaultPenWidth(), aSettings->GetMinPenWidth() );
617 }
618 else
619 {
620 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
621 }
622}
623
624
625bool SCH_ITEM::RenderAsBitmap( double aWorldScale ) const
626{
627 if( IsHypertext() )
628 return false;
629
630 if( const EDA_TEXT* text = dynamic_cast<const EDA_TEXT*>( this ) )
631 return text->GetTextHeight() * aWorldScale < BITMAP_FONT_SIZE_THRESHOLD;
632
633 return false;
634}
635
636
637void SCH_ITEM::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
638{
639 wxString msg;
640
641 if( SYMBOL* symbol = GetParentSymbol() )
642 {
643 if( symbol->IsMultiUnit() )
644 aList.emplace_back( _( "Unit" ), GetUnitDisplayName( GetUnit(), false ) );
645
646 if( symbol->IsMultiBodyStyle() )
647 aList.emplace_back( _( "Body Style" ), GetBodyStyleDescription( GetBodyStyle(), true ) );
648
649 if( dynamic_cast<LIB_SYMBOL*>( symbol ) && IsPrivate() )
650 aList.emplace_back( _( "Private" ), wxEmptyString );
651 }
652}
653
654
655const std::vector<wxString>* SCH_ITEM::GetEmbeddedFonts()
656{
657 if( SCHEMATIC* schematic = Schematic() )
658 return schematic->GetEmbeddedFiles()->GetFontFiles();
659
660 if( SYMBOL* symbol = GetParentSymbol() )
661 {
662 if( EMBEDDED_FILES* symbolEmbeddedFiles = symbol->GetEmbeddedFiles() )
663 return symbolEmbeddedFiles->UpdateFontFiles();
664 }
665
666 return nullptr;
667}
668
669
670static struct SCH_ITEM_DESC
671{
673 {
677
678#ifdef NOTYET
679 // Not yet functional in UI
680 propMgr.AddProperty( new PROPERTY<SCH_ITEM, bool>( _HKI( "Locked" ),
682#endif
683
684 auto multiUnit =
685 [=]( INSPECTABLE* aItem ) -> bool
686 {
687 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( aItem ) )
688 {
689 if( const SYMBOL* symbol = schItem->GetParentSymbol() )
690 return symbol->IsMultiUnit();
691 }
692
693 return false;
694 };
695
696 auto multiBodyStyle =
697 [=]( INSPECTABLE* aItem ) -> bool
698 {
699 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( aItem ) )
700 {
701 if( const SYMBOL* symbol = schItem->GetParentSymbol() )
702 return symbol->IsMultiBodyStyle();
703 }
704
705 return false;
706 };
707
708 propMgr.AddProperty( new PROPERTY<SCH_ITEM, int>( _HKI( "Unit" ),
710 .SetAvailableFunc( multiUnit )
712 .SetChoicesFunc( []( INSPECTABLE* aItem )
713 {
714 wxPGChoices choices;
715 choices.Add( _HKI( "All units" ), 0 );
716
717 if( SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( aItem ) )
718 {
719 if( SYMBOL* symbol = item->GetParentSymbol() )
720 {
721 for( int ii = 1; ii <= symbol->GetUnitCount(); ii++ )
722 choices.Add( symbol->GetUnitDisplayName( ii, false ), ii );
723 }
724 }
725
726 return choices;
727 } );
728
729
730 propMgr.AddProperty( new PROPERTY<SCH_ITEM, wxString>( _HKI( "Body Style" ),
732 .SetAvailableFunc( multiBodyStyle )
734 .SetChoicesFunc( []( INSPECTABLE* aItem )
735 {
736 wxPGChoices choices;
737 choices.Add( _HKI( "All body styles" ) );
738
739 if( SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( aItem ) )
740 {
741 if( SYMBOL* symbol = item->GetParentSymbol() )
742 {
743 for( int ii : { BODY_STYLE::BASE, BODY_STYLE::DEMORGAN } )
744 choices.Add( symbol->GetBodyStyleDescription( ii, false ) );
745 }
746 }
747
748 return choices;
749 } );
750
751 propMgr.AddProperty( new PROPERTY<SCH_ITEM, bool>( _HKI( "Private" ),
754 }
756
758
759
760static bool lessYX( const DANGLING_END_ITEM& a, const DANGLING_END_ITEM& b )
761{
762 const auto aPos = a.GetPosition();
763 const auto bPos = b.GetPosition();
764 return aPos.y < bPos.y ? true : ( aPos.y > bPos.y ? false : aPos.x < bPos.x );
765};
766
767
768static bool lessType( const DANGLING_END_ITEM& a, const DANGLING_END_ITEM& b )
769{
770 return a.GetType() < b.GetType();
771};
772
773
774std::vector<DANGLING_END_ITEM>::iterator
775DANGLING_END_ITEM_HELPER::get_lower_pos( std::vector<DANGLING_END_ITEM>& aItemListByPos,
776 const VECTOR2I& aPos )
777{
778 DANGLING_END_ITEM needle = DANGLING_END_ITEM( PIN_END, nullptr, aPos );
779 auto start = aItemListByPos.begin();
780 auto end = aItemListByPos.end();
781 return std::lower_bound( start, end, needle, lessYX );
782}
783
784
785std::vector<DANGLING_END_ITEM>::iterator
786DANGLING_END_ITEM_HELPER::get_lower_type( std::vector<DANGLING_END_ITEM>& aItemListByType,
787 const DANGLING_END_T& aType )
788{
789 DANGLING_END_ITEM needle = DANGLING_END_ITEM( aType, nullptr, VECTOR2I{} );
790 auto start = aItemListByType.begin();
791 auto end = aItemListByType.end();
792 return std::lower_bound( start, end, needle, lessType );
793}
794
795
797 std::vector<DANGLING_END_ITEM>& aItemListByType,
798 std::vector<DANGLING_END_ITEM>& aItemListByPos )
799{
800 // WIRE_END pairs must be kept together. Hence stable sort.
801 std::stable_sort( aItemListByType.begin(), aItemListByType.end(), lessType );
802
803 // Sort by y first, pins are more likely to share x than y.
804 std::sort( aItemListByPos.begin(), aItemListByPos.end(), lessYX );
805}
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
Definition commit.h:106
void RemoveItem(SCH_ITEM *aItem)
static std::vector< DANGLING_END_ITEM >::iterator get_lower_type(std::vector< DANGLING_END_ITEM > &aItemListByType, const DANGLING_END_T &aType)
Definition sch_item.cpp:786
static std::vector< DANGLING_END_ITEM >::iterator get_lower_pos(std::vector< DANGLING_END_ITEM > &aItemListByPos, const VECTOR2I &aPos)
Definition sch_item.cpp:775
static void sort_dangling_end_items(std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos)
Both contain the same information.
Definition sch_item.cpp:796
Helper class used to store the state of schematic items that can be connected to other schematic item...
Definition sch_item.h:96
DANGLING_END_T GetType() const
Definition sch_item.h:132
The base class for create windows for drawing purpose.
A set of EDA_ITEMs (i.e., without duplicates).
Definition eda_group.h:46
A base class for most all the KiCad significant classes used in schematics and boards.
Definition eda_item.h:98
virtual VECTOR2I GetPosition() const
Definition eda_item.h:272
virtual void ClearEditFlags()
Definition eda_item.h:156
virtual void SetLocked(bool aLocked)
Definition eda_item.h:121
EDA_ITEM_FLAGS GetEditFlags() const
Definition eda_item.h:148
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:142
const KIID m_Uuid
Definition eda_item.h:516
virtual EDA_GROUP * GetParentGroup() const
Definition eda_item.h:116
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition eda_item.h:144
EDA_ITEM_FLAGS m_flags
Definition eda_item.h:527
EDA_ITEM_FLAGS GetTempFlags() const
Definition eda_item.h:161
EDA_GROUP * m_group
The group this item belongs to, if any. No ownership implied.
Definition eda_item.h:529
virtual void SetParent(EDA_ITEM *aParent)
Definition eda_item.h:113
EDA_ITEM * GetParent() const
Definition eda_item.h:112
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition eda_item.cpp:118
virtual bool IsLocked() const
Definition eda_item.h:120
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:39
virtual void ClearTempFlags()
Definition eda_item.h:169
EDA_ITEM * findParent(KICAD_T aType) const
Definition eda_item.cpp:75
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:79
Class that other classes need to inherit from, in order to be inspectable.
Definition inspectable.h:37
static const METRICS & Default()
Definition font.cpp:52
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
const wxString & GetDefaultFont() const
Definition kiid.h:49
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
virtual PROJECT_FILE & GetProjectFile() const
Definition project.h:204
PROPERTY_BASE & SetChoicesFunc(std::function< wxPGChoices(INSPECTABLE *)> aFunc)
Definition property.h:273
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
Definition property.h:259
PROPERTY_BASE & SetIsHiddenFromDesignEditors(bool aIsHidden=true)
Definition property.h:337
Provide class metadata.Helper macro to map type hashes to names.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
static PROPERTY_MANAGER & Instance()
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
Holds all the data relating to one schematic.
Definition schematic.h:88
PROJECT & Project() const
Return a reference to the project this schematic is part of.
Definition schematic.h:103
CONNECTION_GRAPH * ConnectionGraph() const
Definition schematic.h:183
static bool m_IsSchematicExists
True if a SCHEMATIC exists, false if not.
Definition schematic.h:418
SCH_SHEET_PATH & CurrentSheet() const
Definition schematic.h:171
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
void Reset()
Clears connectivity information.
wxString Name(bool aIgnoreSheet=false) const
void SetGraph(CONNECTION_GRAPH *aGraph)
void SetSheet(const SCH_SHEET_PATH &aSheet)
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
virtual bool GetExcludedFromSim() const
Definition sch_item.h:253
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition sch_item.cpp:637
friend class CONNECTION_GRAPH
Definition sch_item.h:721
SCH_ITEM * Duplicate(bool addToParentGroup, SCH_COMMIT *aCommit=nullptr, bool doClone=false) const
Routine to create a new copy of given item.
Definition sch_item.cpp:137
virtual bool IsConnectable() const
Definition sch_item.h:493
int m_unit
Definition sch_item.h:740
virtual int GetPenWidth() const
Definition sch_item.h:320
const SCH_ITEM_VEC & ConnectedItems(const SCH_SHEET_PATH &aPath)
Retrieve the set of items connected to this item on the given sheet.
Definition sch_item.cpp:382
SCH_ITEM & operator=(const SCH_ITEM &aPin)
Definition sch_item.cpp:75
void ClearConnectedItems(const SCH_SHEET_PATH &aPath)
Clear all connections to this item.
Definition sch_item.cpp:373
virtual bool doIsConnected(const VECTOR2I &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition sch_item.h:736
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
Definition sch_item.h:597
int m_bodyStyle
Definition sch_item.h:741
const std::vector< wxString > * GetEmbeddedFonts() override
Definition sch_item.cpp:655
virtual ~SCH_ITEM()
Definition sch_item.cpp:88
const SYMBOL * GetParentSymbol() const
Definition sch_item.cpp:223
virtual wxString GetBodyStyleDescription(int aBodyStyle, bool aLabel) const
Definition sch_item.cpp:179
void SetPrivate(bool aPrivate)
Definition sch_item.h:249
virtual void swapData(SCH_ITEM *aItem)
Swap the internal data structures aItem with the schematic item.
Definition sch_item.cpp:450
virtual const wxString & GetCachedDriverName() const
Definition sch_item.cpp:443
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
Definition sch_item.cpp:217
int GetBodyStyle() const
Definition sch_item.h:244
std::vector< int > ViewGetLayers() const override
Return the layers the item is drawn on (which may be more than its "home" layer)
Definition sch_item.cpp:307
bool ResolveExcludedFromBOM() const
Definition sch_item.cpp:262
SCH_CONNECTION * InitializeConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Create a new connection object associated with this object.
Definition sch_item.cpp:404
virtual wxString GetUnitDisplayName(int aUnit, bool aLabel) const
Definition sch_item.cpp:168
void AddConnectionTo(const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
Add a connection link between this item and another.
Definition sch_item.cpp:388
friend class LIB_SYMBOL
Definition sch_item.h:759
@ SKIP_TST_POS
Definition sch_item.h:671
int GetUnit() const
Definition sch_item.h:238
std::shared_ptr< NETCLASS > GetEffectiveNetClass(const SCH_SHEET_PATH *aSheet=nullptr) const
Definition sch_item.cpp:352
bool ResolveExcludedFromBoard() const
Definition sch_item.cpp:277
virtual bool GetDNP() const
Definition sch_item.h:265
virtual bool operator==(const SCH_ITEM &aOther) const
Definition sch_item.cpp:517
bool m_connectivity_dirty
Definition sch_item.h:753
virtual bool GetExcludedFromBOM() const
Definition sch_item.h:257
bool IsPrivate() const
Definition sch_item.h:250
virtual void ClearCaches()
Definition sch_item.cpp:497
virtual bool GetExcludedFromBoard() const
Definition sch_item.h:261
virtual void SetBodyStyleProp(const wxString &aBodyStyle)
Definition sch_item.cpp:189
virtual int compare(const SCH_ITEM &aOther, int aCompareFlags=0) const
Provide the draw object specific comparison called by the == and < operators.
Definition sch_item.cpp:541
virtual wxString GetBodyStyleProp() const
Definition sch_item.cpp:211
bool RenderAsBitmap(double aWorldScale) const override
Definition sch_item.cpp:625
const wxString & GetDefaultFont(const RENDER_SETTINGS *aSettings) const
Definition sch_item.cpp:580
void SetConnectionGraph(CONNECTION_GRAPH *aGraph)
Update the connection graph for all connections in this item.
Definition sch_item.cpp:340
virtual void SetUnit(int aUnit)
Definition sch_item.h:237
AUTOPLACE_ALGO m_fieldsAutoplaced
Definition sch_item.h:743
std::unordered_set< SCH_RULE_AREA * > m_rule_areas_cache
Store pointers to rule areas which this item is contained within.
Definition sch_item.h:756
void SwapFlags(SCH_ITEM *aItem)
Swap the non-temp and non-edit flags.
Definition sch_item.cpp:476
bool IsConnected(const VECTOR2I &aPoint) const
Test the item to see if it is connected to aPoint.
Definition sch_item.cpp:314
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
Definition sch_item.cpp:51
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition sch_item.h:751
virtual bool operator<(const SCH_ITEM &aItem) const
Definition sch_item.cpp:526
bool m_private
Definition sch_item.h:742
virtual bool IsHypertext() const
Allow items to support hypertext actions when hovered/clicked.
Definition sch_item.h:302
SCH_CONNECTION * GetOrInitConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Definition sch_item.cpp:428
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition sch_item.cpp:323
wxString GetClass() const override
Return the class name.
Definition sch_item.h:177
bool ResolveExcludedFromSim() const
Definition sch_item.cpp:247
const KIFONT::METRICS & GetFontMetrics() const
Definition sch_item.cpp:593
std::map< SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMP > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition sch_item.h:748
int GetEffectivePenWidth(const SCH_RENDER_SETTINGS *aSettings) const
Definition sch_item.cpp:602
bool IsGroupableType() const
Definition sch_item.cpp:105
void SwapItemData(SCH_ITEM *aImage)
Swap data between aItem and aImage.
Definition sch_item.cpp:456
SCH_LAYER_ID m_layer
Definition sch_item.h:739
bool ResolveDNP() const
Definition sch_item.cpp:292
int m_SymbolLineWidth
Override line widths for symbol drawing objects set to default line width.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Schematic symbol object.
Definition sch_symbol.h:75
A base class for LIB_SYMBOL and SCH_SYMBOL.
Definition symbol.h:63
#define _(s)
@ NO_RECURSE
Definition eda_item.h:52
#define BRIGHTENED
item is drawn with a bright contour
#define SELECTED
Item was manually selected by the user.
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
std::uint32_t EDA_ITEM_FLAGS
#define KICAD_FONT_NAME
SCH_LAYER_ID
Eeschema drawing layers.
Definition layer_ids.h:448
@ LAYER_DEVICE
Definition layer_ids.h:465
@ LAYER_WIRE
Definition layer_ids.h:451
@ LAYER_DEVICE_BACKGROUND
Definition layer_ids.h:483
@ LAYER_SELECTION_SHADOWS
Definition layer_ids.h:493
#define UNIMPLEMENTED_FOR(type)
Definition macros.h:96
#define _HKI(x)
Definition page_info.cpp:44
see class PGM_BASE
#define TYPE_HASH(x)
Definition property.h:73
#define IMPLEMENT_ENUM_TO_WXANY(type)
Definition property.h:799
#define REGISTER_TYPE(x)
Class to handle a set of SCH_ITEMs.
static bool lessYX(const DANGLING_END_ITEM &a, const DANGLING_END_ITEM &b)
Definition sch_item.cpp:760
#define BITMAP_FONT_SIZE_THRESHOLD
Definition sch_item.cpp:45
static bool lessType(const DANGLING_END_ITEM &a, const DANGLING_END_ITEM &b)
Definition sch_item.cpp:768
static struct SCH_ITEM_DESC _SCH_ITEM_DESC
@ AUTOPLACE_NONE
Definition sch_item.h:69
DANGLING_END_T
Definition sch_item.h:77
@ PIN_END
Definition sch_item.h:82
std::vector< SCH_ITEM * > SCH_ITEM_VEC
Definition sch_item.h:156
@ BASE
Definition sch_item.h:59
@ DEMORGAN
Definition sch_item.h:60
T * GetAppSettings(const char *aFilename)
bool operator()(const SCH_ITEM *aFirst, const SCH_ITEM *aSecond) const
Definition sch_item.cpp:535
VECTOR2I end
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition typeinfo.h:78
@ SCH_GROUP_T
Definition typeinfo.h:175
@ SCH_TABLE_T
Definition typeinfo.h:167
@ SCH_LINE_T
Definition typeinfo.h:165
@ LIB_SYMBOL_T
Definition typeinfo.h:150
@ SCH_NO_CONNECT_T
Definition typeinfo.h:162
@ SCH_SYMBOL_T
Definition typeinfo.h:174
@ SCH_FIELD_T
Definition typeinfo.h:152
@ SCH_DIRECTIVE_LABEL_T
Definition typeinfo.h:173
@ SCH_LABEL_T
Definition typeinfo.h:169
@ SCH_SHEET_T
Definition typeinfo.h:177
@ SCH_SHAPE_T
Definition typeinfo.h:151
@ SCH_RULE_AREA_T
Definition typeinfo.h:172
@ SCH_HIER_LABEL_T
Definition typeinfo.h:171
@ SCH_BUS_BUS_ENTRY_T
Definition typeinfo.h:164
@ SCHEMATIC_T
Definition typeinfo.h:206
@ SCH_SHEET_PIN_T
Definition typeinfo.h:176
@ SCH_TEXT_T
Definition typeinfo.h:153
@ SCH_BUS_WIRE_ENTRY_T
Definition typeinfo.h:163
@ SCH_BITMAP_T
Definition typeinfo.h:166
@ SCH_TEXTBOX_T
Definition typeinfo.h:154
@ SCH_GLOBAL_LABEL_T
Definition typeinfo.h:170
@ SCH_JUNCTION_T
Definition typeinfo.h:161
@ SCH_PIN_T
Definition typeinfo.h:155
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695