KiCad PCB EDA Suite
pcbnew_scripting_helpers.h File Reference
#include <pcb_edit_frame.h>
#include <io_mgr.h>

Go to the source code of this file.

Functions

void ScriptingSetPcbEditFrame (PCB_EDIT_FRAME *aPCBEdaFrame)
 
BOARDGetBoard ()
 
BOARDLoadBoard (wxString &aFileName, IO_MGR::PCB_FILE_T aFormat)
 
BOARDLoadBoard (wxString &aFileName)
 
bool SaveBoard (wxString &aFileName, BOARD *aBoard)
 
void Refresh ()
 Update the board display after modifying it bu 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...
 

Function Documentation

BOARD* GetBoard ( )

Definition at line 46 of file pcbnew_scripting_helpers.cpp.

References PCB_BASE_FRAME::GetBoard().

Referenced by PCB_EDIT_FRAME::Clean_Pcb(), PCB_EDIT_FRAME::CreateTarget(), PYTHON_ACTION_PLUGINS::deregister_action(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), D_PAD::Draw(), PCB_EDIT_FRAME::EditDimension(), EVT_GRID_CMD_CELL_CHANGED(), EVT_TOOL(), EVT_UPDATE_UI(), PCB_EDIT_FRAME::Exchange_Module(), PCB_EDIT_FRAME::ExportSpecctraFile(), 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(), PCB_BASE_FRAME::LoadModuleFromLibrary(), FOOTPRINT_EDIT_FRAME::ModeditLocateAndDisplay(), FOOTPRINT_EDIT_FRAME::moveExact(), 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::RecreateCmpFileFromBoard(), PCB_EDIT_FRAME::RemoveMisConnectedTracks(), PCB_BASE_FRAME::ResetModuleTextSizes(), 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::Show3D_Frame(), PCB_EDIT_FRAME::SpreadFootprints(), PCB_EDIT_FRAME::SVG_Print(), PCB_EDIT_FRAME::Swap_Layers(), PCB_EDIT_FRAME::UpdateTitle(), and PCB_EDIT_FRAME::UpdateUserInterface().

47 {
48  if( s_PcbEditFrame )
49  return s_PcbEditFrame->GetBoard();
50  else
51  return NULL;
52 }
BOARD * GetBoard() const
static PCB_EDIT_FRAME * s_PcbEditFrame
BOARD* LoadBoard ( wxString &  aFileName,
IO_MGR::PCB_FILE_T  aFormat 
)

Definition at line 74 of file pcbnew_scripting_helpers.cpp.

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

75 {
76  BOARD* brd = IO_MGR::Load( aFormat, aFileName );
77 
78  if( brd )
79  brd->BuildConnectivity();
80 
81  return brd;
82 }
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:179
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:169
BOARD* LoadBoard ( wxString &  aFileName)

Definition at line 61 of file pcbnew_scripting_helpers.cpp.

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

Referenced by LoadBoard().

62 {
63  if( aFileName.EndsWith( wxT( ".kicad_pcb" ) ) )
64  return LoadBoard( aFileName, IO_MGR::KICAD_SEXP );
65 
66  else if( aFileName.EndsWith( wxT( ".brd" ) ) )
67  return LoadBoard( aFileName, IO_MGR::LEGACY );
68 
69  // as fall back for any other kind use the legacy format
70  return LoadBoard( aFileName, IO_MGR::LEGACY );
71 }
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
void Refresh ( )

Update the board display after modifying it bu 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 103 of file pcbnew_scripting_helpers.cpp.

References BOARD::BuildConnectivity(), PCB_DRAW_PANEL_GAL::DisplayBoard(), PCB_BASE_FRAME::GetBoard(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_FRAME::GetGalCanvas(), EDA_DRAW_FRAME::IsGalCanvasActive(), EDA_DRAW_PANEL_GAL::Refresh(), and EDA_DRAW_PANEL::Refresh().

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_GAL::GetViewControls(), PCB_EDIT_FRAME::ImportSpecctraSession(), LIB_EDIT_FRAME::InstallFieldsEditorDialog(), LIB_EDIT_FRAME::LoadOneLibraryPartAux(), PCB_EDIT_FRAME::OnFlipPcbView(), C3D_MODEL_VIEWER::OnMouseMove(), C3D_MODEL_VIEWER::OnMouseWheel(), FOOTPRINT_PREVIEW_WIDGET::OnStatusChange(), DIALOG_FP_LIB_TABLE::optionsEditor(), EDA_DRAW_PANEL::Refresh(), DIALOG_EDIT_LINE_STYLE::resetDefaults(), TEMPLATE_WIDGET::Select(), C3D_MODEL_VIEWER::Set3DModel(), WIDGET_EESCHEMA_COLOR_CONFIG::SetColor(), DRCLISTBOX::SetList(), EDA_MSG_PANEL::SetMessage(), FOOTPRINTS_LISTBOX::SetSelection(), LIBRARY_LISTBOX::SetSelection(), 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(), and PCB_EDIT_FRAME::UseGalCanvas().

104 {
105  if( s_PcbEditFrame )
106  {
107  auto board = s_PcbEditFrame->GetBoard();
108  board->BuildConnectivity();
109 
111  {
112  auto panel = static_cast<PCB_DRAW_PANEL_GAL*>( s_PcbEditFrame->GetGalCanvas() );
113  panel->DisplayBoard(board);
115  }
116  else
117  // first argument is erase background, second is a wxRect that
118  // defines a reftresh area (all canvas if null)
119  s_PcbEditFrame->GetCanvas()->Refresh( true, NULL );
120  }
121 }
virtual void Refresh(bool eraseBackground=true, const wxRect *rect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
Definition: draw_panel.cpp:339
EDA_DRAW_PANEL * GetCanvas()
Definition: draw_frame.h:342
BOARD * GetBoard() const
void DisplayBoard(BOARD *aBoard)
Function DisplayBoard adds all items from the current board to the VIEW, so they can be displayed by ...
bool IsGalCanvasActive() const
Function IsGalCanvasActive is used to check which canvas (GAL-based or standard) is currently in use...
Definition: draw_frame.h:874
void BuildConnectivity()
Builds or rebuilds the board connectivity database for the board, especially the list of connected it...
void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it bu a python script (note: it is automatically called by a...
EDA_DRAW_PANEL_GAL * GetGalCanvas() const
Function GetGalCanvas returns a pointer to GAL-based canvas of given EDA draw frame.
Definition: draw_frame.h:882
static PCB_EDIT_FRAME * s_PcbEditFrame
bool SaveBoard ( wxString &  aFileName,
BOARD aBoard 
)

Definition at line 97 of file pcbnew_scripting_helpers.cpp.

References IO_MGR::KICAD_SEXP, and SaveBoard().

98 {
99  return SaveBoard( aFileName, aBoard, IO_MGR::KICAD_SEXP );
100 }
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 aPCBEdaFrame)

Definition at line 55 of file pcbnew_scripting_helpers.cpp.

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

56 {
57  s_PcbEditFrame = aPcbEditFrame;
58 }
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 133 of file pcbnew_scripting_helpers.cpp.

References PCB_EDIT_FRAME::UpdateUserInterface().

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

134 {
135  if( s_PcbEditFrame )
137 }
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 124 of file pcbnew_scripting_helpers.cpp.

References EDA_DRAW_FRAME::Window_Zoom().

125 {
126  EDA_RECT Rect( wxPoint( xl, yl ), wxSize( width, height )) ;
127 
128  if( s_PcbEditFrame )
129  s_PcbEditFrame->Window_Zoom( Rect );
130 }
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void Window_Zoom(EDA_RECT &Rect)
Definition: zoom.cpp:124
static PCB_EDIT_FRAME * s_PcbEditFrame