KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_screen.h
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) 2009 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 1992-2023 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#ifndef SCREEN_H
26#define SCREEN_H
27
28#include <memory>
29#include <stddef.h>
30#include <unordered_set>
31#include <vector>
32#include <wx/arrstr.h>
33#include <wx/chartype.h>
34#include <wx/gdicmn.h>
35#include <wx/string.h>
36
37#include <base_screen.h>
38#include <core/typeinfo.h>
39#include <kiid.h>
40#include <kiway_holder.h>
41#include <layer_ids.h>
42#include <marker_base.h>
43#include <page_info.h>
44#include <template_fieldnames.h>
45#include <title_block.h>
46
47#include <lib_id.h>
48#include <sch_reference_list.h>
49#include <sch_rtree.h>
50#include <sch_sheet.h>
51#include <sch_label.h>
52#include <sch_sheet_path.h> // SCH_SYMBOL_INSTANCE
53
54class BUS_ALIAS;
55class EDA_ITEM;
56class LIB_SYMBOL;
57class SCH_PIN;
58class SCH_SYMBOL;
59class SCH_LINE;
60class SCH_LABEL_BASE;
61class PLOTTER;
62class REPORTER;
63class SCH_IO_ALTIUM;
64class SCH_EDIT_FRAME;
65class SCH_SHEET_LIST;
68
70{
74};
75
76
78{
80 int Unit;
82
83 std::vector<std::pair<int, wxString>> Fields;
84
85 PICKED_SYMBOL() : Unit( 1 ), Convert( 1 )
86 {
87 }
88};
89
90class SCH_SCREEN : public BASE_SCREEN
91{
92public:
93 SCH_SCREEN( EDA_ITEM* aParent = nullptr );
94
96
97 SCHEMATIC* Schematic() const;
98
108 EE_RTREE& Items() { return m_rtree; }
109 const EE_RTREE& Items() const { return m_rtree; }
110
111 bool IsEmpty() const
112 {
113 return m_rtree.empty();
114 }
115
116 bool HasItems( KICAD_T aItemType ) const;
117
118 bool HasSheets() const { return HasItems( SCH_SHEET_T ); }
119
120 static bool ClassOf( const EDA_ITEM* aItem );
121
122 virtual wxString GetClass() const override
123 {
124 return wxT( "SCH_SCREEN" );
125 }
126
127 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
129
130 const PAGE_INFO& GetPageSettings() const { return m_paper; }
131 void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
132
141 void SetFileName( const wxString& aFileName );
142
143 const wxString& GetFileName() const { return m_fileName; }
144
145 void SetFileReadOnly( bool aIsReadOnly ) { m_isReadOnly = aIsReadOnly; }
146 bool IsReadOnly() const { return m_isReadOnly; }
147
148 void SetFileExists( bool aFileExists ) { m_fileExists = aFileExists; }
149 bool FileExists() const { return m_fileExists; }
150
151 const VECTOR2I& GetAuxOrigin() const { return m_aux_origin; }
152 void SetAuxOrigin( const VECTOR2I& aPosition ) { m_aux_origin = aPosition; }
153
154 const TITLE_BLOCK& GetTitleBlock() const { return m_titles; }
155
156 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
157
158 void DecRefCount();
159 void IncRefCount();
160 int GetRefCount() const { return m_refCount; }
161
163
177 std::vector<SCH_SHEET_PATH>& GetClientSheetPaths()
178 {
180 }
181
182 void Append( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );
183
194 void Append( SCH_SCREEN* aScreen );
195
199 void Clear( bool aFree = true );
200
206 void FreeDrawList();
207
216 SCH_ITEM* GetItem( const VECTOR2I& aPosition, int aAccuracy = 0,
217 KICAD_T aType = SCH_LOCATE_ANY_T ) const;
218
234 void UpdateSymbolLinks( REPORTER* aReporter = nullptr );
235
241
248 void Print( const SCH_RENDER_SETTINGS* aSettings );
249
258 void Plot( PLOTTER* aPlotter, const SCH_PLOT_OPTS& aPlotOpts ) const;
259
268 bool Remove( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );
269
276 void Update( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );
277
286 void DeleteItem( SCH_ITEM* aItem );
287
288 bool CheckIfOnDrawList( const SCH_ITEM* aItem ) const;
289
296 void TestDanglingEnds( const SCH_SHEET_PATH* aPath = nullptr,
297 std::function<void( SCH_ITEM* )>* aChangedHandler = nullptr ) const;
298
305 std::set<SCH_ITEM*> MarkConnections( SCH_LINE* aSegment, bool aSecondPass );
306
310 void ClearDrawingState();
311
312 size_t CountConnectedItems( const VECTOR2I& aPos, bool aTestJunctions ) const;
313
328 bool IsJunction( const VECTOR2I& aPosition ) const;
329
334 bool IsExplicitJunction( const VECTOR2I& aPosition ) const;
335
340 bool IsExplicitJunctionNeeded( const VECTOR2I& aPosition ) const;
341
343 SPIN_STYLE aDefaultOrientation,
344 const SCH_SHEET_PATH* aSheet ) const;
349 bool IsExplicitJunctionAllowed( const VECTOR2I& aPosition ) const;
350
359 bool IsTerminalPoint( const VECTOR2I& aPosition, int aLayer ) const;
360
370 SCH_PIN* GetPin( const VECTOR2I& aPosition, SCH_SYMBOL** aSymbol = nullptr,
371 bool aEndPointOnly = false ) const;
372
379 SCH_SHEET_PIN* GetSheetPin( const VECTOR2I& aPosition ) const;
380
389 void ClearAnnotation( SCH_SHEET_PATH* aSheetPath, bool aResetPrefix );
390
401
407 void GetHierarchicalItems( std::vector<SCH_ITEM*>* aItems ) const;
408
413 void GetSheets( std::vector<SCH_ITEM*>* aItems ) const;
414
425 SCH_LINE* GetLine( const VECTOR2I& aPosition, int aAccuracy = 0, int aLayer = LAYER_NOTES,
426 SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const;
427
428 SCH_LINE* GetWire( const VECTOR2I& aPosition, int aAccuracy = 0,
429 SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const
430 {
431 return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
432 }
433
434 SCH_LINE* GetBus( const VECTOR2I& aPosition, int aAccuracy = 0,
435 SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const
436 {
437 return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
438 }
439
447 std::vector<SCH_LINE*> GetBusesAndWires( const VECTOR2I& aPosition,
448 bool aIgnoreEndpoints = false ) const;
449
455 std::vector<VECTOR2I> GetConnections() const;
456
463 std::vector<VECTOR2I> GetNeededJunctions( const std::deque<EDA_ITEM*>& aItems ) const;
464
472 SCH_LABEL_BASE* GetLabel( const VECTOR2I& aPosition, int aAccuracy = 0 ) const;
473
480 const std::map<wxString, LIB_SYMBOL*>& GetLibSymbols() const { return m_libSymbols; }
481
491 void AddLibSymbol( LIB_SYMBOL* aLibSymbol );
492
496 void AddBusAlias( std::shared_ptr<BUS_ALIAS> aAlias );
497
502 {
503 m_aliases.clear();
504 }
505
509 auto& GetBusAliases() const
510 {
511 return m_aliases;
512 }
513
514 const std::vector<SCH_SYMBOL_INSTANCE>& GetSymbolInstances() const
515 {
516 return m_symbolInstances;
517 }
518
519 const std::vector<SCH_SHEET_INSTANCE>& GetSheetInstances() const
520 {
521 return m_sheetInstances;
522 }
523
524 const KIID& GetUuid() const { return m_uuid; }
525
526 void AssignNewUuid() { m_uuid = KIID(); }
527
532
538
543
544#if defined(DEBUG)
545 void Show( int nestLevel, std::ostream& os ) const override;
546#endif
547
551 void MigrateSimModels();
552
565 void PruneOrphanedSymbolInstances( const wxString& aProjectName,
566 const SCH_SHEET_LIST& aValidSheetPaths );
567
580 void PruneOrphanedSheetInstances( const wxString& aProjectName,
581 const SCH_SHEET_LIST& aValidSheetPaths );
582
583private:
584 friend SCH_EDIT_FRAME; // Only to populate m_symbolInstances.
585 friend SCH_IO_KICAD_SEXPR_PARSER; // Only to load instance information from schematic file.
586 friend SCH_IO_KICAD_SEXPR; // Only to save the loaded instance information to schematic file.
588
589 bool doIsJunction( const VECTOR2I& aPosition, bool aBreakCrossings,
590 bool* aHasExplicitJunctionDot, bool* aHasBusEntry ) const;
591
592 void clearLibSymbols();
593
607 size_t getLibSymbolNameMatches( const SCH_SYMBOL& aSymbol, std::vector<wxString>& aMatches );
608
609
614 {
615 bool operator()( const std::shared_ptr<BUS_ALIAS>& a,
616 const std::shared_ptr<BUS_ALIAS>& b ) const
617 {
618 return a->GetName() < b->GetName();
619 }
620 };
621
622public:
628
629private:
630 wxString m_fileName; // File used to load the screen.
632 int m_refCount; // Number of sheets referencing this screen.
633 // Delete when it goes to zero.
641 std::vector<SCH_SHEET_PATH> m_clientSheetPathList;
642
643
644 PAGE_INFO m_paper; // The size of the paper to print or plot on.
646 VECTOR2I m_aux_origin; // Origin used for drill & place files by Pcbnew.
648
649 int m_modification_sync; // Inequality with SYMBOL_LIBS::GetModificationHash()
650 // will trigger ResolveAll().
651
652 bool m_zoomInitialized; // Set to true once the zoom value is initialized with
653 // `InitZoom()`.
654
656
659
661 std::set< std::shared_ptr< BUS_ALIAS >, BusAliasCmp > m_aliases;
662
664 std::map<wxString, LIB_SYMBOL*> m_libSymbols;
665
680 std::vector<SCH_SYMBOL_INSTANCE> m_symbolInstances;
681 std::vector<SCH_SHEET_INSTANCE> m_sheetInstances;
682
690};
691
692
703{
704public:
705 SCH_SCREENS( SCH_SHEET* aSheet );
706 SCH_SCREENS( SCH_SHEET& aSheet ) : SCH_SCREENS( &aSheet ) {}
707 ~SCH_SCREENS();
708 size_t GetCount() const { return m_screens.size(); }
711 SCH_SCREEN* GetScreen( unsigned int aIndex ) const;
712 SCH_SHEET* GetSheet( unsigned int aIndex ) const;
713
722 void ClearAnnotationOfNewSheetPaths( SCH_SHEET_LIST& aInitialSheetPathList );
723
734
741 void DeleteAllMarkers( enum MARKER_BASE::MARKER_T aMarkerType, bool aIncludeExclusions );
742
746 void DeleteMarkers( enum MARKER_BASE::MARKER_T aMarkerTyp, int aErrorCode,
747 bool aIncludeExclusions = true );
748
752 void DeleteMarker( SCH_MARKER* aMarker );
753
765 void UpdateSymbolLinks( REPORTER* aReporter = nullptr );
766
767 void ClearEditFlags();
768
780
787 size_t GetLibNicknames( wxArrayString& aLibNicknames );
788
796 int ChangeSymbolLibNickname( const wxString& aFrom, const wxString& aTo );
797
807 bool HasSchematic( const wxString& aSchematicFileName );
808
813
818
824
825 void PruneOrphanedSymbolInstances( const wxString& aProjectName,
826 const SCH_SHEET_LIST& aValidSheetPaths );
827
828 void PruneOrphanedSheetInstances( const wxString& aProjectName,
829 const SCH_SHEET_LIST& aValidSheetPaths );
830
831private:
832 void addScreenToList( SCH_SCREEN* aScreen, SCH_SHEET* aSheet );
833 void buildScreenList( SCH_SHEET* aSheet);
834
835 std::vector< SCH_SCREEN* > m_screens;
836 std::vector< SCH_SHEET* > m_sheets;
837 unsigned int m_index;
838};
839
840#endif /* SCREEN_H */
BASE_SCREEN class implementation.
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:41
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
Implements an R-tree for fast spatial and type indexing of schematic items.
Definition: sch_rtree.h:40
bool empty() const
Definition: sch_rtree.h:176
Definition: kiid.h:49
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:49
Define a library symbol object.
Definition: lib_symbol.h:77
Describe the page size and margins of a paper page on which to eventually print or plot.
Definition: page_info.h:59
Base plotter engine class.
Definition: plotter.h:104
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:71
Holds all the data relating to one schematic.
Definition: schematic.h:75
Schematic editor (Eeschema) main window.
Object to parser s-expression symbol library and schematic file formats.
A SCH_IO derivation for loading schematic files using the new s-expression file format.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:174
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:41
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
Definition: sch_screen.h:703
SCH_SCREEN * GetNext()
unsigned int m_index
Definition: sch_screen.h:837
std::vector< SCH_SHEET * > m_sheets
Definition: sch_screen.h:836
SCH_SCREEN * GetScreen(unsigned int aIndex) const
void UpdateSymbolLinks(REPORTER *aReporter=nullptr)
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in the full schematic.
void DeleteMarker(SCH_MARKER *aMarker)
Delete a specific marker.
void DeleteMarkers(enum MARKER_BASE::MARKER_T aMarkerTyp, int aErrorCode, bool aIncludeExclusions=true)
Delete all markers of a particular type and error code.
void buildScreenList(SCH_SHEET *aSheet)
void FixLegacyPowerSymbolMismatches()
Fix legacy power symbols that have mismatched value text fields and invisible power pin names.
SCH_SCREEN * GetFirst()
void DeleteAllMarkers(enum MARKER_BASE::MARKER_T aMarkerType, bool aIncludeExclusions)
Delete all electronic rules check markers of aMarkerType from all the screens in the list.
void PruneOrphanedSheetInstances(const wxString &aProjectName, const SCH_SHEET_LIST &aValidSheetPaths)
int ChangeSymbolLibNickname(const wxString &aFrom, const wxString &aTo)
Change all of the symbol library nicknames.
SCH_SCREENS(SCH_SHEET &aSheet)
Definition: sch_screen.h:706
void BuildClientSheetPathList()
built the list of sheet paths sharing a screen for each screen in use
size_t GetCount() const
Definition: sch_screen.h:708
void ClearAnnotationOfNewSheetPaths(SCH_SHEET_LIST &aInitialSheetPathList)
Clear the annotation for the symbols inside new sheetpaths when a complex hierarchy is modified and n...
void PruneOrphanedSymbolInstances(const wxString &aProjectName, const SCH_SHEET_LIST &aValidSheetPaths)
bool HasNoFullyDefinedLibIds()
Test all of the schematic symbols to see if all LIB_ID objects library nickname is not set.
void ClearEditFlags()
SCH_SHEET * GetSheet(unsigned int aIndex) const
int ReplaceDuplicateTimeStamps()
Test all sheet and symbol objects in the schematic for duplicate time stamps and replaces them as nec...
std::vector< SCH_SCREEN * > m_screens
Definition: sch_screen.h:835
bool HasSchematic(const wxString &aSchematicFileName)
Check if one of the schematics in the list of screens is aSchematicFileName.
size_t GetLibNicknames(wxArrayString &aLibNicknames)
Fetch all of the symbol library nicknames into aLibNicknames.
void SetLegacySymbolInstanceData()
Update the symbol value and footprint instance data for legacy designs.
void addScreenToList(SCH_SCREEN *aScreen, SCH_SHEET *aSheet)
void SetFileFormatVersionAtLoad(int aVersion)
Definition: sch_screen.h:127
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:130
std::map< wxString, LIB_SYMBOL * > m_libSymbols
Library symbols required for this schematic.
Definition: sch_screen.h:664
SCH_PIN * GetPin(const VECTOR2I &aPosition, SCH_SYMBOL **aSymbol=nullptr, bool aEndPointOnly=false) const
Test the screen for a symbol pin item at aPosition.
bool m_fileExists
Definition: sch_screen.h:658
void ClearDrawingState()
Clear the state flags of all the items in the screen.
auto & GetBusAliases() const
Return a set of bus aliases defined in this screen.
Definition: sch_screen.h:509
std::vector< SCH_SHEET_INSTANCE > m_sheetInstances
Definition: sch_screen.h:681
SCH_LINE * GetLine(const VECTOR2I &aPosition, int aAccuracy=0, int aLayer=LAYER_NOTES, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
Return a line item located at aPosition.
void SetTitleBlock(const TITLE_BLOCK &aTitleBlock)
Definition: sch_screen.h:156
void ClearBusAliases()
Remove all bus alias definitions.
Definition: sch_screen.h:501
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Definition: sch_screen.cpp:152
void AddLibSymbol(LIB_SYMBOL *aLibSymbol)
Add aLibSymbol to the library symbol map.
void AddBusAlias(std::shared_ptr< BUS_ALIAS > aAlias)
Add a bus alias definition (and transfers ownership of the pointer).
void FixLegacyPowerSymbolMismatches()
Fix legacy power symbols that have mismatched value text fields and invisible power pin names.
bool HasItems(KICAD_T aItemType) const
Definition: sch_screen.cpp:138
void Clear(bool aFree=true)
Delete all draw items and clears the project settings.
Definition: sch_screen.cpp:277
void PruneOrphanedSymbolInstances(const wxString &aProjectName, const SCH_SHEET_LIST &aValidSheetPaths)
Remove all invalid symbol instance data in this screen object for the project defined by aProjectName...
std::vector< SCH_SHEET_PATH > & GetClientSheetPaths()
Return the number of times this screen is used.
Definition: sch_screen.h:177
void UpdateSymbolLinks(REPORTER *aReporter=nullptr)
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic from the project SYMB...
Definition: sch_screen.cpp:777
SCH_LINE * GetWire(const VECTOR2I &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
Definition: sch_screen.h:428
int m_refCount
Definition: sch_screen.h:632
const EE_RTREE & Items() const
Definition: sch_screen.h:109
TITLE_BLOCK m_titles
Definition: sch_screen.h:645
void TestDanglingEnds(const SCH_SHEET_PATH *aPath=nullptr, std::function< void(SCH_ITEM *)> *aChangedHandler=nullptr) const
Test all of the connectable objects in the schematic for unused connection points.
void EnsureAlternateReferencesExist()
For screens shared by many sheetpaths (complex hierarchies): to be able to clear or modify any refere...
void SetPageSettings(const PAGE_INFO &aPageSettings)
Definition: sch_screen.h:131
bool AllSymbolDefaultInstancesNotSet()
Check all symbol default instance to see if they are not set yet.
void PruneOrphanedSheetInstances(const wxString &aProjectName, const SCH_SHEET_LIST &aValidSheetPaths)
Remove all invalid sheet instance data in this screen object for the project defined by aProjectName ...
std::vector< SCH_LINE * > GetBusesAndWires(const VECTOR2I &aPosition, bool aIgnoreEndpoints=false) const
Return buses and wires passing through aPosition.
const std::map< wxString, LIB_SYMBOL * > & GetLibSymbols() const
Fetch a list of unique LIB_SYMBOL object pointers required to properly render each SCH_SYMBOL in this...
Definition: sch_screen.h:480
int m_modification_sync
Definition: sch_screen.h:649
double m_LastZoomLevel
last value for the zoom level, useful in Eeschema when changing the current displayed sheet to reuse ...
Definition: sch_screen.h:627
const VECTOR2I & GetAuxOrigin() const
Definition: sch_screen.h:151
void SetAuxOrigin(const VECTOR2I &aPosition)
Definition: sch_screen.h:152
bool IsExplicitJunction(const VECTOR2I &aPosition) const
Indicates that a junction dot is necessary at the given location.
Definition: sch_screen.cpp:486
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
Definition: sch_screen.h:108
int m_fileFormatVersionAtLoad
Definition: sch_screen.h:631
const wxString & GetFileName() const
Definition: sch_screen.h:143
void DecRefCount()
Definition: sch_screen.cpp:131
const KIID & GetUuid() const
Definition: sch_screen.h:524
std::set< SCH_ITEM * > MarkConnections(SCH_LINE *aSegment, bool aSecondPass)
Return all wires and junctions connected to aSegment which are not connected any symbol pin.
Definition: sch_screen.cpp:407
friend SCH_IO_KICAD_SEXPR_PARSER
Definition: sch_screen.h:585
void Print(const SCH_RENDER_SETTINGS *aSettings)
Print all the items in the screen to aDC.
Definition: sch_screen.cpp:965
SCH_ITEM * GetItem(const VECTOR2I &aPosition, int aAccuracy=0, KICAD_T aType=SCH_LOCATE_ANY_T) const
Check aPosition within a distance of aAccuracy for items of type aFilter.
Definition: sch_screen.cpp:391
bool IsExplicitJunctionAllowed(const VECTOR2I &aPosition) const
Indicates that a juction dot may be placed at the given location.
Definition: sch_screen.cpp:505
void clearLibSymbols()
Definition: sch_screen.cpp:108
wxString m_fileName
Definition: sch_screen.h:630
bool IsTerminalPoint(const VECTOR2I &aPosition, int aLayer) const
Test if aPosition is a connection point on aLayer.
Definition: sch_screen.cpp:712
bool IsReadOnly() const
Definition: sch_screen.h:146
void UpdateLocalLibSymbolLinks()
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic with the local projec...
Definition: sch_screen.cpp:932
void IncRefCount()
Definition: sch_screen.cpp:125
friend SCH_IO_ALTIUM
Definition: sch_screen.h:587
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
Definition: sch_screen.cpp:117
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_screen.cpp:146
void SetLegacySymbolInstanceData()
Update the symbol value and footprint instance data for legacy designs.
const std::vector< SCH_SYMBOL_INSTANCE > & GetSymbolInstances() const
Definition: sch_screen.h:514
SCH_LINE * GetBus(const VECTOR2I &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
Definition: sch_screen.h:434
bool Remove(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:322
std::vector< SCH_SHEET_PATH > m_clientSheetPathList
The list of sheet paths sharing this screen.
Definition: sch_screen.h:641
friend SCH_IO_KICAD_SEXPR
Definition: sch_screen.h:586
SCHEMATIC * Schematic() const
Definition: sch_screen.cpp:99
EE_RTREE m_rtree
Definition: sch_screen.h:647
bool HasSheets() const
Definition: sch_screen.h:118
int GetFileFormatVersionAtLoad() const
Definition: sch_screen.h:128
VECTOR2I m_aux_origin
Definition: sch_screen.h:646
void GetHierarchicalItems(std::vector< SCH_ITEM * > *aItems) const
Add all schematic sheet and symbol objects in the screen to aItems.
bool IsExplicitJunctionNeeded(const VECTOR2I &aPosition) const
Indicates that a junction dot is necessary at the given location, and does not yet exist.
Definition: sch_screen.cpp:495
SCH_SHEET_PIN * GetSheetPin(const VECTOR2I &aPosition) const
Test the screen if aPosition is a sheet label object.
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:154
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:296
void Plot(PLOTTER *aPlotter, const SCH_PLOT_OPTS &aPlotOpts) const
Plot all the schematic objects to aPlotter.
virtual wxString GetClass() const override
Return the class name.
Definition: sch_screen.h:122
friend SCH_EDIT_FRAME
Definition: sch_screen.h:584
void Update(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Update aItem's bounding box in the tree.
Definition: sch_screen.cpp:315
void SetConnectivityDirty()
Definition: sch_screen.cpp:958
bool m_zoomInitialized
Definition: sch_screen.h:652
std::vector< VECTOR2I > GetNeededJunctions(const std::deque< EDA_ITEM * > &aItems) const
Return the unique set of points belonging to aItems where a junction is needed.
bool FileExists() const
Definition: sch_screen.h:149
int GetRefCount() const
Definition: sch_screen.h:160
void AssignNewUuid()
Definition: sch_screen.h:526
PAGE_INFO m_paper
Definition: sch_screen.h:644
bool IsJunction(const VECTOR2I &aPosition) const
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:478
const std::vector< SCH_SHEET_INSTANCE > & GetSheetInstances() const
Definition: sch_screen.h:519
bool m_isReadOnly
Read only status of the screen file.
Definition: sch_screen.h:655
void GetSheets(std::vector< SCH_ITEM * > *aItems) const
Similar to Items().OfType( SCH_SHEET_T ), but return the sheets in a deterministic order (L-R,...
bool CheckIfOnDrawList(const SCH_ITEM *aItem) const
Definition: sch_screen.cpp:385
std::vector< VECTOR2I > GetConnections() const
Collect a unique list of all possible connection points in the schematic.
SPIN_STYLE GetLabelOrientationForPoint(const VECTOR2I &aPosition, SPIN_STYLE aDefaultOrientation, const SCH_SHEET_PATH *aSheet) const
Definition: sch_screen.cpp:514
KIID m_uuid
A unique identifier for each schematic file.
Definition: sch_screen.h:689
std::vector< SCH_SYMBOL_INSTANCE > m_symbolInstances
The list of symbol instances loaded from the schematic file.
Definition: sch_screen.h:680
void ClearAnnotation(SCH_SHEET_PATH *aSheetPath, bool aResetPrefix)
Clear the annotation for the symbols in aSheetPath on the screen.
void SetFileReadOnly(bool aIsReadOnly)
Definition: sch_screen.h:145
bool doIsJunction(const VECTOR2I &aPosition, bool aBreakCrossings, bool *aHasExplicitJunctionDot, bool *aHasBusEntry) const
size_t CountConnectedItems(const VECTOR2I &aPos, bool aTestJunctions) const
void MigrateSimModels()
Migrate any symbols having V6 simulation models to their V7 equivalents.
void DeleteItem(SCH_ITEM *aItem)
Removes aItem from the linked list and deletes the object.
Definition: sch_screen.cpp:360
std::set< std::shared_ptr< BUS_ALIAS >, BusAliasCmp > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:661
size_t getLibSymbolNameMatches(const SCH_SYMBOL &aSymbol, std::vector< wxString > &aMatches)
Return a list of potential library symbol matches for aSymbol.
bool IsEmpty() const
Definition: sch_screen.h:111
void SetFileExists(bool aFileExists)
Definition: sch_screen.h:148
SCH_LABEL_BASE * GetLabel(const VECTOR2I &aPosition, int aAccuracy=0) const
Return a label item located at aPosition.
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Definition: sch_sheet_pin.h:66
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition: sch_sheet.h:57
Schematic symbol object.
Definition: sch_symbol.h:105
Hold the information shown in the lower right corner of a plot, printout, or editing view.
Definition: title_block.h:41
@ LAYER_WIRE
Definition: layer_ids.h:356
@ LAYER_NOTES
Definition: layer_ids.h:371
@ LAYER_BUS
Definition: layer_ids.h:357
SCH_LINE_TEST_T
Definition: sch_screen.h:70
@ ENTIRE_LENGTH_T
Definition: sch_screen.h:71
@ EXCLUDE_END_POINTS_T
Definition: sch_screen.h:73
@ END_POINTS_ONLY_T
Definition: sch_screen.h:72
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
LIB_ID LibId
Definition: sch_screen.h:79
std::vector< std::pair< int, wxString > > Fields
Definition: sch_screen.h:83
Compare two BUS_ALIAS objects by name.
Definition: sch_screen.h:614
bool operator()(const std::shared_ptr< BUS_ALIAS > &a, const std::shared_ptr< BUS_ALIAS > &b) const
Definition: sch_screen.h:615
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:198
@ SCH_SHEET_T
Definition: typeinfo.h:174