68#include <dialogs/dialog_text_properties.h>
71#include <dialogs/dialog_table_properties.h>
76#include <wx/filedlg.h>
85 m_lastTextBold( false ),
86 m_lastTextItalic( false ),
99 m_mruPath( wxEmptyString ),
100 m_lastAutoLabelRotateOnPlacement( false ),
101 m_drawingRuleArea( false ),
102 m_inDrawingTool( false )
111 auto belowRootSheetCondition =
117 auto inDrawingRuleArea =
141 bool placeOneOnly = symbol !=
nullptr;
144 std::vector<PICKED_SYMBOL>* historyList =
nullptr;
145 bool ignorePrimePosition =
false;
178 filter.FilterPowerSymbols(
true );
182 wxFAIL_MSG(
"PlaceSymbol(): unexpected request" );
207 : KICURSOR::COMPONENT );
218 existingRefs.
Clear();
240 existingRefs,
false, &hierarchy );
245 for(
size_t i = 0; i < refs.
GetCount(); i++ )
246 existingRefs.
AddItem( refs[i] );
278 ignorePrimePosition =
true;
286 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
292 bool isSyntheticClick = symbol && evt->IsActivate() && evt->HasPosition()
293 && evt->Matches( aEvent );
295 if( evt->IsCancelInteractive() || ( symbol && evt->IsAction( &
ACTIONS::undo ) ) )
309 else if( evt->IsActivate() && !isSyntheticClick )
311 if( symbol && evt->IsMoveTool() )
314 evt->SetPassEvent(
false );
321 evt->SetPassEvent(
false );
325 if( evt->IsMoveTool() )
336 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
345 std::set<UTF8> unique_libid;
346 std::vector<PICKED_SYMBOL> alreadyPlaced;
363 alreadyPlaced.push_back( pickedSymbol );
383 if( evt->IsPrime() && !ignorePrimePosition )
385 cursorPos =
grid.Align( evt->Position(), GRID_HELPER_GRIDS::GRID_CONNECTABLE );
392 GRID_HELPER_GRIDS::GRID_CONNECTABLE );
402 existingRefs.
AddItem( placedSymbolReference );
406 symbol->AutoplaceFields(
nullptr,
false );
417 symbol->AutoplaceFields( screen,
false );
422 commit.
Added( symbol, screen );
428 commit.
Push(
_(
"Place Symbol" ) );
441 int new_unit = symbol->
GetUnit();
444 && symbol->GetUnit() < symbol->GetUnitCount() )
456 nextSymbol =
static_cast<SCH_SYMBOL*
>( symbol->Duplicate() );
457 nextSymbol->
SetUnit( new_unit );
464 addSymbol( nextSymbol );
470 existingRefs.
AddItem( placedSymbolReference );
504 if( symbol && symbol->GetBodyStyle() != bodyStyle )
528 symbol->SetPosition( cursorPos );
566 static const std::vector<KICAD_T> symbolTypes = {
SCH_SYMBOL_T };
569 if( selection.
Size() != 1 )
590 if( missingUnits.empty() )
597 const int nextMissing = *std::min_element( missingUnits.begin(), missingUnits.end() );
599 std::unique_ptr<SCH_SYMBOL> newSymbol = std::make_unique<SCH_SYMBOL>( *symbol );
602 newSymbol->SetUnitProp( nextMissing );
603 newSymbol->SetRefProp( symbol->
GetRef( &sheetPath,
false ) );
617 wxString sheetFileName = wxEmptyString;
619 if( placingDesignBlock )
634 wxString* importSourceFile = aEvent.
Parameter<wxString*>();
636 if( importSourceFile !=
nullptr )
637 sheetFileName = *importSourceFile;
650 if( !cfg || !common_settings )
660 : KICURSOR::COMPONENT );
663 auto placeSheetContents =
678 placingDesignBlock ) )
698 commit.
Added( item, screen );
699 newItems.emplace_back( item );
720 if( !keepAnnotations )
750 commit.
Push( placingDesignBlock ?
_(
"Add design block" )
751 :
_(
"Import Schematic Sheet Content..." ) );
762 if( sheetFileName.IsEmpty() )
767 if (!placingDesignBlock) {
769 if( sheetFileName.IsEmpty() )
772 file = wxEmptyString;
776 path = wxPathOnly( sheetFileName );
777 file = wxFileName( sheetFileName ).GetFullName();
782 wxFileDialog dlg(
m_frame,
_(
"Choose Schematic" ),
path, file,
784 wxFD_OPEN | wxFD_FILE_MUST_EXIST );
787 dlg.SetCustomizeHook( dlgHook );
789 if( dlg.ShowModal() == wxID_CANCEL )
792 sheetFileName = dlg.GetPath();
797 if( sheetFileName.IsEmpty() )
811 designBlock =
nullptr;
838 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
844 bool isSyntheticClick = designBlock && evt->IsActivate() && evt->HasPosition()
845 && evt->Matches( aEvent );
847 if( evt->IsCancelInteractive() || ( designBlock && evt->IsAction( &
ACTIONS::undo ) ) )
852 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
854 if( placingDesignBlock )
860 new wxString( sheetFileName ) );
894 bool immediateMode =
image !=
nullptr;
895 bool ignorePrimePosition =
false;
958 ignorePrimePosition =
true;
966 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
972 bool isSyntheticClick =
image && evt->IsActivate() && evt->HasPosition()
973 && evt->Matches( aEvent );
995 else if( evt->IsActivate() && !isSyntheticClick )
997 if(
image && evt->IsMoveTool() )
1000 evt->SetPassEvent(
false );
1007 evt->SetPassEvent(
false );
1011 if( evt->IsMoveTool() )
1022 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
1029 _(
"Image Files" ) + wxS(
" " ) + wxImage::GetImageExtWildcard(),
1032 if( dlg.ShowModal() != wxID_OK )
1038 if( evt->IsPrime() && !ignorePrimePosition )
1040 cursorPos =
grid.Align( evt->Position() );
1049 wxString fullFilename = dlg.GetPath();
1052 if( wxFileExists( fullFilename ) )
1055 if( !
image || !
image->GetReferenceImage().ReadImageFile( fullFilename ) )
1057 wxMessageBox( wxString::Format(
_(
"Could not load image from '%s'." ), fullFilename ) );
1080 commit.
Push(
_(
"Place Image" ) );
1119 image->SetPosition( cursorPos );
1135 evt->SetPassEvent();
1165 if( dlgResult != wxID_OK )
1171 wxMessageBox(
_(
"No graphic items found in file." ) );
1178 std::vector<SCH_ITEM*> newItems;
1179 std::vector<SCH_ITEM*> selectedItems;
1183 for( std::unique_ptr<EDA_ITEM>& ptr : list )
1186 wxCHECK2( item,
continue );
1188 newItems.push_back( item );
1189 selectedItems.push_back( item );
1190 preview.
Add( item );
1201 commit.
Push(
_(
"Import Graphic" ) );
1210 EDA_ITEMS selItems( selectedItems.begin(), selectedItems.end() );
1215 auto setCursor = [&]()
1235 for(
SCH_ITEM* item : selectedItems )
1236 item->Move(
delta );
1238 currentOffset +=
delta;
1248 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1253 if( evt->IsCancelInteractive() || evt->IsActivate() )
1262 else if( evt->IsMotion() )
1264 delta = cursorPos - currentOffset;
1266 for(
SCH_ITEM* item : selectedItems )
1267 item->Move(
delta );
1269 currentOffset +=
delta;
1283 commit.
Push(
_(
"Import Graphic" ) );
1288 evt->SetPassEvent();
1311 bool loggedInfoBarError =
false;
1312 wxString description;
1314 bool allowRepeat =
false;
1340 description =
_(
"Add No Connect Flag" );
1347 description =
_(
"Add Junction" );
1353 description =
_(
"Add Wire to Bus Entry" );
1358 wxASSERT_MSG(
false,
"Unknown item type in SCH_DRAWING_TOOLS::SingleClickPlace" );
1396 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1398 cursorPos = evt->IsPrime() ? evt->Position() : controls->
GetMousePosition();
1399 cursorPos =
grid.BestSnapAnchor( cursorPos,
grid.GetItemGrid( previewItem ),
nullptr );
1402 if( evt->IsCancelInteractive() )
1407 else if( evt->IsActivate() )
1409 if( evt->IsMoveTool() )
1422 if( !screen->
GetItem( cursorPos, 0, type ) )
1429 "wires and/or pins." ) );
1430 loggedInfoBarError =
true;
1433 else if( loggedInfoBarError )
1449 commit.
Added( newItem, screen );
1453 commit.
Push( description );
1508 std::deque<SCH_ITEM*> strokeItems;
1509 strokeItems.push_back( previewItem );
1517 std::deque<SCH_JUNCTION*> junctions;
1518 junctions.push_back(
static_cast<SCH_JUNCTION*
>( previewItem ) );
1533 evt->SetPassEvent();
1538 evt->SetPassEvent();
1571 wxASSERT( aWire->
IsWire() );
1577 SCH_ITEM* wireDriver = wireConnection->Driver();
1579 if( wireDriver && wireDriver->
IsType( { SCH_LABEL_T, SCH_GLOBAL_LABEL_T } ) )
1580 return wireConnection->LocalName();
1583 return wxEmptyString;
1589 SCHEMATIC* schematic = getModel<SCHEMATIC>();
1598 textItem =
new SCH_TEXT( aPosition );
1603 textItem = labelItem;
1613 labelItem->
GetFields().emplace_back(
SCH_FIELD( {0,0}, 0, labelItem, wxT(
"Netclass" ) ) );
1615 SCH_FIELD( { 0, 0 }, 0, labelItem, wxT(
"Component Class" ) ) );
1616 labelItem->
GetFields().back().SetItalic(
true );
1617 labelItem->
GetFields().back().SetVisible(
true );
1618 textItem = labelItem;
1625 textItem = labelItem;
1633 textItem = labelItem;
1641 wxFAIL_MSG(
"SCH_EDIT_FRAME::CreateNewText() unknown layer type" );
1680 else if( !netName.IsEmpty() )
1741 pin->SetText( std::to_string( aSheet->
GetPins().size() + 1 ) );
1743 pin->SetPosition( aPosition );
1744 pin->ClearSelected();
1757 bool ignorePrimePosition =
false;
1760 wxString description;
1791 else if( isGlobalLabel )
1793 else if( isNetLabel )
1795 else if( isClassLabel )
1797 else if( isHierLabel )
1803 auto updatePreview =
1837 && ( isText || isGlobalLabel || isHierLabel || isClassLabel || isNetLabel ) )
1840 ignorePrimePosition =
true;
1848 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
1851 cursorPos =
grid.BestSnapAnchor( cursorPos, snapGrid, item );
1855 bool isSyntheticClick = item && evt->IsActivate() && evt->HasPosition()
1858 if( evt->IsCancelInteractive() || evt->IsAction( &
ACTIONS::undo ) )
1872 else if( evt->IsActivate() && !isSyntheticClick )
1874 if( item && evt->IsMoveTool() )
1877 evt->SetPassEvent(
false );
1884 evt->SetPassEvent(
false );
1888 if( evt->IsPointEditor() )
1892 else if( evt->IsMoveTool() )
1903 else if( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) || isSyntheticClick )
1913 description =
_(
"Add Text" );
1915 else if( isHierLabel )
1922 SCHEMATIC* schematic = getModel<SCHEMATIC>();
1940 description =
_(
"Add Hierarchical Label" );
1942 else if( isNetLabel )
1945 description =
_(
"Add Label" );
1947 else if( isGlobalLabel )
1950 description =
_(
"Add Label" );
1952 else if( isClassLabel )
1955 description =
_(
"Add Label" );
1957 else if( isSheetPin )
1970 + wxPoint( 20, 20 ) );
1983 pin->SetText( label->GetText() );
1984 pin->SetShape( label->GetShape() );
1988 description =
_(
"Add Sheet Pin" );
1994 if( evt->IsPrime() && !ignorePrimePosition )
1996 cursorPos =
grid.Align( evt->Position() );
2003 cursorPos =
grid.BestSnapAnchor( cursorPos, snapGrid, item );
2046 commit.
Push( description );
2080 else if( item && evt->IsSelectionEvent() )
2085 if( selection.
GetSize() == 1 )
2126 evt->SetPassEvent();
2151 SCHEMATIC* schematic = getModel<SCHEMATIC>();
2156 wxString description;
2206 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2212 bool isSyntheticClick = item && evt->IsActivate() && evt->HasPosition()
2215 if( evt->IsCancelInteractive() || ( item && evt->IsAction( &
ACTIONS::undo ) ) )
2227 else if( evt->IsActivate() && !isSyntheticClick )
2229 if( item && evt->IsMoveTool() )
2232 evt->SetPassEvent(
false );
2239 if( evt->IsPointEditor() )
2243 else if( evt->IsMoveTool() )
2254 else if( evt->IsClick(
BUT_LEFT ) && !item )
2277 description =
_(
"Add Text Box" );
2295 else if( item && ( evt->IsClick(
BUT_LEFT )
2341 commit.
Push( wxString::Format(
_(
"Draw %s" ), item->
GetClass() ) );
2372 else if( evt->IsDblClick(
BUT_LEFT ) && !item )
2390 evt->SetPassEvent();
2419 bool started =
false;
2435 auto cleanup = [&]()
2437 polyGeomMgr.
Reset();
2462 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2471 if( evt->IsCancelInteractive() )
2482 evt->SetPassEvent(
false );
2486 else if( evt->IsActivate() )
2491 if( evt->IsPointEditor() )
2495 else if( evt->IsMoveTool() )
2518 const bool endPolygon = evt->IsDblClick(
BUT_LEFT )
2525 polyGeomMgr.
Reset();
2532 else if( polyGeomMgr.
AddPoint( cursorPos ) )
2549 cursorPos = last.value();
2559 else if( started && ( evt->IsMotion() || evt->IsDrag(
BUT_LEFT ) ) )
2565 evt->SetPassEvent();
2579 SCHEMATIC* schematic = getModel<SCHEMATIC>();
2630 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2636 bool isSyntheticClick = table && evt->IsActivate() && evt->HasPosition()
2639 if( evt->IsCancelInteractive() || ( table && evt->IsAction( &
ACTIONS::undo ) ) )
2651 else if( evt->IsActivate() && !isSyntheticClick )
2653 if( table && evt->IsMoveTool() )
2656 evt->SetPassEvent(
false );
2663 if( evt->IsPointEditor() )
2667 else if( evt->IsMoveTool() )
2678 else if( evt->IsClick(
BUT_LEFT ) && !table )
2698 else if( table && ( evt->IsClick(
BUT_LEFT )
2714 commit.
Push(
_(
"Draw Table" ) );
2732 VECTOR2I requestedSize( cursorPos - origin );
2734 int colCount = std::max( 1, requestedSize.
x / ( fontSize * 15 ) );
2735 int rowCount = std::max( 1, requestedSize.
y / ( fontSize * 2 ) );
2737 VECTOR2I cellSize( std::max( gridSize.
x * 5, requestedSize.
x / colCount ),
2738 std::max( gridSize.
y * 2, requestedSize.
y / rowCount ) );
2740 cellSize.
x =
KiROUND( (
double) cellSize.
x / gridSize.
x ) * gridSize.
x;
2741 cellSize.
y =
KiROUND( (
double) cellSize.
y / gridSize.
y ) * gridSize.
y;
2746 for(
int col = 0; col < colCount; ++col )
2749 for(
int row = 0; row < rowCount; ++row )
2753 for(
int col = 0; col < colCount; ++col )
2769 else if( evt->IsDblClick(
BUT_LEFT ) && !table )
2787 evt->SetPassEvent();
2811 if( isDrawSheetCopy )
2813 wxString* ptr = aEvent.
Parameter<wxString*>();
2820 else if( isDrawSheetFromDesignBlock )
2823 wxCHECK( designBlock, 0 );
2827 if( ( isDrawSheetCopy || isDrawSheetFromDesignBlock ) && !wxFileExists( filename ) )
2829 wxMessageBox( wxString::Format(
_(
"File '%s' does not exist." ), filename ) );
2871 if( aEvent.
HasPosition() && !( isDrawSheetCopy || isDrawSheetFromDesignBlock ) )
2879 grid.SetUseGrid(
getView()->GetGAL()->GetGridSnapping() && !evt->DisableGridSnapping() );
2885 bool isSyntheticClick = sheet && evt->IsActivate() && evt->HasPosition()
2888 if( evt->IsCancelInteractive() || ( sheet && evt->IsAction( &
ACTIONS::undo ) ) )
2902 else if( evt->IsActivate() && !isSyntheticClick )
2904 if( sheet && evt->IsMoveTool() )
2907 evt->SetPassEvent(
false );
2914 evt->SetPassEvent(
false );
2918 if( evt->IsPointEditor() )
2922 else if( evt->IsMoveTool() )
2933 else if( !sheet && ( evt->IsClick(
BUT_LEFT ) || evt->IsDblClick(
BUT_LEFT ) ) )
2937 if( selection.
Size() == 1
2946 else if( evt->IsDblClick(
BUT_LEFT ) )
2959 if( isDrawSheetCopy )
2961 wxFileName fn( filename );
2967 else if( isDrawSheetFromDesignBlock )
2969 wxFileName fn( filename );
2975 std::vector<SCH_FIELD>& sheetFields = sheet->
GetFields();
2978 for(
const auto& field : designBlock->
GetFields() )
2980 SCH_FIELD newField( sheet, sheetFields.size(), field.first );
2981 newField.
SetText( field.second );
2984 sheetFields.emplace_back( newField );
3003 wxString pageNumber;
3007 pageNumber.Printf( wxT(
"%d" ),
static_cast<int>( hierarchy.size() ) + 1 );
3013 else if( sheet && ( evt->IsClick(
BUT_LEFT )
3023 nullptr, &filename ) )
3043 && !( ( isDrawSheetCopy || isDrawSheetFromDesignBlock )
3056 c.
Push( isDrawSheetCopy ?
"Import Sheet Copy" :
"Draw Sheet" );
3105 evt->SetPassEvent();
3136 if( !sheetPaths.size() )
3140 m_frame, std::move( sheetPaths ),
3141 std::make_shared<SHEET_SYNCHRONIZATION_AGENT>(
3151 commit.
Push(
_(
"Modify sheet pin" ) );
3157 commit.
Push(
_(
"Modify schematic item" ) );
3169 selectionTool->AddItemToSel( aItem,
true );
3239 static const std::function<void( std::list<SCH_SHEET_PATH>&,
SCH_SCREEN*,
3241 getSheetChildren = []( std::list<SCH_SHEET_PATH>& aPaths,
SCH_SCREEN* aScene,
3242 std::set<SCH_SCREEN*>& aVisited,
SCH_SHEET_PATH const& aCurPath )
3244 if( ! aScene || aVisited.find(aScene) != aVisited.end() )
3247 std::vector<SCH_ITEM*> sheetChildren;
3248 aScene->GetSheets( &sheetChildren );
3249 aVisited.insert( aScene );
3251 for(
SCH_ITEM* child : sheetChildren )
3256 aPaths.push_back( cp );
3257 getSheetChildren( aPaths, sheet->
GetScreen(), aVisited, cp );
3261 std::list<SCH_SHEET_PATH> sheetPaths;
3262 std::set<SCH_SCREEN*> visited;
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 refreshPreview
static TOOL_ACTION finishInteractive
constexpr bool Contains(const Vec &aPoint) const
COMMIT & Modify(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Create an undo entry for an item that has been already modified.
COMMIT & Added(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Remove a new item from the model.
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
LIB_ID GetSelectedLibId(int *aUnit=nullptr) const
To be called after this dialog returns from ShowModal().
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 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 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_DESIGN_BLOCK_CHOOSER m_DesignBlockChooserPanel
PANEL_ANNOTATE m_AnnotatePanel
PANEL_SYM_CHOOSER m_SymChooserPanel
AUTOPLACE_FIELDS m_AutoplaceFields
static TOOL_ACTION drawSheetFromFile
static TOOL_ACTION mirrorV
static TOOL_ACTION drawSheetFromDesignBlock
static TOOL_ACTION placeDesignBlock
static TOOL_ACTION properties
static TOOL_ACTION addItemsToSel
Selects a list of items (specified as the event parameter)
static TOOL_ACTION changeSheet
static TOOL_ACTION drawTable
static TOOL_ACTION syncAllSheetsPins
static TOOL_ACTION placeSymbol
static TOOL_ACTION clearSelection
Clears the current selection.
static TOOL_ACTION drawRuleArea
static TOOL_ACTION placeClassLabel
static TOOL_ACTION placeNextSymbolUnit
static TOOL_ACTION closeOutline
static TOOL_ACTION drawCircle
static TOOL_ACTION rotateCCW
static TOOL_ACTION placePower
static TOOL_ACTION deleteLastPoint
static TOOL_ACTION placeSheetPin
static TOOL_ACTION mirrorH
static TOOL_ACTION syncSheetPins
static TOOL_ACTION rotateCW
static TOOL_ACTION importGraphics
static TOOL_ACTION leaveSheet
static TOOL_ACTION placeGlobalLabel
static TOOL_ACTION placeHierLabel
static TOOL_ACTION drawTextBox
static TOOL_ACTION drawRectangle
static TOOL_ACTION placeImage
static TOOL_ACTION enterSheet
static TOOL_ACTION placeSchematicText
static TOOL_ACTION drawArc
static TOOL_ACTION drawSheet
static TOOL_ACTION drawBezier
static TOOL_ACTION placeLabel
static TOOL_ACTION repeatDrawItem
static TOOL_ACTION placeBusWireEntry
static TOOL_ACTION placeJunction
static TOOL_ACTION importSheet
static TOOL_ACTION placeNoConnect
EE_TYPE Overlapping(const BOX2I &aRect) const
A color representation with 4 components: red, green, blue, alpha.
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.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
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.
const LIB_ID & GetLibId() 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)
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 override
Return the full schematic flattened hierarchical sheet list.
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
Revert the commit by restoring the modified items state.
virtual void Revert() override
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
Schematic editor (Eeschema) main window.
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...
void UpdateHierarchyNavigator(bool aRefreshNetNavigator=true)
Update the hierarchy navigation tree and history.
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
DESIGN_BLOCK * GetDesignBlock(const LIB_ID &aLibId, bool aUseCacheLib=false, bool aShowErrorMsg=false)
Load design block from design block library table.
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 FlipBodyStyle(SCH_SYMBOL *aSymbol)
void SetSheetNumberAndCount()
Set the m_ScreenNumber and m_NumberOfScreens members for screens.
void SelectUnit(SCH_SYMBOL *aSymbol, int aUnit)
void UpdateDesignBlockOptions()
Design block panel options have changed and the panel needs to be refreshed.
DESIGN_BLOCK_PANE * GetDesignBlockPane() const
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.
Instances are attached to a symbol or sheet and provide a place for the symbol's value,...
void SetText(const wxString &aText) override
void SetSpinStyle(SPIN_STYLE aSpinStyle) override
Base class for any item which can be embedded within the SCHEMATIC container class,...
virtual bool IsConnectable() const
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction)
virtual void SetUnit(int aUnit)
virtual void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual)
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)
setAutoRotateOnPlacement
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()
Gets 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
Indicates that a juction 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()
void SetBackgroundColor(KIGFX::COLOR4D aColor)
SCH_SCREEN * GetScreen() const
VECTOR2I GetPosition() const override
void SetScreen(SCH_SCREEN *aScreen)
Set the SCH_SCREEN associated with this sheet to aScreen.
void AutoplaceFields(SCH_SCREEN *aScreen, bool aManual) override
void SetBorderWidth(int aWidth)
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
void SetRowHeight(int aRow, int aHeight)
void SetColCount(int aCount)
void SetColWidth(int aCol, int aWidth)
void AddCell(SCH_TABLECELL *aCell)
VECTOR2I GetPosition() const override
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
void SetPosition(const VECTOR2I &aPos) 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.
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.
bool NoPrintableChars(const wxString &aString)
Return true if the string is empty or contains only whitespace.
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
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.