KiCad PCB EDA Suite
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
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, jaen-pierre.charras@gipsa-lab.inpg.com
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#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;
69
71{
75};
76
77
79{
81 int Unit;
83
84 std::vector<std::pair<FIELD_T, wxString>> Fields;
85
87 Unit( 1 ),
88 Convert( 1 )
89 {
90 }
91};
92
93class SCH_SCREEN : public BASE_SCREEN
94{
95public:
96 SCH_SCREEN( EDA_ITEM* aParent = nullptr );
97
99
100 SCHEMATIC* Schematic() const;
101
112 EE_RTREE& Items() { return m_rtree; }
113 const EE_RTREE& Items() const { return m_rtree; }
114
115 bool IsEmpty() const
116 {
117 return m_rtree.empty();
118 }
119
120 bool HasItems( KICAD_T aItemType ) const;
121
122 bool HasSheets() const { return HasItems( SCH_SHEET_T ); }
123
124 static bool ClassOf( const EDA_ITEM* aItem );
125
126 virtual wxString GetClass() const override
127 {
128 return wxT( "SCH_SCREEN" );
129 }
130
131 void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
133
134 const PAGE_INFO& GetPageSettings() const { return m_paper; }
135 void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_paper = aPageSettings; }
136
145 void SetFileName( const wxString& aFileName );
146
147 const wxString& GetFileName() const { return m_fileName; }
148
149 void SetFileReadOnly( bool aIsReadOnly ) { m_isReadOnly = aIsReadOnly; }
150 bool IsReadOnly() const { return m_isReadOnly; }
151
152 void SetFileExists( bool aFileExists ) { m_fileExists = aFileExists; }
153 bool FileExists() const { return m_fileExists; }
154
155 const VECTOR2I& GetAuxOrigin() const { return m_aux_origin; }
156 void SetAuxOrigin( const VECTOR2I& aPosition ) { m_aux_origin = aPosition; }
157
158 const TITLE_BLOCK& GetTitleBlock() const { return m_titles; }
159
160 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) { m_titles = aTitleBlock; }
161
162 void DecRefCount();
163 void IncRefCount();
164 int GetRefCount() const { return m_refCount; }
165
167
181 std::vector<SCH_SHEET_PATH>& GetClientSheetPaths()
182 {
184 }
185
186 void Append( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );
187
198 void Append( SCH_SCREEN* aScreen );
199
203 void Clear( bool aFree = true );
204
210 void FreeDrawList();
211
220 SCH_ITEM* GetItem( const VECTOR2I& aPosition, int aAccuracy = 0,
221 KICAD_T aType = SCH_LOCATE_ANY_T ) const;
222
238 void UpdateSymbolLinks( REPORTER* aReporter = nullptr );
239
245
254 void Plot( PLOTTER* aPlotter, const SCH_PLOT_OPTS& aPlotOpts ) const;
255
264 bool Remove( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );
265
272 void Update( SCH_ITEM* aItem, bool aUpdateLibSymbol = true );
273
282 void DeleteItem( SCH_ITEM* aItem );
283
284 bool CheckIfOnDrawList( const SCH_ITEM* aItem ) const;
285
292 void TestDanglingEnds( const SCH_SHEET_PATH* aPath = nullptr,
293 std::function<void( SCH_ITEM* )>* aChangedHandler = nullptr ) const;
294
301 std::set<SCH_ITEM*> MarkConnections( SCH_LINE* aSegment, bool aSecondPass );
302
306 void ClearDrawingState();
307
308 size_t CountConnectedItems( const VECTOR2I& aPos, bool aTestJunctions ) const;
309
324 bool IsJunction( const VECTOR2I& aPosition ) const;
325
331 bool IsExplicitJunction( const VECTOR2I& aPosition ) const;
332
338 bool IsExplicitJunctionNeeded( const VECTOR2I& aPosition ) const;
339
341 SPIN_STYLE aDefaultOrientation,
342 const SCH_SHEET_PATH* aSheet ) const;
348 bool IsExplicitJunctionAllowed( const VECTOR2I& aPosition ) const;
349
358 bool IsTerminalPoint( const VECTOR2I& aPosition, int aLayer ) const;
359
369 SCH_PIN* GetPin( const VECTOR2I& aPosition, SCH_SYMBOL** aSymbol = nullptr,
370 bool aEndPointOnly = false ) const;
371
378 SCH_SHEET_PIN* GetSheetPin( const VECTOR2I& aPosition ) const;
379
388 void ClearAnnotation( SCH_SHEET_PATH* aSheetPath, bool aResetPrefix );
389
400
406 void GetHierarchicalItems( std::vector<SCH_ITEM*>* aItems ) const;
407
412 void GetSheets( std::vector<SCH_ITEM*>* aItems ) const;
413
424 SCH_LINE* GetLine( const VECTOR2I& aPosition, int aAccuracy = 0, int aLayer = LAYER_NOTES,
425 SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const;
426
427 SCH_LINE* GetWire( const VECTOR2I& aPosition, int aAccuracy = 0,
428 SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const
429 {
430 return GetLine( aPosition, aAccuracy, LAYER_WIRE, aSearchType );
431 }
432
433 SCH_LINE* GetBus( const VECTOR2I& aPosition, int aAccuracy = 0,
434 SCH_LINE_TEST_T aSearchType = ENTIRE_LENGTH_T ) const
435 {
436 return GetLine( aPosition, aAccuracy, LAYER_BUS, aSearchType );
437 }
438
446 std::vector<SCH_LINE*> GetBusesAndWires( const VECTOR2I& aPosition,
447 bool aIgnoreEndpoints = false ) const;
448
454 std::vector<VECTOR2I> GetConnections() const;
455
462 std::vector<VECTOR2I> GetNeededJunctions( const std::deque<EDA_ITEM*>& aItems ) const;
463
471 SCH_LABEL_BASE* GetLabel( const VECTOR2I& aPosition, int aAccuracy = 0 ) const;
472
479 const std::map<wxString, LIB_SYMBOL*>& GetLibSymbols() const { return m_libSymbols; }
480
490 void AddLibSymbol( LIB_SYMBOL* aLibSymbol );
491
497 void FixupEmbeddedData();
498
502 void AddBusAlias( std::shared_ptr<BUS_ALIAS> aAlias );
503
508 {
509 m_aliases.clear();
510 }
511
515 auto& GetBusAliases() const
516 {
517 return m_aliases;
518 }
519
520 const std::vector<SCH_SYMBOL_INSTANCE>& GetSymbolInstances() const
521 {
522 return m_symbolInstances;
523 }
524
525 const std::vector<SCH_SHEET_INSTANCE>& GetSheetInstances() const
526 {
527 return m_sheetInstances;
528 }
529
530 const KIID& GetUuid() const { return m_uuid; }
531
532 void AssignNewUuid() { m_uuid = KIID(); }
533
538
544
549
551
558 bool InProjectPath() const;
559
560#if defined(DEBUG)
561 void Show( int nestLevel, std::ostream& os ) const override;
562#endif
563
567 void MigrateSimModels();
568
581 void PruneOrphanedSymbolInstances( const wxString& aProjectName,
582 const SCH_SHEET_LIST& aValidSheetPaths );
583
596 void PruneOrphanedSheetInstances( const wxString& aProjectName,
597 const SCH_SHEET_LIST& aValidSheetPaths );
598
602 std::set<wxString> GetSheetNames() const;
603
613
614private:
615 friend SCH_EDIT_FRAME; // Only to populate m_symbolInstances.
616 friend SCH_IO_KICAD_SEXPR_PARSER; // Only to load instance information from schematic file.
617 friend SCH_IO_KICAD_SEXPR; // Only to save the loaded instance information to schematic file.
620
621 bool doIsJunction( const VECTOR2I& aPosition, bool aBreakCrossings,
622 bool* aHasExplicitJunctionDot, bool* aHasBusEntry ) const;
623
624 void clearLibSymbols();
625
639 size_t getLibSymbolNameMatches( const SCH_SYMBOL& aSymbol, std::vector<wxString>& aMatches );
640
645 {
646 bool operator()( const std::shared_ptr<BUS_ALIAS>& a,
647 const std::shared_ptr<BUS_ALIAS>& b ) const
648 {
649 return a->GetName() < b->GetName();
650 }
651 };
652
653public:
659
660private:
661 wxString m_fileName; // File used to load the screen.
663 int m_refCount; // Number of sheets referencing this screen.
664 // Delete when it goes to zero.
672 std::vector<SCH_SHEET_PATH> m_clientSheetPathList;
673
674
675 PAGE_INFO m_paper; // The size of the paper to print or plot on.
677 VECTOR2I m_aux_origin; // Origin used for drill & place files by Pcbnew.
679
680 int m_modification_sync; // Inequality with SYMBOL_LIBS::GetModificationHash()
681 // will trigger ResolveAll().
682
683 bool m_zoomInitialized; // Set to true once the zoom value is initialized with
684 // `InitZoom()`.
685
687
690
692 std::set< std::shared_ptr< BUS_ALIAS >, BusAliasCmp > m_aliases;
693
695 std::map<wxString, LIB_SYMBOL*> m_libSymbols;
696
711 std::vector<SCH_SYMBOL_INSTANCE> m_symbolInstances;
712 std::vector<SCH_SHEET_INSTANCE> m_sheetInstances;
713
721};
722
723
734{
735public:
736 SCH_SCREENS( SCH_SHEET* aSheet );
737 SCH_SCREENS( SCH_SHEET& aSheet ) : SCH_SCREENS( &aSheet ) {}
738 ~SCH_SCREENS();
739 size_t GetCount() const { return m_screens.size(); }
742 SCH_SCREEN* GetScreen( unsigned int aIndex ) const;
743 SCH_SHEET* GetSheet( unsigned int aIndex ) const;
744
753 void ClearAnnotationOfNewSheetPaths( SCH_SHEET_LIST& aInitialSheetPathList );
754
765
772 void DeleteAllMarkers( enum MARKER_BASE::MARKER_T aMarkerType, bool aIncludeExclusions );
773
777 void DeleteMarkers( enum MARKER_BASE::MARKER_T aMarkerTyp, int aErrorCode,
778 bool aIncludeExclusions = true );
779
783 void DeleteMarker( SCH_MARKER* aMarker );
784
796 void UpdateSymbolLinks( REPORTER* aReporter = nullptr );
797
798 void ClearEditFlags();
799
811
818 size_t GetLibNicknames( wxArrayString& aLibNicknames );
819
827 int ChangeSymbolLibNickname( const wxString& aFrom, const wxString& aTo );
828
838 bool HasSchematic( const wxString& aSchematicFileName );
839
844
849
855
856 void PruneOrphanedSymbolInstances( const wxString& aProjectName,
857 const SCH_SHEET_LIST& aValidSheetPaths );
858
859 void PruneOrphanedSheetInstances( const wxString& aProjectName,
860 const SCH_SHEET_LIST& aValidSheetPaths );
861
863
864private:
865 void addScreenToList( SCH_SCREEN* aScreen, SCH_SHEET* aSheet );
866 void buildScreenList( SCH_SHEET* aSheet);
867
868 std::vector< SCH_SCREEN* > m_screens;
869 std::vector< SCH_SHEET* > m_sheets;
870 unsigned int m_index;
871};
872
873#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:95
Implement an R-tree for fast spatial and type indexing of schematic items.
Definition: sch_rtree.h:40
bool empty() const
Definition: sch_rtree.h:179
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:85
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:105
A pure virtual class used to derive REPORTER objects from.
Definition: reporter.h:73
Holds all the data relating to one schematic.
Definition: schematic.h:69
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:168
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:734
SCH_SCREEN * GetNext()
unsigned int m_index
Definition: sch_screen.h:870
std::vector< SCH_SHEET * > m_sheets
Definition: sch_screen.h:869
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:737
void BuildClientSheetPathList()
Build the list of sheet paths sharing a screen for each screen in use.
bool HasSymbolFieldNamesWithWhiteSpace() const
size_t GetCount() const
Definition: sch_screen.h:739
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:868
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:131
const PAGE_INFO & GetPageSettings() const
Definition: sch_screen.h:134
std::map< wxString, LIB_SYMBOL * > m_libSymbols
Library symbols required for this schematic.
Definition: sch_screen.h:695
SCH_PIN * GetPin(const VECTOR2I &aPosition, SCH_SYMBOL **aSymbol=nullptr, bool aEndPointOnly=false) const
Test the screen for a symbol pin item at aPosition.
Definition: sch_screen.cpp:970
bool m_fileExists
Flag to indicate the file associated with this screen has been created.
Definition: sch_screen.h:689
void ClearDrawingState()
Clear the state flags of all the items in the screen.
Definition: sch_screen.cpp:963
auto & GetBusAliases() const
Return a set of bus aliases defined in this screen.
Definition: sch_screen.h:515
std::vector< SCH_SHEET_INSTANCE > m_sheetInstances
Definition: sch_screen.h:712
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:160
void ClearBusAliases()
Remove all bus alias definitions.
Definition: sch_screen.h:507
void Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Definition: sch_screen.cpp:155
void AddLibSymbol(LIB_SYMBOL *aLibSymbol)
Add aLibSymbol to the library symbol map.
bool HasSymbolFieldNamesWithWhiteSpace() const
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:141
void Clear(bool aFree=true)
Delete all draw items and clears the project settings.
Definition: sch_screen.cpp:280
bool HasInstanceDataFromOtherProjects() const
Check symbols for instance data from other projects.
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:181
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:671
SCH_LINE * GetWire(const VECTOR2I &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
Definition: sch_screen.h:427
int m_refCount
Definition: sch_screen.h:663
std::set< wxString > GetSheetNames() const
const EE_RTREE & Items() const
Definition: sch_screen.h:113
TITLE_BLOCK m_titles
Definition: sch_screen.h:676
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:135
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:479
int m_modification_sync
Definition: sch_screen.h:680
double m_LastZoomLevel
last value for the zoom level, useful in Eeschema when changing the current displayed sheet to reuse ...
Definition: sch_screen.h:658
const VECTOR2I & GetAuxOrigin() const
Definition: sch_screen.h:155
void SetAuxOrigin(const VECTOR2I &aPosition)
Definition: sch_screen.h:156
bool IsExplicitJunction(const VECTOR2I &aPosition) const
Indicate that a junction dot is necessary at the given location.
Definition: sch_screen.cpp:489
EE_RTREE & Items()
Get the full RTree, usually for iterating.
Definition: sch_screen.h:112
int m_fileFormatVersionAtLoad
Definition: sch_screen.h:662
const wxString & GetFileName() const
Definition: sch_screen.h:147
void DecRefCount()
Definition: sch_screen.cpp:134
const KIID & GetUuid() const
Definition: sch_screen.h:530
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:410
friend SCH_IO_KICAD_SEXPR_PARSER
Definition: sch_screen.h:616
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:394
bool IsExplicitJunctionAllowed(const VECTOR2I &aPosition) const
Indicate that a junction dot may be placed at the given location.
Definition: sch_screen.cpp:508
void clearLibSymbols()
Definition: sch_screen.cpp:111
wxString m_fileName
Definition: sch_screen.h:661
bool IsTerminalPoint(const VECTOR2I &aPosition, int aLayer) const
Test if aPosition is a connection point on aLayer.
Definition: sch_screen.cpp:606
bool IsReadOnly() const
Definition: sch_screen.h:150
void UpdateLocalLibSymbolLinks()
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic with the local projec...
Definition: sch_screen.cpp:826
void IncRefCount()
Definition: sch_screen.cpp:128
friend SCH_IO_ALTIUM
Definition: sch_screen.h:618
friend TEST_SCH_SCREEN_FIXTURE
Definition: sch_screen.h:619
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
Definition: sch_screen.cpp:120
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_screen.cpp:149
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:520
SCH_LINE * GetBus(const VECTOR2I &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
Definition: sch_screen.h:433
bool Remove(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Remove aItem from the schematic associated with this screen.
Definition: sch_screen.cpp:325
std::vector< SCH_SHEET_PATH > m_clientSheetPathList
The list of sheet paths sharing this screen.
Definition: sch_screen.h:672
friend SCH_IO_KICAD_SEXPR
Definition: sch_screen.h:617
SCHEMATIC * Schematic() const
Definition: sch_screen.cpp:102
EE_RTREE m_rtree
Definition: sch_screen.h:678
void FixupEmbeddedData()
After loading a file from disk, the library symbols do not yet contain the full data for their embedd...
bool HasSheets() const
Definition: sch_screen.h:122
int GetFileFormatVersionAtLoad() const
Definition: sch_screen.h:132
VECTOR2I m_aux_origin
Definition: sch_screen.h:677
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
Indicate that a junction dot is necessary at the given location, and does not yet exist.
Definition: sch_screen.cpp:498
SCH_SHEET_PIN * GetSheetPin(const VECTOR2I &aPosition) const
Test the screen if aPosition is a sheet label object.
bool InProjectPath() const
Check if the schematic file is in the current project path.
const TITLE_BLOCK & GetTitleBlock() const
Definition: sch_screen.h:158
void FreeDrawList()
Free all the items from the schematic associated with the screen.
Definition: sch_screen.cpp:299
void Plot(PLOTTER *aPlotter, const SCH_PLOT_OPTS &aPlotOpts) const
Plot all the schematic objects to aPlotter.
Definition: sch_screen.cpp:859
virtual wxString GetClass() const override
Return the class name.
Definition: sch_screen.h:126
friend SCH_EDIT_FRAME
Definition: sch_screen.h:615
void Update(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Update aItem's bounding box in the tree.
Definition: sch_screen.cpp:318
void SetConnectivityDirty()
Definition: sch_screen.cpp:852
bool m_zoomInitialized
Definition: sch_screen.h:683
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:153
int GetRefCount() const
Definition: sch_screen.h:164
void AssignNewUuid()
Definition: sch_screen.h:532
PAGE_INFO m_paper
Definition: sch_screen.h:675
bool IsJunction(const VECTOR2I &aPosition) const
Test if a junction is required for the items at aPosition on the screen.
Definition: sch_screen.cpp:481
const std::vector< SCH_SHEET_INSTANCE > & GetSheetInstances() const
Definition: sch_screen.h:525
bool m_isReadOnly
Read only status of the screen file.
Definition: sch_screen.h:686
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:388
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:517
KIID m_uuid
A unique identifier for each schematic file.
Definition: sch_screen.h:720
std::vector< SCH_SYMBOL_INSTANCE > m_symbolInstances
The list of symbol instances loaded from the schematic file.
Definition: sch_screen.h:711
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:149
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)
Remove aItem from the linked list and deletes the object.
Definition: sch_screen.cpp:363
std::set< std::shared_ptr< BUS_ALIAS >, BusAliasCmp > m_aliases
List of bus aliases stored in this screen.
Definition: sch_screen.h:692
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:115
void SetFileExists(bool aFileExists)
Definition: sch_screen.h:152
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:47
Schematic symbol object.
Definition: sch_symbol.h:75
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:441
@ LAYER_NOTES
Definition: layer_ids.h:456
@ LAYER_BUS
Definition: layer_ids.h:442
SCH_LINE_TEST_T
Definition: sch_screen.h:71
@ ENTIRE_LENGTH_T
Definition: sch_screen.h:72
@ EXCLUDE_END_POINTS_T
Definition: sch_screen.h:74
@ END_POINTS_ONLY_T
Definition: sch_screen.h:73
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
LIB_ID LibId
Definition: sch_screen.h:80
std::vector< std::pair< FIELD_T, wxString > > Fields
Definition: sch_screen.h:84
Compare two BUS_ALIAS objects by name.
Definition: sch_screen.h:645
bool operator()(const std::shared_ptr< BUS_ALIAS > &a, const std::shared_ptr< BUS_ALIAS > &b) const
Definition: sch_screen.h:646
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