57#include <python_scripting.h>
99#include <wx/wupdlock.h>
123#include "../scripting/python_scripting.h"
125#include <wx/filedlg.h>
127using namespace std::placeholders;
130#define INSPECT_DRC_ERROR_DIALOG_NAME wxT( "InspectDrcErrorDialog" )
131#define INSPECT_CLEARANCE_DIALOG_NAME wxT( "InspectClearanceDialog" )
132#define INSPECT_CONSTRAINTS_DIALOG_NAME wxT( "InspectConstraintsDialog" )
133#define FOOTPRINT_DIFF_DIALOG_NAME wxT( "FootprintDiffDialog" )
199 m_exportNetlistAction(
nullptr ),
200 m_findDialog(
nullptr ),
201 m_inspectDrcErrorDlg(
nullptr ),
202 m_inspectClearanceDlg(
nullptr ),
203 m_inspectConstraintsDlg(
nullptr ),
204 m_footprintDiffDlg(
nullptr ),
205 m_importProperties(
nullptr )
207 m_maximizeByDefault =
true;
208 m_showBorderAndTitleBlock =
true;
209 m_SelTrackWidthBox =
nullptr;
210 m_SelViaSizeBox =
nullptr;
211 m_SelLayerBox =
nullptr;
212 m_show_layer_manager_tools =
true;
213 m_supportsAutoSave =
true;
214 m_probingSchToPcb =
false;
215 m_show_search =
false;
216 m_show_net_inspector =
false;
220 m_ZoneFillsDirty =
true;
222 m_aboutTitle =
_HKI(
"KiCad PCB Editor" );
227 m_exportNetlistAction =
new TOOL_ACTION(
"pcbnew.EditorControl.exportNetlist",
229 _(
"Export netlist used to update schematics" ) );
234 GetGalDisplayOptions(),
238 SetBoard(
new BOARD() );
241 wxIconBundle icon_bundle;
244 icon_bundle.AddIcon( icon );
246 icon_bundle.AddIcon( icon );
248 icon_bundle.AddIcon( icon );
250 icon_bundle.AddIcon( icon );
252 icon_bundle.AddIcon( icon );
254 SetIcons( icon_bundle );
263 GetScreen()->m_Center =
false;
270 ReCreateAuxiliaryToolbar();
272 ReCreateOptToolbar();
276 &PCB_EDIT_FRAME::onPluginAvailabilityChanged,
this );
281 float proportion = GetPcbNewSettings()->m_AuiPanels.properties_splitter;
282 m_propertiesPanel->SetSplitterProportion( proportion );
290 m_auimgr.SetManagedWindow(
this );
294 unsigned int auiFlags = wxAUI_MGR_DEFAULT;
295#if !defined( _WIN32 )
298 auiFlags |= wxAUI_MGR_LIVE_RESIZE;
300 m_auimgr.SetFlags( auiFlags );
303 m_auimgr.AddPane( m_mainToolBar,
EDA_PANE().HToolbar().Name( wxS(
"MainToolbar" ) )
305 m_auimgr.AddPane( m_auxiliaryToolBar,
EDA_PANE().HToolbar().Name( wxS(
"AuxToolbar" ) )
307 m_auimgr.AddPane( m_messagePanel,
EDA_PANE().Messages().Name( wxS(
"MsgPanel" ) )
308 .Bottom().Layer( 6 ) );
311 m_auimgr.AddPane( m_optionsToolBar,
EDA_PANE().VToolbar().Name( wxS(
"OptToolbar" ) )
312 .Left().Layer( 3 ) );
314 m_auimgr.AddPane( m_drawToolBar,
EDA_PANE().VToolbar().Name( wxS(
"ToolsToolbar" ) )
315 .Right().Layer( 3 ) );
317 m_auimgr.AddPane( m_appearancePanel,
EDA_PANE().Name( wxS(
"LayersManager" ) )
319 .Caption(
_(
"Appearance" ) ).PaneBorder(
false )
320 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
322 m_auimgr.AddPane( m_selectionFilterPanel,
EDA_PANE().Name( wxS(
"SelectionFilter" ) )
323 .Right().Layer( 4 ).Position( 2 )
324 .Caption(
_(
"Selection Filter" ) ).PaneBorder(
false )
325 .MinSize( FromDIP( 180 ), -1 ).BestSize( FromDIP( 180 ), -1 ) );
327 m_auimgr.AddPane( m_propertiesPanel,
EDA_PANE().Name( PropertiesPaneName() )
329 .Caption(
_(
"Properties" ) ).PaneBorder(
false )
330 .MinSize( FromDIP( wxSize( 240, 60 ) ) ).BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
333 m_auimgr.AddPane( GetCanvas(),
EDA_PANE().Canvas().Name( wxS(
"DrawFrame" ) )
336 m_auimgr.AddPane( m_netInspectorPanel,
EDA_PANE()
337 .Name( NetInspectorPanelName() )
339 .Caption(
_(
"Net Inspector" ) )
341 .MinSize( FromDIP( wxSize( 240, 60 ) ) )
342 .BestSize( FromDIP( wxSize( 300, 200 ) ) ) );
344 m_auimgr.AddPane( m_searchPane,
EDA_PANE().Name( SearchPaneName() )
346 .Caption(
_(
"Search" ) ).PaneBorder(
false )
347 .MinSize( FromDIP( wxSize ( 180, 60 ) ) ).BestSize( FromDIP( wxSize ( 180, 100 ) ) )
348 .FloatingSize( FromDIP( wxSize( 480, 200 ) ) )
349 .DestroyOnClose(
false ) );
352 m_auimgr.GetPane(
"LayersManager" ).Show( m_show_layer_manager_tools );
353 m_auimgr.GetPane(
"SelectionFilter" ).Show( m_show_layer_manager_tools );
354 m_auimgr.GetPane( PropertiesPaneName() ).Show( GetPcbNewSettings()->m_AuiPanels.show_properties );
355 m_auimgr.GetPane( NetInspectorPanelName() ).Show( m_show_net_inspector );
356 m_auimgr.GetPane( SearchPaneName() ).Show( m_show_search );
359 m_auimgr.GetPane(
"SelectionFilter" ).dock_proportion = 0;
361 FinishAUIInitialization();
365 if( settings->m_AuiPanels.right_panel_width > 0 )
367 wxAuiPaneInfo& layersManager = m_auimgr.GetPane( wxS(
"LayersManager" ) );
368 SetAuiPaneSize( m_auimgr, layersManager, settings->m_AuiPanels.right_panel_width, -1 );
371 if( settings->m_AuiPanels.properties_panel_width > 0 && m_propertiesPanel )
373 wxAuiPaneInfo& propertiesPanel = m_auimgr.GetPane( PropertiesPaneName() );
375 settings->m_AuiPanels.properties_panel_width, -1 );
378 if( settings->m_AuiPanels.search_panel_height > 0
379 && ( settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_TOP
380 || settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_BOTTOM ) )
382 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
383 searchPane.Direction( settings->m_AuiPanels.search_panel_dock_direction );
384 SetAuiPaneSize( m_auimgr, searchPane, -1, settings->m_AuiPanels.search_panel_height );
386 else if( settings->m_AuiPanels.search_panel_width > 0
387 && ( settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_LEFT
388 || settings->m_AuiPanels.search_panel_dock_direction == wxAUI_DOCK_RIGHT ) )
390 wxAuiPaneInfo& searchPane = m_auimgr.GetPane( SearchPaneName() );
391 searchPane.Direction( settings->m_AuiPanels.search_panel_dock_direction );
392 SetAuiPaneSize( m_auimgr, searchPane, settings->m_AuiPanels.search_panel_width, -1 );
395 m_appearancePanel->SetTabIndex( settings->m_AuiPanels.appearance_panel_tab );
405 [
this]( wxIdleEvent& aEvent )
407 BOX2D viewport = GetCanvas()->GetView()->GetViewport();
409 if( viewport != m_lastNetnamesViewport )
412 m_lastNetnamesViewport = viewport;
427 m_toolManager->GetTool<
DRC_TOOL>()->GetDRCEngine()->InitEngine( wxFileName() );
434 PythonSyncEnvironmentVariables();
435 PythonSyncProjectName();
441 m_apiHandler = std::make_unique<API_HANDLER_PCB>(
this );
442 Pgm().GetApiServer().RegisterHandler( m_apiHandler.get() );
445 GetCanvas()->SwitchBackend( m_canvasType );
455 if( strK2S.Find( wxT(
"pcbnew.app" ) ) != wxNOT_FOUND )
458 strK2S += wxT(
"../../" );
461 strK2S += wxT(
"Contents/MacOS/" );
464 wxFileName appK2S( strK2S, wxT(
"kicad2step" ) );
467 appK2S.SetExt( wxT(
"exe" ) );
482 m_appearancePanel->OnBoardChanged();
492 UpdateToolbarControlSizes();
497 m_eventCounterTimer =
new wxTimer(
this );
500 [&]( wxTimerEvent& aEvent )
502 GetCanvas()->m_PaintEventCounter->Show();
503 GetCanvas()->m_PaintEventCounter->Reset();
511 m_eventCounterTimer->GetId() );
513 m_eventCounterTimer->Start( 1000 );
520 DragAcceptFiles(
true );
537 Pgm().GetApiServer().DeregisterHandler( m_apiHandler.get() );
539 &PCB_EDIT_FRAME::onPluginAvailabilityChanged,
this );
546 open_dlg->Close(
true );
573 if( aBuildConnectivity )
645 if( screen !=
nullptr )
715 pcbTool->SetIsBoardEditor(
true );
748#define ENABLE( x ) ACTION_CONDITIONS().Enable( x )
749#define CHECK( x ) ACTION_CONDITIONS().Check( x )
786 if( SCRIPTING::IsWxAvailable() )
789 auto enableZoneControlCondition =
797 ENABLE( enableZoneControlCondition )
800 ENABLE( enableZoneControlCondition )
801 .Check( cond.
ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_ZONE_OUTLINE ) ) );
803 ENABLE( enableZoneControlCondition )
804 .Check( cond.
ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_FRACTURE_BORDERS ) ) );
806 ENABLE( enableZoneControlCondition )
807 .Check( cond.
ZoneDisplayMode( ZONE_DISPLAY_MODE::SHOW_TRIANGULATION ) ) );
811 auto constrainedDrawingModeCond =
817 auto boardFlippedCond =
823 auto layerManagerCond =
829 auto propertiesCond =
835 auto netInspectorCond =
841 auto searchPaneCond =
847 auto highContrastCond =
853 auto globalRatsnestCond =
859 auto curvedRatsnestCond =
865 auto netHighlightCond =
872 auto enableNetHighlightCond =
886 .Enable( enableNetHighlightCond ) );
891 auto isArcKeepCenterMode =
897 auto isArcKeepEndpointMode =
906 auto isHighlightMode =
920 auto isWalkaroundMode =
938 if( bci->GetNetCode() > 0 )
955 static const std::vector<KICAD_T> zoneTypes = {
PCB_ZONE_T };
977#define CURRENT_TOOL( action ) mgr->SetConditions( action, CHECK( cond.CurrentTool( action ) ) )
992#define CURRENT_EDIT_TOOL( action ) \
993 mgr->SetConditions( action, ACTION_CONDITIONS().Check( cond.CurrentTool( action ) ) \
994 .Enable( isDRCIdle ) )
1032#undef CURRENT_EDIT_TOOL
1041 if( event.GetId() == wxID_EXIT )
1044 if( event.GetId() == wxID_CLOSE ||
Kiface().IsSingle() )
1056 marker->GetRCItem()->SetItems(
GetCanvas()->GetDrawingSheet() );
1058 commit.
Add( marker );
1084 if( zoneFillerTool->
IsBusy() )
1088 if( wxWindow* reporter =
dynamic_cast<wxWindow*
>( zoneFillerTool->
GetProgressReporter() ) )
1089 reporter->ShowWithEffect( wxSHOW_EFFECT_EXPAND );
1094 if(
Kiface().IsSingle() )
1098 if( fpEditor && !fpEditor->Close() )
1103 if( fpViewer && !fpViewer->Close() )
1110 if( chooser && !chooser->Close() )
1117 if( fpEditor && fpEditor->IsCurrentFPFromBoard() )
1119 if( !fpEditor->CanCloseFPFromBoard(
true ) )
1127 wxString msg =
_(
"Save changes to '%s' before closing?" );
1132 return Files_io_from_id( ID_SAVE_BOARD );
1151 GetCanvas()->SetEvtHandlerEnabled(
false );
1162 open_dlg->Close(
true );
1202 if( !fn.IsOk() || !fn.IsDirWritable() )
1203 fn.SetPath( wxFileName::GetTempDir() );
1205 wxLogTrace(
traceAutoSave, wxT(
"Deleting auto save file <" ) + fn.GetFullPath() + wxT(
">" ) );
1208 if( fn.FileExists() && !wxRemoveFile( fn.GetFullPath() ) )
1210 wxLogTrace(
traceAutoSave, wxT(
"The auto save file could not be removed!" ) );
1221 m_auimgr.GetPane( wxS(
"LayersManager" ) ).Show(
false );
1222 m_auimgr.GetPane( wxS(
"TabbedPanel" ) ).Show(
false );
1253 if( !dialogLock.owns_lock() )
1261 if( !aInitialPage.IsEmpty() )
1293 if( (
GetBoard()->GetVisibleLayers() & maskAndPasteLayers ).any() )
1313 text->ClearRenderCache();
1314 text->ClearBoundingBoxCache();
1423 if( oldLayer == aLayer )
1456 if(
via->GetViaType() == VIATYPE::BLIND_BURIED
1457 ||
via->GetViaType() == VIATYPE::MICROVIA )
1462 if(
via->GetRemoveUnconnected() )
1474 if(
pad->GetRemoveUnconnected() )
1484 if(
pad->GetAttribute() == PAD_ATTRIB::SMD )
1486 if( ( oldLayer ==
F_Cu || aLayer ==
F_Cu ) &&
pad->IsOnLayer(
F_Cu ) )
1489 if( ( oldLayer ==
B_Cu || aLayer ==
B_Cu ) &&
pad->IsOnLayer(
B_Cu ) )
1492 else if(
pad->IsOnLayer( oldLayer ) ||
pad->IsOnLayer( aLayer ) )
1532 layerEnum.
Map( layer,
GetBoard()->GetLayerName( layer ) );
1552 if( fn.FileExists() && !fn.IsFileWritable() )
1593 SetStatusText( wxEmptyString );
1642 if(
project.m_PcbLastPath[ aType ].IsEmpty() )
1643 return wxEmptyString;
1645 wxFileName absoluteFileName =
project.m_PcbLastPath[ aType ];
1648 absoluteFileName.MakeAbsolute( pcbFileName.GetPath() );
1649 return absoluteFileName.GetFullPath();
1657 wxFileName relativeFileName = aLastPath;
1660 relativeFileName.MakeRelativeTo( pcbFileName.GetPath() );
1662 if( relativeFileName.GetFullPath() !=
project.m_PcbLastPath[ aType ] )
1664 project.m_PcbLastPath[ aType ] = relativeFileName.GetFullPath();
1676 if( !GetTitle().StartsWith( wxT(
"*" ) ) )
1698 bool readOnly =
false;
1699 bool unsaved =
false;
1701 if( fn.IsOk() && fn.FileExists() )
1702 readOnly = !fn.IsFileWritable();
1711 title += fn.GetName();
1714 title += wxS(
" " ) +
_(
"[Read Only]" );
1717 title += wxS(
" " ) +
_(
"[Unsaved]" );
1719 title += wxT(
" \u2014 " ) +
_(
"PCB Editor" );
1754 layerEnum.
Map( layer,
GetBoard()->GetLayerName( layer ) );
1783 wxString findString;
1787 if( selection.
Size() == 1 )
1791 switch( front->
Type() )
1801 if( findString.Contains( wxT(
"\n" ) ) )
1802 findString = findString.Before(
'\n' );
1833 plotSettings.
SetFormat( PLOT_FORMAT::GERBER );
1836 plotSettings.
SetFormat( PLOT_FORMAT::DXF );
1839 plotSettings.
SetFormat( PLOT_FORMAT::HPGL );
1842 plotSettings.
SetFormat( PLOT_FORMAT::PDF );
1845 plotSettings.
SetFormat( PLOT_FORMAT::POST );
1851 wxFAIL_MSG( wxT(
"ToPlotter(): unexpected plot type" ) );
break;
1864 if(
Kiface().IsSingle() )
1876 if( !frame->IsShownOnScreen() )
1878 wxFileName fn(
Prj().GetProjectPath(),
Prj().GetProjectName(),
1883 if( !fn.FileExists() )
1887 if( !fn.FileExists() )
1889 DisplayError(
this,
_(
"The schematic for this board cannot be found." ) );
1898 frame->Show(
true );
1909 const wxString& aAnnotateMessage )
1913 if( standalone == 0 )
1916 "stand-alone mode. In order to create or update PCBs from "
1917 "schematics, you must launch the KiCad project manager and "
1918 "create a project." ) );
1922 if( standalone < 0 )
1927 std::string payload( aAnnotateMessage );
1931 if( payload == aAnnotateMessage )
1949 wxString extra_info = e.
Problem() + wxT(
" : " ) + e.
What() + wxT(
" at " ) + e.
Where();
1952 "report this issue to the KiCad team using the menu "
1953 "Help->Report Bug."), extra_info );
1964 wxFileName schematic(
Prj().GetProjectPath(),
Prj().GetProjectName(),
1967 if( !schematic.FileExists() )
1969 wxFileName legacySchematic(
Prj().GetProjectPath(),
Prj().GetProjectName(),
1972 if( legacySchematic.FileExists() )
1974 schematic = legacySchematic;
1978 msg.Printf(
_(
"Schematic file '%s' not found." ), schematic.GetFullPath() );
1984 if(
Kiface().IsSingle() )
2018 if( !frame->IsShownOnScreen() )
2021 frame->
OpenProjectFiles( std::vector<wxString>( 1, schematic.GetFullPath() ) );
2022 frame->Show(
true );
2027 if( frame->IsIconized() )
2029 frame->Iconize(
false );
2033 frame->Maximize(
false );
2047 for(
const std::pair<const wxString, ENV_VAR_ITEM>& var : vars )
2048 UpdatePythonEnvVar( var.first, var.second.GetValue() );
2052 for(
const std::pair<const wxString, ENV_VAR_ITEM>& var : vars )
2053 wxSetEnv( var.first, var.second.GetValue() );
2071 if( aFootprint ==
nullptr )
2110 fp_editor->Show(
true );
2121 fp_editor->Show(
true );
2137 bool aSelectedMode )
2157 bool aResetText,
bool aResetTextLayers,
bool aResetTextEffects,
2165 if( aResetTextLayers )
2176 if( aResetTextEffects )
2201 std::vector<PCB_TEXT*> candidates;
2208 candidates.push_back( candidate );
2211 if( candidates.size() == 0 )
2214 if( candidates.size() == 1 )
2215 return candidates[0];
2218 std::vector<PCB_TEXT*> candidatesOnSameLayer;
2220 for(
PCB_TEXT* candidate : candidates )
2222 if( candidate->GetLayer() == aRefItem->
GetLayer() )
2223 candidatesOnSameLayer.push_back( candidate );
2226 if( candidatesOnSameLayer.size() == 1 )
2227 return candidatesOnSameLayer[0];
2230 std::vector<PCB_TEXT*> candidatesAtSamePos;
2232 for(
PCB_TEXT* candidate : candidatesOnSameLayer.size() ? candidatesOnSameLayer : candidates )
2235 candidatesAtSamePos.push_back( candidate );
2238 if( candidatesAtSamePos.size() > 0 )
2239 return candidatesAtSamePos[0];
2240 else if( candidatesOnSameLayer.size() > 0 )
2241 return candidatesOnSameLayer[0];
2243 return candidates[0];
2249 bool resetTextLayers,
bool resetTextEffects,
2250 bool resetTextContent,
bool resetFabricationAttrs,
2251 bool reset3DModels,
bool* aUpdated )
2254 bool dummyBool =
false;
2257 aUpdated = &dummyBool;
2282 for(
PAD* newPad : aNew->
Pads() )
2284 PAD* oldPad =
nullptr;
2288 if( newPad->GetNumber().IsEmpty() )
2295 PAD* last_pad =
nullptr;
2312 const_cast<KIID&
>( newPad->m_Uuid ) = oldPad->
m_Uuid;
2318 if( newPad->IsOnCopperLayer() )
2338 processTextItem( *oldTextItem, *newTextItem, resetTextContent, resetTextLayers,
2339 resetTextEffects, aUpdated );
2341 else if( !deleteExtraTexts )
2350 resetTextEffects, aUpdated );
2357 resetTextLayers, resetTextEffects, aUpdated );
2363 if( oldField->IsReference() || oldField->IsValue() )
2371 aNew->
Add( newField );
2376 processTextItem( *oldField, *newField, resetTextContent, resetTextLayers,
2377 resetTextEffects, aUpdated );
2382 if( resetFabricationAttrs )
2394 int existingFlagsToKeep = aExisting->
GetAttributes() & ~FP_ALLOW_SOLDERMASK_BRIDGES;
2395 aNew->
SetAttributes( existingFlagsToKeep | libraryFlagsToKeep );
2417 aCommit.
Remove( aExisting );
2418 aCommit.
Add( aNew );
2448 wxHyperlinkCtrl* button =
new wxHyperlinkCtrl( infobar, wxID_ANY,
_(
"Edit design rules" ),
2451 button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<
void( wxHyperlinkEvent& aEvent )>(
2452 [&]( wxHyperlinkEvent& aEvent )
2457 infobar->RemoveAllButtons();
2458 infobar->AddButton( button );
2459 infobar->AddCloseButton();
2460 infobar->ShowMessage(
_(
"Could not compile custom design rules." ), wxICON_ERROR,
2468 if( aEnvVarsChanged )
2496 if( zoneFillerTool->
IsBusy() )
2513 wxString wildcard = wxT(
"*.hyp" );
2516 fn.SetExt( wxT(
"hyp") );
2518 wxFileDialog dlg(
this,
_(
"Export Hyperlynx Layout" ), fn.GetPath(), fn.GetFullName(),
2519 wildcard, wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
2521 if( dlg.ShowModal() != wxID_OK )
2527 fn.SetExt( wxT(
"hyp" ) );
2541 return m_auimgr.GetPane( wxS(
"LayersManager" ) ).IsShown();
2559 if( IsShownOnScreen() )
2576 _(
"Violation Report" ) );
2586 _(
"Clearance Report" ) );
2596 _(
"Constraints Report" ) );
2606 _(
"Compare Footprint with Library" ) );
2637void PCB_EDIT_FRAME::onPluginAvailabilityChanged( wxCommandEvent& aEvt )
2639 wxLogTrace(
traceApi,
"PCB frame: EDA_EVT_PLUGIN_AVAILABILITY_CHANGED" );
Class PCBNEW_ACTION_PLUGINS.
const KICOMMON_API wxEventTypeTag< wxCommandEvent > EDA_EVT_PLUGIN_AVAILABILITY_CHANGED
Notifies other parts of KiCad when plugin availability changes.
constexpr EDA_IU_SCALE pcbIUScale
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
BOX2I BOX2ISafe(const BOX2D &aInput)
static TOOL_ACTION toggleGrid
static TOOL_ACTION millimetersUnits
static TOOL_ACTION unselectAll
static TOOL_ACTION togglePolarCoords
static TOOL_ACTION pluginsReload
static TOOL_ACTION pasteSpecial
static TOOL_ACTION milsUnits
static TOOL_ACTION toggleBoundingBoxes
static TOOL_ACTION showSearch
static TOOL_ACTION duplicate
static TOOL_ACTION inchesUnits
static TOOL_ACTION highContrastMode
static TOOL_ACTION embeddedFiles
static TOOL_ACTION toggleCursorStyle
static TOOL_ACTION measureTool
static TOOL_ACTION doDelete
static TOOL_ACTION selectionTool
static TOOL_ACTION zoomFitScreen
static TOOL_ACTION deleteTool
static TOOL_ACTION zoomTool
static TOOL_ACTION showProperties
static TOOL_ACTION gridSetOrigin
static TOOL_ACTION toggleGridOverrides
static TOOL_ACTION selectAll
Manage TOOL_ACTION objects.
void SetConditions(const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
Set the conditions the UI elements for activating a specific tool action should use for determining t...
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void ApplyLayerPreset(const wxString &aPresetName)
int GetTabIndex() const
Set the current notebook tab.
bool IsLayerOptionsExpanded()
void UpdateDisplayOptions()
Return a list of the layer presets created by the user.
void OnColorThemeChanged()
Respond to change in OS's DarkMode.
bool IsNetOptionsExpanded()
APP_SETTINGS_BASE is a settings class that should be derived for each standalone KiCad application.
Handles how to draw a screen (a board, a schematic ...)
bool IsContentModified() const
const wxString & GetPageNumber() const
bool test(size_t pos) const
virtual void Push(const wxString &aMessage=wxEmptyString, int aCommitFlags=0) override
Revert the commit by restoring the modified items state.
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
bool SetNetCode(int aNetCode, bool aNoAssert)
Set net using a net code.
bool GetLocalRatsnestVisible() const
Handle actions specific to the board editor in PcbNew.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
virtual void SetLocked(bool aLocked)
PCB_GROUP * GetParentGroup() const
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
VECTOR2I GetFPRelativePosition() const
void SetFPRelativePosition(const VECTOR2I &aPos)
virtual bool IsLocked() const
Information pertinent to a Pcbnew printed circuit board.
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
void RemoveAllListeners()
Remove all listeners.
const PAGE_INFO & GetPageSettings() const
GAL_SET GetVisibleElements() const
Return a set of all the element categories that are visible.
bool BuildConnectivity(PROGRESS_REPORTER *aReporter=nullptr)
Build or rebuild the board connectivity database for the board, especially the list of connected item...
void SynchronizeNetsAndNetClasses(bool aResetTrackAndViaSizes)
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
TITLE_BLOCK & GetTitleBlock()
const std::map< wxString, wxString > & GetProperties() const
void SetProject(PROJECT *aProject, bool aReferenceOnly=false)
Link a board to a given project.
const wxString & GetFileName() const
void SetElementVisibility(GAL_LAYER_ID aLayer, bool aNewState)
Change the visibility of an element category.
PROJECT * GetProject() const
void UpdateRatsnestExclusions()
Update the visibility flags on the current unconnected ratsnest lines.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
void SetColor(int aLayer, const COLOR4D &aColor)
COLOR4D GetColor(int aLayer) const
COMMIT & Remove(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been removed.
COMMIT & Add(EDA_ITEM *aItem, BASE_SCREEN *aScreen=nullptr)
Notify observers that aItem has been added.
Handle actions that are shared between different applications.
static std::mutex g_Mutex
void SetCallback(std::function< void(BOARD_ITEM *)> aCallback)
Function to be called on each found event.
bool Show(bool show=true) override
The Show method is overridden to make the search combobox focused by default.
void Preload(const wxString &aFindString)
void FindNext(bool reverse)
Finds the next item.
A dialog to set the plot options and create plot files in various formats.
void SetSheetPath(const std::string &aSheetPath)
Set the sheet path displayed in the title block.
void SetSheetCount(int aSheetCount)
Changes the sheet-count number displayed in the title block.
void SetPageNumber(const std::string &aPageNumber)
Changes the page number displayed in the title block.
void SetSheetName(const std::string &aSheetName)
Set the sheet name displayed in the title block.
void SetIsFirstPage(bool aIsFirstPage)
Change if this is first page.
void SetFileName(const std::string &aFileName)
Set the file name displayed in the title block.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
virtual void setupUIConditions()
Setup the UI conditions for the various actions and their controls in this frame.
virtual void ThemeChanged()
Process light/dark theme change.
virtual bool CanAcceptApiCommands()
Checks if this frame is ready to accept API commands.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
virtual void OnSize(wxSizeEvent &aEvent)
virtual bool canCloseWindow(wxCloseEvent &aCloseEvent)
virtual int GetUndoCommandCount() const
WX_INFOBAR * GetInfoBar()
virtual wxString GetFullScreenDesc() const
void OnSelectGrid(wxCommandEvent &event)
Command event handler for selecting grid sizes.
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
virtual void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
Changes the current rendering backend.
virtual void OnSize(wxSizeEvent &event) override
Recalculate the size of toolbars and display panel when the frame size changes.
virtual void OnSelectZoom(wxCommandEvent &event)
Set the zoom factor when selected by the zoom list box in the main tool bar.
GAL_DISPLAY_OPTIONS_IMPL & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
virtual wxString GetScreenDesc() const
static const wxString PropertiesPaneName()
virtual void Zoom_Automatique(bool aWarpPointer)
Redraw the screen with best zoom level and the best centering that shows all the page or the board.
NET_INSPECTOR_PANEL * m_netInspectorPanel
static const wxString NetInspectorPanelName()
SEARCH_PANE * m_searchPane
PROPERTIES_PANEL * m_propertiesPanel
static constexpr GAL_TYPE GAL_FALLBACK
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.
void ForceRefresh()
Force a redraw.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
A base class for most all the KiCad significant classes used in schematics and boards.
KICAD_T Type() const
Returns the type of object.
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
virtual void SetParent(EDA_ITEM *aParent)
Specialization of the wxAuiPaneInfo class for KiCad panels.
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
const EDA_ANGLE & GetTextAngle() const
virtual const wxString & GetText() const
Return the string associated with the text object.
virtual bool IsVisible() const
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
GR_TEXT_H_ALIGN_T GetHorizJustify() const
virtual void SetVisible(bool aVisible)
GR_TEXT_V_ALIGN_T GetVertJustify() const
virtual void SetText(const wxString &aText)
int GetTextThickness() const
VECTOR2I GetTextSize() const
SELECTION_CONDITION NoActiveTool()
Create a functor testing if there are no tools active in the frame.
SELECTION_CONDITION BoundingBoxes()
SELECTION_CONDITION RedoAvailable()
Create a functor that tests if there are any items in the redo queue.
SELECTION_CONDITION ScriptingConsoleVisible()
Create a functor testing if the python scripting console window is visible.
SELECTION_CONDITION Units(EDA_UNITS aUnit)
Create a functor that tests if the frame has the specified units.
SELECTION_CONDITION GridVisible()
Create a functor testing if the grid is visible in a frame.
SELECTION_CONDITION PolarCoordinates()
Create a functor testing if polar coordinates are current being used.
SELECTION_CONDITION GridOverrides()
Create a functor testing if the grid overrides wires is enabled in a frame.
SELECTION_CONDITION FullscreenCursor()
Create a functor testing if the cursor is full screen in a frame.
ENUM_MAP & Map(T aValue, const wxString &aName)
static ENUM_MAP< T > & Instance()
ENUM_MAP & Undefined(T aValue)
void ReadWindowSettings(WINDOW_SETTINGS &aCfg)
Read GAL config options from application-level config.
bool Contains(GAL_LAYER_ID aPos)
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
virtual const wxString What() const
A composite of Problem() and Where()
virtual const wxString Problem() const
what was the problem?
virtual const wxString Where() const
where did the Problem() occur?
Read the new s-expression based KiCad netlist format.
virtual void LoadNetlist() override
Load the contents of the netlist file into aNetlist.
APP_SETTINGS_BASE * KifaceSettings() const
A color representation with 4 components: red, green, blue, alpha.
void SetGridColor(const COLOR4D &aGridColor)
Set the grid color.
virtual RENDER_SETTINGS * GetSettings()=0
Return a pointer to current settings that are going to be used when drawing items.
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
const std::set< int > & GetHighlightNetCodes() const
Return the netcode of currently highlighted net.
An abstract base class for deriving all objects that can be added to a VIEW.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
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 SetLayerVisible(int aLayer, bool aVisible=true)
Control the visibility of a particular layer.
bool IsMirroredX() const
Return true if view is flipped across the X axis.
void UpdateAllItems(int aUpdateFlags)
Update all items in the view according to the given flags.
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
void MarkTargetDirty(int aTarget)
Set or clear target 'dirty' flag.
void UpdateAllItemsConditionally(int aUpdateFlags, std::function< bool(VIEW_ITEM *)> aCondition)
Update items in the view according to the given flags and condition.
An implementation of class VIEW_CONTROLS for wxWidgets library.
std::unique_ptr< PROF_COUNTER > m_MotionEventCounter
A wxFrame capable of the OpenProjectFiles function, meaning it can load a portion of a KiCad project.
virtual bool OpenProjectFiles(const std::vector< wxString > &aFileList, int aCtl=0)
Open a project or set of files given by aFileList.
void OnSockRequestServer(wxSocketEvent &evt)
void OnSockRequest(wxSocketEvent &evt)
A minimalistic software bus for communications between various DLLs/DSOs (DSOs) within the same KiCad...
virtual void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged)
Call CommonSettingsChanged() on all KIWAY_PLAYERs.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
int SetLayerSelection(int layer)
const UTF8 & GetLibItemName() const
LSET is a set of PCB_LAYER_IDs.
static LSET AllLayersMask()
LSEQ Seq(const PCB_LAYER_ID *aWishListSequence, unsigned aCount) const
Return an LSEQ from the union of this LSET and a desired sequence.
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
static const int UNCONNECTED
Constant that holds the "unconnected net" number (typically 0) all items "connected" to this net are ...
Store information read from a netlist along with the flags used to update the NETLIST in the BOARD.
virtual void OnBoardChanged()
Notification from file loader when board changed and connectivity rebuilt.
virtual void OnParentSetupChanged()
Rebuild inspector data if project settings updated.
const wxString & GetPinType() const
const wxString & GetPinFunction() const
bool IsOnCopperLayer() const override
void SetInitialPage(const wxString &aPage, const wxString &aParentPage=wxEmptyString)
Describe the page size and margins of a paper page on which to eventually print or plot.
DISPLAY_OPTIONS m_Display
EDA_ANGLE m_RotationAngle
ARC_EDIT_MODE m_ArcEditMode
Gather all the actions that are shared by tools.
static TOOL_ACTION toggleHV45Mode
static TOOL_ACTION drawRuleArea
static TOOL_ACTION microwaveCreateGap
static TOOL_ACTION placeText
static TOOL_ACTION pointEditorArcKeepCenter
static TOOL_ACTION drawOrthogonalDimension
static TOOL_ACTION drawRectangle
static TOOL_ACTION padDisplayMode
static TOOL_ACTION placeReferenceImage
static TOOL_ACTION showRatsnest
static TOOL_ACTION showLayersManager
static TOOL_ACTION toggleNetHighlight
static TOOL_ACTION drawCircle
static TOOL_ACTION routeDiffPair
Activation of the Push and Shove router (differential pair mode)
static TOOL_ACTION tuneDiffPair
static TOOL_ACTION layerChanged
static TOOL_ACTION ddAppendBoard
Drag and drop.
static TOOL_ACTION highlightNet
static TOOL_ACTION drawTable
static TOOL_ACTION drawTextBox
static TOOL_ACTION routerHighlightMode
Actions to enable switching modes via hotkey assignments.
static TOOL_ACTION routerWalkaroundMode
static TOOL_ACTION routerShoveMode
static TOOL_ACTION drawZoneCutout
static TOOL_ACTION drawPolygon
static TOOL_ACTION hideNetInRatsnest
static TOOL_ACTION zoneDisplayFilled
static TOOL_ACTION showNetInRatsnest
static TOOL_ACTION drawRadialDimension
static TOOL_ACTION tuneSingleTrack
static TOOL_ACTION viaDisplayMode
static TOOL_ACTION drawLeader
static TOOL_ACTION drillOrigin
static TOOL_ACTION tuneSkew
static TOOL_ACTION trackDisplayMode
static TOOL_ACTION showNetInspector
static TOOL_ACTION microwaveCreateStubArc
static TOOL_ACTION zoneDisplayTriangulated
static TOOL_ACTION ungroup
static TOOL_ACTION selectUnconnected
Select unconnected footprints from ratsnest of selection.
static TOOL_ACTION zoneDisplayFractured
static TOOL_ACTION drawVia
static TOOL_ACTION drawArc
static TOOL_ACTION zoneDuplicate
Duplicate zone onto another layer.
static TOOL_ACTION graphicsOutlines
Display footprint graphics as outlines.
static TOOL_ACTION drawSimilarZone
static TOOL_ACTION pointEditorArcKeepEndpoint
static TOOL_ACTION drawCenterDimension
static TOOL_ACTION selectSameSheet
Select all components on the same sheet as the selected footprint.
static TOOL_ACTION microwaveCreateStub
static TOOL_ACTION selectNet
Select all connections belonging to a single net.
static TOOL_ACTION microwaveCreateLine
static TOOL_ACTION flipBoard
static TOOL_ACTION zoneDisplayOutline
static TOOL_ACTION ratsnestLineMode
static TOOL_ACTION textOutlines
Display texts as lines.
static TOOL_ACTION highlightNetSelection
static TOOL_ACTION microwaveCreateFunctionShape
static TOOL_ACTION zoneMerge
static TOOL_ACTION unlock
static TOOL_ACTION placeFootprint
static TOOL_ACTION routeSingleTrack
Activation of the Push and Shove router.
static TOOL_ACTION deselectNet
Remove all connections belonging to a single net from the active selection.
static TOOL_ACTION showPythonConsole
static TOOL_ACTION drawLine
static TOOL_ACTION localRatsnestTool
static TOOL_ACTION drawAlignedDimension
static TOOL_ACTION drawZone
static TOOL_ACTION selectOnSchematic
Select symbols/pins on schematic corresponding to selected footprints/pads.
Common, abstract interface for edit frames.
COLOR_SETTINGS * GetColorSettings(bool aForceRefresh=false) const override
Helper to retrieve the current color settings.
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
void doCloseWindow() override
void unitsChangeRefresh() override
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
APPEARANCE_CONTROLS * GetAppearancePanel()
APPEARANCE_CONTROLS * m_appearancePanel
PANEL_SELECTION_FILTER * m_selectionFilterPanel
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
virtual const PCB_PLOT_PARAMS & GetPlotSettings() const
Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
PCBNEW_SETTINGS * GetPcbNewSettings() const
virtual PCB_LAYER_ID GetActiveLayer() const
void OnModify() override
Must be called after a change in order to set the "modify" flag and update other data structures and ...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void SetPageSettings(const PAGE_INFO &aPageSettings) override
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
virtual void SetPlotSettings(const PCB_PLOT_PARAMS &aSettings)
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Places aFootprint at the current cursor position and updates footprint coordinates with the new posit...
virtual void SetActiveLayer(PCB_LAYER_ID aLayer)
virtual void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
Update the 3D view, if the viewer is opened by this frame.
Handle actions that are shared between different frames in PcbNew.
double m_ZoneOpacity
Opacity override for filled zone areas.
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
void UpdateColors()
Update the color settings in the painter and GAL.
void SetDrawingSheet(DS_PROXY_VIEW_ITEM *aDrawingSheet)
Sets (or updates) drawing-sheet used by the draw panel.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
void SyncLayersVisibility(const BOARD *aBoard)
Update "visibility" property of each layer of a given BOARD.
virtual void SetHighContrastLayer(int aLayer) override
SetHighContrastLayer(), with some extra smarts for PCB.
Group generic conditions for PCB editor states.
SELECTION_CONDITION PadFillDisplay()
Create a functor that tests if the frame fills the pads.
SELECTION_CONDITION TrackFillDisplay()
Create a functor that tests if the frame fills tracks.
SELECTION_CONDITION HasItems()
Create a functor that tests if there are items in the board.
SELECTION_CONDITION GraphicsFillDisplay()
Create a functor that tests if the frame fills graphics items.
SELECTION_CONDITION ZoneDisplayMode(ZONE_DISPLAY_MODE aMode)
Create a functor that tests the current zone display mode in the frame.
SELECTION_CONDITION ViaFillDisplay()
Create a functor that tests if the frame fills vias.
SELECTION_CONDITION Get45degMode()
Create a functor that tests whether only 45 degree lines should be allowed.
SELECTION_CONDITION TextFillDisplay()
Create a functor that tests if the frame fills text items.
The main frame for Pcbnew.
void HardRedraw() override
Rebuild the GAL and redraws the screen.
void OnDisplayOptionsChanged() override
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString)
void SetLastPath(LAST_PATH_TYPE aType, const wxString &aLastPath)
Set the path of the last file successfully read.
void FindNext(bool reverse=false)
Find the next item using our existing search parameters.
void ResolveDRCExclusions(bool aCreateMarkers)
If aCreateMarkers then create DRC exclusion markers from the serialized data.
void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr) override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void SetActiveLayer(PCB_LAYER_ID aLayer) override
Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS.
void OnModify() override
Must be called after a board change to set the modified flag.
void ThemeChanged() override
Called when light/dark theme is changed.
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
void ReCreateHToolbar() override
void SetElementVisibility(GAL_LAYER_ID aElement, bool aNewState)
Change the visibility of an element category.
DIALOG_BOOK_REPORTER * m_inspectDrcErrorDlg
void OnClearFileHistory(wxCommandEvent &aEvent)
virtual ~PCB_EDIT_FRAME()
void SwitchCanvas(EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
Switch currently used canvas (Cairo / OpenGL).
BOARD_ITEM_CONTAINER * GetModel() const override
DIALOG_BOOK_REPORTER * GetInspectDrcErrorDialog()
void OnExportSTEP(wxCommandEvent &event)
Export the current BOARD to a STEP assembly.
void ExchangeFootprint(FOOTPRINT *aExisting, FOOTPRINT *aNew, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetFabricationAttrs=true, bool resetTextContent=true, bool reset3DModels=true, bool *aUpdated=nullptr)
Replace aExisting footprint by aNew footprint using the Existing footprint settings (position,...
DIALOG_FIND * m_findDialog
DIALOG_BOOK_REPORTER * m_inspectConstraintsDlg
void SetPageSettings(const PAGE_INFO &aPageSettings) override
bool IsElementVisible(GAL_LAYER_ID aElement) const
Test whether a given element category is visible.
bool CanAcceptApiCommands() override
Checks if this frame is ready to accept API commands.
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
void onBoardLoaded()
Update the state of the GUI after a new board is loaded or created.
void SetGridColor(const COLOR4D &aColor) override
void ProjectChanged() override
Notification event that the project has changed.
wxString GetLastPath(LAST_PATH_TYPE aType)
Get the last path for a particular type.
void OnExportIDF3(wxCommandEvent &event)
Export the current BOARD to a IDFv3 board and lib files.
void ShowChangedLanguage() override
Redraw the menus and what not in current language.
void doCloseWindow() override
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Recreate the layer box by clearing the old list and building a new one from the new layer names and c...
void SaveProjectLocalSettings() override
Save changes to the project local settings.
void PythonSyncProjectName()
Synchronize the project name from KiCad's environment into the Python interpreter.
bool m_show_layer_manager_tools
void OnExportVRML(wxCommandEvent &event)
Export the current BOARD to a VRML file.
void ShowFindDialog()
Show the Find dialog.
void onSize(wxSizeEvent &aEvent)
int ShowExchangeFootprintsDialog(FOOTPRINT *aFootprint, bool aUpdateMode, bool aSelectedMode)
int TestStandalone()
Test if standalone mode.
void ShowFootprintPropertiesDialog(FOOTPRINT *aFootprint)
void OnExportHyperlynx(wxCommandEvent &event)
Export the current BOARD to a Hyperlynx HYP file.
bool IsContentModified() const override
Get if the current board has been modified but not saved.
void PythonSyncEnvironmentVariables()
Synchronize the environment variables from KiCad's environment into the Python interpreter.
bool Clear_Pcb(bool doAskAboutUnsavedChanges, bool aFinal=false)
Delete all and reinitialize the current board.
TOOL_ACTION * m_exportNetlistAction
The export board netlist tool action object.
void ReCreateAuxiliaryToolbar() override
bool m_show_net_inspector
bool FetchNetlistFromSchematic(NETLIST &aNetlist, const wxString &aAnnotateMessage)
wxString GetCurrentFileName() const override
Get the full filename + path of the currently opened file in the frame.
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
void ExportSVG(wxCommandEvent &event)
Show the Export to SVG file dialog.
void RecreateCmpFileFromBoard(wxCommandEvent &aEvent)
Recreates a .cmp file from the current loaded board.
DIALOG_BOOK_REPORTER * GetFootprintDiffDialog()
EDA_ANGLE GetRotationAngle() const override
Return the angle used for rotate operations.
COLOR4D GetGridColor() override
void Files_io(wxCommandEvent &event)
Call Files_io_from_id with the wxCommandEvent id.
void UpdateTitle()
Set the main window title bar text.
DIALOG_BOOK_REPORTER * m_footprintDiffDlg
PCB_LAYER_BOX_SELECTOR * m_SelLayerBox
void ExportToGenCAD(wxCommandEvent &event)
Create a file in GenCAD 1.4 format from the current board.
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Called after the preferences dialog is run.
void Process_Special_Functions(wxCommandEvent &event)
SELECTION & GetCurrentSelection() override
Get the current selection from the canvas area.
void OnQuit(wxCommandEvent &event)
void onCloseModelessBookReporterDialogs(wxCommandEvent &aEvent)
bool canCloseWindow(wxCloseEvent &aCloseEvent) override
DIALOG_BOOK_REPORTER * GetInspectClearanceDialog()
wxTimer * m_eventCounterTimer
void Tracks_and_Vias_Size_Event(wxCommandEvent &event)
void SaveSettings(APP_SETTINGS_BASE *aCfg) override
Save common frame parameters to a configuration data file.
static const wxString SearchPaneName()
DIALOG_BOOK_REPORTER * m_inspectClearanceDlg
void OnFileHistory(wxCommandEvent &event)
void ToPlotter(int aID)
Open a dialog frame to create plot and drill files relative to the current board.
DIALOG_BOOK_REPORTER * GetInspectConstraintsDialog()
A set of BOARD_ITEMs (i.e., without duplicates).
virtual bool RemoveItem(BOARD_ITEM *aItem)
Remove item from group.
virtual bool AddItem(BOARD_ITEM *aItem)
Add item to group.
Net inspection panel for pcbnew.
Parameters and options when plotting/printing a board.
void SetFormat(PLOT_FORMAT aFormat)
Tool that displays edit points allowing to modify items by dragging the points.
static bool HasUnlockedItems(const SELECTION &aSelection)
Test if any selected items are unlocked.
static bool HasLockedItems(const SELECTION &aSelection)
Test if any selected items are locked.
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
virtual ENV_VAR_MAP & GetLocalEnvVariables() const
virtual const wxString & GetExecutablePath() const
A progress reporter interface for use in multi-threaded environments.
The backing store for a PROJECT, in JSON format.
The project local settings are things that are attached to a particular project, but also might be pa...
wxString m_ActiveLayerPreset
The name of a LAYER_PRESET that is currently activated (or blank if none)
PCB_LAYER_ID m_ActiveLayer
The current (active) board layer for editing.
virtual PROJECT_LOCAL_SETTINGS & GetLocalSettings() const
void IncrementNetclassesTicker()
virtual PROJECT_FILE & GetProjectFile() const
void IncrementTextVarsTicker()
float SplitterProportion() const
static SELECTION_CONDITION HasTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if among the selected items there is at least one of a given types.
static bool NotEmpty(const SELECTION &aSelection)
Test if there are any items selected.
static SELECTION_CONDITION MoreThan(int aNumber)
Create a functor that tests if the number of selected items is greater than the value given as parame...
static bool Idle(const SELECTION &aSelection)
Test if there no items selected or being edited.
static SELECTION_CONDITION Count(int aNumber)
Create a functor that tests if the number of selected items is equal to the value given as parameter.
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
static SELECTION_CONDITION OnlyTypes(std::vector< KICAD_T > aTypes)
Create a functor that tests if the selected items are only of given types.
int Size() const
Returns the number of selected parts.
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
A modified version of the wxInfoBar class that allows us to:
void RemoveAllButtons()
Remove all the buttons that have been added by the user.
@ OUTDATED_SAVE
OUTDATED_SAVE Messages that should be cleared on save.
void AddCloseButton(const wxString &aTooltip=_("Hide this message."))
Add the default close button to the infobar on the right side.
void ShowMessage(const wxString &aMessage, int aFlags=wxICON_INFORMATION) override
Show the info bar with the provided message and icon.
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
This file is part of the common library.
#define DIALOG_DRC_WINDOW_NAME
bool InvokeExportSVG(PCB_EDIT_FRAME *aCaller, BOARD *aBoard)
Function InvokeExportSVG shows the Export SVG dialog.
Declaration of the eda_3d_viewer class.
static constexpr EDA_ANGLE ANGLE_90
#define KICAD_DEFAULT_DRAWFRAME_STYLE
#define PCB_EDIT_FRAME_NAME
GERBVIEW_FRAME::OnZipFileHistory GERBVIEW_FRAME::OnSelectHighlightChoice EVT_UPDATE_UI(ID_TOOLBARH_GERBVIEW_SELECT_ACTIVE_LAYER, GERBVIEW_FRAME::OnUpdateLayerSelectBox) void GERBVIEW_FRAME
const wxString EESCHEMA_EXE
bool ExportBoardToHyperlynx(BOARD *aBoard, const wxFileName &aPath)
@ FRAME_FOOTPRINT_CHOOSER
int ExecuteFile(const wxString &aEditorName, const wxString &aFileName, wxProcess *aCallback, bool aFileForKicad)
Call the executable file aEditorName with the parameter aFileName.
bool m_ShowEventCounters
Shows debugging event counters in various places.
static const std::string LegacySchematicFileExtension
static const std::string LegacyPcbFileExtension
static const std::string KiCadSchematicFileExtension
static const std::string AutoSaveFilePrefix
static const std::string KiCadPcbFileExtension
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
const wxChar *const traceApi
Flag to enable debug output related to the API plugin system.
@ ID_EDA_SOCKET_EVENT_SERV
std::map< wxString, ENV_VAR_ITEM > ENV_VAR_MAP
int GetNetnameLayer(int aLayer)
Returns a netname layer corresponding to the given layer.
GAL_LAYER_ID
GAL layers are "virtual" layers, i.e.
@ LAYER_ZONES
Control for copper zone opacity/visibility (color ignored)
PCB_LAYER_ID
A quick note on layer IDs:
@ REPAINT
Item needs to be redrawn.
@ GEOMETRY
Position or shape has changed.
@ ALL
All except INITIAL_ADD.
@ TARGET_NONCACHED
Auxiliary rendering target (noncached)
@ RM_MarkObstacles
Ignore collisions, mark obstacles.
@ RM_Walkaround
Only walk around.
static void processTextItem(const PCB_TEXT &aSrc, PCB_TEXT &aDest, bool aResetText, bool aResetTextLayers, bool aResetTextEffects, bool *aUpdated)
copy text settings from aSrc to aDest
#define FOOTPRINT_DIFF_DIALOG_NAME
static PCB_TEXT * getMatchingTextItem(PCB_TEXT *aRefItem, FOOTPRINT *aFootprint)
EVT_MENU_RANGE(ID_POPUP_PCB_SELECT_WIDTH_START_RANGE, ID_POPUP_PCB_SELECT_WIDTH_END_RANGE, PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event) EVT_UPDATE_UI_RANGE(ID_POPUP_PCB_SELECT_WIDTH1
ID_POPUP_PCB_SELECT_WIDTH8
bool ExportBoardToHyperlynx(BOARD *aBoard, const wxFileName &aPath)
#define INSPECT_CLEARANCE_DIALOG_NAME
PCB_EDIT_FRAME::OnUpdateSelectTrackWidth EVT_UPDATE_UI_RANGE(ID_POPUP_PCB_SELECT_VIASIZE1, ID_POPUP_PCB_SELECT_VIASIZE8, PCB_EDIT_FRAME::OnUpdateSelectViaSize) PCB_EDIT_FRAME
#define INSPECT_DRC_ERROR_DIALOG_NAME
#define INSPECT_CONSTRAINTS_DIALOG_NAME
@ ID_POPUP_PCB_SELECT_WIDTH_START_RANGE
@ ID_POPUP_PCB_SELECT_WIDTH1
@ ID_POPUP_PCB_SELECT_VIASIZE8
@ ID_GEN_EXPORT_FILE_HYPERLYNX
@ ID_IMPORT_NON_KICAD_BOARD
@ ID_MENU_RECOVER_BOARD_AUTOSAVE
@ ID_AUX_TOOLBAR_PCB_VIA_SIZE
@ ID_AUX_TOOLBAR_PCB_SELECT_AUTO_WIDTH
@ ID_MENU_EXPORT_FOOTPRINTS_TO_NEW_LIBRARY
@ ID_POPUP_PCB_SELECT_WIDTH_END_RANGE
@ ID_MENU_EXPORT_FOOTPRINTS_TO_LIBRARY
@ ID_GEN_EXPORT_FILE_VRML
@ ID_POPUP_PCB_SELECT_VIASIZE1
@ ID_GEN_EXPORT_FILE_STEP
@ ID_TOOLBARH_PCB_SELECT_LAYER
@ ID_GEN_EXPORT_FILE_IDF3
@ ID_AUX_TOOLBAR_PCB_TRACK_WIDTH
@ ID_GEN_EXPORT_FILE_GENCADFORMAT
void ScriptingOnDestructPcbEditFrame(PCB_EDIT_FRAME *aPcbEditFrame)
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
PGM_BASE & Pgm()
The global Program "get" accessor.
#define PROJECT_VAR_NAME
A variable name whose value holds the current project directory.
LAST_PATH_TYPE
For storing PcbNew MRU paths of various types.
#define CURRENT_TOOL(action)
std::function< bool(const SELECTION &)> SELECTION_CONDITION
Functor type that checks a specific condition for selected items.
KIWAY Kiway(KFCTL_STANDALONE)
wxString UnescapeString(const wxString &aSource)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
A min-max version of BOX2 for fast intersection checking.
bool Intersects(const BOX2I_MINMAX &aOther) const
constexpr int mmToIU(double mm) const
A filename or source description, a problem input line, a line number, a byte offset,...
float properties_splitter
int properties_panel_width
bool appearance_expand_layer_display
bool appearance_expand_net_display
int search_panel_dock_direction
TRACK_CLEARANCE_MODE m_TrackClearance
bool m_DisplayRatsnestLinesCurved
bool m_ShowGlobalRatsnest
wxLogTrace helper definitions.
@ PCB_GENERATOR_T
class PCB_GENERATOR, generator on a layer
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
@ PCB_ZONE_T
class ZONE, a copper pour area
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
@ PCB_FIELD_T
class PCB_FIELD, text associated with a footprint property
@ PCB_FOOTPRINT_T
class FOOTPRINT, a footprint
@ PCB_PAD_T
class PAD, a pad in a footprint
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition of file extensions used in Kicad.
void SetAuiPaneSize(wxAuiManager &aManager, wxAuiPaneInfo &aPane, int aWidth, int aHeight)
Sets the size of an AUI pane, working around http://trac.wxwidgets.org/ticket/13180.
WX_VIEW_CONTROLS class definition.