69#include <dialogs/dialog_text_properties.h>
72#include <dialogs/dialog_table_properties.h>
77#include <wx/filedlg.h>
86 m_lastTextBold( false ),
87 m_lastTextItalic( false ),
100 m_mruPath( wxEmptyString ),
101 m_lastAutoLabelRotateOnPlacement( false ),
102 m_drawingRuleArea( false ),
103 m_inDrawingTool( false )
112 auto belowRootSheetCondition =
118 auto inDrawingRuleArea =
142 bool placeOneOnly = symbol !=
nullptr;
145 std::vector<PICKED_SYMBOL>* historyList =
nullptr;
146 bool ignorePrimePosition =
false;
179 filter.FilterPowerSymbols(
true );
183 wxFAIL_MSG(
"PlaceSymbol(): unexpected request" );
208 : KICURSOR::COMPONENT );
219 existingRefs.
Clear();
241 existingRefs,
false, &hierarchy );
246 for(
size_t i = 0; i < refs.
GetCount(); i++ )
247 existingRefs.
AddItem( refs[i] );
279 ignorePrimePosition =
true;
287 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
293 bool isSyntheticClick = symbol && evt->IsActivate() && evt->HasPosition()
294 && evt->Matches( aEvent );
296 if( evt->IsCancelInteractive() || ( symbol && evt->IsAction( &
ACTIONS::undo ) ) )
310 else if( evt->IsActivate() && !isSyntheticClick )
312 if( symbol && evt->IsMoveTool() )
315 evt->SetPassEvent(
false );
322 evt->SetPassEvent(
false );
326 if( evt->IsMoveTool() )
337 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
346 std::set<UTF8> unique_libid;
347 std::vector<PICKED_SYMBOL> alreadyPlaced;
364 alreadyPlaced.push_back( pickedSymbol );
384 if( evt->IsPrime() && !ignorePrimePosition )
386 cursorPos =
grid.Align( evt->Position(), GRID_HELPER_GRIDS::GRID_CONNECTABLE );
393 GRID_HELPER_GRIDS::GRID_CONNECTABLE );
404 if( keywords.Contains( wxT(
"global power" ) ) )
406 keywords.Replace( wxT(
"global power" ), wxT(
"local power" ) );
412 if( desc.Contains( wxT(
"global label" ) ) )
414 desc.Replace( wxT(
"global label" ), wxT(
"local label" ) );
433 existingRefs.
AddItem( placedSymbolReference );
456 commit.
Added( symbol, screen );
462 commit.
Push(
_(
"Place Symbol" ) );
475 int new_unit = symbol->
GetUnit();
478 && symbol->GetUnit() < symbol->GetUnitCount() )
490 nextSymbol =
static_cast<SCH_SYMBOL*
>( symbol->Duplicate() );
491 nextSymbol->
SetUnit( new_unit );
498 addSymbol( nextSymbol );
504 existingRefs.
AddItem( placedSymbolReference );
538 if( symbol && symbol->GetBodyStyle() != bodyStyle )
562 symbol->SetPosition( cursorPos );
600 static const std::vector<KICAD_T> symbolTypes = {
SCH_SYMBOL_T };
603 if( selection.
Size() != 1 )
624 if( missingUnits.empty() )
631 const int nextMissing = *std::min_element( missingUnits.begin(), missingUnits.end() );
633 std::unique_ptr<SCH_SYMBOL> newSymbol = std::make_unique<SCH_SYMBOL>( *symbol );
636 newSymbol->SetUnitSelection( &sheetPath, nextMissing );
637 newSymbol->SetUnit( nextMissing );
638 newSymbol->SetRefProp( symbol->
GetRef( &sheetPath,
false ) );
652 wxString sheetFileName = wxEmptyString;
654 if( placingDesignBlock )
669 wxString* importSourceFile = aEvent.
Parameter<wxString*>();
671 if( importSourceFile !=
nullptr )
672 sheetFileName = *importSourceFile;
685 if( !cfg || !common_settings )
695 : KICURSOR::COMPONENT );
698 auto placeSheetContents =
715 placingDesignBlock ) )
738 group->SetName( wxFileName( sheetFileName ).
GetName() );
748 static_cast<SCH_SYMBOL*
>( item )->ClearAnnotation( &sheetPath,
false );
754 group->AddItem( item );
756 commit.
Added( item, screen );
757 newItems.emplace_back( item );
784 if( !keepAnnotations )
814 commit.
Push( placingDesignBlock ?
_(
"Add design block" )
815 :
_(
"Import Schematic Sheet Content..." ) );
826 if( sheetFileName.IsEmpty() )
831 if (!placingDesignBlock) {
833 if( sheetFileName.IsEmpty() )
836 file = wxEmptyString;
840 path = wxPathOnly( sheetFileName );
841 file = wxFileName( sheetFileName ).GetFullName();
846 wxFileDialog dlg(
m_frame,
_(
"Choose Schematic" ),
path, file,
848 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
851 dlg.SetCustomizeHook( dlgHook );
853 if( dlg.ShowModal() == wxID_CANCEL )
856 sheetFileName = dlg.GetPath();
861 if( sheetFileName.IsEmpty() )
875 designBlock =
nullptr;
902 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
908 bool isSyntheticClick = designBlock && evt->IsActivate() && evt->HasPosition()
909 && evt->Matches( aEvent );
911 if( evt->IsCancelInteractive() || ( designBlock && evt->IsAction( &
ACTIONS::undo ) ) )
916 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
918 if( placingDesignBlock )
926 new wxString( sheetFileName ) );
960 bool immediateMode =
image !=
nullptr;
961 bool ignorePrimePosition =
false;
1024 ignorePrimePosition =
true;
1032 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1038 bool isSyntheticClick =
image && evt->IsActivate() && evt->HasPosition()
1039 && evt->Matches( aEvent );
1061 else if( evt->IsActivate() && !isSyntheticClick )
1063 if(
image && evt->IsMoveTool() )
1066 evt->SetPassEvent(
false );
1073 evt->SetPassEvent(
false );
1077 if( evt->IsMoveTool() )
1088 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
1095 _(
"Image Files" ) + wxS(
" " ) + wxImage::GetImageExtWildcard(),
1098 if( dlg.ShowModal() != wxID_OK )
1104 if( evt->IsPrime() && !ignorePrimePosition )
1106 cursorPos =
grid.Align( evt->Position() );
1115 wxString fullFilename = dlg.GetPath();
1118 if( wxFileExists( fullFilename ) )
1121 if( !
image || !
image->GetReferenceImage().ReadImageFile( fullFilename ) )
1123 wxMessageBox( wxString::Format(
_(
"Could not load image from '%s'." ), fullFilename ) );
1146 commit.
Push(
_(
"Place Image" ) );
1185 image->SetPosition( cursorPos );
1201 evt->SetPassEvent();
1231 if( dlgResult != wxID_OK )
1237 wxMessageBox(
_(
"No graphic items found in file." ) );
1244 std::vector<SCH_ITEM*> newItems;
1245 std::vector<SCH_ITEM*> selectedItems;
1249 for( std::unique_ptr<EDA_ITEM>& ptr : list )
1252 wxCHECK2_MSG( item,
continue, wxString::Format(
"Bad item type: ", ptr->Type() ) );
1254 newItems.push_back( item );
1255 selectedItems.push_back( item );
1256 preview.
Add( item );
1267 commit.
Push(
_(
"Import Graphic" ) );
1276 EDA_ITEMS selItems( selectedItems.begin(), selectedItems.end() );
1281 auto setCursor = [&]()
1301 for(
SCH_ITEM* item : selectedItems )
1302 item->Move(
delta );
1304 currentOffset +=
delta;
1314 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1319 if( evt->IsCancelInteractive() || evt->IsActivate() )
1328 else if( evt->IsMotion() )
1330 delta = cursorPos - currentOffset;
1332 for(
SCH_ITEM* item : selectedItems )
1333 item->Move(
delta );
1335 currentOffset +=
delta;
1349 commit.
Push(
_(
"Import Graphic" ) );
1354 evt->SetPassEvent();
1377 bool loggedInfoBarError =
false;
1378 wxString description;
1380 bool allowRepeat =
false;
1406 description =
_(
"Add No Connect Flag" );
1413 description =
_(
"Add Junction" );
1419 description =
_(
"Add Wire to Bus Entry" );
1424 wxASSERT_MSG(
false,
"Unknown item type in SCH_DRAWING_TOOLS::SingleClickPlace" );
1462 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1464 cursorPos = evt->IsPrime() ? evt->Position() : controls->
GetMousePosition();
1465 cursorPos =
grid.BestSnapAnchor( cursorPos,
grid.GetItemGrid( previewItem ),
nullptr );
1468 if( evt->IsCancelInteractive() )
1473 else if( evt->IsActivate() )
1475 if( evt->IsMoveTool() )
1488 if( !screen->
GetItem( cursorPos, 0, type ) )
1495 "wires and/or pins." ) );
1496 loggedInfoBarError =
true;
1499 else if( loggedInfoBarError )
1515 commit.
Added( newItem, screen );
1519 commit.
Push( description );
1574 std::deque<SCH_ITEM*> strokeItems;
1575 strokeItems.push_back( previewItem );
1583 std::deque<SCH_JUNCTION*> junctions;
1584 junctions.push_back(
static_cast<SCH_JUNCTION*
>( previewItem ) );
1599 evt->SetPassEvent();
1604 evt->SetPassEvent();
1637 wxASSERT( aWire->
IsWire() );
1643 SCH_ITEM* wireDriver = wireConnection->Driver();
1645 if( wireDriver && wireDriver->
IsType( { SCH_LABEL_T, SCH_GLOBAL_LABEL_T } ) )
1646 return wireConnection->LocalName();
1649 return wxEmptyString;
1654 std::list<std::unique_ptr<SCH_LABEL_BASE>>& aLabelList )
1656 SCHEMATIC* schematic = getModel<SCHEMATIC>();
1675 labelItem->
GetFields().emplace_back( labelItem, FIELD_T::USER, wxT(
"Netclass" ) );
1676 labelItem->
GetFields().emplace_back( labelItem, FIELD_T::USER, wxT(
"Component Class" ) );
1677 labelItem->
GetFields().back().SetItalic(
true );
1678 labelItem->
GetFields().back().SetVisible(
true );
1692 labelItem = globalLabel;
1700 wxFAIL_MSG(
"SCH_EDIT_FRAME::CreateNewText() unknown layer type" );
1718 if( !netName.IsEmpty() )
1721 labelItem->
SetText( netName );
1764 SCHEMATIC* schematic = getModel<SCHEMATIC>();
1768 textItem =
new SCH_TEXT( aPosition );
1803 pin->SetText( std::to_string( aSheet->
GetPins().size() + 1 ) );
1805 pin->SetPosition( aPosition );
1806 pin->ClearSelected();
1830 bool ignorePrimePosition =
false;
1833 wxString description;
1864 else if( isGlobalLabel )
1866 else if( isNetLabel )
1868 else if( isClassLabel )
1870 else if( isHierLabel )
1876 auto updatePreview =
1885 RECURSE_MODE::NO_RECURSE );
1898 auto prepItemForPlacement =
1930 && ( isText || isGlobalLabel || isHierLabel || isClassLabel || isNetLabel ) )
1933 ignorePrimePosition =
true;
1937 std::list<std::unique_ptr<SCH_LABEL_BASE>> itemsToPlace;
1944 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1947 cursorPos =
grid.BestSnapAnchor( cursorPos, snapGrid, item );
1951 bool isSyntheticClick = item && evt->IsActivate() && evt->HasPosition()
1954 if( evt->IsCancelInteractive() || evt->IsAction( &
ACTIONS::undo ) )
1968 else if( evt->IsActivate() && !isSyntheticClick )
1970 if( item && evt->IsMoveTool() )
1973 evt->SetPassEvent(
false );
1980 evt->SetPassEvent(
false );
1984 if( evt->IsPointEditor() )
1988 else if( evt->IsMoveTool() )
1999 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
2010 description =
_(
"Add Text" );
2012 else if( isHierLabel )
2019 SCHEMATIC* schematic = getModel<SCHEMATIC>();
2030 itemsToPlace.push_back( std::unique_ptr<SCH_LABEL_BASE>( label ) );
2037 description =
_(
"Add Hierarchical Label" );
2039 else if( isNetLabel )
2042 description =
_(
"Add Label" );
2044 else if( isGlobalLabel )
2047 description =
_(
"Add Label" );
2049 else if( isClassLabel )
2052 description =
_(
"Add Label" );
2054 else if( isSheetPin )
2067 + wxPoint( 20, 20 ) );
2089 m_statusPopup->SetText(
_(
"No new hierarchical labels found." ) );
2091 + wxPoint( 20, 20 ) );
2103 description =
_(
"Add Sheet Pin" );
2109 if( evt->IsPrime() && !ignorePrimePosition )
2111 cursorPos =
grid.Align( evt->Position() );
2118 cursorPos =
grid.BestSnapAnchor( cursorPos, snapGrid, item );
2121 if( !itemsToPlace.empty() )
2123 item = itemsToPlace.front().release();
2124 itemsToPlace.pop_front();
2128 prepItemForPlacement( item, cursorPos );
2154 commit.
Push( description );
2183 m_statusPopup->SetText(
_(
"No new hierarchical labels found." ) );
2185 + wxPoint( 20, 20 ) );
2194 else if( !itemsToPlace.empty() )
2197 item = itemsToPlace.front().release();
2198 itemsToPlace.pop_front();
2199 prepItemForPlacement( item, cursorPos );
2211 else if( item && evt->IsSelectionEvent() )
2216 if( selection.
GetSize() == 1 )
2265 evt->SetPassEvent();
2290 SCHEMATIC* schematic = getModel<SCHEMATIC>();
2295 wxString description;
2345 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2351 bool isSyntheticClick = item && evt->IsActivate() && evt->HasPosition()
2354 if( evt->IsCancelInteractive() || ( item && evt->IsAction( &
ACTIONS::undo ) ) )
2366 else if( evt->IsActivate() && !isSyntheticClick )
2368 if( item && evt->IsMoveTool() )
2371 evt->SetPassEvent(
false );
2378 if( evt->IsPointEditor() )
2382 else if( evt->IsMoveTool() )
2393 else if( evt->IsClick(
BUT_LEFT ) && !item )
2416 description =
_(
"Add Text Box" );
2434 else if( item && ( evt->IsClick(
BUT_LEFT )
2480 commit.
Push( wxString::Format(
_(
"Draw %s" ), item->
GetClass() ) );
2511 else if( evt->IsDblClick(
BUT_LEFT ) && !item )
2529 evt->SetPassEvent();
2558 bool started =
false;
2574 auto cleanup = [&]()
2576 polyGeomMgr.
Reset();
2601 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2610 if( evt->IsCancelInteractive() )
2621 evt->SetPassEvent(
false );
2625 else if( evt->IsActivate() )
2630 if( evt->IsPointEditor() )
2634 else if( evt->IsMoveTool() )
2657 const bool endPolygon = evt->IsDblClick(
BUT_LEFT )
2664 polyGeomMgr.
Reset();
2671 else if( polyGeomMgr.
AddPoint( cursorPos ) )
2689 cursorPos = last.value();
2699 else if( started && ( evt->IsMotion() || evt->IsDrag(
BUT_LEFT ) ) )
2705 evt->SetPassEvent();
2719 SCHEMATIC* schematic = getModel<SCHEMATIC>();
2770 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2776 bool isSyntheticClick =
table
2777 && evt->IsActivate()
2778 && evt->HasPosition()
2779 && evt->Matches( aEvent );
2793 else if( evt->IsActivate() && !isSyntheticClick )
2795 if(
table && evt->IsMoveTool() )
2798 evt->SetPassEvent(
false );
2805 if( evt->IsPointEditor() )
2809 else if( evt->IsMoveTool() )
2825 table->SetColCount( 1 );
2831 table->AddCell( tableCell );
2833 table->SetParent( schematic );
2835 table->SetPosition( cursorPos );
2845 table->ClearEditFlags();
2856 commit.
Push(
_(
"Draw Table" ) );
2874 VECTOR2I requestedSize( cursorPos - origin );
2876 int colCount = std::max( 1, requestedSize.
x / ( fontSize * 15 ) );
2877 int rowCount = std::max( 1, requestedSize.
y / ( fontSize * 2 ) );
2879 VECTOR2I cellSize( std::max( gridSize.
x * 5, requestedSize.
x / colCount ),
2880 std::max( gridSize.
y * 2, requestedSize.
y / rowCount ) );
2882 cellSize.
x =
KiROUND( (
double) cellSize.
x / gridSize.
x ) * gridSize.
x;
2883 cellSize.
y =
KiROUND( (
double) cellSize.
y / gridSize.
y ) * gridSize.
y;
2885 table->ClearCells();
2886 table->SetColCount( colCount );
2888 for(
int col = 0; col < colCount; ++col )
2889 table->SetColWidth( col, cellSize.
x );
2891 for(
int row = 0; row < rowCount; ++row )
2893 table->SetRowHeight( row, cellSize.
y );
2895 for(
int col = 0; col < colCount; ++col )
2903 table->AddCell( cell );
2929 evt->SetPassEvent();
2953 if( isDrawSheetCopy )
2955 wxString* ptr = aEvent.
Parameter<wxString*>();
2962 else if( isDrawSheetFromDesignBlock )
2965 wxCHECK( designBlock, 0 );
2969 if( ( isDrawSheetCopy || isDrawSheetFromDesignBlock ) && !wxFileExists( filename ) )
2971 wxMessageBox( wxString::Format(
_(
"File '%s' does not exist." ), filename ) );
3013 if( aEvent.
HasPosition() && !( isDrawSheetCopy || isDrawSheetFromDesignBlock ) )
3021 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
3027 bool isSyntheticClick = sheet && evt->IsActivate() && evt->HasPosition()
3030 if( evt->IsCancelInteractive() || ( sheet && evt->IsAction( &
ACTIONS::undo ) ) )
3044 else if( evt->IsActivate() && !isSyntheticClick )
3046 if( sheet && evt->IsMoveTool() )
3049 evt->SetPassEvent(
false );
3056 evt->SetPassEvent(
false );
3060 if( evt->IsPointEditor() )
3064 else if( evt->IsMoveTool() )
3075 else if( !sheet && ( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) ) )
3079 if( selection.
Size() == 1
3088 else if( evt->IsDblClick(
BUT_LEFT ) )
3101 if( isDrawSheetCopy )
3103 wxFileName fn( filename );
3108 else if( isDrawSheetFromDesignBlock )
3110 wxFileName fn( filename );
3115 std::vector<SCH_FIELD>& sheetFields = sheet->
GetFields();
3118 for(
const auto& [fieldName, fieldValue] : designBlock->
GetFields() )
3120 sheetFields.emplace_back( sheet, FIELD_T::USER, fieldName );
3121 sheetFields.back().SetText( fieldValue );
3122 sheetFields.back().SetVisible(
false );
3127 sheet->
GetField( FIELD_T::SHEET_NAME )->
SetText( wxT(
"Untitled Sheet" ) );
3140 wxString pageNumber;
3144 pageNumber.Printf( wxT(
"%d" ),
static_cast<int>( hierarchy.size() ) + 1 );
3150 else if( sheet && ( evt->IsClick(
BUT_LEFT )
3160 nullptr, &filename ) )
3180 && !( ( isDrawSheetCopy || isDrawSheetFromDesignBlock )
3193 c.
Push( isDrawSheetCopy ?
"Import Sheet Copy" :
"Draw Sheet" );
3241 evt->SetPassEvent();
3272 if( !sheetPaths.size() )
3278 m_frame, std::move( sheetPaths ),
3279 std::make_shared<SHEET_SYNCHRONIZATION_AGENT>(
3289 commit.
Push(
_(
"Modify sheet pin" ) );
3295 commit.
Push(
_(
"Modify schematic item" ) );
3307 selectionTool->AddItemToSel( aItem,
true );
3312 std::set<EDA_ITEM*> aTemplates )
3385 if( labels.empty() )
3389 m_statusPopup->SetText(
_(
"No new hierarchical labels found." ) );
3403 SCH_ITEM* lastPlacedLabel =
nullptr;
3405 auto calculatePositionForLabel = [&](
const SCH_ITEM* lastLabel,
3416 int currentWidth = currentLabel->GetBoundingBox().GetWidth();
3417 int currentHeight = currentLabel->GetBoundingBox().GetHeight();
3420 if( ( lastX + lastWidth + currentWidth )
3422 return { lastX + lastWidth, lastY };
3425 if( ( lastY + lastHeight + currentHeight )
3434 if( !lastPlacedLabel )
3436 std::vector<SCH_SHEET_PIN*> existingPins = sheet->
GetPins();
3438 if( !existingPins.empty() )
3440 std::sort( existingPins.begin(), existingPins.end(),
3443 return ( a->GetPosition().x < b->GetPosition().x )
3444 || ( a->GetPosition().x == b->GetPosition().x
3445 && a->GetPosition().y < b->GetPosition().y );
3448 lastPlacedLabel = existingPins.back();
3452 cursorPos = calculatePositionForLabel( lastPlacedLabel, label );
3469 commit.
Push(
_(
"Add Sheet Pin" ) );
3471 lastPlacedLabel = item;
3481 static const std::function<void( std::list<SCH_SHEET_PATH>&,
SCH_SCREEN*,
3483 getSheetChildren = []( std::list<SCH_SHEET_PATH>& aPaths,
SCH_SCREEN* aScene,
3484 std::set<SCH_SCREEN*>& aVisited,
SCH_SHEET_PATH const& aCurPath )
3486 if( ! aScene || aVisited.find(aScene) != aVisited.end() )
3489 std::vector<SCH_ITEM*> sheetChildren;
3490 aScene->GetSheets( &sheetChildren );
3491 aVisited.insert( aScene );
3493 for(
SCH_ITEM* child : sheetChildren )
3498 aPaths.push_back( cp );
3499 getSheetChildren( aPaths, sheet->
GetScreen(), aVisited, cp );
3503 std::list<SCH_SHEET_PATH> sheetPaths;
3504 std::set<SCH_SCREEN*> visited;
3509 if( sheetPaths.size() == 0 )
3524 std::vector<SCH_HIERLABEL*> labels;
3528 labels.push_back( label );
3531 std::sort( labels.begin(), labels.end(),
3534 return StrNumCmp( label1->GetText(), label2->GetText(), true ) < 0;
3539 if( !aSheet->
HasPin( label->GetText() ) )
3552 std::vector<SCH_HIERLABEL*> labels;
3560 labels.push_back( label );
constexpr EDA_IU_SCALE schIUScale
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
static TOOL_ACTION cancelInteractive
static TOOL_ACTION duplicate
static TOOL_ACTION activatePointEditor
static TOOL_ACTION doDelete
static TOOL_ACTION increment
static TOOL_ACTION selectionClear
Clear the current selection.
static TOOL_ACTION refreshPreview
static TOOL_ACTION finishInteractive
static TOOL_ACTION selectItems
Select a list of items (specified as the event parameter)
PANEL_DESIGN_BLOCK_CHOOSER m_DesignBlockChooserPanel
constexpr const Vec & GetPosition() const
constexpr size_type GetWidth() const
constexpr size_type GetHeight() const
constexpr bool Contains(const Vec &aPoint) const
constexpr const SizeVec & GetSize() const
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Modify a given item in the model.
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Add a new item to the model.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
DESIGN_BLOCK * GetDesignBlock(const LIB_ID &aLibId, bool aUseCacheLib, bool aShowErrorMsg)
Load design block from design block library table.
const wxString & GetSchematicFile() const
const LIB_ID & GetLibId() const
const nlohmann::ordered_map< wxString, wxString > & GetFields() const
std::list< std::unique_ptr< EDA_ITEM > > & GetImportedItems()
bool IsPlacementInteractive()
void SetLabelList(std::list< std::unique_ptr< SCH_LABEL_BASE > > *aLabelList)
FIELDS_GRID_TABLE * GetFieldsGridTable()
void ShowInfoBarMsg(const wxString &aMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of...
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
WX_INFOBAR * GetInfoBar()
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
VECTOR2I GetNearestGridPosition(const VECTOR2I &aPosition) const
Return the nearest aGridSize location to aPosition.
void SetCurrentCursor(KICURSOR aCursor)
Set the current cursor shape for this panel.
A base class for most all the KiCad significant classes used in schematics and boards.
virtual VECTOR2I GetPosition() const
virtual void ClearEditFlags()
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 void SetParent(EDA_ITEM *aParent)
virtual wxString GetFriendlyName() const
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
FILL_T GetFillMode() const
void SetFillColor(const COLOR4D &aColor)
COLOR4D GetFillColor() const
void SetEnd(const VECTOR2I &aEnd)
const EDA_ANGLE & GetTextAngle() const
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)
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
PANEL_SYM_CHOOSER m_SymChooserPanel
AUTOPLACE_FIELDS m_AutoplaceFields
EE_TYPE Overlapping(const BOX2I &aRect) const
EE_TYPE OfType(KICAD_T aType) const
A color representation with 4 components: red, green, blue, alpha.
void Update(const KIGFX::VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
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.
VECTOR2D GetCursorPosition() const
Return the current cursor position 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
virtual void Add(VIEW_ITEM *aItem, int aDrawPriority=-1)
Add a VIEW_ITEM to the view.
virtual void Remove(VIEW_ITEM *aItem)
Remove a VIEW_ITEM from the view.
void RecacheAllItems()
Rebuild GAL display lists.
void AddToPreview(VIEW_ITEM *aItem, bool aTakeOwnership=true)
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool IsValid() const
Check if this LID_ID is valid.
const UTF8 & GetLibItemName() const
Define a library symbol object.
wxString GetDescription() const override
const LIB_ID & GetLibId() const override
wxString GetKeyWords() const override
void SetDescription(const wxString &aDescription)
Gets 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.
@ DIRECT
Unconstrained point-to-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_LIB_TABLE * SchSymbolLibTable(PROJECT *aProject)
Accessor for project symbol library table.
static SYMBOL_LIBS * SchLibs(PROJECT *aProject)
These are all prefaced with "Sch".
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
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
SCH_SHEET_LIST Hierarchy() const
Return the full schematic flattened hierarchical sheet list.
static TOOL_ACTION rotateCCW
static TOOL_ACTION placeClassLabel
static TOOL_ACTION placeSheetPin
static TOOL_ACTION placeNextSymbolUnit
static TOOL_ACTION mirrorV
static TOOL_ACTION drawSheetFromFile
static TOOL_ACTION placeGlobalLabel
static TOOL_ACTION drawTextBox
static TOOL_ACTION syncAllSheetsPins
static TOOL_ACTION closeOutline
static TOOL_ACTION drawArc
static TOOL_ACTION drawSheet
static TOOL_ACTION properties
static TOOL_ACTION leaveSheet
static TOOL_ACTION autoplaceAllSheetPins
static TOOL_ACTION drawRectangle
static TOOL_ACTION placeHierLabel
static TOOL_ACTION placeLabel
static TOOL_ACTION drawCircle
static TOOL_ACTION importGraphics
static TOOL_ACTION placeBusWireEntry
static TOOL_ACTION drawBezier
static TOOL_ACTION rotateCW
static TOOL_ACTION importSheet
static TOOL_ACTION placeJunction
static TOOL_ACTION drawRuleArea
static TOOL_ACTION placeSymbol
static TOOL_ACTION placeImage
static TOOL_ACTION deleteLastPoint
static TOOL_ACTION drawSheetFromDesignBlock
static TOOL_ACTION mirrorH
static TOOL_ACTION placeDesignBlock
static TOOL_ACTION drawTable
static TOOL_ACTION placeSchematicText
static TOOL_ACTION changeSheet
static TOOL_ACTION enterSheet
static TOOL_ACTION repeatDrawItem
static TOOL_ACTION placeNoConnect
static TOOL_ACTION syncSheetPins
static TOOL_ACTION placePower
void AddToScreen(EDA_ITEM *aItem, SCH_SCREEN *aScreen=nullptr)
Add an item to the screen (and view) aScreen is the screen the item is located on,...
SCH_DRAW_PANEL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
PICKED_SYMBOL PickSymbolFromLibrary(const SYMBOL_LIBRARY_FILTER *aFilter, std::vector< PICKED_SYMBOL > &aHistoryList, std::vector< PICKED_SYMBOL > &aAlreadyPlaced, bool aShowFootprints, const LIB_ID *aHighlight=nullptr, bool aAllowFields=true)
Call the library viewer to select symbol to import into schematic.
void SyncView()
Mark all items for refresh.
EESCHEMA_SETTINGS * eeconfig() const
LIB_SYMBOL * GetLibSymbol(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load symbol from symbol library table.
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.
virtual void Push(const wxString &aMessage=wxT("A commit"), int aCommitFlags=0) override
Execute the changes.
virtual void Revert() override
Revert the commit by restoring the modified items state.
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
Schematic editor (Eeschema) main window.
SCH_DESIGN_BLOCK_PANE * GetDesignBlockPane() const
void OnModify() override
Must be called after a schematic change in order to set the "modify" flag and update other data struc...
SCH_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
void SchematicCleanUp(SCH_COMMIT *aCommit, SCH_SCREEN *aScreen=nullptr)
Perform routine schematic cleaning including breaking wire and buses and deleting identical objects s...
bool LoadSheetFromFile(SCH_SHEET *aSheet, SCH_SHEET_PATH *aCurrentSheet, const wxString &aFileName, bool aSkipRecursionCheck=false, bool aSkipLibCheck=false)
Load a the KiCad schematic file aFileName into the sheet aSheet.
void AnnotateSymbols(SCH_COMMIT *aCommit, ANNOTATE_SCOPE_T aAnnotateScope, ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption, bool aRecursive, int aStartNumber, bool aResetAnnotation, bool aRepairTimestamps, REPORTER &aReporter)
Annotate the symbols in the schematic that are not currently annotated.
void HardRedraw() override
Rebuild the GAL and redraw the screen.
SCH_SHEET_PATH & GetCurrentSheet() const
SCHEMATIC & Schematic() const
bool EditSheetProperties(SCH_SHEET *aSheet, SCH_SHEET_PATH *aHierarchy, bool *aIsUndoable=nullptr, bool *aClearAnnotationNewItems=nullptr, bool *aUpdateHierarchyNavigator=nullptr, wxString *aSourceSheetFilename=nullptr)
Edit an existing sheet or add a new sheet to the schematic.
void UpdateHierarchyNavigator(bool aRefreshNetNavigator=true, bool aClear=false)
Update the hierarchy navigation tree and history.
void FlipBodyStyle(SCH_SYMBOL *aSymbol)
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
void SelectUnit(SCH_SYMBOL *aSymbol, int aUnit)
void AutoRotateItem(SCH_SCREEN *aScreen, SCH_ITEM *aItem)
Automatically set the rotation of an item (if the item supports it).
void SaveCopyForRepeatItem(const SCH_ITEM *aItem)
Clone aItem and owns that clone in this container.
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 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 ReannotateByOptions(ANNOTATE_ORDER_T aSortOption, ANNOTATE_ALGO_T aAlgoOption, int aStartNumber, const SCH_REFERENCE_LIST &aAdditionalRefs, bool aStartAtCurrent, SCH_SHEET_LIST *aHierarchy)
Forces reannotation of the provided references.
void AddItem(const SCH_REFERENCE &aItem)
void UpdateAnnotation()
Update the symbol references for the schematic project (or the current sheet).
A helper to define a symbol's reference designator in a schematic.
bool AlwaysAnnotate() const
Verify the reference should always be automatically annotated.
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
void BeginEdit(const VECTOR2I &aStartPoint) override
Begin drawing a symbol library draw item at aPosition.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
void EndEdit(bool aClosed=false) override
End an object editing action.
void SetStroke(const STROKE_PARAMS &aStroke) override
bool ContinueEdit(const VECTOR2I &aPosition) override
Continue an edit in progress at aPosition.
void CalcEdit(const VECTOR2I &aPosition) override
Calculate the attributes of an item at aPosition when it is being edited.
wxString GetClass() const override
Return the class name.
STROKE_PARAMS GetStroke() const 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.
void GetSymbols(SCH_REFERENCE_LIST &aReferences, bool aIncludePowerSymbols=true, 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...
void UpdateAllScreenReferences() const
Update all the symbol references for this sheet path.
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.
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.
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
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()
void ClearAnnotation(const SCH_SHEET_PATH *aSheetPath, bool aResetPrefix)
Clear exiting symbol annotation.
const LIB_ID & GetLibId() const override
bool IsMulti() const override
void SetUnitSelection(const SCH_SHEET_PATH *aSheet, int aUnitSelection)
Set the selected unit of this symbol on one sheet.
const wxString GetRef(const SCH_SHEET_PATH *aSheet, bool aIncludeUnit=false) const override
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 void Add(EDA_ITEM *aItem)
VECTOR2I GetReferencePoint() const
virtual unsigned int GetSize() const override
Return the number of stored items.
virtual void Clear() override
Remove all the stored items from the group.
int Size() const
Returns the number of selected parts.
SHEET_SYNCHRONIZATION_PLACEMENT
std::function< void()> MODIFICATION
Helper object to filter a list of libraries.
SYMBOL_LIB * GetCacheLibrary()
Object used to load, save, search, and otherwise manipulate symbol library files.
void Dismiss() override
Dismisses the infobar and updates the containing layout and AUI manager (if one is provided).
This file is part of the common library.
static constexpr EDA_ANGLE ANGLE_0
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
#define IS_NEW
New item, just created.
#define STRUCT_DELETED
flag indication structures to be erased
#define ENDPOINT
ends. (Used to support dragging.)
#define SKIP_STRUCT
flag indicating that the structure should be ignored
#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_BASE
@ ID_POPUP_SCH_SELECT_ALT
@ ID_POPUP_SCH_SELECT_UNIT_END
static const std::string KiCadSchematicFileExtension
static wxString KiCadSchematicFileWildcard()
PGM_BASE & Pgm()
The global program "get" accessor.
LIB_SYMBOL * SchGetLibSymbol(const LIB_ID &aLibId, SYMBOL_LIB_TABLE *aLibTable, SYMBOL_LIB *aCacheLib, wxWindow *aParent, bool aShowErrorMsg)
Load symbol from symbol library table.
Class to handle a set of SCH_ITEMs.
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.
BOX2I boundingBox(T aObject, int aLayer)
Used by SHAPE_INDEX to get the bounding box of a generic T object.
LINE_STYLE
Dashed line types.
constexpr int MilsToIU(int mils) const
COLOR4D default_sheet_border_color
COLOR4D default_sheet_background_color
int default_line_thickness
POWER_SYMBOLS new_power_symbols
SCH_SYMBOL * m_Symbol
< Provide a symbol to place
Definition for symbol library class.
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.