KiCad PCB EDA Suite
pcbnew_scripting_helpers.cpp File Reference

Scripting helper functions for pcbnew functionality. More...

#include <Python.h>
#include <pcbnew_scripting_helpers.h>
#include <pcbnew.h>
#include <pcbnew_id.h>
#include <build_version.h>
#include <class_board.h>
#include <class_drawpanel.h>
#include <kicad_string.h>
#include <io_mgr.h>
#include <macros.h>
#include <stdlib.h>
#include <pcb_draw_panel_gal.h>
#include <action_plugin.h>

Go to the source code of this file.

Functions

BOARDGetBoard ()
 
void ScriptingSetPcbEditFrame (PCB_EDIT_FRAME *aPcbEditFrame)
 
BOARDLoadBoard (wxString &aFileName)
 
BOARDLoadBoard (wxString &aFileName, IO_MGR::PCB_FILE_T aFormat)
 
bool SaveBoard (wxString &aFileName, BOARD *aBoard, IO_MGR::PCB_FILE_T aFormat)
 
bool SaveBoard (wxString &aFileName, BOARD *aBoard)
 
void Refresh ()
 Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
 
void WindowZoom (int xl, int yl, int width, int height)
 
void UpdateUserInterface ()
 Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...) (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins. More...
 
bool IsActionRunning ()
 Are we currently in an action plugin? More...
 

Variables

static PCB_EDIT_FRAMEs_PcbEditFrame = NULL
 

Detailed Description

Scripting helper functions for pcbnew functionality.

Definition in file pcbnew_scripting_helpers.cpp.

Function Documentation

BOARD* GetBoard ( )

Definition at line 48 of file pcbnew_scripting_helpers.cpp.

References PCB_BASE_FRAME::GetBoard().

Referenced by PCB_EDIT_FRAME::Clean_Pcb(), PCB_EDIT_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CreateTarget(), PYTHON_ACTION_PLUGINS::deregister_action(), DISPLAY_FOOTPRINTS_FRAME::DISPLAY_FOOTPRINTS_FRAME(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), PCB_EDIT_FRAME::DoShowBoardSetupDialog(), D_PAD::Draw(), EVT_GRID_CMD_CELL_CHANGED(), EVT_UPDATE_UI(), PCB_EDIT_FRAME::Exchange_Module(), PCB_EDIT_FRAME::ExportSpecctraFile(), PCB_EDIT_FRAME::ExportSVG(), PCB_EDIT_FRAME::ExportToSpecctra(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::GenD356File(), PCB_EDIT_FRAME::GenFootprintsReport(), PCB_EDIT_FRAME::GetLastNetListRead(), PCB_DRAW_PANEL_GAL::GetMsgPanelInfo(), PCB_EDIT_FRAME::ImportSpecctraSession(), PCB_EDIT_FRAME::IsElementVisible(), PCB_EDIT_FRAME::IsMicroViaAcceptable(), PCB_EDIT_FRAME::ListAndSelectModuleName(), FOOTPRINT_EDIT_FRAME::Load_Module_From_BOARD(), FOOTPRINT_EDIT_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), FOOTPRINT_EDIT_FRAME::moveExact(), PCB_EDIT_FRAME::onBoardLoaded(), PCB_EDIT_FRAME::OnCloseWindow(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), FOOTPRINT_EDIT_FRAME::OnVerticalToolbar(), FOOTPRINT_EDIT_FRAME::OpenProjectFiles(), FOOTPRINT_EDIT_FRAME::Process_Special_Functions(), PCB_BASE_EDIT_FRAME::PutDataInPreviousState(), PCB_EDIT_FRAME::ReadPcbNetlist(), PCB_EDIT_FRAME::RecreateBOMFileFromBoard(), PCB_EDIT_FRAME::RemoveMisConnectedTracks(), PCB_BASE_EDIT_FRAME::SaveCopyInUndoList(), PCB_BASE_FRAME::SelectCopperLayerPair(), PCB_BASE_FRAME::SelectLayer(), PCB_EDIT_FRAME::SetElementVisibility(), PCB_EDIT_FRAME::SetLastNetListRead(), PCB_EDIT_FRAME::SetVisibleAlls(), PCB_EDIT_FRAME::SpreadFootprints(), PCB_EDIT_FRAME::Swap_Layers(), PCB_EDIT_FRAME::UpdateTitle(), and PCB_EDIT_FRAME::UpdateUserInterface().

49 {
50  if( s_PcbEditFrame )
51  return s_PcbEditFrame->GetBoard();
52  else
53  return NULL;
54 }
BOARD * GetBoard() const
static PCB_EDIT_FRAME * s_PcbEditFrame
bool IsActionRunning ( )

Are we currently in an action plugin?

Definition at line 144 of file pcbnew_scripting_helpers.cpp.

References ACTION_PLUGINS::IsActionRunning().

145 {
147 }
static bool IsActionRunning()
Function IsActionRunning.
BOARD* LoadBoard ( wxString &  aFileName)

Definition at line 63 of file pcbnew_scripting_helpers.cpp.

References IO_MGR::KICAD_SEXP, IO_MGR::LEGACY, and LoadBoard().

Referenced by LoadBoard().

64 {
65  if( aFileName.EndsWith( wxT( ".kicad_pcb" ) ) )
66  return LoadBoard( aFileName, IO_MGR::KICAD_SEXP );
67 
68  else if( aFileName.EndsWith( wxT( ".brd" ) ) )
69  return LoadBoard( aFileName, IO_MGR::LEGACY );
70 
71  // as fall back for any other kind use the legacy format
72  return LoadBoard( aFileName, IO_MGR::LEGACY );
73 }
BOARD * LoadBoard(wxString &aFileName)
Legacy Pcbnew file formats prior to s-expression.
Definition: io_mgr.h:54
S-expression Pcbnew file format.
Definition: io_mgr.h:55
BOARD* LoadBoard ( wxString &  aFileName,
IO_MGR::PCB_FILE_T  aFormat 
)

Definition at line 76 of file pcbnew_scripting_helpers.cpp.

References BOARD::BuildConnectivity(), and IO_MGR::Load().

77 {
78  BOARD* brd = IO_MGR::Load( aFormat, aFileName );
79 
80  if( brd )
81  brd->BuildConnectivity();
82 
83  return brd;
84 }
static BOARD * Load(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aAppendToMe=NULL, const PROPERTIES *aProperties=NULL)
Function Load finds the requested PLUGIN and if found, calls the PLUGIN->Load(..) funtion on it using...
Definition: io_mgr.cpp:171
void BuildConnectivity()
Builds or rebuilds the board connectivity database for the board, especially the list of connected it...
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:170
void Refresh ( )

Update the board display after modifying it by a python script (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins.

Could be deprecated because modifying a board (especially deleting items) outside a action plugin can crash Pcbnew.

Definition at line 105 of file pcbnew_scripting_helpers.cpp.

References BOARD::BuildConnectivity(), PCB_BASE_FRAME::GetBoard(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetGalCanvas(), EDA_DRAW_FRAME::IsGalCanvasActive(), EDA_DRAW_PANEL::Refresh(), and PCB_EDIT_FRAME::UseGalCanvas().

Referenced by EDA_MSG_PANEL::AppendMessage(), C3D_MODEL_VIEWER::Clear3DModel(), DRCLISTBOX::DeleteAllItems(), DRCLISTBOX::DeleteItem(), PYTHON_ACTION_PLUGINS::deregister_action(), LIB_EDIT_FRAME::emptyScreen(), EDA_MSG_PANEL::EraseMsgBox(), EDA_DRAW_PANEL::GetGrid(), SCH_DRAW_PANEL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), PCB_EDIT_FRAME::ImportSpecctraSession(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), PCB_EDIT_FRAME::onBoardLoaded(), PCB_EDIT_FRAME::OnFlipPcbView(), C3D_MODEL_VIEWER::OnMouseMove(), C3D_MODEL_VIEWER::OnMouseWheel(), FOOTPRINT_PREVIEW_WIDGET::OnStatusChange(), POSITION_RELATIVE_TOOL::RelativeItemSelectionMove(), DIALOG_EDIT_LINE_STYLE::resetDefaults(), ZONE_FILLER_TOOL::SegzoneDeleteFill(), TEMPLATE_WIDGET::Select(), C3D_MODEL_VIEWER::Set3DModel(), WIDGET_EESCHEMA_COLOR_CONFIG::SetColor(), DRCLISTBOX::SetList(), EDA_MSG_PANEL::SetMessage(), FOOTPRINTS_LISTBOX::SetSelection(), LIBRARY_LISTBOX::SetSelection(), SCH_DRAW_PANEL::SwitchBackend(), EDA_3D_VIEWER::takeScreenshot(), TEMPLATE_WIDGET::Unselect(), mpWindow::UpdateAll(), DIALOG_EDIT_LINE_STYLE::updateColorButton(), KIGFX::OPENGL_GAL::updatedGalDisplayOptions(), KIGFX::CAIRO_GAL::updatedGalDisplayOptions(), DIALOG_PAGES_SETTINGS::UpdatePageLayoutExample(), PCB_EDIT_FRAME::UseGalCanvas(), ZONE_FILLER_TOOL::ZoneFill(), ZONE_FILLER_TOOL::ZoneFillAll(), ZONE_FILLER_TOOL::ZoneUnfill(), and ZONE_FILLER_TOOL::ZoneUnfillAll().

106 {
107  if( s_PcbEditFrame )
108  {
109  auto board = s_PcbEditFrame->GetBoard();
110  board->BuildConnectivity();
111 
113  {
114  auto gal_canvas = static_cast<PCB_DRAW_PANEL_GAL*>( s_PcbEditFrame->GetGalCanvas() );
115 
116  // Reinit everything: this is the easy way to do that
117  s_PcbEditFrame->UseGalCanvas( true );
118  gal_canvas->Refresh();
119  }
120  else
121  // first argument is erase background, second is a wxRect that
122  // defines a reftresh area (all canvas if null)
123  s_PcbEditFrame->GetCanvas()->Refresh( true, NULL );
124  }
125 }
virtual EDA_DRAW_PANEL * GetCanvas() const
Definition: draw_frame.h:388
void UseGalCanvas(bool aEnable) override
>
BOARD * GetBoard() const
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:914
void BuildConnectivity()
Builds or rebuilds the board connectivity database for the board, especially the list of connected it...
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:921
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL)
static PCB_EDIT_FRAME * s_PcbEditFrame
bool SaveBoard ( wxString &  aFileName,
BOARD aBoard,
IO_MGR::PCB_FILE_T  aFormat 
)

Definition at line 87 of file pcbnew_scripting_helpers.cpp.

References BOARD::BuildConnectivity(), NETCLASS::Default, BOARD::GetDesignSettings(), IO_MGR::Save(), BOARD_DESIGN_SETTINGS::SetCurrentNetClass(), and BOARD::SynchronizeNetsAndNetClasses().

Referenced by SaveBoard().

88 {
89  aBoard->BuildConnectivity();
92 
93  IO_MGR::Save( aFormat, aFileName, aBoard, NULL );
94 
95  return true;
96 }
void SynchronizeNetsAndNetClasses()
Function SynchronizeNetsAndNetClasses copies NETCLASS info to each NET, based on NET membership in a ...
Definition: netclass.cpp:160
static const char Default[]
the name of the default NETCLASS
Definition: netclass.h:80
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:538
void BuildConnectivity()
Builds or rebuilds the board connectivity database for the board, especially the list of connected it...
static void Save(PCB_FILE_T aFileType, const wxString &aFileName, BOARD *aBoard, const PROPERTIES *aProperties=NULL)
Function Save will write either a full aBoard to a storage file in a format that this implementation ...
Definition: io_mgr.cpp:186
bool SetCurrentNetClass(const wxString &aNetClassName)
Function SetCurrentNetClass Must be called after a netclass selection (or after a netclass parameter ...
bool SaveBoard ( wxString &  aFileName,
BOARD aBoard 
)

Definition at line 99 of file pcbnew_scripting_helpers.cpp.

References IO_MGR::KICAD_SEXP, and SaveBoard().

100 {
101  return SaveBoard( aFileName, aBoard, IO_MGR::KICAD_SEXP );
102 }
bool SaveBoard(wxString &aFileName, BOARD *aBoard, IO_MGR::PCB_FILE_T aFormat)
S-expression Pcbnew file format.
Definition: io_mgr.h:55
void ScriptingSetPcbEditFrame ( PCB_EDIT_FRAME aPcbEditFrame)

Definition at line 57 of file pcbnew_scripting_helpers.cpp.

Referenced by PCB::IFACE::CreateWindow().

58 {
59  s_PcbEditFrame = aPcbEditFrame;
60 }
static PCB_EDIT_FRAME * s_PcbEditFrame
void UpdateUserInterface ( )

Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...) (note: it is automatically called by action plugins, after running the plugin, so call this function is usually not needed inside action plugins.

Definition at line 137 of file pcbnew_scripting_helpers.cpp.

References PCB_EDIT_FRAME::UpdateUserInterface().

Referenced by PYTHON_ACTION_PLUGINS::deregister_action(), PCB_EDIT_FRAME::DoShowBoardSetupDialog(), and PCB_EDIT_FRAME::UseGalCanvas().

138 {
139  if( s_PcbEditFrame )
141 }
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...)
static PCB_EDIT_FRAME * s_PcbEditFrame
void WindowZoom ( int  xl,
int  yl,
int  width,
int  height 
)

Definition at line 128 of file pcbnew_scripting_helpers.cpp.

References EDA_DRAW_FRAME::Window_Zoom().

129 {
130  EDA_RECT Rect( wxPoint( xl, yl ), wxSize( width, height ) );
131 
132  if( s_PcbEditFrame )
133  s_PcbEditFrame->Window_Zoom( Rect );
134 }
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
virtual void Window_Zoom(EDA_RECT &Rect)
static PCB_EDIT_FRAME * s_PcbEditFrame

Variable Documentation

PCB_EDIT_FRAME* s_PcbEditFrame = NULL
static

Definition at line 46 of file pcbnew_scripting_helpers.cpp.