27#include <unordered_set>
77#include <wx/filedlg.h>
107 auto belowRootSheetCondition =
110 return m_frame->GetCurrentSheet().Last() != &
m_frame->Schematic().Root();
120 auto inDrawingRuleArea =
147 bool placeOneOnly = symbol !=
nullptr;
150 std::vector<PICKED_SYMBOL>* historyList =
nullptr;
151 bool ignorePrimePosition =
false;
155 bool keepSymbol =
false;
184 filter.FilterPowerSymbols(
true );
188 wxFAIL_MSG(
"PlaceSymbol(): unexpected request" );
203 m_view->AddToPreview( aSymbol,
false );
224 existingRefs.
Clear();
235 if( !newInstances.empty()
237 ||
SCH_REFERENCE( symbol, newInstances[0] ).AlwaysAnnotate() ) )
239 AnnotateNewSymbol( symbol, newInstances, existingRefs, schSettings, &hierarchy );
242 m_frame->GetCurrentSheet().UpdateAllScreenReferences();
265 existingRefs.
AddItem( placedSymbolReference );
277 ignorePrimePosition =
true;
285 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
291 bool isSyntheticClick = symbol && evt->IsActivate() && evt->HasPosition() && evt->Matches( aEvent );
293 if( evt->IsCancelInteractive() || ( symbol && evt->IsAction( &
ACTIONS::undo ) ) )
295 m_frame->GetInfoBar()->Dismiss();
312 else if( evt->IsActivate() && !isSyntheticClick )
314 if( symbol && evt->IsMoveTool() )
317 evt->SetPassEvent(
false );
323 m_frame->ShowInfoBarMsg(
_(
"Press <ESC> to cancel symbol creation." ) );
324 evt->SetPassEvent(
false );
328 if( evt->IsMoveTool() )
331 frame()->PushTool( originalEvent );
347 std::set<UTF8> unique_libid;
348 std::vector<PICKED_SYMBOL> alreadyPlaced;
368 alreadyPlaced.push_back( pickedSymbol );
374 bool footprintPreviews =
m_frame->eeconfig()->m_Appearance.footprint_preview;
389 if( evt->IsPrime() && !ignorePrimePosition )
416 if( keywords.Contains( wxT(
"global power" ) ) )
418 keywords.Replace( wxT(
"global power" ), wxT(
"local power" ) );
424 if( desc.Contains( wxT(
"global label" ) ) )
426 desc.Replace( wxT(
"global label" ), wxT(
"local label" ) );
439 symbol =
new SCH_SYMBOL( *libSymbol, &
m_frame->GetCurrentSheet(), sel, cursorPos,
446 existingRefs.
AddItem( placedSymbolReference );
449 if(
m_frame->eeconfig()->m_AutoplaceFields.enable )
461 m_frame->AddToScreen( symbol, screen );
463 if(
m_frame->eeconfig()->m_AutoplaceFields.enable )
466 m_frame->SaveCopyForRepeatItem( symbol );
469 commit.
Added( symbol, screen );
475 commit.
Push(
_(
"Place Symbol" ) );
480 if( placeOneOnly && !placeAllUnits )
485 if( keepSymbol || placeAllUnits )
497 const wxString currentRefStr = currentReference.
GetRef();
498 const bool isUnannotated = !currentRefStr.IsEmpty() && currentRefStr.Last() ==
'?';
499 const LIB_ID symLibId = symbol->GetLibId();
502 [&](
int aUnit ) ->
bool
512 if( schematic.
Contains( candidate ) )
522 while( currentReference.
GetUnit() <= symbol->GetUnitCount()
523 && unitOccupied( currentReference.
GetUnit() ) )
528 if( currentReference.
GetUnit() > symbol->GetUnitCount() )
535 if( keepSymbol || currentReference.
GetUnit() > 1 )
541 addSymbol( nextSymbol );
544 if( currentReference.
GetUnit() == 1 )
549 existingRefs.
AddItem( placedSymbolReference );
557 if( placeOneOnly && !symbol )
578 m_frame->SelectUnit( symbol, unit );
587 if( symbol && symbol->GetBodyStyle() != bodyStyle )
589 m_frame->SelectBodyStyle( symbol, bodyStyle );
610 symbol->SetPosition( cursorPos );
612 m_view->AddToPreview( symbol,
false );
613 m_frame->SetMsgPanel( symbol );
661 int requestedUnit = params.
m_Unit;
666 static const std::vector<KICAD_T> symbolTypes = {
SCH_SYMBOL_T };
669 if( selection.
Size() != 1 )
671 m_frame->ShowInfoBarMsg(
_(
"Select a single symbol to place the next unit." ) );
682 if( !symbol->IsMultiUnit() )
684 m_frame->ShowInfoBarMsg(
_(
"This symbol has only one unit." ) );
690 if( missingUnits.empty() )
692 m_frame->ShowInfoBarMsg(
_(
"All units of this symbol are already placed." ) );
698 if( requestedUnit > 0 )
700 if( missingUnits.count( requestedUnit ) == 0 )
702 m_frame->ShowInfoBarMsg(
_(
"Requested unit already placed." ) );
706 nextMissing = requestedUnit;
711 nextMissing = *std::min_element( missingUnits.begin(), missingUnits.end() );
714 std::unique_ptr<SCH_SYMBOL> newSymbol = std::make_unique<SCH_SYMBOL>( *symbol );
720 newSymbol->SetUnitSelection( nextMissing );
721 newSymbol->SetUnit( nextMissing );
722 newSymbol->SetRefProp( symbol->GetBaseRef( &sheetPath ) );
739 std::optional<VECTOR2I> connectionAnchor;
740 std::optional<VECTOR2I> positionAnchor;
743 []( std::optional<VECTOR2I>& aBest,
const VECTOR2I& aCandidate )
745 if( !aBest || aCandidate.y < aBest->y || ( aCandidate.y == aBest->y && aCandidate.x < aBest->x ) )
754 for(
const VECTOR2I& pt : item->GetConnectionPoints() )
755 keepTopLeft( connectionAnchor, pt );
757 keepTopLeft( positionAnchor, item->GetPosition() );
760 return connectionAnchor ? connectionAnchor : positionAnchor;
782 struct RESET_FORCED_CURSOR_GUARD
786 ~RESET_FORCED_CURSOR_GUARD()
792 RESET_FORCED_CURSOR_GUARD forcedCursorGuard{ controls };
794 if( !cfg || !common_settings )
799 std::unique_ptr<DESIGN_BLOCK> designBlock;
800 wxString sheetFileName = wxEmptyString;
802 if( placingDesignBlock )
813 sheetFileName = designBlock->GetSchematicFile();
815 if( sheetFileName.IsEmpty() || !wxFileExists( sheetFileName ) )
817 m_frame->ShowInfoBarError(
_(
"Design block has no schematic to place." ),
true );
824 wxString* importSourceFile = aEvent.
Parameter<wxString*>();
826 if( importSourceFile !=
nullptr )
827 sheetFileName = *importSourceFile;
837 auto placeSheetContents =
851 std::unordered_set<EDA_ITEM*> existingItems;
854 existingItems.insert( item );
856 if( !
m_frame->LoadSheetFromFile( sheetPath.
Last(), &sheetPath, sheetFileName,
true,
857 placingDesignBlock ) )
862 m_frame->SetSheetNumberAndCount();
878 baseName = designBlock->GetLibId().GetLibItemName().wx_str();
879 group->SetDesignBlockLibId( designBlock->GetLibId() );
883 baseName = wxFileName( sheetFileName ).GetName();
894 if( !existingItems.contains( item ) )
901 if( item->Type() ==
SCH_SYMBOL_T && !keepAnnotations && !autoAnnotate )
902 static_cast<SCH_SYMBOL*
>( item )->ClearAnnotation( &sheetPath,
false );
907 if( !item->GetParentGroup() )
910 group->AddItem( item );
912 newItems.emplace_back( item );
915 commit.
Added( item, screen );
933 std::vector<SCH_ITEM*> blockItems =
FlattenGroups( newItems );
941 if( !keepAnnotations || placingDesignBlock )
986 commit.
Push( placingDesignBlock ?
_(
"Add Design Block" )
987 :
_(
"Import Schematic Sheet Content" ) );
992 m_frame->SetContentModified( screenWasModified );
996 m_frame->UpdateHierarchyNavigator();
1003 if( sheetFileName.IsEmpty() )
1008 if (!placingDesignBlock)
1010 if( sheetFileName.IsEmpty() )
1012 path = wxPathOnly(
m_frame->Prj().GetProjectFullName() );
1013 file = wxEmptyString;
1017 path = wxPathOnly( sheetFileName );
1018 file = wxFileName( sheetFileName ).GetFullName();
1023 wxFileDialog dlg(
m_frame,
_(
"Choose Schematic" ),
path, file,
1027 dlg.SetCustomizeHook( dlgHook );
1031 if( dlg.ShowModal() == wxID_CANCEL )
1034 sheetFileName = dlg.GetPath();
1036 m_frame->GetDesignBlockPane()->UpdateCheckboxes();
1039 if( sheetFileName.IsEmpty() )
1075 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1081 bool isSyntheticClick = designBlock && evt->IsActivate() && evt->HasPosition() && evt->Matches( aEvent );
1083 if( evt->IsCancelInteractive() || ( designBlock && evt->IsAction( &
ACTIONS::undo ) ) )
1085 m_frame->GetInfoBar()->Dismiss();
1088 else if( evt->IsActivate() && !isSyntheticClick )
1090 m_frame->GetInfoBar()->Dismiss();
1097 if( placingDesignBlock )
1125 evt->SetPassEvent();
1137 bool immediateMode =
image !=
nullptr;
1138 bool ignorePrimePosition =
false;
1177 m_view->RecacheAllItems();
1202 ignorePrimePosition =
true;
1210 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1216 bool isSyntheticClick =
image && evt->IsActivate() && evt->HasPosition() && evt->Matches( aEvent );
1220 m_frame->GetInfoBar()->Dismiss();
1230 else if( evt->IsActivate() && !isSyntheticClick )
1232 if(
image && evt->IsMoveTool() )
1235 evt->SetPassEvent(
false );
1241 m_frame->ShowInfoBarMsg(
_(
"Press <ESC> to cancel image creation." ) );
1242 evt->SetPassEvent(
false );
1246 if( evt->IsMoveTool() )
1249 m_frame->PushTool( originalEvent );
1267 bool cancelled =
false;
1272 cancelled = dlg.ShowModal() != wxID_OK;
1281 if( evt->IsPrime() && !ignorePrimePosition )
1283 cursorPos =
grid.Align( evt->Position() );
1292 wxString fullFilename = dlg.GetPath();
1295 if( wxFileExists( fullFilename ) )
1298 if( !
image || !
image->GetReferenceImage().ReadImageFile( fullFilename ) )
1300 wxMessageBox( wxString::Format(
_(
"Could not load image from '%s'." ), fullFilename ) );
1312 m_view->RecacheAllItems();
1323 commit.
Push(
_(
"Place Image" ) );
1355 evt->SetPassEvent();
1360 image->SetPosition( cursorPos );
1363 m_view->RecacheAllItems();
1376 evt->SetPassEvent();
1399 bool loggedInfoBarError =
false;
1400 wxString description;
1402 bool allowRepeat =
false;
1428 description =
_(
"Add No Connect Flag" );
1435 description =
_(
"Add Junction" );
1441 description =
_(
"Add Wire to Bus Entry" );
1446 wxASSERT_MSG(
false,
"Unknown item type in SCH_DRAWING_TOOLS::SingleClickPlace" );
1485 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1487 cursorPos = evt->IsPrime() ? evt->Position() : controls->
GetMousePosition();
1488 cursorPos =
grid.ResolveSnap( cursorPos,
grid.GetItemGrid( previewItem ),
nullptr ).position;
1491 if( evt->IsCancelInteractive() )
1495 else if( evt->IsActivate() )
1497 if( evt->IsMoveTool() )
1500 frame()->PushTool( originalEvent );
1515 commit.
Removed( existingItem, screen );
1516 m_frame->RemoveFromScreen( existingItem, screen );
1517 commit.
Push(
_(
"Remove No Connect Flag" ) );
1526 m_frame->ShowInfoBarError(
_(
"Junction location contains no joinable wires and/or pins." ) );
1527 loggedInfoBarError =
true;
1530 else if( loggedInfoBarError )
1532 m_frame->GetInfoBar()->Dismiss();
1540 lwbTool->
AddJunction( &commit, screen, cursorPos );
1542 m_frame->Schematic().CleanUp( &commit );
1544 commit.
Push( description );
1552 m_frame->AddToScreen( newItem, screen );
1555 m_frame->SaveCopyForRepeatItem( newItem );
1558 commit.
Added( newItem, screen );
1560 m_frame->Schematic().CleanUp( &commit );
1562 commit.
Push( description );
1582 m_frame->SetMsgPanel( previewItem );
1619 std::deque<SCH_ITEM*> strokeItems;
1620 strokeItems.push_back( previewItem );
1635 std::deque<SCH_JUNCTION*> junctions;
1636 junctions.push_back(
static_cast<SCH_JUNCTION*
>( previewItem ) );
1659 evt->SetPassEvent();
1664 evt->SetPassEvent();
1697 wxASSERT( aWire->
IsWire() );
1701 const auto labelDriverName = [](
const auto& aConnection ) -> wxString
1703 SCH_ITEM* driver = aConnection.Driver();
1705 if( driver && driver->
IsType( { SCH_LABEL_T, SCH_GLOBAL_LABEL_T } ) )
1706 return aConnection.LocalName();
1708 return wxEmptyString;
1713 const auto connection =
m_frame->Schematic().Connectivity().Connection( aWire->
m_Uuid, sheetPath.
PathRef() );
1714 return connection ? labelDriverName( *connection ) : wxString();
1718 return wireConnection ? labelDriverName( *wireConnection ) : wxString();
1723 std::list<std::unique_ptr<SCH_LABEL_BASE>>& aLabelList )
1746 labelItem->
GetFields().back().SetItalic(
true );
1747 labelItem->
GetFields().back().SetVisible(
true );
1761 labelItem = globalLabel;
1769 wxFAIL_MSG(
"SCH_DRAWING_TOOLS::createNewLabel() unknown label type" );
1789 if( !netName.IsEmpty() )
1792 labelItem->
SetText( netName );
1827 if( aLabelList.empty() )
1828 aLabelList.push_back( std::unique_ptr<SCH_LABEL_BASE>( labelItem ) );
1842 textItem =
new SCH_TEXT( aPosition );
1877 pin->SetText( std::to_string( aSheet->
GetPins().size() + 1 ) );
1879 pin->SetPosition( aPosition );
1880 pin->ClearSelected();
1904 bool ignorePrimePosition =
false;
1907 wxString description;
1909 std::list<std::unique_ptr<SCH_LABEL_BASE>> itemsToPlace;
1941 else if( isGlobalLabel )
1943 else if( isNetLabel || isClassLabel )
1945 else if( isHierLabel )
1951 auto updatePreview =
1955 m_view->AddToPreview( item,
false );
1958 m_view->AddToPreview( aChild,
false );
1972 while( !itemsToPlace.empty() )
1973 itemsToPlace.erase( itemsToPlace.begin() );
1976 auto prepItemForPlacement =
2008 && ( isText || isGlobalLabel || isHierLabel || isClassLabel || isNetLabel ) )
2011 ignorePrimePosition =
true;
2021 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2024 cursorPos =
grid.ResolveSnap( cursorPos, snapGrid, item ).position;
2028 bool isSyntheticClick = item && evt->IsActivate() && evt->HasPosition() && evt->
Matches( aEvent );
2030 if( evt->IsCancelInteractive() || evt->IsAction( &
ACTIONS::undo ) )
2032 m_frame->GetInfoBar()->Dismiss();
2039 else if( evt->IsActivate() && !isSyntheticClick )
2041 if( item && evt->IsMoveTool() )
2044 evt->SetPassEvent(
false );
2050 m_frame->ShowInfoBarMsg(
_(
"Press <ESC> to cancel item creation." ) );
2051 evt->SetPassEvent(
false );
2055 if( evt->IsPointEditor() )
2061 if( evt->IsMoveTool() )
2064 frame()->PushTool( originalEvent );
2082 description =
_(
"Add Text" );
2084 else if( isHierLabel )
2101 itemsToPlace.push_back( std::unique_ptr<SCH_LABEL_BASE>( label ) );
2108 description =
_(
"Add Hierarchical Label" );
2110 else if( isNetLabel )
2113 description =
_(
"Add Label" );
2115 else if( isGlobalLabel )
2118 description =
_(
"Add Label" );
2120 else if( isClassLabel )
2123 description =
_(
"Add Label" );
2125 else if( isSheetPin )
2130 if( !sheet &&
m_selectionTool->SelectPoint( cursorPos, { SCH_SHEET_T }, &i ) )
2157 m_statusPopup->SetText(
_(
"No new hierarchical labels found." ) );
2168 description =
_(
"Add Sheet Pin" );
2174 if( evt->IsPrime() && !ignorePrimePosition )
2176 cursorPos =
grid.Align( evt->Position() );
2183 cursorPos =
grid.ResolveSnap( cursorPos, snapGrid, item ).position;
2186 if( !itemsToPlace.empty() )
2188 item = itemsToPlace.front().release();
2189 itemsToPlace.pop_front();
2193 prepItemForPlacement( item, cursorPos );
2195 if(
m_frame->GetMoveWarpsCursor() )
2207 if( isSheetPin && sheet )
2215 m_frame->SaveCopyForRepeatItem( item );
2222 commit.
Push( description );
2243 if( isSheetPin && sheet )
2250 m_statusPopup->SetText(
_(
"No new hierarchical labels found." ) );
2258 else if( !itemsToPlace.empty() )
2260 item = itemsToPlace.front().release();
2261 itemsToPlace.pop_front();
2262 prepItemForPlacement( item, cursorPos );
2274 else if( item && evt->IsSelectionEvent() )
2279 if( selection.
GetSize() == 1 )
2291 if( evt->HasParameter() )
2307 evt->SetPassEvent();
2342 evt->SetPassEvent();
2346 evt->SetPassEvent();
2383 bool started =
false;
2403 polyGeomMgr.
Reset();
2428 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2436 if( evt->IsCancelInteractive() )
2445 evt->SetPassEvent(
false );
2449 else if( evt->IsActivate() )
2454 if( evt->IsPointEditor() )
2460 if( evt->IsMoveTool() )
2463 frame()->PushTool( originalEvent );
2481 const bool endPolygon = evt->IsDblClick(
BUT_LEFT )
2489 polyGeomMgr.
Reset();
2496 else if( polyGeomMgr.
AddPoint( cursorPos ) )
2513 cursorPos = last.value();
2523 else if( started && ( evt->IsMotion()
2540 evt->SetPassEvent();
2545 evt->SetPassEvent();
2611 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2617 bool isSyntheticClick =
table && evt->IsActivate() && evt->HasPosition() && evt->Matches( aEvent );
2626 else if( evt->IsActivate() && !isSyntheticClick )
2628 if(
table && evt->IsMoveTool() )
2631 evt->SetPassEvent(
false );
2638 if( evt->IsPointEditor() )
2644 if( evt->IsMoveTool() )
2647 frame()->PushTool( originalEvent );
2658 table->SetColCount( 1 );
2664 table->AddCell( tableCell );
2666 table->SetParent( schematic );
2668 table->SetPosition( cursorPos );
2678 table->ClearEditFlags();
2689 commit.
Push(
_(
"Draw Table" ) );
2707 VECTOR2I requestedSize( cursorPos - origin );
2709 int colCount = std::max( 1, requestedSize.
x / ( fontSize * 15 ) );
2710 int rowCount = std::max( 1, requestedSize.
y / ( fontSize * 2 ) );
2712 VECTOR2I cellSize( std::max( gridSize.
x * 5, requestedSize.
x / colCount ),
2713 std::max( gridSize.
y * 2, requestedSize.
y / rowCount ) );
2715 cellSize.
x =
KiROUND( (
double) cellSize.
x / gridSize.
x ) * gridSize.
x;
2716 cellSize.
y =
KiROUND( (
double) cellSize.
y / gridSize.
y ) * gridSize.
y;
2718 table->ClearCells();
2719 table->SetColCount( colCount );
2721 for(
int col = 0; col < colCount; ++col )
2722 table->SetColWidth( col, cellSize.
x );
2724 for(
int row = 0; row < rowCount; ++row )
2726 table->SetRowHeight( row, cellSize.
y );
2728 for(
int col = 0; col < colCount; ++col )
2736 table->AddCell( cell );
2768 evt->SetPassEvent();
2777 evt->SetPassEvent();
2797 std::unique_ptr<DESIGN_BLOCK> designBlock;
2803 if( isDrawSheetCopy )
2805 wxString* ptr = aEvent.
Parameter<wxString*>();
2812 else if( isDrawSheetFromDesignBlock )
2815 wxCHECK( designBlock, 0 );
2816 filename = designBlock->GetSchematicFile();
2819 if( ( isDrawSheetCopy || isDrawSheetFromDesignBlock ) && !wxFileExists( filename ) )
2821 wxMessageBox( wxString::Format(
_(
"File '%s' does not exist." ), filename ) );
2835 bool startedWithDrag =
false;
2865 if( aEvent.
HasPosition() && !( isDrawSheetCopy || isDrawSheetFromDesignBlock ) )
2873 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2879 bool isSyntheticClick = sheet && evt->IsActivate() && evt->HasPosition()
2882 if( evt->IsCancelInteractive() || ( sheet && evt->IsAction( &
ACTIONS::undo ) ) )
2884 m_frame->GetInfoBar()->Dismiss();
2891 else if( evt->IsActivate() && !isSyntheticClick )
2893 if( sheet && evt->IsMoveTool() )
2896 evt->SetPassEvent(
false );
2902 m_frame->ShowInfoBarMsg(
_(
"Press <ESC> to cancel sheet creation." ) );
2903 evt->SetPassEvent(
false );
2907 if( evt->IsPointEditor() )
2913 if( evt->IsMoveTool() )
2916 frame()->PushTool( originalEvent );
2921 else if( !sheet && ( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT )
2927 if( selection.
Size() == 1
2951 startedWithDrag = evt->IsDrag(
BUT_LEFT );
2958 if( isDrawSheetCopy )
2960 wxFileName fn( filename );
2965 else if( isDrawSheetFromDesignBlock )
2968 wxFileName fn( filename );
2973 std::vector<SCH_FIELD>& sheetFields = sheet->
GetFields();
2976 for(
const auto& [fieldName, fieldValue] : designBlock->GetFields() )
2978 sheetFields.emplace_back( sheet,
FIELD_T::USER, fieldName );
2979 sheetFields.back().SetText( fieldValue );
2980 sheetFields.back().SetTextPos( sheet->
GetPosition() );
2981 sheetFields.back().SetVisible(
false );
3005 else if( sheet && ( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT )
3009 || ( startedWithDrag && evt->IsMouseUp(
BUT_LEFT ) ) ) )
3014 if(
m_frame->EditSheetProperties( sheet, &
m_frame->GetCurrentSheet(),
nullptr,
nullptr,
nullptr,
3030 m_frame->AddToScreen( sheet );
3035 m_frame->Schematic().RefreshHierarchy();
3061 c.
Add( sheetGroup, screen );
3066 c.
Push( isDrawSheetCopy ?
"Import Sheet Copy" :
"Draw Sheet" );
3073 if( ( isDrawSheetCopy || isDrawSheetFromDesignBlock )
3098 evt->SetPassEvent();
3108 m_frame->SetMsgPanel( sheet );
3124 evt->SetPassEvent();
3154 grid.x += gridSize.
x;
3157 grid.y += gridSize.
y;
3165 if( !sheetPaths.size() )
3169 m_frame, std::move( sheetPaths ),
3170 std::make_shared<SHEET_SYNCHRONIZATION_AGENT>(
3180 commit.
Push(
_(
"Modify Sheet Pin" ) );
3186 commit.
Push(
_(
"Modify Schematic Item" ) );
3198 selectionTool->AddItemToSel( aItem,
true );
3203 std::set<EDA_ITEM*> aTemplates )
3276 if( labels.empty() )
3281 m_statusPopup->SetText(
_(
"No new hierarchical labels found." ) );
3296 commit.
Push(
_(
"Auto-place Sheet Pins" ) );
3303 static const std::function<void( std::list<SCH_SHEET_PATH>&,
SCH_SCREEN*, std::set<SCH_SCREEN*>&,
3305 []( std::list<SCH_SHEET_PATH>& aPaths,
SCH_SCREEN* aScene, std::set<SCH_SCREEN*>& aVisited,
3308 if( ! aScene || aVisited.find(aScene) != aVisited.end() )
3311 std::vector<SCH_ITEM*> sheetChildren;
3312 aScene->GetSheets( &sheetChildren );
3313 aVisited.insert( aScene );
3315 for(
SCH_ITEM* child : sheetChildren )
3320 aPaths.push_back( cp );
3321 getSheetChildren( aPaths, sheet->
GetScreen(), aVisited, cp );
3325 std::list<SCH_SHEET_PATH> sheetPaths;
3326 std::set<SCH_SCREEN*> visited;
3329 std::vector<SCH_SHEET*> topLevelSheets =
m_frame->Schematic().GetTopLevelSheets();
3331 for(
SCH_SHEET* topSheet : topLevelSheets )
3333 if( topSheet && topSheet->GetScreen() )
3337 getSheetChildren( sheetPaths, topSheet->GetScreen(), visited, current );
3341 if( sheetPaths.size() == 0 )
3343 m_frame->ShowInfoBarMsg(
_(
"No sub schematic found in the current project" ) );
3358 std::vector<SCH_HIERLABEL*> labels;
3363 labels.push_back( label );
3366 std::sort( labels.begin(), labels.end(),
3369 return StrNumCmp( label1->GetText(), label2->GetText(), CMP_T::IGNORE_CASE ) < 0;
3374 if( !aSheet->
HasPin( label->GetText() ) )
constexpr EDA_IU_SCALE schIUScale
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
static TOOL_ACTION deleteLastPoint
static TOOL_ACTION cursorDblClick
static TOOL_ACTION duplicate
static TOOL_ACTION activatePointEditor
static TOOL_ACTION doDelete
static TOOL_ACTION cursorClick
static TOOL_ACTION increment
static TOOL_ACTION selectionClear
Clear the current selection.
static TOOL_ACTION refreshPreview
static TOOL_ACTION finishInteractive
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
PANEL_DESIGN_BLOCK_CHOOSER m_DesignBlockChooserPanel
bool IsContentModified() const
constexpr bool Contains(const Vec &aPoint) const
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr, RECURSE_MODE aRecurse=RECURSE_MODE::NO_RECURSE)
Modify a given item in the model.
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
COMMIT & Removed(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been removed.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
DESIGN_BLOCK * GetDesignBlock(const LIB_ID &aLibId, bool aUseCacheLib, bool aShowErrorMsg, wxString *aErrorMsg=nullptr)
Load design block from design block library table.
void SetLabelList(std::list< std::unique_ptr< SCH_LABEL_BASE > > *aLabelList)
FIELDS_GRID_TABLE * GetFieldsGridTable()
void SetDesignBlockLibId(const LIB_ID &aLibId)
void AddItem(EDA_ITEM *aItem)
Add item to group.
void SetName(const wxString &aName)
A base class for most all the KiCad significant classes used in schematics and boards.
virtual void SetPosition(const VECTOR2I &aPos)
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
EDA_ITEM_FLAGS GetEditFlags() const
void SetFlags(EDA_ITEM_FLAGS aMask)
KICAD_T Type() const
Returns the type of object.
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
virtual void SetParent(EDA_ITEM *aParent)
virtual void SetEnd(const VECTOR2I &aEnd)
virtual void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
virtual const wxString & GetText() const
Return the string associated with the text object.
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
GR_TEXT_H_ALIGN_T GetHorizJustify() const
virtual void SetVisible(bool aVisible)
virtual EDA_ANGLE GetTextAngle() const
void SetBold(bool aBold)
Set the text to be bold - this will also update the font if needed.
GR_TEXT_V_ALIGN_T GetVertJustify() const
virtual void SetText(const wxString &aText)
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
void SetItalic(bool aItalic)
Set the text to be italic - this will also update the font if needed.
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
PANEL_ANNOTATE m_AnnotatePanel
EE_TYPE OfType(KICAD_T aType) const
const VECTOR2D & GetGridSize() const
Return the grid size.
An interface for classes handling user events controlling the view behavior such as zooming,...
virtual void CaptureCursor(bool aEnabled)
Force the cursor to stay within the drawing panel area.
virtual void ForceCursorPosition(bool aEnabled, const VECTOR2D &aPosition=VECTOR2D(0, 0))
Place the cursor immediately at a given point.
virtual void ShowCursor(bool aEnabled)
Enable or disables display of cursor.
virtual void WarpMouseCursor(const VECTOR2D &aPosition, bool aWorldCoordinates=false, bool aWarpView=false)=0
If enabled (.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
virtual VECTOR2D GetMousePosition(bool aWorldCoordinates=true) const =0
Return the current mouse pointer position.
virtual void SetCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true, bool aTriggeredByArrows=false, long aArrowCommand=0)=0
Move cursor to the requested position expressed in world coordinates.
virtual void SetAutoPan(bool aEnabled)
Turn on/off auto panning (this feature is used when there is a tool active (eg.
virtual void PinCursorInsideNonAutoscrollArea(bool aWarpMouseCursor)=0
GAL * GetGAL() const
Return the GAL this view is using to draw graphical primitives.
LEGACY_SYMBOL_LIB * GetCacheLibrary()
Object used to load, save, search, and otherwise manipulate symbol library files.
A logical library item identifier and consists of various portions much like a URI.
bool IsValid() const
Check if this LID_ID is valid.
Define a library symbol object.
wxString GetDescription() const override
Get the Description field text value */.
const LIB_ID & GetLibId() const override
wxString GetKeyWords() const override
bool IsPower() const override
void SetDescription(const wxString &aDescription)
Set the Description field text value.
void SetKeyWords(const wxString &aKeyWords)
bool IsLocalPower() const override
bool IsGlobalPower() const override
A singleton reporter that reports to nowhere.
virtual COMMON_SETTINGS * GetCommonSettings() const
Class that handles the drawing of a polygon, including management of last corner deletion and drawing...
bool AddPoint(const VECTOR2I &aPt)
Lock in a polygon point.
void SetCursorPosition(const VECTOR2I &aPos)
Set the current cursor position.
bool NewPointClosesOutline(const VECTOR2I &aPt) const
std::optional< VECTOR2I > DeleteLastCorner()
Remove the last-added point from the polygon.
void SetFinished()
Mark the polygon finished and update the client.
void SetLeaderMode(LEADER_MODE aMode)
Set the leader mode to use when calculating the leader/returner lines.
void Reset()
Clear the manager state and start again.
static SYMBOL_LIBRARY_ADAPTER * SymbolLibAdapter(PROJECT *aProject)
Accessor for project symbol library manager adapter.
static LEGACY_SYMBOL_LIBS * LegacySchLibs(PROJECT *aProject)
Returns the list of symbol libraries from a legacy (pre-5.x) design This is only used from the remapp...
An adjunct helper to the DRAWING_TOOL interactive tool, which handles incoming geometry changes from ...
These are loaded from Eeschema settings but then overwritten by the project settings.
bool m_IntersheetRefsShow
Holds all the data relating to one schematic.
SCHEMATIC_SETTINGS & Settings() const
bool Contains(const SCH_REFERENCE &aRef) const
Check if the schematic contains the specified reference.
static TOOL_ACTION rotateCCW
static TOOL_ACTION placeClassLabel
static TOOL_ACTION placeSheetPin
static TOOL_ACTION placeNextSymbolUnit
static TOOL_ACTION editValue
static TOOL_ACTION setExcludeFromBOM
static TOOL_ACTION mirrorV
static TOOL_ACTION drawSheetFromFile
static TOOL_ACTION placeGlobalLabel
static TOOL_ACTION autoplaceFields
static TOOL_ACTION changeSymbol
static TOOL_ACTION syncAllSheetsPins
static TOOL_ACTION closeOutline
static TOOL_ACTION drawSheet
static TOOL_ACTION properties
static TOOL_ACTION editReference
static TOOL_ACTION leaveSheet
static TOOL_ACTION autoplaceAllSheetPins
static TOOL_ACTION placeHierLabel
static TOOL_ACTION placeLabel
static TOOL_ACTION toText
static TOOL_ACTION placeBusWireEntry
static TOOL_ACTION toHLabel
static TOOL_ACTION rotateCW
static TOOL_ACTION importSheet
static TOOL_ACTION setExcludeFromSim
static TOOL_ACTION toLabel
static TOOL_ACTION placeJunction
static TOOL_ACTION setDNP
static TOOL_ACTION drawRuleArea
static TOOL_ACTION placeSymbol
static TOOL_ACTION placeImage
static TOOL_ACTION editWithLibEdit
static TOOL_ACTION toDLabel
static TOOL_ACTION setExcludeFromPosFiles
static TOOL_ACTION cycleBodyStyle
static TOOL_ACTION drawSheetFromDesignBlock
static TOOL_ACTION mirrorH
static TOOL_ACTION placeDesignBlock
static TOOL_ACTION drawTable
static TOOL_ACTION placeSchematicText
static TOOL_ACTION toTextBox
static TOOL_ACTION changeSheet
static TOOL_ACTION enterSheet
static TOOL_ACTION editFootprint
static TOOL_ACTION repeatDrawItem
static TOOL_ACTION placeNoConnect
static TOOL_ACTION toGLabel
static TOOL_ACTION setExcludeFromBoard
static TOOL_ACTION syncSheetPins
static TOOL_ACTION placePower
Object to handle a bitmap image that can be inserted in a schematic.
Base class for a bus or wire entry.
VECTOR2I GetPosition() const override
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
Class for a wire to bus entry.
Commit for the schematic and symbol editors.
void Revert() override
Revert the commit by restoring the modified items state.
void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Execute the changes.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
Schematic editor (Eeschema) main window.
void SetText(const wxString &aText) override
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this label.
A set of SCH_ITEMs (i.e., without duplicates).
void SetSpinStyle(SPIN_STYLE aSpinStyle) override
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual bool IsConnectable() const
virtual void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo)
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
virtual void CalcEdit(const VECTOR2I &aPosition)
Calculate the attributes of an item at aPosition when it is being edited.
virtual void SetUnit(int aUnit)
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
bool AutoRotateOnPlacement() const
autoRotateOnPlacement
SPIN_STYLE GetSpinStyle() const
void SetShape(LABEL_FLAG_SHAPE aShape)
LABEL_FLAG_SHAPE GetShape() const
void SetAutoRotateOnPlacement(bool autoRotate=true)
std::vector< SCH_FIELD > & GetFields()
virtual void SetSpinStyle(SPIN_STYLE aSpinStyle)
Segment description base class to describe items which have 2 end points (track, wire,...
bool IsWire() const
Return true if the line is a wire.
VECTOR2I GetEndPoint() const
VECTOR2I GetStartPoint() const
Container to create a flattened list of symbols because in a complex hierarchy, a symbol can be used ...
void SortByReferenceOnly()
Sort the list of references by reference.
void AddItem(const SCH_REFERENCE &aItem)
A helper to define a symbol's reference designator in a schematic.
EE_RTREE & Items()
Get the full RTree, usually for iterating.
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
Indicate that a junction dot may be placed at the given location.
void SetPosition(const VECTOR2I &aPos) override
VECTOR2I GetPosition() const override
A container for handling SCH_SHEET_PATH objects in a flattened hierarchy.
void SortByPageNumbers(bool aUpdateVirtualPageNums=true)
Sort the list of sheets by page number.
SCH_SHEET_LIST FindAllSheetsForScreen(const SCH_SCREEN *aScreen) const
Return a SCH_SHEET_LIST with a copy of all the SCH_SHEET_PATH using a particular screen.
wxString GetNextPageNumber() const
void GetSymbols(SCH_REFERENCE_LIST &aReferences, SYMBOL_FILTER aSymbolFilter, bool aForceIncludeOrphanSymbols=false) const
Add a SCH_REFERENCE object to aReferences for each symbol in the list of sheets.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SCREEN * LastScreen()
void SetPageNumber(const wxString &aPageNumber)
Set the sheet instance user definable page number.
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
const KIID_PATH & PathRef() const
Borrow the cached path until this sheet path is modified or destroyed.
void push_back(SCH_SHEET *aSheet)
Forwarded method from std::vector.
Define a sheet pin (label) used in sheets to create hierarchical schematics.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
void SetBorderColor(KIGFX::COLOR4D aColor)
void AddPin(SCH_SHEET_PIN *aSheetPin)
Add aSheetPin to the sheet.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
std::vector< SCH_FIELD > & GetFields()
Return a reference to the vector holding the sheet's fields.
SCH_FIELD * GetField(FIELD_T aFieldType)
Return a mandatory field in this sheet.
void SetBackgroundColor(KIGFX::COLOR4D aColor)
SCH_SCREEN * GetScreen() const
VECTOR2I GetPosition() const override
bool HasPin(const wxString &aName) const
Check if the sheet already has a sheet pin named aName.
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
void SetBorderWidth(int aWidth)
void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo) override
void Resize(const VECTOR2I &aSize)
Resize this sheet to aSize and adjust all of the labels accordingly.
std::vector< SCH_SHEET_PIN * > & GetPins()
const LIB_ID & GetLibId() const override
void SetUnitSelection(const SCH_SHEET_PATH *aSheet, int aUnitSelection)
Set the selected unit of this symbol on one sheet.
RAII class that sets an value at construction and resets it to the original value at destruction.
const VECTOR2I NearestPoint(const VECTOR2I &aP) const
Compute a point on the segment (this) that is closest to point aP.
virtual unsigned int GetSize() const override
Return the number of stored items.
int Size() const
Returns the number of selected parts.
void SetReferencePoint(const VECTOR2I &aP)
SHEET_SYNCHRONIZATION_PLACEMENT
std::function< void()> MODIFICATION
Spin style for labels of all kinds on schematics.
An interface to the global shared library manager that is schematic-specific and linked to one projec...
Helper object to filter a list of libraries.
This file is part of the common library.
const int minSize
Push and Shove router track width and via size dialog.
static constexpr EDA_ANGLE ANGLE_0
#define IGNORE_PARENT_GROUP
#define IS_NEW
New item, just created.
#define STRUCT_DELETED
flag indication structures to be erased
#define ENDPOINT
ends. (Used to support dragging.)
#define IS_MOVING
Item being moved.
#define STARTPOINT
When a line is selected, these flags indicate which.
@ ID_POPUP_SCH_SELECT_UNIT
@ ID_POPUP_SCH_SELECT_BODY_STYLE
@ ID_POPUP_SCH_SELECT_BODY_STYLE_END
@ ID_POPUP_SCH_SELECT_UNIT_END
@ DIRECT
Unconstrained point-to-point.
static const std::string KiCadSchematicFileExtension
static wxString ImageFileWildcard()
static wxString KiCadSchematicFileWildcard()
Definition for symbol library class.
PGM_BASE & Pgm()
The global program "get" accessor.
LIB_SYMBOL * SchGetLibSymbol(const LIB_ID &aLibId, SYMBOL_LIBRARY_ADAPTER *aLibMgr, LEGACY_SYMBOL_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Load symbol from symbol library table.
Class to handle a set of SCH_ITEMs.
std::vector< EDA_ITEM * > EDA_ITEMS
LABEL_FLAG_SHAPE
Label and flag shapes used with text objects.
void AnnotateNewSymbol(SCH_SYMBOL *aSymbol, const std::vector< SCH_SHEET_PATH > &aPaths, SCH_REFERENCE_LIST &aExistingRefs, const SCHEMATIC_SETTINGS &aSettings, SCH_SHEET_LIST *aHierarchy)
Annotate a newly placed symbol on each of aPaths in turn, avoiding aExistingRefs and adding the resul...
ANNOTATE_ORDER_T
Schematic annotation order options.
@ ANNOTATE_SELECTION
Annotate the selection.
ANNOTATE_ALGO_T
Schematic annotation type options.
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
Increment event parameters.
COLOR4D default_sheet_border_color
bool auto_place_sheet_pins
COLOR4D default_sheet_background_color
int default_line_thickness
POWER_SYMBOLS new_power_symbols
bool m_Reannotate
If a symbol is provide, reannotate it?
bool m_PlaceAllUnits
For a preselected multi-unit symbol, keep placing remaining units instead of exiting.
SCH_SYMBOL * m_Symbol
Provide a symbol to place.
int m_Unit
Unit number to place; 0 means next available unit.
SCH_SYMBOL * m_Symbol
Symbol used as reference for unit placement.
@ USER
The field ID hasn't been set yet; field is invalid.
@ INTERSHEET_REFS
Global label cross-reference page numbers.
IbisParser parser & reporter
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
VECTOR2< int32_t > VECTOR2I
Definition of file extensions used in Kicad.