KiCad PCB EDA Suite
pcbnew_scripting_helpers.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2013 NBEE Embedded Systems SL, Miguel Angel Ajo <[email protected]>
5 * Copyright (C) 2013-2021 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#ifndef __PCBNEW_SCRIPTING_HELPERS_H
26#define __PCBNEW_SCRIPTING_HELPERS_H
27
28#include <pcb_edit_frame.h>
29#include <io_mgr.h>
30
31/* we could be including all these methods as static in a class, but
32 * we want plain pcbnew.<method_name> access from python
33 */
34
35#ifndef SWIG
36void ScriptingSetPcbEditFrame( PCB_EDIT_FRAME* aPCBEdaFrame );
37
38#endif
39
40// For Python scripts: return the current board.
42
43BOARD* LoadBoard( wxString& aFileName, IO_MGR::PCB_FILE_T aFormat );
44
45// Default LoadBoard() to load .kicad_pcb files:.
46BOARD* LoadBoard( wxString& aFileName );
47
54BOARD* NewBoard( wxString& aFileName );
55
57
64
74bool SaveBoard( wxString& aFileName, BOARD* aBoard, bool aSkipSettings = false );
75
82wxArrayString GetFootprintLibraries();
83
90wxArrayString GetFootprints( const wxString& aNickName );
91
99bool ExportSpecctraDSN( wxString& aFullFilename );
100
110bool ExportSpecctraDSN( BOARD* aBoard, wxString& aFullFilename );
111
118bool ExportVRML( const wxString& aFullFileName, double aMMtoWRMLunit, bool aExport3DFiles,
119 bool aUseRelativePaths, const wxString& a3D_Subdir, double aXRef, double aYRef );
120
129bool ImportSpecctraSES( wxString& aFullFilename );
130
142bool ExportFootprintsToLibrary( bool aStoreInNewLib, const wxString& aLibName = wxEmptyString,
143 wxString* aLibPath = nullptr );
144
153void Refresh();
154
162
168int GetUserUnits();
169
173bool IsActionRunning();
174
187bool WriteDRCReport( BOARD* aBoard, const wxString& aFileName, EDA_UNITS aUnits,
188 bool aReportAllTrackErrors );
189
190#endif // __PCBNEW_SCRIPTING_HELPERS_H
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:240
PCB_FILE_T
The set of file types that the IO_MGR knows about, and for which there has been a plugin written.
Definition: io_mgr.h:54
The main frame for Pcbnew.
EDA_UNITS
Definition: eda_units.h:39
bool ImportSpecctraSES(wxString &aFullFilename)
Import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an ...
SETTINGS_MANAGER * GetSettingsManager()
bool WriteDRCReport(BOARD *aBoard, const wxString &aFileName, EDA_UNITS aUnits, bool aReportAllTrackErrors)
Run the DRC check on the given board and writes the results to a report file.
BOARD * CreateEmptyBoard()
Construct a default BOARD with a temporary (no filename) project.
bool SaveBoard(wxString &aFileName, BOARD *aBoard, bool aSkipSettings=false)
Saves a copy of the given board and its associated project to the given path.
wxArrayString GetFootprintLibraries()
Get the nicknames of all of the footprint libraries configured in pcbnew in both the project and glob...
int GetUserUnits()
Return the currently selected user unit value for the interface.
wxArrayString GetFootprints(const wxString &aNickName)
Get the names of all of the footprints available in a footprint library.
bool IsActionRunning()
Are we currently in an action plugin?
BOARD * LoadBoard(wxString &aFileName, IO_MGR::PCB_FILE_T aFormat)
void UpdateUserInterface()
Update the layer manager and other widgets from the board setup (layer and items visibility,...
void ScriptingSetPcbEditFrame(PCB_EDIT_FRAME *aPCBEdaFrame)
bool ExportSpecctraDSN(wxString &aFullFilename)
Will export the current BOARD to a specctra dsn file.
void Refresh()
Update the board display after modifying it by a python script (note: it is automatically called by a...
bool ExportVRML(const wxString &aFullFileName, double aMMtoWRMLunit, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
Export the current BOARD to a VRML (wrl) file.
BOARD * GetBoard()
BOARD * NewBoard(wxString &aFileName)
Creates a new board and project with the given filename (will overwrite existing files!...
bool ExportFootprintsToLibrary(bool aStoreInNewLib, const wxString &aLibName=wxEmptyString, wxString *aLibPath=nullptr)
Save footprints in a library: