74 m_fileFormatVersionAtLoad( 0 ),
75 m_paper( wxT(
"A4" ) ),
76 m_isReadOnly( false ),
101 wxT(
"SCH_SCREEN must have a SCHEMATIC parent!" ) );
109 for(
const std::pair<const wxString, LIB_SYMBOL*>& libSymbol :
m_libSymbols )
110 delete libSymbol.second;
118 wxASSERT( aFileName.IsEmpty() || wxIsAbsolutePath( aFileName ) );
132 wxCHECK_RET(
m_refCount != 0, wxT(
"Screen reference count already zero. Bad programmer!" ) );
141 return sheets.
begin() != sheets.
end();
186 std::vector<wxString> matches;
189 foundSymbol =
nullptr;
191 for(
const wxString& libSymbolName : matches )
198 foundSymbol = it->second;
200 wxCHECK2( foundSymbol,
continue );
210 newName = libSymbolName;
216 foundSymbol =
nullptr;
223 newName.Printf( wxT(
"%s_%d" ),
230 newName.Printf( wxT(
"%s_%d" ),
244 LIB_ID newLibId( wxEmptyString, newName );
248 newLibSymbol->
SetName( newName );
265 wxCHECK_RET( aScreen,
"Invalid screen object." );
272 aScreen->
Clear(
false );
299 std::vector<SCH_ITEM*> delete_list;
304 return ( aItem->Type() != SCH_SHEET_PIN_T && aItem->Type() != SCH_FIELD_T );
316 if(
Remove( aItem, aUpdateLibSymbol ) )
317 Append( aItem, aUpdateLibSymbol );
330 bool removeUnusedLibSymbol =
true;
338 removeUnusedLibSymbol =
false;
343 if( removeUnusedLibSymbol )
361 wxCHECK_RET( aItem, wxT(
"Cannot delete invalid item from screen." ) );
375 wxCHECK_RET( sheet, wxT(
"Sheet pin parent not properly set, bad programmer!" ) );
398 if( item->HitTest( aPosition, aAccuracy ) )
408#define PROCESSED CANDIDATE
410 std::set<SCH_ITEM*> retval;
411 std::stack<SCH_LINE*> to_search;
413 wxCHECK_MSG( aSegment && aSegment->
Type() ==
SCH_LINE_T, retval, wxT(
"Invalid pointer." ) );
415 to_search.push( aSegment );
417 while( !to_search.empty() )
448 retval.insert( junction );
450 retval.insert( line );
451 to_search.push( line );
453 else if( !junction && !
pin )
455 retval.insert( line );
456 to_search.push( line );
463 retval.insert( line );
464 to_search.push( line );
471 item->ClearTempFlags();
479 bool hasExplicitJunction;
481 bool isJunction =
doIsJunction( aPosition,
false, &hasExplicitJunction, &hasBusEntry );
489 bool hasExplicitJunction;
491 bool isJunction =
doIsJunction( aPosition,
false, &hasExplicitJunction, &hasBusEntry );
493 return isJunction && !hasBusEntry;
499 bool hasExplicitJunction;
501 bool isJunction =
doIsJunction( aPosition,
false, &hasExplicitJunction, &hasBusEntry );
503 return isJunction && !hasBusEntry && !hasExplicitJunction;
510 auto ret = aDefaultOrientation;
516 switch( item->Type() )
521 if( busEntry->m_connected_bus_item )
525 auto bus =
static_cast<const SCH_LINE*
>( busEntry->m_connected_bus_item );
526 if( bus->Angle().AsDegrees() == 90.0 )
530 if( aPosition.
x < bus->GetPosition().x )
532 else if( aPosition.
x > bus->GetPosition().x )
535 else if( bus->Angle().AsDegrees() == 0.0 )
539 if( aPosition.
y < bus->GetPosition().y )
541 else if( aPosition.
y > bus->GetPosition().y )
550 auto line =
static_cast<const SCH_LINE*
>( item );
554 if( -45 < angle && angle <= 45 )
556 if( line->GetStartPoint().x <= line->GetEndPoint().x )
563 if( line->GetStartPoint().y <= line->GetEndPoint().y )
577 if(
pin->GetPosition() == aPosition )
579 if(
pin->GetOrientation() == PIN_ORIENTATION::PIN_RIGHT )
581 else if(
pin->GetOrientation() == PIN_ORIENTATION::PIN_LEFT )
583 else if(
pin->GetOrientation() == PIN_ORIENTATION::PIN_UP )
585 else if(
pin->GetOrientation() == PIN_ORIENTATION::PIN_DOWN )
706 bool hasExplicitJunction;
708 bool isJunction =
doIsJunction( aPosition,
true, &hasExplicitJunction, &hasBusEntry );
710 return isJunction && !hasBusEntry;
716 bool* aHasExplicitJunctionDot,
bool* aHasBusEntry )
const
718 enum layers { WIRES = 0, BUSES };
720 *aHasExplicitJunctionDot =
false;
721 *aHasBusEntry =
false;
723 bool breakLines[ 2 ] = {
false };
724 std::unordered_set<int> exitAngles[ 2 ];
725 std::vector<const SCH_LINE*> midPointLines[ 2 ];
728 int uniqueAngle = 10000;
730 for(
const SCH_ITEM* item :
Items().Overlapping( aPosition ) )
735 switch( item->Type() )
738 if( item->HitTest( aPosition, -1 ) )
739 *aHasExplicitJunctionDot =
true;
759 breakLines[ layer ] =
true;
760 exitAngles[ layer ].insert( line->
GetAngleFrom( aPosition ) );
762 else if( line->
HitTest( aPosition, -1 ) )
764 if( aBreakCrossings )
765 breakLines[ layer ] =
true;
768 midPointLines[ layer ].push_back( line );
774 if( item->IsConnected( aPosition ) )
776 breakLines[ BUSES ] =
true;
777 exitAngles[ BUSES ].insert( uniqueAngle++ );
778 breakLines[ WIRES ] =
true;
779 exitAngles[ WIRES ].insert( uniqueAngle++ );
780 *aHasBusEntry =
true;
787 if( item->IsConnected( aPosition ) )
789 breakLines[ WIRES ] =
true;
790 exitAngles[ WIRES ].insert( uniqueAngle++ );
800 for(
int layer : { WIRES, BUSES } )
802 if( breakLines[ layer ] )
804 for(
const SCH_LINE* line : midPointLines[ layer ] )
806 exitAngles[ layer ].insert( line->GetAngleFrom( aPosition ) );
807 exitAngles[ layer ].insert( line->GetReverseAngleFrom( aPosition ) );
812 return exitAngles[ WIRES ].size() >= 3 || exitAngles[ BUSES ].size() >= 3;
819 wxT(
"Invalid layer type passed to SCH_SCREEN::IsTerminalPoint()." ) );
832 if( sheetPin && sheetPin->
IsConnected( aPosition ) )
855 if(
GetPin( aPosition,
nullptr,
true ) )
868 if( sheetPin && sheetPin->
IsConnected( aPosition ) )
883 wxCHECK_RET(
Schematic(),
"Cannot call SCH_SCREEN::UpdateSymbolLinks with no SCHEMATIC" );
886 std::unique_ptr< LIB_SYMBOL > libSymbol;
887 std::vector<SCH_SYMBOL*> symbols;
894 symbols.push_back(
static_cast<SCH_SYMBOL*
>( item ) );
909 auto it =
m_libSymbols.find( symbol->GetSchSymbolLibraryName() );
915 msg.Printf(
_(
"Setting schematic symbol '%s %s' library identifier to '%s'." ),
923 symbol->SetLibSymbol(
new LIB_SYMBOL( *it->second ) );
927 if( !symbol->GetLibId().IsValid() )
931 msg.Printf(
_(
"Schematic symbol reference '%s' library identifier is not valid. "
932 "Unable to link library symbol." ),
943 if( !libs->
HasLibrary( symbol->GetLibId().GetLibNickname() ) && !legacyLibs )
947 msg.Printf(
_(
"Symbol library '%s' not found and no fallback cache library "
948 "available. Unable to link library symbol." ),
949 symbol->GetLibId().GetLibNickname().wx_str() );
956 if( libs->
HasLibrary( symbol->GetLibId().GetLibNickname() ) )
966 msg.Printf(
_(
"I/O error %s resolving library symbol %s" ), ioe.
What(),
975 SYMBOL_LIB& legacyCacheLib = legacyLibs->back();
978 wxCHECK2( legacyCacheLib.
IsCache(),
continue );
980 wxString
id = symbol->GetLibId().Format();
982 id.Replace(
':',
'_' );
986 msg.Printf(
_(
"Falling back to cache to set symbol '%s:%s' link '%s'." ),
1000 libSymbol->SetParent();
1002 m_libSymbols.insert( { symbol->GetSchSymbolLibraryName(),
1007 msg.Printf(
_(
"Setting schematic symbol '%s %s' library identifier to '%s'." ),
1018 msg.Printf(
_(
"No library symbol found for schematic symbol '%s %s'." ),
1025 symbol->SetLibSymbol( libSymbol.release() );
1037 std::vector<SCH_SYMBOL*> symbols;
1040 symbols.push_back(
static_cast<SCH_SYMBOL*
>( item ) );
1047 auto it =
m_libSymbols.find( symbol->GetSchSymbolLibraryName() );
1054 symbol->SetLibSymbol( libSymbol );
1064 item->SetConnectivityDirty(
true );
1071 std::vector<SCH_ITEM*> junctions;
1072 std::vector<SCH_ITEM*> bitmaps;
1073 std::vector<SCH_ITEM*> other;
1077 if( item->IsMoving() )
1081 junctions.push_back( item );
1083 bitmaps.push_back( item );
1085 other.push_back( item );
1089 std::stable_sort( other.begin(), other.end(),
1092 if( a->Type() == b->Type() )
1093 return a->GetLayer() > b->GetLayer();
1095 return a->Type() < b->Type();
1099 item->Print( aSettings,
VECTOR2I( 0, 0 ) );
1102 item->PrintBackground( aSettings,
VECTOR2I( 0, 0 ) );
1105 item->Print( aSettings,
VECTOR2I( 0, 0 ) );
1108 item->Print( aSettings,
VECTOR2I( 0, 0 ) );
1115 std::vector<SCH_ITEM*> junctions;
1116 std::vector<SCH_ITEM*> bitmaps;
1117 std::vector<SCH_SYMBOL*> symbols;
1118 std::vector<SCH_ITEM*> other;
1122 if( item->IsMoving() )
1126 junctions.push_back( item );
1128 bitmaps.push_back( item );
1130 other.push_back( item );
1141 symbols.push_back(
static_cast<SCH_SYMBOL*
>( item ) );
1149 std::sort( other.begin(), other.end(),
1152 if( a->Type() == b->Type() )
1153 return a->GetLayer() > b->GetLayer();
1155 return a->Type() > b->Type();
1159 constexpr bool background =
true;
1164 for(
const SCH_ITEM* item : bitmaps )
1167 item->Plot( aPlotter, background );
1170 for(
const SCH_ITEM* item : other )
1173 item->Plot( aPlotter, background );
1176 for(
const SCH_ITEM* item : other )
1179 item->Plot( aPlotter, !background );
1188 for(
SCH_FIELD field : sym->GetFields() )
1189 field.Plot( aPlotter,
false );
1191 sym->PlotPins( aPlotter );
1194 sym->PlotDNP( aPlotter );
1197 for(
const SCH_ITEM* item : junctions )
1200 item->Plot( aPlotter, !background );
1208 item->ClearTempFlags();
1213 bool aEndPointOnly )
const
1220 candidate =
static_cast<SCH_SYMBOL*
>( item );
1229 std::vector<LIB_PIN*> pins;
1232 for(
LIB_PIN* test_pin : pins )
1253 if(
pin && aSymbol )
1254 *aSymbol = candidate;
1268 sheetPin = sheet->
GetPin( aPosition );
1284 if( ( item->Type() !=
SCH_JUNCTION_T || aTestJunctions ) && item->IsConnected( aPos ) )
1324 if( item->IsType( { SCH_SYMBOL_T, SCH_SHEET_T, SCH_LABEL_LOCATE_ANY_T } ) )
1325 aItems->push_back( item );
1333 aItems->push_back( item );
1335 std::sort( aItems->begin(), aItems->end(),
1338 if( a->GetPosition().x == b->GetPosition().x )
1341 if( a->GetPosition().y == b->GetPosition().y )
1342 return a->m_Uuid < b->m_Uuid;
1344 return a->GetPosition().y < b->GetPosition().y;
1348 return a->GetPosition().x < b->GetPosition().x;
1355 std::function<
void(
SCH_ITEM* )>* aChangedHandler )
const
1359 std::vector<DANGLING_END_ITEM> endPoints;
1364 if( item->IsConnectable() )
1365 item->GetEndPoints( endPoints );
1370 if( item->UpdateDanglingState( endPoints, aPath ) )
1372 if( aChangedHandler )
1373 (*aChangedHandler)( item );
1381 item->RunOnChildren( getends );
1386 update_state( item );
1387 item->RunOnChildren( update_state );
1398 aAccuracy = std::max( aAccuracy, 1 );
1400 for(
SCH_ITEM* item :
Items().Overlapping( aPosition, aAccuracy ) )
1405 if( item->GetLayer() != aLayer )
1408 if( !item->HitTest( aPosition, aAccuracy ) )
1411 switch( aSearchType )
1417 if( !( (
SCH_LINE*) item )->IsEndPoint( aPosition ) )
1422 if( ( (
SCH_LINE*) item )->IsEndPoint( aPosition ) )
1432 bool aIgnoreEndpoints )
const
1434 std::vector<SCH_LINE*> retVal;
1438 if( item->IsType( { SCH_ITEM_LOCATE_WIRE_T, SCH_ITEM_LOCATE_BUS_T } ) )
1442 if( aIgnoreEndpoints && wire->
IsEndPoint( aPosition ) )
1446 retVal.push_back( wire );
1456 std::vector<VECTOR2I> retval;
1463 std::vector<VECTOR2I> pts = item->GetConnectionPoints();
1464 retval.insert( retval.end(), pts.begin(), pts.end() );
1469 std::sort( retval.begin(), retval.end(),
1472 return a.x < b.x || ( a.x == b.x && a.y < b.y );
1474 retval.erase( std::unique( retval.begin(), retval.end() ), retval.end() );
1482 std::vector<VECTOR2I> pts;
1485 for(
const EDA_ITEM* edaItem : aItems )
1493 pts.insert( pts.end(), new_pts.begin(), new_pts.end() );
1501 for(
const VECTOR2I& pt : connections )
1504 pts.push_back( pt );
1510 std::sort( pts.begin(), pts.end(),
1513 return a.x < b.x || ( a.x == b.x && a.y < b.y );
1516 pts.erase( unique( pts.begin(), pts.end() ), pts.end() );
1519 pts.erase( std::remove_if( pts.begin(), pts.end(),
1520 [
this](
const VECTOR2I& a ) ->
bool
1522 return !IsExplicitJunctionNeeded( a );
1532 for(
SCH_ITEM* item :
Items().Overlapping( aPosition, aAccuracy ) )
1534 switch( item->Type() )
1540 if( item->HitTest( aPosition, aAccuracy ) )
1556 wxCHECK( aLibSymbol, );
1615 std::vector<wxString>& aMatches )
1620 aMatches.emplace_back( searchName );
1629 if( pair.first.StartsWith( searchName, &suffix ) && suffix.ToLong( &tmp ) )
1630 aMatches.emplace_back( pair.first );
1633 return aMatches.size();
1638void SCH_SCREEN::Show(
int nestLevel, std::ostream& os )
const
1641 NestedSpace( nestLevel, os ) <<
'<' <<
GetClass().Lower().mb_str() <<
">\n";
1644 item->Show( nestLevel + 1, os );
1646 NestedSpace( nestLevel, os ) <<
"</" <<
GetClass().Lower().mb_str() <<
">\n";
1703 if( aScreen ==
nullptr )
1708 if( screen == aScreen )
1723 wxCHECK_RET( screen,
"No screen for aSheet" );
1742 wxCHECK_RET( sch,
"Null schematic in SCH_SCREENS::ClearAnnotationOfNewSheetPaths" );
1752 bool path_exists =
false;
1754 for(
const SCH_SHEET_PATH& existing_sheetpath: aInitialSheetPathList )
1756 if( existing_sheetpath.Path() == sheetpath.Path() )
1766 SCH_SCREEN* curr_screen = sheetpath.LastScreen();
1781 std::vector<SCH_ITEM*> items;
1786 return a->
m_Uuid < b->m_Uuid;
1789 std::set<
EDA_ITEM*,
decltype( timestamp_cmp )> unique_stamps( timestamp_cmp );
1792 screen->GetHierarchicalItems( &items );
1794 if( items.size() < 2 )
1799 if( !unique_stamps.insert( item ).second )
1804 const_cast<KIID&
>( item->m_Uuid ) =
KIID();
1821 for(
SCH_ITEM* item : screen->Items() )
1822 item->ClearEditFlags();
1833 if( item == aMarker )
1835 screen->DeleteItem( item );
1844 bool aIncludeExclusions )
1848 std::vector<SCH_ITEM*> markers;
1853 std::shared_ptr<RC_ITEM>rcItem = marker->
GetRCItem();
1856 && ( aErrorCode ==
ERCE_UNSPECIFIED || rcItem->GetErrorCode() == aErrorCode )
1857 && ( !marker->
IsExcluded() || aIncludeExclusions ) )
1859 markers.push_back( item );
1864 screen->DeleteItem( marker );
1870 bool aIncludeExclusions )
1879 screen->UpdateSymbolLinks( aReporter );
1888 wxCHECK_RET( sch,
"Null schematic in SCH_SCREENS::UpdateSymbolLinks" );
1901 bool has_symbols =
false;
1916 return has_symbols ? true :
false;
1929 if( !nickname.
empty() && ( aLibNicknames.Index( nickname ) == wxNOT_FOUND ) )
1930 aLibNicknames.Add( nickname );
1934 return aLibNicknames.GetCount();
1967 if( screen->GetFileName() == aSchematicFileName )
1980 wxFileName rhs = aSchematicFileName;
1982 wxCHECK( rhs.IsAbsolute(),
false );
1986 lhs = screen->GetFileName();
1988 if( lhs.GetPath() != rhs.GetPath() )
1991 lhsLower = lhs.GetFullName().Lower();
1992 rhsLower = rhs.GetFullName().Lower();
1994 if( lhsLower == rhsLower && lhs.GetFullName() != rhs.GetFullName() )
2011 wxCHECK_RET( sch,
"Null schematic in SCH_SCREENS::BuildClientSheetPathList" );
2014 curr_screen->GetClientSheetPaths().clear();
2018 SCH_SCREEN* used_screen = sheetpath.LastScreen();
2023 if( used_screen == curr_screen )
2036 screen->SetLegacySymbolInstanceData();
2043 screen->FixLegacyPowerSymbolMismatches();
2057 SIM_MODEL::MigrateSimModel<SCH_SYMBOL, SCH_FIELD>( *symbol, &
Schematic()->
Prj() );
constexpr EDA_IU_SCALE schIUScale
Handles how to draw a screen (a board, a schematic ...)
int m_virtualPageNumber
An integer based page number used for printing a range of pages.
bool m_Center
Center on screen.
int m_pageCount
The number of BASE_SCREEN objects in this design.
void SetContentModified(bool aModified=true)
void InitDataPoints(const VECTOR2I &aPageSizeInternalUnits)
void SetOrigin(const Vec &pos)
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
void Recalculate(const SCH_SHEET_LIST &aSheetList, bool aUnconditional=false, std::function< void(SCH_ITEM *)> *aChangedItemHandler=nullptr)
Updates the connection graph for the given list of sheets.
A base class for most all the KiCad significant classes used in schematics and boards.
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
void SetFlags(EDA_ITEM_FLAGS aMask)
KICAD_T Type() const
Returns the type of object.
virtual void SetParent(EDA_ITEM *aParent)
EDA_ITEM * GetParent() const
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
EE_TYPE Overlapping(const BOX2I &aRect) const
bool remove(SCH_ITEM *aItem)
Remove an item from the tree.
void insert(SCH_ITEM *aItem)
Insert an item into the tree.
bool contains(const SCH_ITEM *aItem, bool aRobust=false) const
Determine if a given item exists in the tree.
iterator end()
Returns a read/write iterator that points to one past the last element in the EE_RTREE.
iterator begin()
Returns a read/write iterator that points to the first element in the EE_RTREE N.B.
EE_TYPE OfType(KICAD_T aType) const
void clear()
Remove all items from the RTree.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
int GetDefaultPenWidth() const
A logical library item identifier and consists of various portions much like a URI.
wxString GetUniStringLibId() const
const wxString GetUniStringLibItemName() const
Get strings for display messages in dialogs.
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
const UTF8 & GetLibNickname() const
Return the logical library name portion of a LIB_ID.
Define a library symbol object.
LIB_ITEMS_CONTAINER & GetDrawItems()
Return a reference to the draw item list.
LIB_ID GetLibId() const override
wxString GetName() const override
std::unique_ptr< LIB_SYMBOL > Flatten() const
Return a flattened symbol inheritance to the caller.
void SetLibId(const LIB_ID &aLibId)
virtual void SetName(const wxString &aName)
bool HasLibrary(const wxString &aNickname, bool aCheckEnabled=false) const
Test for the existence of aNickname in the library table.
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
std::shared_ptr< RC_ITEM > GetRCItem() const
enum TYPEMARKER GetMarkerType() const
const VECTOR2I GetSizeIU(double aIUScale) const
Gets the page size in internal units.
Base plotter engine class.
RENDER_SETTINGS * RenderSettings()
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
A small class to help profiling.
void Show(std::ostream &aStream=std::cerr)
Print the elapsed time (in a suitable unit) to a stream.
A pure virtual class used to derive REPORTER objects from.
virtual REPORTER & ReportTail(const wxString &aText, SEVERITY aSeverity=RPT_SEVERITY_UNDEFINED)
Places the report at the end of the list, for objects that support report ordering.
Holds all the data relating to one schematic.
CONNECTION_GRAPH * ConnectionGraph() const override
SCH_SHEET_LIST GetSheets() const override
Builds and returns an updated schematic hierarchy TODO: can this be cached?
PROJECT & Prj() const override
Return a reference to the project this schematic is part of.
Class for a wire to bus entry.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual bool IsConnectable() const
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
bool IsConnected(const VECTOR2I &aPoint) const
Test the item to see if it is connected to aPoint.
virtual std::vector< VECTOR2I > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
Segment description base class to describe items which have 2 end points (track, wire,...
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
int GetAngleFrom(const VECTOR2I &aPoint) const
EDA_ANGLE Angle() const
Gets the angle between the start and end lines.
VECTOR2I GetEndPoint() const
VECTOR2I GetStartPoint() const
bool IsEndPoint(const VECTOR2I &aPoint) const
Container class that holds multiple SCH_SCREEN objects in a hierarchy.
std::vector< SCH_SHEET * > m_sheets
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 buildScreenList(SCH_SHEET *aSheet)
void DeleteMarkers(enum MARKER_BASE::TYPEMARKER aMarkerTyp, int aErrorCode, bool aIncludeExclusions=true)
Delete all markers of a particular type and error code.
void FixLegacyPowerSymbolMismatches()
Fix legacy power symbols that have mismatched value text fields and invisible power pin names.
int ChangeSymbolLibNickname(const wxString &aFrom, const wxString &aTo)
Change all of the symbol library nicknames.
SCH_SCREENS(SCH_SHEET *aSheet)
void BuildClientSheetPathList()
built the list of sheet paths sharing a screen for each screen in use
void ClearAnnotationOfNewSheetPaths(SCH_SHEET_LIST &aInitialSheetPathList)
Clear the annotation for the symbols inside new sheetpaths when a complex hierarchy is modified and n...
bool CanCauseCaseSensitivityIssue(const wxString &aSchematicFileName) const
Check aSchematicFileName for a potential file name case sensitivity issue.
bool HasNoFullyDefinedLibIds()
Test all of the schematic symbols to see if all LIB_ID objects library nickname is not set.
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...
void DeleteAllMarkers(enum MARKER_BASE::TYPEMARKER aMarkerType, bool aIncludeExclusions)
Delete all electronic rules check markers of aMarkerType from all the screens in the list.
std::vector< SCH_SCREEN * > m_screens
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)
std::map< wxString, LIB_SYMBOL * > m_libSymbols
Library symbols required for this schematic.
void ClearDrawingState()
Clear the state flags of all the items in the screen.
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 Append(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
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
void Clear(bool aFree=true)
Delete all draw items and clears the project settings.
LIB_PIN * GetPin(const VECTOR2I &aPosition, SCH_SYMBOL **aSymbol=nullptr, bool aEndPointOnly=false) const
Test the screen for a symbol pin item at aPosition.
std::vector< SCH_SHEET_PATH > & GetClientSheetPaths()
Return the number of times this screen is used.
void UpdateSymbolLinks(REPORTER *aReporter=nullptr)
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic from the project SYMB...
SCH_LINE * GetWire(const VECTOR2I &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
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...
std::vector< SCH_LINE * > GetBusesAndWires(const VECTOR2I &aPosition, bool aIgnoreEndpoints=false) const
Return buses and wires passing through aPosition.
double m_LastZoomLevel
last value for the zoom level, useful in Eeschema when changing the current displayed sheet to reuse ...
bool IsExplicitJunction(const VECTOR2I &aPosition) const
Indicates that a junction dot is necessary at the given location.
EE_RTREE & Items()
Gets the full RTree, usually for iterating.
void Print(const RENDER_SETTINGS *aSettings)
Print all the items in the screen to aDC.
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.
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.
bool IsExplicitJunctionAllowed(const VECTOR2I &aPosition) const
Indicates that a juction dot may be placed at the given location.
bool IsTerminalPoint(const VECTOR2I &aPosition, int aLayer) const
Test if aPosition is a connection point on aLayer.
void UpdateLocalLibSymbolLinks()
Initialize the LIB_SYMBOL reference for each SCH_SYMBOL found in this schematic with the local projec...
void SetFileName(const wxString &aFileName)
Set the file name for this screen to aFileName.
static bool ClassOf(const EDA_ITEM *aItem)
void SetLegacySymbolInstanceData()
Update the symbol value and footprint instance data for legacy designs.
SCH_LINE * GetBus(const VECTOR2I &aPosition, int aAccuracy=0, SCH_LINE_TEST_T aSearchType=ENTIRE_LENGTH_T) const
bool Remove(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Remove aItem from the schematic associated with this screen.
SCH_SCREEN(EDA_ITEM *aParent=nullptr)
SCHEMATIC * Schematic() const
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.
SCH_SHEET_PIN * GetSheetPin(const VECTOR2I &aPosition) const
Test the screen if aPosition is a sheet label object.
void Plot(PLOTTER *aPlotter) const
Plot all the schematic objects to aPlotter.
void FreeDrawList()
Free all the items from the schematic associated with the screen.
virtual wxString GetClass() const override
Return the class name.
void Update(SCH_ITEM *aItem, bool aUpdateLibSymbol=true)
Update aItem's bounding box in the tree.
void SetConnectivityDirty()
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 IsJunction(const VECTOR2I &aPosition) const
Test if a junction is required for the items at aPosition on the screen.
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
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
void ClearAnnotation(SCH_SHEET_PATH *aSheetPath, bool aResetPrefix)
Clear the annotation for the symbols in aSheetPath on the screen.
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.
std::set< std::shared_ptr< BUS_ALIAS >, BusAliasCmp > m_aliases
List of bus aliases stored in this screen.
size_t getLibSymbolNameMatches(const SCH_SYMBOL &aSymbol, std::vector< wxString > &aMatches)
Return a list of potential library symbol matches for aSymbol.
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.
SCH_SHEET * GetParent() const
Get the parent sheet object of this sheet pin.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
SCH_SHEET_PIN * GetPin(const VECTOR2I &aPosition)
Return the sheet pin item found at aPosition in the sheet.
void RemovePin(const SCH_SHEET_PIN *aSheetPin)
Remove aSheetPin from the sheet.
SCH_SCREEN * GetScreen() const
void GetLibPins(std::vector< LIB_PIN * > &aPinsList) const
Populate a vector with all the pins from the library object.
void SetLibId(const LIB_ID &aName)
LIB_ITEM * GetDrawItem(const VECTOR2I &aPosition, KICAD_T aType=TYPE_NOT_INIT)
Return the symbol library item at aPosition that is part of this symbol.
const std::vector< SCH_SYMBOL_INSTANCE > & GetInstanceReferences() const
void SetValueFieldText(const wxString &aValue)
wxString GetSchSymbolLibraryName() const
bool AddSheetPathReferenceEntryIfMissing(const KIID_PATH &aSheetPath)
Add an instance to the alternate references list (m_instanceReferences), if this entry does not alrea...
VECTOR2I GetPinPhysicalPosition(const LIB_PIN *Pin) const
void ClearAnnotation(const SCH_SHEET_PATH *aSheetPath, bool aResetPrefix)
Clear exiting symbol annotation.
std::vector< SCH_PIN * > GetPins(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve a list of the SCH_PINs for the given sheet path.
void AddHierarchicalReference(const KIID_PATH &aPath, const wxString &aRef, int aUnit)
Add a full hierarchical reference to this symbol.
void SetSchSymbolLibraryName(const wxString &aName)
The name of the symbol in the schematic library symbol list.
int GetOrientation() const
Get the display symbol orientation.
const LIB_ID & GetLibId() const
std::vector< LIB_PIN * > GetAllLibPins() const
std::unique_ptr< LIB_SYMBOL > & GetLibSymbolRef()
void SetLibSymbol(LIB_SYMBOL *aLibSymbol)
Set this schematic symbol library symbol reference to aLibSymbol.
A collection of SYMBOL_LIB objects.
LIB_SYMBOL * LoadSymbol(const wxString &aNickname, const wxString &aName)
Load a LIB_SYMBOL having aName from the library given by aNickname.
Object used to load, save, search, and otherwise manipulate symbol library files.
LIB_SYMBOL * FindSymbol(const wxString &aName) const
Find LIB_SYMBOL by aName.
An 8 bit string that is assuredly encoded in UTF8, and supplies special conversion support to and fro...
static const wxChar DanglingProfileMask[]
#define STRUCT_DELETED
flag indication structures to be erased
#define IS_MOVING
Item being moved.
SYMBOL_ORIENTATION_T
enum used in RotationMiroir()
@ SYM_ROTATE_COUNTERCLOCKWISE
static const wxChar DanglingProfileMask[]
wxString UnescapeString(const wxString &aSource)
The EE_TYPE struct provides a type-specific auto-range iterator to the RTree.
A simple container for schematic symbol instance information.
Definition for symbol library class.
@ VALUE_FIELD
Field Value of part, i.e. "3.3K".
@ REFERENCE_FIELD
Field Reference of part, i.e. "IC21".
bool IsPointOnSegment(const VECTOR2I &aSegStart, const VECTOR2I &aSegEnd, const VECTOR2I &aTestPoint)
Test if aTestPoint is on line defined by aSegStart and aSegEnd.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.