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
48static const std::vector<KICAD_T> labelTypes = { SCH_LABEL_LOCATE_ANY_T };
49
50
51/* Constructor and destructor for SCH_ITEM */
52/* They are not inline because this creates problems with gcc at linking time in debug mode */
53
54SCH_ITEM::SCH_ITEM( EDA_ITEM* aParent, KICAD_T aType, int aUnit, int aBodyStyle ) :
55 EDA_ITEM( aParent, aType, true, false ),
56 m_unit( aUnit ),
57 m_bodyStyle( aBodyStyle ),
58 m_private( false )
59{
60 m_layer = LAYER_WIRE; // It's only a default, in fact
62 m_connectivity_dirty = false; // Item is unconnected until it is placed, so it's clean
63}
64
65
67 EDA_ITEM( aItem )
68{
69 m_layer = aItem.m_layer;
70 m_unit = aItem.m_unit;
72 m_private = aItem.m_private;
75}
76
77
79{
80 m_layer = aItem.m_layer;
81 m_unit = aItem.m_unit;
83 m_private = aItem.m_private;
86
87 return *this;
88}
89
90
92{
93 for( const auto& it : m_connection_map )
94 delete it.second;
95
96 // Remove this item from any rule areas that contain it
97 for( SCH_RULE_AREA* ruleArea : m_rule_areas_cache )
98 ruleArea->RemoveItem( this );
99
100 // Do not try to modify SCHEMATIC::ConnectionGraph()
101 // if the schematic does not exist
103 return;
104
105 SCHEMATIC* sch = Schematic();
106
107 if( sch != nullptr )
108 sch->ConnectionGraph()->RemoveItem( this );
109}
110
111
113{
114 switch( Type() )
115 {
116 case SCH_SYMBOL_T:
117 case SCH_PIN_T:
118 case SCH_SHAPE_T:
119 case SCH_BITMAP_T:
120 case SCH_FIELD_T:
121 case SCH_TEXT_T:
122 case SCH_TEXTBOX_T:
123 case SCH_TABLE_T:
124 case SCH_GROUP_T:
125 case SCH_LINE_T:
126 case SCH_JUNCTION_T:
127 case SCH_NO_CONNECT_T:
130 case SCH_LABEL_T:
132 case SCH_HIER_LABEL_T:
133 case SCH_RULE_AREA_T:
135 case SCH_SHEET_PIN_T:
136 case SCH_SHEET_T:
137 return true;
138 default:
139 return false;
140 }
141}
142
143
144SCH_ITEM* SCH_ITEM::Duplicate( bool addToParentGroup, SCH_COMMIT* aCommit, bool doClone ) const
145{
146 SCH_ITEM* newItem = (SCH_ITEM*) Clone();
147
148 if( !doClone )
149 const_cast<KIID&>( newItem->m_Uuid ) = KIID();
150
151 newItem->ClearFlags( SELECTED | BRIGHTENED );
152
153 newItem->RunOnChildren(
154 []( SCH_ITEM* aChild )
155 {
156 aChild->ClearFlags( SELECTED | BRIGHTENED );
157 },
159
160 if( addToParentGroup )
161 {
162 wxCHECK_MSG( aCommit, newItem, "Must supply a commit to update parent group" );
163
164 if( EDA_GROUP* group = newItem->GetParentGroup() )
165 {
166 aCommit->Modify( group->AsEdaItem(), nullptr, RECURSE_MODE::NO_RECURSE );
167 group->AddItem( newItem );
168 }
169 }
170
171 return newItem;
172}
173
174
175wxString SCH_ITEM::GetUnitDisplayName( int aUnit, bool aLabel ) const
176{
177 if( aUnit == 0 )
178 return aLabel ? _( "All units" ) : wxString( _HKI( "All units" ) );
179 else if( const SYMBOL* symbol = GetParentSymbol() )
180 return symbol->GetUnitDisplayName( aUnit, aLabel );
181
182 return wxEmptyString;
183}
184
185
186wxString SCH_ITEM::GetBodyStyleDescription( int aBodyStyle, bool aLabel ) const
187{
188 if( aBodyStyle == 0 )
189 return aLabel ? _( "All body styles" ) : wxString( _HKI( "All body styles" ) );
190 else if( const SYMBOL* symbol = GetParentSymbol() )
191 return symbol->GetBodyStyleDescription( aBodyStyle, aLabel );
192
193 return wxEmptyString;
194}
195
196
197void SCH_ITEM::SetUnitString( const wxString& aUnit )
198{
199 if( aUnit == _HKI( "All units" ) )
200 {
201 m_unit = 0;
202 return;
203 }
204
205 if( SYMBOL* symbol = GetParentSymbol() )
206 {
207 for( int ii = 1; ii <= symbol->GetUnitCount(); ii++ )
208 {
209 if( symbol->GetUnitDisplayName( ii, false ) == aUnit )
210 {
211 m_unit = ii;
212 return;
213 }
214 }
215 }
216}
217
218
220{
221 return GetUnitDisplayName( m_unit, false );
222}
223
224void SCH_ITEM::SetBodyStyleProp( const wxString& aBodyStyle )
225{
226 if( aBodyStyle == _HKI( "All body styles" ) )
227 {
228 m_bodyStyle = 0;
229 return;
230 }
231
232 if( SYMBOL* symbol = GetParentSymbol() )
233 {
234 for( int bodyStyle : { BODY_STYLE::BASE, BODY_STYLE::DEMORGAN } )
235 {
236 if( symbol->GetBodyStyleDescription( bodyStyle, false ) == aBodyStyle )
237 {
238 m_bodyStyle = bodyStyle;
239 return;
240 }
241 }
242 }
243}
244
245
247{
248 return GetBodyStyleDescription( m_bodyStyle, false );
249}
250
251
253{
254 return static_cast<SCHEMATIC*>( findParent( SCHEMATIC_T ) );
255}
256
257
259{
260 if( SYMBOL* sch_symbol = static_cast<SCH_SYMBOL*>( findParent( SCH_SYMBOL_T ) ) )
261 return sch_symbol;
262
263 if( SYMBOL* lib_symbol = static_cast<LIB_SYMBOL*>( findParent( LIB_SYMBOL_T ) ) )
264 return lib_symbol;
265
266 return nullptr;
267}
268
269
271{
272 if( SYMBOL* sch_symbol = static_cast<SCH_SYMBOL*>( findParent( SCH_SYMBOL_T ) ) )
273 return sch_symbol;
274
275 if( SYMBOL* lib_symbol = static_cast<LIB_SYMBOL*>( findParent( LIB_SYMBOL_T ) ) )
276 return lib_symbol;
277
278 return nullptr;
279}
280
281
283 const wxString& aVariantName ) const
284{
285 if( GetExcludedFromSim( aInstance, aVariantName ) )
286 return true;
287
288 for( SCH_RULE_AREA* area : m_rule_areas_cache )
289 {
290 if( area->GetExcludedFromSim( aInstance, aVariantName ) )
291 return true;
292 }
293
294 return false;
295}
296
297
299 const wxString& aVariantName ) const
300{
301 if( GetExcludedFromBOM( aInstance, aVariantName ) )
302 return true;
303
304 for( SCH_RULE_AREA* area : m_rule_areas_cache )
305 {
306 if( area->GetExcludedFromBOM( aInstance, aVariantName ) )
307 return true;
308 }
309
310 return false;
311}
312
313
315 const wxString& aVariantName ) const
316{
317 if( GetExcludedFromBoard( aInstance, aVariantName ) )
318 return true;
319
320 for( SCH_RULE_AREA* area : m_rule_areas_cache )
321 {
322 if( area->GetExcludedFromBoard( aInstance, aVariantName ) )
323 return true;
324 }
325
326 return false;
327}
328
329
331 const wxString& aVariantName ) const
332{
333 if( GetExcludedFromPosFiles( aInstance, aVariantName ) )
334 return true;
335
336 for( SCH_RULE_AREA* area : m_rule_areas_cache )
337 {
338 if( area->GetExcludedFromPosFiles( aInstance, aVariantName ) )
339 return true;
340 }
341
342 return false;
343}
344
345
346bool SCH_ITEM::ResolveDNP( const SCH_SHEET_PATH* aInstance, const wxString& aVariantName ) const
347{
348 if( GetDNP( aInstance, aVariantName ) )
349 return true;
350
351 for( SCH_RULE_AREA* area : m_rule_areas_cache )
352 {
353 if( area->GetDNP( aInstance, aVariantName ) )
354 return true;
355 }
356
357 return false;
358}
359
360
361wxString SCH_ITEM::ResolveText( const wxString& aText, const SCH_SHEET_PATH* aPath, int aDepth ) const
362{
363 // Use aDepth to track recursion across nested GetShownText/ResolveText calls
364 int depth = aDepth;
365
366 std::function<bool( wxString* )> libSymbolResolver =
367 [&]( wxString* token ) -> bool
368 {
369 LIB_SYMBOL* symbol = static_cast<LIB_SYMBOL*>( m_parent );
370 return symbol->ResolveTextVar( token, depth + 1 );
371 };
372
373 std::function<bool( wxString* )> symbolResolver =
374 [&]( wxString* token ) -> bool
375 {
376 SCH_SYMBOL* symbol = static_cast<SCH_SYMBOL*>( m_parent );
377 return symbol->ResolveTextVar( aPath, token, depth + 1 );
378 };
379
380 std::function<bool( wxString* )> schematicResolver =
381 [&]( wxString* token ) -> bool
382 {
383 if( !aPath )
384 return false;
385
386 if( SCHEMATIC* schematic = Schematic() )
387 return schematic->ResolveTextVar( aPath, token, depth + 1 );
388
389 return false;
390 };
391
392 std::function<bool( wxString* )> sheetResolver =
393 [&]( wxString* token ) -> bool
394 {
395 if( !aPath )
396 return false;
397
398 SCH_SHEET* sheet = static_cast<SCH_SHEET*>( m_parent );
399
400 SCHEMATIC* schematic = Schematic();
401 SCH_SHEET_PATH path = *aPath;
402 path.push_back( sheet );
403
404 bool retval = sheet->ResolveTextVar( &path, token, depth + 1 );
405
406 if( schematic )
407 retval |= schematic->ResolveTextVar( &path, token, depth + 1 );
408
409 return retval;
410 };
411
412 std::function<bool( wxString* )> labelResolver =
413 [&]( wxString* token ) -> bool
414 {
415 if( !aPath )
416 return false;
417
418 SCH_LABEL_BASE* label = static_cast<SCH_LABEL_BASE*>( m_parent );
419 return label->ResolveTextVar( aPath, token, depth + 1 );
420 };
421
422 wxString variantName;
423
424 if( SCHEMATIC* schematic = Schematic() )
425 variantName = schematic->GetCurrentVariant();
426
427 // Create a unified resolver that delegates to the appropriate resolver based on parent type
428 std::function<bool( wxString* )> fieldResolver =
429 [&]( wxString* token ) -> bool
430 {
431 bool resolved = false;
432
433 if( m_parent && m_parent->Type() == LIB_SYMBOL_T )
434 resolved = libSymbolResolver( token );
435 else if( m_parent && m_parent->Type() == SCH_SYMBOL_T )
436 resolved = symbolResolver( token );
437 else if( m_parent && m_parent->Type() == SCH_SHEET_T )
438 resolved = sheetResolver( token );
439 else if( m_parent && m_parent->IsType( labelTypes ) )
440 resolved = labelResolver( token );
441 else if( Schematic() )
442 {
443 // Project-level and schematic-level variables
444 resolved = Schematic()->Project().TextVarResolver( token );
445 resolved |= schematicResolver( token );
446 }
447
448 return resolved;
449 };
450
451 return ResolveTextVars( aText, &fieldResolver, depth );
452}
453
454
455std::vector<int> SCH_ITEM::ViewGetLayers() const
456{
457 // Basic fallback
459}
460
461
462bool SCH_ITEM::IsConnected( const VECTOR2I& aPosition ) const
463{
464 if(( m_flags & STRUCT_DELETED ) || ( m_flags & SKIP_STRUCT ) )
465 return false;
466
467 return doIsConnected( aPosition );
468}
469
470
472{
473 if( !IsConnectable() )
474 return nullptr;
475
476 if( !aSheet )
477 {
478 SCHEMATIC* sch = Schematic();
479
480 if( !sch )
481 return nullptr; // Item has been removed from schematic (e.g. SCH_PIN during symbol deletion)
482
483 aSheet = &sch->CurrentSheet();
484 }
485
486 auto it = m_connection_map.find( *aSheet );
487
488 if( it == m_connection_map.end() )
489 return nullptr;
490 else
491 return it->second;
492}
493
494
496{
497 for( auto& [path, conn] : m_connection_map )
498 {
499 conn->SetGraph( aGraph );
500
501 for( auto& member : conn->AllMembers() )
502 member->SetGraph( aGraph );
503 }
504}
505
506
507std::shared_ptr<NETCLASS> SCH_ITEM::GetEffectiveNetClass( const SCH_SHEET_PATH* aSheet ) const
508{
509 static std::shared_ptr<NETCLASS> nullNetclass = std::make_shared<NETCLASS>( wxEmptyString );
510
511 SCHEMATIC* schematic = Schematic();
512
513 if( schematic )
514 {
515 std::shared_ptr<NET_SETTINGS>& netSettings = schematic->Project().GetProjectFile().m_NetSettings;
516 SCH_CONNECTION* connection = Connection( aSheet );
517
518 if( connection )
519 return netSettings->GetEffectiveNetClass( connection->Name() );
520 else
521 return netSettings->GetDefaultNetclass();
522 }
523
524 return nullNetclass;
525}
526
527
529{
530 auto it = m_connected_items.find( aSheet );
531
532 if( it != m_connected_items.end() )
533 it->second.clear();
534}
535
536
538{
539 return m_connected_items[ aSheet ];
540}
541
542
544{
545 SCH_ITEM_VEC& vec = m_connected_items[ aSheet ];
546
547 // The vector elements are small, so reserve 1k at a time to prevent re-allocations
548 if( vec.size() == vec.capacity() )
549 vec.reserve( vec.size() + 4096 );
550
551 // Add item to the correct place in the sorted vector if it is not already there
552 auto it = std::lower_bound( vec.begin(), vec.end(), aItem );
553
554 if( it == vec.end() || *it != aItem )
555 vec.insert( it, aItem );
556}
557
558
560 CONNECTION_GRAPH* aGraph )
561{
562 SCH_CONNECTION* connection = Connection( &aSheet );
563
564 // N.B. Do not clear the dirty connectivity flag here because we may need
565 // to create a connection for a different sheet, and we don't want to
566 // skip the connection creation because the flag is cleared.
567 if( connection )
568 {
569 connection->Reset();
570 }
571 else
572 {
573 connection = new SCH_CONNECTION( this );
574 m_connection_map.insert( std::make_pair( aSheet, connection ) );
575 }
576
577 connection->SetGraph( aGraph );
578 connection->SetSheet( aSheet );
579 return connection;
580}
581
582
584 CONNECTION_GRAPH* aGraph )
585{
586 if( !IsConnectable() )
587 return nullptr;
588
589 SCH_CONNECTION* connection = Connection( &aSheet );
590
591 if( connection )
592 return connection;
593 else
594 return InitializeConnection( aSheet, aGraph );
595}
596
597
598const wxString& SCH_ITEM::GetCachedDriverName() const
599{
600 static wxString s_empty;
601 return s_empty;
602}
603
604
606{
608}
609
610
612{
613 if( aImage == nullptr )
614 return;
615
616 EDA_ITEM* parent = GetParent();
617
618 SwapFlags( aImage );
619 std::swap( m_layer, aImage->m_layer );
620 std::swap( m_unit, aImage->m_unit );
621 std::swap( m_bodyStyle, aImage->m_bodyStyle );
622 std::swap( m_private, aImage->m_private );
623 std::swap( m_fieldsAutoplaced, aImage->m_fieldsAutoplaced );
624 std::swap( m_group, aImage->m_group );
625 swapData( aImage );
626
627 SetParent( parent );
628}
629
630
632{
633 EDA_ITEM_FLAGS editFlags = GetEditFlags();
634 EDA_ITEM_FLAGS tempFlags = GetTempFlags();
635 EDA_ITEM_FLAGS aItem_editFlags = aItem->GetEditFlags();
636 EDA_ITEM_FLAGS aItem_tempFlags = aItem->GetTempFlags();
637
638 std::swap( m_flags, aItem->m_flags );
639
641 SetFlags( editFlags );
643 SetFlags( tempFlags );
644
645 aItem->ClearEditFlags();
646 aItem->SetFlags( aItem_editFlags );
647 aItem->ClearTempFlags();
648 aItem->SetFlags( aItem_tempFlags );
649}
650
651
653{
654 auto clearTextCaches =
655 []( SCH_ITEM* aItem )
656 {
657 EDA_TEXT* text = dynamic_cast<EDA_TEXT*>( aItem );
658
659 if( text )
660 {
661 text->ClearBoundingBoxCache();
662 text->ClearRenderCache();
663 }
664 };
665
666 clearTextCaches( this );
667
668 RunOnChildren( clearTextCaches, RECURSE_MODE::NO_RECURSE );
669}
670
671
672bool SCH_ITEM::operator==( const SCH_ITEM& aOther ) const
673{
674 if( Type() != aOther.Type() )
675 return false;
676
677 return compare( aOther, SCH_ITEM::COMPARE_FLAGS::EQUALITY ) == 0;
678}
679
680
681bool SCH_ITEM::operator<( const SCH_ITEM& aOther ) const
682{
683 if( Type() != aOther.Type() )
684 return Type() < aOther.Type();
685
686 return ( compare( aOther ) < 0 );
687}
688
689
690bool SCH_ITEM::cmp_items::operator()( const SCH_ITEM* aFirst, const SCH_ITEM* aSecond ) const
691{
692 return aFirst->compare( *aSecond, COMPARE_FLAGS::EQUALITY ) < 0;
693}
694
695
696int SCH_ITEM::compare( const SCH_ITEM& aOther, int aCompareFlags ) const
697{
698 if( Type() != aOther.Type() )
699 return Type() - aOther.Type();
700
701 if( !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::UNIT ) && m_unit != aOther.m_unit )
702 return m_unit - aOther.m_unit;
703
704 if( !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::UNIT ) && m_bodyStyle != aOther.m_bodyStyle )
705 return m_bodyStyle - aOther.m_bodyStyle;
706
707 if( IsPrivate() != aOther.IsPrivate() )
708 return IsPrivate() ? 1 : -1;
709
710 if( !( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::SKIP_TST_POS ) )
711 {
712 if( GetPosition().x != aOther.GetPosition().x )
713 return GetPosition().x - aOther.GetPosition().x;
714
715 if( GetPosition().y != aOther.GetPosition().y )
716 return GetPosition().y - aOther.GetPosition().y;
717 }
718
719 if( ( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::EQUALITY )
720 || ( aCompareFlags & SCH_ITEM::COMPARE_FLAGS::ERC ) )
721 {
722 return 0;
723 }
724
725 if( m_Uuid < aOther.m_Uuid )
726 return -1;
727
728 if( m_Uuid > aOther.m_Uuid )
729 return 1;
730
731 return 0;
732}
733
734
736{
737 if( SCHEMATIC* schematic = Schematic() )
738 return schematic->Settings().m_MaxError;
739 else
740 return schIUScale.mmToIU( ARC_LOW_DEF_MM );
741}
742
743
744const wxString& SCH_ITEM::GetDefaultFont( const RENDER_SETTINGS* aSettings ) const
745{
746 static wxString defaultName = KICAD_FONT_NAME;
747
748 if( aSettings )
749 return aSettings->GetDefaultFont();
750 else if( EESCHEMA_SETTINGS* cfg = GetAppSettings<EESCHEMA_SETTINGS>( "eeschema" ) )
751 return cfg->m_Appearance.default_font;
752 else
753 return defaultName;
754}
755
756
758{
759 if( SCHEMATIC* schematic = Schematic() )
760 return schematic->Settings().m_FontMetrics;
761
763}
764
765
767{
768 // For historical reasons, a stored value of 0 means "default width" and negative
769 // numbers meant "don't stroke".
770
771 if( GetPenWidth() < 0 )
772 {
773 return 0;
774 }
775 else if( GetPenWidth() == 0 )
776 {
777 if( GetParent() && GetParent()->Type() == LIB_SYMBOL_T )
778 return std::max( aSettings->m_SymbolLineWidth, aSettings->GetMinPenWidth() );
779 else
780 return std::max( aSettings->GetDefaultPenWidth(), aSettings->GetMinPenWidth() );
781 }
782 else
783 {
784 return std::max( GetPenWidth(), aSettings->GetMinPenWidth() );
785 }
786}
787
788
789bool SCH_ITEM::RenderAsBitmap( double aWorldScale ) const
790{
791 if( HasHypertext() )
792 return false;
793
794 if( const EDA_TEXT* text = dynamic_cast<const EDA_TEXT*>( this ) )
795 return text->GetTextHeight() * aWorldScale < BITMAP_FONT_SIZE_THRESHOLD;
796
797 return false;
798}
799
800
801void SCH_ITEM::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
802{
803 if( SYMBOL* symbol = GetParentSymbol() )
804 {
805 if( symbol->IsMultiUnit() )
806 aList.emplace_back( _( "Unit" ), GetUnitDisplayName( GetUnit(), false ) );
807
808 if( symbol->IsMultiBodyStyle() )
809 aList.emplace_back( _( "Body Style" ), GetBodyStyleDescription( GetBodyStyle(), true ) );
810
811 if( dynamic_cast<LIB_SYMBOL*>( symbol ) && IsPrivate() )
812 aList.emplace_back( _( "Private" ), wxEmptyString );
813 }
814}
815
816
817const std::vector<wxString>* SCH_ITEM::GetEmbeddedFonts()
818{
819 if( SCHEMATIC* schematic = Schematic() )
820 return schematic->GetEmbeddedFiles()->GetFontFiles();
821
822 if( SYMBOL* symbol = GetParentSymbol() )
823 {
824 if( EMBEDDED_FILES* symbolEmbeddedFiles = symbol->GetEmbeddedFiles() )
825 return symbolEmbeddedFiles->UpdateFontFiles();
826 }
827
828 return nullptr;
829}
830
831
832static struct SCH_ITEM_DESC
833{
835 {
839
840#ifdef NOTYET
841 // Not yet functional in UI
842 propMgr.AddProperty( new PROPERTY<SCH_ITEM, bool>( _HKI( "Locked" ),
844#endif
845
846 auto multiUnit =
847 [=]( INSPECTABLE* aItem ) -> bool
848 {
849 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( aItem ) )
850 {
851 if( const SYMBOL* symbol = schItem->GetParentSymbol() )
852 return symbol->IsMultiUnit();
853 }
854
855 return false;
856 };
857
858 auto multiBodyStyle =
859 [=]( INSPECTABLE* aItem ) -> bool
860 {
861 if( SCH_ITEM* schItem = dynamic_cast<SCH_ITEM*>( aItem ) )
862 {
863 if( const SYMBOL* symbol = schItem->GetParentSymbol() )
864 return symbol->IsMultiBodyStyle();
865 }
866
867 return false;
868 };
869
870 propMgr.AddProperty( new PROPERTY<SCH_ITEM, wxString>( _HKI( "Unit" ),
872 .SetAvailableFunc( multiUnit )
874 .SetChoicesFunc( []( INSPECTABLE* aItem )
875 {
876 wxPGChoices choices;
877 choices.Add( _HKI( "All units" ), 0 );
878
879 if( SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( aItem ) )
880 {
881 if( SYMBOL* symbol = item->GetParentSymbol() )
882 {
883 for( int ii = 1; ii <= symbol->GetUnitCount(); ii++ )
884 choices.Add( symbol->GetUnitDisplayName( ii, false ), ii );
885 }
886 }
887
888 return choices;
889 } );
890
891
892 propMgr.AddProperty( new PROPERTY<SCH_ITEM, wxString>( _HKI( "Body Style" ),
894 .SetAvailableFunc( multiBodyStyle )
896 .SetChoicesFunc( []( INSPECTABLE* aItem )
897 {
898 wxPGChoices choices;
899 choices.Add( _HKI( "All body styles" ) );
900
901 if( SCH_ITEM* item = dynamic_cast<SCH_ITEM*>( aItem ) )
902 {
903 if( SYMBOL* symbol = item->GetParentSymbol() )
904 {
905 for( int ii : { BODY_STYLE::BASE, BODY_STYLE::DEMORGAN } )
906 choices.Add( symbol->GetBodyStyleDescription( ii, false ) );
907 }
908 }
909
910 return choices;
911 } );
912
913 propMgr.AddProperty( new PROPERTY<SCH_ITEM, bool>( _HKI( "Private" ),
916 }
918
920
921
922static bool lessYX( const DANGLING_END_ITEM& a, const DANGLING_END_ITEM& b )
923{
924 const auto aPos = a.GetPosition();
925 const auto bPos = b.GetPosition();
926 return aPos.y < bPos.y ? true : ( aPos.y > bPos.y ? false : aPos.x < bPos.x );
927};
928
929
930static bool lessType( const DANGLING_END_ITEM& a, const DANGLING_END_ITEM& b )
931{
932 return a.GetType() < b.GetType();
933};
934
935
936std::vector<DANGLING_END_ITEM>::iterator
937DANGLING_END_ITEM_HELPER::get_lower_pos( std::vector<DANGLING_END_ITEM>& aItemListByPos,
938 const VECTOR2I& aPos )
939{
940 DANGLING_END_ITEM needle = DANGLING_END_ITEM( PIN_END, nullptr, aPos );
941 auto start = aItemListByPos.begin();
942 auto end = aItemListByPos.end();
943 return std::lower_bound( start, end, needle, lessYX );
944}
945
946
947std::vector<DANGLING_END_ITEM>::iterator
948DANGLING_END_ITEM_HELPER::get_lower_type( std::vector<DANGLING_END_ITEM>& aItemListByType,
949 const DANGLING_END_T& aType )
950{
951 DANGLING_END_ITEM needle = DANGLING_END_ITEM( aType, nullptr, VECTOR2I{} );
952 auto start = aItemListByType.begin();
953 auto end = aItemListByType.end();
954 return std::lower_bound( start, end, needle, lessType );
955}
956
957
959 std::vector<DANGLING_END_ITEM>& aItemListByType,
960 std::vector<DANGLING_END_ITEM>& aItemListByPos )
961{
962 // WIRE_END pairs must be kept together. Hence stable sort.
963 std::stable_sort( aItemListByType.begin(), aItemListByType.end(), lessType );
964
965 // Sort by y first, pins are more likely to share x than y.
966 std::sort( aItemListByPos.begin(), aItemListByPos.end(), lessYX );
967}
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
constexpr double ARC_LOW_DEF_MM
Definition base_units.h:118
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:948
static std::vector< DANGLING_END_ITEM >::iterator get_lower_pos(std::vector< DANGLING_END_ITEM > &aItemListByPos, const VECTOR2I &aPos)
Definition sch_item.cpp:937
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:958
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:277
virtual void ClearEditFlags()
Definition eda_item.h:161
virtual void SetLocked(bool aLocked)
Definition eda_item.h:121
EDA_ITEM_FLAGS GetEditFlags() const
Definition eda_item.h:153
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition eda_item.h:147
const KIID m_Uuid
Definition eda_item.h:521
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:149
EDA_ITEM_FLAGS m_flags
Definition eda_item.h:532
EDA_ITEM_FLAGS GetTempFlags() const
Definition eda_item.h:166
EDA_GROUP * m_group
The group this item belongs to, if any. No ownership implied.
Definition eda_item.h:534
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 * m_parent
Owner.
Definition eda_item.h:533
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:174
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:80
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
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the symbol.
std::shared_ptr< NET_SETTINGS > m_NetSettings
Net settings for this project (owned here)
virtual bool TextVarResolver(wxString *aToken) const
Definition project.cpp:85
virtual PROJECT_FILE & GetProjectFile() const
Definition project.h:203
PROPERTY_BASE & SetChoicesFunc(std::function< wxPGChoices(INSPECTABLE *)> aFunc)
Definition property.h:276
PROPERTY_BASE & SetAvailableFunc(std::function< bool(INSPECTABLE *)> aFunc)
Set a callback function to determine whether an object provides this property.
Definition property.h:262
PROPERTY_BASE & SetIsHiddenFromDesignEditors(bool aIsHidden=true)
Definition property.h:340
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:199
bool ResolveTextVar(const SCH_SHEET_PATH *aSheetPath, wxString *token, int aDepth) const
static bool m_IsSchematicExists
True if a SCHEMATIC exists, false if not.
Definition schematic.h:527
SCH_SHEET_PATH & CurrentSheet() const
Definition schematic.h:187
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
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:801
friend class CONNECTION_GRAPH
Definition sch_item.h:754
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:144
virtual bool IsConnectable() const
Definition sch_item.h:526
int m_unit
Definition sch_item.h:773
bool ResolveExcludedFromPosFiles(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.cpp:330
virtual int GetPenWidth() const
Definition sch_item.h:353
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:537
SCH_ITEM & operator=(const SCH_ITEM &aPin)
Definition sch_item.cpp:78
void ClearConnectedItems(const SCH_SHEET_PATH &aPath)
Clear all connections to this item.
Definition sch_item.cpp:528
virtual bool doIsConnected(const VECTOR2I &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition sch_item.h:769
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
Definition sch_item.h:630
int m_bodyStyle
Definition sch_item.h:774
const std::vector< wxString > * GetEmbeddedFonts() override
Definition sch_item.cpp:817
virtual ~SCH_ITEM()
Definition sch_item.cpp:91
const SYMBOL * GetParentSymbol() const
Definition sch_item.cpp:258
virtual wxString GetBodyStyleDescription(int aBodyStyle, bool aLabel) const
Definition sch_item.cpp:186
void SetPrivate(bool aPrivate)
Definition sch_item.h:252
virtual void swapData(SCH_ITEM *aItem)
Swap the internal data structures aItem with the schematic item.
Definition sch_item.cpp:605
virtual const wxString & GetCachedDriverName() const
Definition sch_item.cpp:598
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
Definition sch_item.cpp:252
int GetBodyStyle() const
Definition sch_item.h:247
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:455
SCH_CONNECTION * InitializeConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Create a new connection object associated with this object.
Definition sch_item.cpp:559
virtual wxString GetUnitDisplayName(int aUnit, bool aLabel) const
Definition sch_item.cpp:175
void AddConnectionTo(const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
Add a connection link between this item and another.
Definition sch_item.cpp:543
friend class LIB_SYMBOL
Definition sch_item.h:792
@ SKIP_TST_POS
Definition sch_item.h:704
virtual bool HasHypertext() const
Indicates that the item has at least one hypertext action.
Definition sch_item.h:327
virtual bool GetExcludedFromPosFiles(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.h:278
int GetUnit() const
Definition sch_item.h:238
std::shared_ptr< NETCLASS > GetEffectiveNetClass(const SCH_SHEET_PATH *aSheet=nullptr) const
Definition sch_item.cpp:507
virtual bool operator==(const SCH_ITEM &aOther) const
Definition sch_item.cpp:672
bool m_connectivity_dirty
Definition sch_item.h:786
bool IsPrivate() const
Definition sch_item.h:253
virtual void ClearCaches()
Definition sch_item.cpp:652
int GetMaxError() const
Definition sch_item.cpp:735
virtual bool GetExcludedFromBoard(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.h:271
virtual void SetBodyStyleProp(const wxString &aBodyStyle)
Definition sch_item.cpp:224
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:696
virtual wxString GetBodyStyleProp() const
Definition sch_item.cpp:246
bool RenderAsBitmap(double aWorldScale) const override
Definition sch_item.cpp:789
const wxString & GetDefaultFont(const RENDER_SETTINGS *aSettings) const
Definition sch_item.cpp:744
void SetConnectionGraph(CONNECTION_GRAPH *aGraph)
Update the connection graph for all connections in this item.
Definition sch_item.cpp:495
AUTOPLACE_ALGO m_fieldsAutoplaced
Definition sch_item.h:776
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:789
void SwapFlags(SCH_ITEM *aItem)
Swap the non-temp and non-edit flags.
Definition sch_item.cpp:631
bool IsConnected(const VECTOR2I &aPoint) const
Test the item to see if it is connected to aPoint.
Definition sch_item.cpp:462
virtual void SetUnitString(const wxString &aUnit)
Definition sch_item.cpp:197
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
Definition sch_item.cpp:54
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition sch_item.h:784
virtual bool operator<(const SCH_ITEM &aItem) const
Definition sch_item.cpp:681
bool ResolveExcludedFromBOM(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.cpp:298
bool m_private
Definition sch_item.h:775
SCH_CONNECTION * GetOrInitConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Definition sch_item.cpp:583
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:471
wxString ResolveText(const wxString &aText, const SCH_SHEET_PATH *aPath, int aDepth=0) const
Definition sch_item.cpp:361
wxString GetClass() const override
Return the class name.
Definition sch_item.h:177
bool ResolveExcludedFromBoard(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.cpp:314
const KIFONT::METRICS & GetFontMetrics() const
Definition sch_item.cpp:757
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:781
bool ResolveDNP(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.cpp:346
virtual wxString GetUnitString() const
Definition sch_item.cpp:219
int GetEffectivePenWidth(const SCH_RENDER_SETTINGS *aSettings) const
Definition sch_item.cpp:766
bool IsGroupableType() const
Definition sch_item.cpp:112
void SwapItemData(SCH_ITEM *aImage)
Swap data between aItem and aImage.
Definition sch_item.cpp:611
bool ResolveExcludedFromSim(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.cpp:282
SCH_LAYER_ID m_layer
Definition sch_item.h:772
virtual bool GetExcludedFromSim(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.h:257
virtual bool GetDNP(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.h:285
virtual bool GetExcludedFromBOM(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const
Definition sch_item.h:264
virtual bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth) const
Resolve any references to system tokens supported by the label.
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...
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:48
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the sheet.
Schematic symbol object.
Definition sch_symbol.h:76
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the symbol.
A base class for LIB_SYMBOL and SCH_SYMBOL.
Definition symbol.h:63
wxString ResolveTextVars(const wxString &aSource, const std::function< bool(wxString *)> *aResolver, int &aDepth)
Multi-pass text variable expansion and math expression evaluation.
Definition common.cpp:296
#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:449
@ LAYER_DEVICE
Definition layer_ids.h:466
@ LAYER_WIRE
Definition layer_ids.h:452
@ LAYER_DEVICE_BACKGROUND
Definition layer_ids.h:484
@ LAYER_SELECTION_SHADOWS
Definition layer_ids.h:495
#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:74
#define IMPLEMENT_ENUM_TO_WXANY(type)
Definition property.h:821
#define REGISTER_TYPE(x)
static const std::vector< KICAD_T > labelTypes
Definition sch_field.cpp:44
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:922
#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:930
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:690
std::string path
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:177
@ SCH_TABLE_T
Definition typeinfo.h:169
@ SCH_LINE_T
Definition typeinfo.h:167
@ LIB_SYMBOL_T
Definition typeinfo.h:152
@ SCH_NO_CONNECT_T
Definition typeinfo.h:164
@ SCH_SYMBOL_T
Definition typeinfo.h:176
@ SCH_FIELD_T
Definition typeinfo.h:154
@ SCH_DIRECTIVE_LABEL_T
Definition typeinfo.h:175
@ SCH_LABEL_T
Definition typeinfo.h:171
@ SCH_SHEET_T
Definition typeinfo.h:179
@ SCH_SHAPE_T
Definition typeinfo.h:153
@ SCH_RULE_AREA_T
Definition typeinfo.h:174
@ SCH_HIER_LABEL_T
Definition typeinfo.h:173
@ SCH_BUS_BUS_ENTRY_T
Definition typeinfo.h:166
@ SCH_LABEL_LOCATE_ANY_T
Definition typeinfo.h:195
@ SCHEMATIC_T
Definition typeinfo.h:208
@ SCH_SHEET_PIN_T
Definition typeinfo.h:178
@ SCH_TEXT_T
Definition typeinfo.h:155
@ SCH_BUS_WIRE_ENTRY_T
Definition typeinfo.h:165
@ SCH_BITMAP_T
Definition typeinfo.h:168
@ SCH_TEXTBOX_T
Definition typeinfo.h:156
@ SCH_GLOBAL_LABEL_T
Definition typeinfo.h:172
@ SCH_JUNCTION_T
Definition typeinfo.h:163
@ SCH_PIN_T
Definition typeinfo.h:157
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695