KiCad PCB EDA Suite
PCB_EDIT_FRAME Class Reference

PCB_EDIT_FRAME is the main frame for Pcbnew. More...

#include <pcb_edit_frame.h>

Inheritance diagram for PCB_EDIT_FRAME:
PCB_BASE_EDIT_FRAME PCB_BASE_FRAME EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

Classes

struct  LAYER_TOOLBAR_ICON_VALUES
 Store the previous layer toolbar icon state information. More...
 

Public Types

enum  FETCH_NETLIST_MODE { NO_ANNOTATION, QUIET_ANNOTATION, ANNOTATION_DIALOG }
 Function FetchNetlistFromSchematic. More...
 
enum  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Function ClearUndoORRedoList (virtual). More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

virtual ~PCB_EDIT_FRAME ()
 
void LoadFootprints (NETLIST &aNetlist, REPORTER &aReporter)
 Function loadFootprints loads the footprints for each COMPONENT in aNetlist from the list of libraries. More...
 
void OnQuit (wxCommandEvent &event)
 
bool IsContentModified () override
 Get if the current board has been modified but not saved. More...
 
void PythonPluginsReload ()
 Reload the Python plugins if they are newer than the already loaded, and load new plugins if any. More...
 
void PythonPluginsShowFolder ()
 Open the plugins folder in the default system file browser. More...
 
void PythonSyncEnvironmentVariables ()
 Synchronize the environment variables from KiCad's environment into the Python interpreter. More...
 
void PythonSyncProjectName ()
 Synchronize the project name from KiCad's environment into the Python interpreter. More...
 
void UpdateUserInterface ()
 Update the layer manager and other widgets from the board setup (layer and items visibility, colors ...) More...
 
void ExecuteRemoteCommand (const char *cmdline) override
 Execute a remote command send by Eeschema via a socket, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) this is a virtual function called by EDA_DRAW_FRAME::OnSockRequest(). More...
 
void KiwayMailIn (KIWAY_EXPRESS &aEvent) override
 Function KiwayMailIn receives KIWAY_EXPRESS messages from other players. More...
 
void ToPlotter (int aID)
 Function ToPlotter Open a dialog frame to create plot and drill files relative to the current board. More...
 
void ExportSVG (wxCommandEvent &event)
 Function SVG_Print Shows the Export to SVG file dialog. More...
 
void OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)
 
bool LayerManagerShown ()
 
bool MicrowaveToolbarShown ()
 
void OnUpdateSelectViaSize (wxUpdateUIEvent &aEvent)
 
void OnUpdateSelectTrackWidth (wxUpdateUIEvent &aEvent)
 
void OnLayerColorChange (wxCommandEvent &aEvent)
 
void RunEeschema ()
 
void UpdateTrackWidthSelectBox (wxChoice *aTrackWidthSelectBox, bool aEdit=true)
 
void UpdateViaSizeSelectBox (wxChoice *aViaSizeSelectBox, bool aEdit=true)
 
COLOR4D GetGridColor () override
 Function GetGridColor() , virtual. More...
 
void SetGridColor (COLOR4D aColor) override
 Function SetGridColor() , virtual. More...
 
void Process_Config (wxCommandEvent &event)
 
void SaveProjectSettings () override
 Function SaveProjectSettings saves changes to the project settings to the project (.pro) file. More...
 
bool LoadProjectSettings ()
 Load the current project's file configuration settings which are pertinent to this PCB_EDIT_FRAME instance. More...
 
void LoadSettings (APP_SETTINGS_BASE *aCfg) override
 Load common frame parameters from a configuration file. More...
 
void SaveSettings (APP_SETTINGS_BASE *aCfg) override
 Saves common frame parameters to a configuration data file. More...
 
wxString GetLastPath (LAST_PATH_TYPE aType)
 Get the last path for a particular type. More...
 
void SetLastPath (LAST_PATH_TYPE aType, const wxString &aLastPath)
 Set the path of the last file successfully read. More...
 
void RecordDRCExclusions ()
 Scan existing markers and record data from any that are Excluded. More...
 
void ResolveDRCExclusions ()
 Update markers to match recorded exclusions. More...
 
void Process_Special_Functions (wxCommandEvent &event)
 
void Tracks_and_Vias_Size_Event (wxCommandEvent &event)
 
void ReCreateHToolbar () override
 
void ReCreateAuxiliaryToolbar () override
 
void ReCreateVToolbar () override
 
void ReCreateMicrowaveVToolbar ()
 
void ReCreateOptToolbar () override
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
void ReCreateLayerBox (bool aForceResizeToolbar=true)
 Re create the layer Box by clearing the old list, and building le new one, from the new layers names and cole layers. More...
 
bool SetCurrentNetClass (const wxString &aNetClassName)
 Function SetCurrentNetClass Must be called after a netclass selection (or after a netclass parameter change calls BOARD_DESIGN_SETTINGS::SetCurrentNetClass() and update trace width and via size combo boxes on main toolbar Initialize vias and tracks values displayed in comb boxes of the auxiliary toolbar and some others parameters (netclass name ....) More...
 
void OnModify () override
 Function OnModify must be called after a board change to set the modified flag. More...
 
void SetActiveLayer (PCB_LAYER_ID aLayer) override
 Function SetActiveLayer will change the currently active layer to aLayer and also update the PCB_LAYER_WIDGET. More...
 
APPEARANCE_CONTROLSGetAppearancePanel ()
 
void OnUpdateLayerAlpha (wxUpdateUIEvent &aEvent) override
 Update the UI to reflect changes to the current layer's transparency. More...
 
void OnDisplayOptionsChanged () override
 
bool IsElementVisible (GAL_LAYER_ID aElement) const
 Function IsElementVisible tests whether a given element category is visible. More...
 
void SetElementVisibility (GAL_LAYER_ID aElement, bool aNewState)
 Function SetElementVisibility changes the visibility of an element category. More...
 
void ActivateGalCanvas () override
 

More...
 
void ShowBoardSetupDialog (const wxString &aInitialPage=wxEmptyString, const wxString &aErrorMsg=wxEmptyString, int aErrorCtrlId=-1, int aErrorLine=-1, int aErrorCol=-1)
 Function ShowBoardSetupDialog. More...
 
void PrepareLayerIndicator (bool aForceRebuild=false)
 
void ToggleLayersManager ()
 
void ToggleMicrowaveToolbar ()
 
int DoGenFootprintsPositionFile (const wxString &aFullFileName, bool aUnitsMM, bool aForceSmdItems, bool aTopSide, bool aBottomSide, bool aFormatCSV=false)
 Function DoGenFootprintsPositionFile Creates an ascii footprint position file. More...
 
void GenFootprintsReport (wxCommandEvent &event)
 Function GenFootprintsReport Calls DoGenFootprintsReport to create a footprint reprot file See DoGenFootprintsReport for file format. More...
 
bool DoGenFootprintsReport (const wxString &aFullFilename, bool aUnitsMM)
 Function DoGenFootprintsReport Creates an ascii footprint report file giving some infos on footprints and board outlines. More...
 
void GenD356File (wxCommandEvent &event)
 
void OnFileHistory (wxCommandEvent &event)
 
void OnClearFileHistory (wxCommandEvent &aEvent)
 
void Files_io (wxCommandEvent &event)
 Function Files_io. More...
 
bool Files_io_from_id (int aId)
 Function Files_io_from_id Read and write board files. More...
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
 Function OpenProjectFiles (was LoadOnePcbFile) loads a KiCad board (.kicad_pcb) from aFileName. More...
 
bool SavePcbFile (const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
 Function SavePcbFile writes the board data structures to a aFileName Creates backup when requested and update flags (modified and saved flgs) More...
 
bool SavePcbCopy (const wxString &aFileName, bool aCreateProject=false)
 Function SavePcbCopy writes the board data structures to a aFileName but unlike SavePcbFile, does not make anything else (no backup, borad fliename change, no flag changes ...) Used under a project mgr to save under a new name the current board. More...
 
bool Clear_Pcb (bool aQuery, bool aFinal=false)
 Function Clear_Pcb delete all and reinitialize the current board. More...
 
void SetBoard (BOARD *aBoard) override
 

More...
 
BOARD_ITEM_CONTAINERGetModel () const override
 

More...
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 

More...
 
void RecreateCmpFileFromBoard (wxCommandEvent &aEvent)
 Function RecreateBOMFileFromBoard Recreates a .cmp file from the current loaded board this is the same as created by CvPcb. More...
 
void ArchiveModulesOnBoard (bool aStoreInNewLib, const wxString &aLibName=wxEmptyString, wxString *aLibPath=NULL)
 Function ArchiveModulesOnBoard Save modules in a library: More...
 
void RecreateBOMFileFromBoard (wxCommandEvent &aEvent)
 Function RecreateBOMFileFromBoard Creates a BOM file from the current loaded board. More...
 
void ExportToGenCAD (wxCommandEvent &event)
 Function ExportToGenCAD creates a file in GenCAD 1.4 format from the current board. More...
 
void OnExportVRML (wxCommandEvent &event)
 Function OnExportVRML will export the current BOARD to a VRML file. More...
 
bool ExportVRML_File (const wxString &aFullFileName, double aMMtoWRMLunit, bool aExport3DFiles, bool aUseRelativePaths, bool aUsePlainPCB, const wxString &a3D_Subdir, double aXRef, double aYRef)
 Function ExportVRML_File Creates the file(s) exporting current BOARD to a VRML file. More...
 
void OnExportIDF3 (wxCommandEvent &event)
 Function OnExportIDF3 will export the current BOARD to a IDFv3 board and lib files. More...
 
void OnExportHyperlynx (wxCommandEvent &event)
 Function OnExportHyperlynx will export the current BOARD to a Hyperlynx HYP file. More...
 
bool Export_IDF3 (BOARD *aPcb, const wxString &aFullFileName, bool aUseThou, double aXRef, double aYRef)
 Function Export_IDF3 Creates an IDF3 compliant BOARD (*.emn) and LIBRARY (*.emp) file. More...
 
void OnExportSTEP (wxCommandEvent &event)
 Function OnExportSTEP Exports the current BOARD to a STEP assembly. More...
 
bool ExportSpecctraFile (const wxString &aFullFilename)
 Function ExportSpecctraFile will export the current BOARD to a specctra dsn file. More...
 
bool ImportSpecctraSession (const wxString &aFullFilename)
 Function ImportSpecctraSession will import a specctra *.ses file and use it to relocate MODULEs and to replace all vias and tracks in an existing and loaded BOARD. More...
 
void InstallFootprintPropertiesDialog (MODULE *Module)
 
int InstallExchangeModuleFrame (MODULE *aModule, bool updateMode, bool selectedMode)
 
void Exchange_Module (MODULE *aSrc, MODULE *aDest, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetFabricationAttrs=true, bool reset3DModels=true)
 Function Exchange_Module Replaces OldModule by NewModule, using OldModule settings: position, orientation, pad netnames ...) OldModule is deleted or put in undo list. More...
 
void OnEditItemRequest (BOARD_ITEM *aItem) override
 Function OnEditItemRequest Install the corresponding dialog editor for the given item. More...
 
void SwitchLayer (wxDC *DC, PCB_LAYER_ID layer) override
 
void SetTrackSegmentWidth (TRACK *aTrackItem, PICKED_ITEMS_LIST *aItemsListPicker, bool aUseNetclassValue)
 Function SetTrackSegmentWidth Modify one track segment width or one via diameter (using DRC control). More...
 
void Edit_Zone_Params (ZONE_CONTAINER *zone_container)
 Function Edit_Zone_Params Edit params (layer, clearance, ...) for a zone outline. More...
 
void ShowTargetOptionsDialog (PCB_TARGET *aTarget)
 
void ShowDimensionPropertyDialog (DIMENSION *aDimension)
 
void InstallNetlistFrame ()
 
bool FetchNetlistFromSchematic (NETLIST &aNetlist, FETCH_NETLIST_MODE aMode)
 
bool ReannotateSchematic (std::string &aNetlist)
 Sends a command to Eeschema to re-annotate the schematic. More...
 
bool TestStandalone (void)
 Test if standalone mode. More...
 
void DoUpdatePCBFromNetlist (NETLIST &aNetlist, bool aUseTimestamps)
 Function DoUpdatePCBFromNetlist An automated version of UpdatePCBFromNetlist which skips the UI dialog. More...
 
bool ReadNetlistFromFile (const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter)
 Reads a netlist from a file into a NETLIST object. More...
 
void OnNetlistChanged (BOARD_NETLIST_UPDATER &aUpdater, bool *aRunDragCommand)
 Called after netlist is updated. More...
 
void LockModule (MODULE *aModule, bool aLocked)
 
void SendMessageToEESCHEMA (BOARD_ITEM *objectToSync)
 Function SendMessageToEESCHEMA sends a message to the schematic editor so that it may move its cursor to a part with the same reference as the objectToSync. More...
 
void SendCrossProbeNetName (const wxString &aNetName)
 Sends a net name to eeschema for highlighting. More...
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
void UpdateTitle ()
 Function UpdateTitle sets the main window title bar text. More...
 
void On3DShapeLibWizard (wxCommandEvent &event)
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allows Pcbnew to install its preferences panel into the preferences dialog. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Called after the preferences dialog is run. More...
 
void ProjectChanged () override
 Notification event that the project has changed. More...
 
wxString GetCurrentFileName () const override
 Get the full filename + path of the currently opened file in the frame. More...
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
bool TryBefore (wxEvent &aEvent) override
 
wxString CreateNewLibrary (const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
 If a library name is given, creates a new footprint library in the project folder with the given name. More...
 
bool AddLibrary (const wxString &aLibName=wxEmptyString)
 Function AddLibrary Add an existing library to either the global or project library table. More...
 
void SaveCopyInUndoList (EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
 Function SaveCopyInUndoList Creates a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aTypeCommand, const wxPoint &aTransformPoint=wxPoint(0, 0)) override
 Function SaveCopyInUndoList Creates a new entry in undo list of commands. More...
 
void RestoreCopyFromRedoList (wxCommandEvent &aEvent)
 Function RestoreCopyFromRedoList Redo the last edit: More...
 
void RestoreCopyFromUndoList (wxCommandEvent &aEvent)
 Function RestoreCopyFromUndoList Undo the last edit: More...
 
void RollbackFromUndo ()
 Performs an undo of the last edit WITHOUT logging a corresponding redo. More...
 
void PutDataInPreviousState (PICKED_ITEMS_LIST *aList, bool aRedoCommand, bool aRebuildRatsnet=true)
 Function PutDataInPreviousState Used in undo or redo command. More...
 
bool UndoRedoBlocked () const
 Function UndoRedoBlocked Checks if the undo and redo operations are currently blocked. More...
 
void UndoRedoBlock (bool aBlock=true)
 Function UndoRedoBlock Enables/disable undo and redo operations. More...
 
void SetGridVisibility (bool aVisible) override
 Function SetGridVisibility() More...
 
int GetRotationAngle () const
 Function GetRotationAngle() Returns the angle used for rotate operations. More...
 
void SetRotationAngle (int aRotationAngle)
 Function SetRotationAngle() Sets the angle used for rotate operations. More...
 
void InstallTextOptionsFrame (BOARD_ITEM *aText)
 Routine for main window class to launch text properties dialog. More...
 
void InstallGraphicItemPropertiesDialog (BOARD_ITEM *aItem)
 
COLOR_SETTINGSGetColorSettings () override
 Helper to retrieve the current color settings. More...
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Function ClearUndoORRedoList free the undo or redo list from List element Wrappers are deleted. More...
 
EDA_3D_VIEWERGet3DViewerFrame ()
 
virtual void Update3DView (bool aForceReload, const wxString *aTitle=nullptr)
 Update the 3D view, if the viewer is opened by this frame. More...
 
MODULELoadFootprint (const LIB_ID &aFootprintId)
 Function LoadFootprint attempts to load aFootprintId from the footprint library table. More...
 
EDA_RECT GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
 Function GetBoardBoundingBox calculates the bounding box containing all board items (or board edge segments). More...
 
const BOX2I GetDocumentExtents () const override
 
const PAGE_INFOGetPageSettings () const override
 
const wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPointGetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const wxPointGetAuxOrigin () const
 
const wxPoint GetUserOrigin () const
 
ORIGIN_TRANSFORMSGetOriginTransforms () override
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
virtual BOARD_DESIGN_SETTINGSGetDesignSettings () const
 Returns the BOARD_DESIGN_SETTINGS for the open project Overloaded in FOOTPRINT_EDIT_FRAME. More...
 
PCBNEW_SETTINGSSettings ()
 
void SetDrawBgColor (COLOR4D aColor) override
 
const PCB_DISPLAY_OPTIONSGetDisplayOptions () const
 Function GetDisplayOptions Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode) More...
 
void SetDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions)
 
const ZONE_SETTINGSGetZoneSettings () const
 
void SetZoneSettings (const ZONE_SETTINGS &aSettings)
 
virtual const PCB_PLOT_PARAMSGetPlotSettings () const
 Function GetPlotSettings returns the PCB_PLOT_PARAMS for the BOARD owned by this frame. More...
 
virtual void SetPlotSettings (const PCB_PLOT_PARAMS &aSettings)
 
BOARDGetBoard () const
 
EDA_ITEMGetItem (const KIID &aId) override
 Fetch an item by KIID. More...
 
void FocusOnItem (BOARD_ITEM *aItem)
 
virtual void UpdateStatusBar () override
 Update the status bar information. More...
 
PCB_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
EDA_3D_VIEWERCreateAndShow3D_Frame ()
 Shows the 3D view frame. More...
 
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide ()
 Function GetCollectorsGuide. More...
 
wxString SelectLibrary (const wxString &aNicknameExisting)
 Function SelectLibrary puts up a dialog and allows the user to pick a library, for unspecified use. More...
 
MODULEGetFootprintFromBoardByReference ()
 Function GetFootprintFromBoardByReference. More...
 
MODULECreateNewModule (const wxString &aModuleName)
 Function CreateNewModule Creates a new module or footprint, at position 0,0 The new module contains only 2 texts: a reference and a value: Reference = REF** Value = "VAL**" or Footprint name in lib Note: they are dummy texts, which will be replaced by the actual texts when the fooprint is placed on a board and a netlist is read. More...
 
void PlaceModule (MODULE *aModule, bool aRecreateRatsnest=true)
 Function PlaceModule places aModule at the current cursor position and updates module coordinates with the new position. More...
 
void InstallPadOptionsFrame (D_PAD *pad)
 
MODULESelectFootprintFromLibTree (LIB_ID aPreselect=LIB_ID())
 Function SelectFootprintFromLibTree opens a dialog to select a footprint. More...
 
virtual void AddModuleToBoard (MODULE *module)
 Adds the given module to the board. More...
 
wxString SelectFootprintFromLibBrowser ()
 Function SelectFootprintFromLibBrowser launches the footprint viewer to select the name of a footprint to load. More...
 
void Compile_Ratsnest (bool aDisplayStatus)
 Function Compile_Ratsnest Create the entire board ratsnest. More...
 
PCB_LAYER_ID SelectLayer (PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
 Install the dialog box for layer selection. More...
 
virtual PCB_LAYER_ID GetActiveLayer () const
 
int GetSeverity (int aErrorCode) const override
 
PCBNEW_SETTINGSGetPcbNewSettings ()
 
FOOTPRINT_EDITOR_SETTINGSGetFootprintEditorSettings ()
 
virtual MAGNETIC_SETTINGSGetMagneticItemsSettings ()
 
void DisplayGridMsg () override
 Function DisplayGridMsg() More...
 
PCB_DRAW_PANEL_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
virtual void SetAutoZoom (bool aAutoZoom)
 Does nothing. More...
 
virtual bool GetAutoZoom ()
 Always returns false. More...
 
bool LockFile (const wxString &aFileName)
 Mark a schematic file as being in use. More...
 
void ReleaseFile ()
 Release the current file marked in use. More...
 
wxFindReplaceData & GetFindReplaceData ()
 
wxArrayString & GetFindHistoryList ()
 
bool GetShowPolarCoords () const
 For those frames that support polar coordinates. More...
 
void SetShowPolarCoords (bool aShow)
 
void ToggleUserUnits () override
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
virtual COLOR4D GetDrawBgColor () const
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
virtual wxString GetScreenDesc () const
 
void EraseMsgBox ()
 
bool IsGridVisible () const
 
void OnSelectGrid (wxCommandEvent &event)
 Command event handler for selecting grid sizes. More...
 
void OnGridSettings (wxCommandEvent &event)
 
void UpdateGridSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectGrid (wxUpdateUIEvent &aEvent)
 Update the checked item in the grid combobox. More...
 
void UpdateZoomSelectBox ()
 Rebuild the grid combobox to respond to any changes in the GUI (units, user grid changes, etc.) More...
 
void OnUpdateSelectZoom (wxUpdateUIEvent &aEvent)
 Update the checked item in the zoom combobox. More...
 
const wxString GetZoomLevelIndicator () const
 Return a human readable value for display in dialogs. More...
 
virtual void OnSelectZoom (wxCommandEvent &event)
 Set the zoom factor when selected by the zoom list box in the main tool bar. More...
 
virtual void OnSize (wxSizeEvent &event)
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void HardRedraw ()
 Rebuild the GAL and redraws the screen. More...
 
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. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Function CreateBasicMenu. More...
 
void PrintWorkSheet (RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aScale, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the page layout with the frame and the basic inscriptions. More...
 
void DisplayToolMsg (const wxString &msg) override
 
virtual void OnPageSettingsChange ()
 Called when modifying the page settings. More...
 
void DisplayUnitsMsg ()
 Display current unit pane in the status bar. More...
 
void CreateServer (int service, bool local=true)
 
void OnSockRequest (wxSocketEvent &evt)
 
void OnSockRequestServer (wxSocketEvent &evt)
 
void AppendMsgPanel (const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
 Append a message to the message panel. More...
 
virtual void ClearMsgPanel ()
 Clear all messages from the message panel. More...
 
void SetMsgPanel (const std::vector< MSG_PANEL_ITEM > &aList)
 Clear the message panel and populates it with the contents of aList. More...
 
void SetMsgPanel (EDA_ITEM *aItem)
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual void PrintPage (RENDER_SETTINGS *aSettings)
 Print the page pointed by current screen, set by the calling print function. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE LoadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of ckeck tools. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handles command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=NULL, wxWindow *aResultantFocusWindow=NULL)
 Function ShowModal puts up this wxFrame as if it were a modal dialog, with all other instantiated wxFrames disabled until this KIWAY_PLAYER derivative calls DismissModal(). More...
 
bool Destroy () override
 Our version of Destroy() which is virtual from wxWidgets. More...
 
bool IsModal () const override
 Return true if the frame is shown in our modal mode and false if the frame is shown as an usual frame In modal mode, the caller that created the frame is responsible to Destroy() this frame after closing. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 Function IsDismissed returns false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). More...
 
void DismissModal (bool aRetVal, const wxString &aResult=wxEmptyString)
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
virtual void OnCharHook (wxKeyEvent &event)
 Capture the key event before it is sent to the GUI. More...
 
void OnMenuEvent (wxMenuEvent &event)
 The TOOL_DISPATCHER needs these to work around some issues in wxWidgets where the menu events aren't captured by the menus themselves. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions) override
 Register an action's update conditions with the UI layer to allow the UI to appropriately display the state of its controls. More...
 
virtual void RegisterUIUpdateHandler (int aID, const ACTION_CONDITIONS &aConditions)
 Register a UI update handler for the control with ID aID. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction) override
 Unregister a UI handler for an action that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (int aID)
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
void OnMaximize (wxMaximizeEvent &aEvent)
 
void SetAutoSaveInterval (int aInterval)
 
int GetAutoSaveInterval () const
 
bool IsType (FRAME_T aType) const
 
virtual const SEARCH_STACKsys_search ()
 Return a SEARCH_STACK pertaining to entire program. More...
 
virtual wxString help_name ()
 
void OnKicadAbout (wxCommandEvent &event)
 
void OnPreferences (wxCommandEvent &event)
 
void PrintMsg (const wxString &text)
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg)
 
void ShowInfoBarWarning (const wxString &aWarningMsg)
 
void ShowInfoBarMsg (const wxString &aMsg)
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
void LoadWindowState (const wxString &aFileName)
 
virtual void LoadWindowState (const WINDOW_STATE &aState)
 Load frame state info from a configuration file. More...
 
void LoadWindowSettings (const WINDOW_SETTINGS *aCfg)
 Loads window settings from the given settings object Normally called by LoadSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Saves window settings to the given settings object Normally called by SaveSettings unless the window in question is a child window that stores its settings somewhere other than APP_SETTINGS_BASE::m_Window. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Returns a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName)
 Checks if aFileName can be written. More...
 
void CheckForAutoSaveFile (const wxFileName &aFileName)
 Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input. More...
 
const wxString & GetAboutTitle () const
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoRedoList ()
 Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are deleted by ClearUndoORRedoList() according to their status. More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToUndoList add a command to undo in undo list delete the very old commands when the max count of undo commands is reached ( using ClearUndoORRedoList) More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Function PushCommandToRedoList add a command to redo in redo list delete the very old commands when the max count of redo commands is reached ( using ClearUndoORRedoList) More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 PopCommandFromUndoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 PopCommandFromRedoList return the last command to undo and remove it from list nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicates that hotkeys should perform an immediate action even if another tool is currently active. More...
 
bool GetDragSelects () const
 Indicates that a drag should draw a selection rectangle, even when started over an item. More...
 
bool GetMoveWarpsCursor () const
 Indicates that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType ()
 
KIWAYKiway () const
 Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Function Prj returns a reference to the PROJECT "associated with" this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 Function SetKiway. More...
 

Static Public Member Functions

static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handles events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g. More...
 

Public Attributes

PCB_LAYER_BOX_SELECTORm_SelLayerBox
 
wxChoice * m_SelTrackWidthBox
 
wxChoice * m_SelViaSizeBox
 
bool m_show_microwave_tools
 
bool m_show_layer_manager_tools
 
bool m_ZoneFillsDirty
 

Protected Member Functions

void setupTools ()
 
void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType) override
 switches currently used canvas (Cairo / OpenGL). More...
 
void onBoardLoaded ()
 Updates the state of the GUI after a new board is loaded or created. More...
 
bool doAutoSave () override
 Function doAutoSave performs auto save when the board has been modified and not saved within the auto save interval. More...
 
bool isAutoSaveRequired () const override
 Function isautoSaveRequired returns true if the board has been modified. More...
 
bool importFile (const wxString &aFileName, int aFileType)
 Load the given filename but sets the path to the current project path. More...
 
int inferLegacyEdgeClearance (BOARD *aBoard)
 Use the existing edge_cut line thicknesses to infer the edge clearace. More...
 
bool fixEagleNets (const std::unordered_map< wxString, wxString > &aRemap)
 Rematch orphaned zones and vias to schematic nets. More...
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
void doCloseWindow () override
 
 PCB_EDIT_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
void onSize (wxSizeEvent &aEvent)
 
void unitsChangeRefresh () override
 Called when when the units setting has changed to allow for any derived classes to handle refreshing and controls that have units based measurements in them. More...
 
MODULEloadFootprint (const LIB_ID &aFootprintId)
 Function loadFootprint attempts to load aFootprintId from the footprint library table. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void InitExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. More...
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 Function language_change is an event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 

Static Protected Member Functions

static const wxChar * pythonConsoleNameId ()
 Has meaning only if KICAD_SCRIPTING_WXPYTHON option is not defined. More...
 
static wxWindow * findPythonConsole ()
 
static wxString GetBackupSuffix ()
 
static wxString GetAutoSaveFilePrefix ()
 

Protected Attributes

LAYER_TOOLBAR_ICON_VALUES m_prevIconVal
 
int m_rotationAngle
 User defined rotation angle (in tenths of a degree). More...
 
bool m_undoRedoBlocked
 Is undo/redo operation currently blocked? More...
 
PCB_LAYER_WIDGETm_Layers
 Layer manager. It is the responsibility of the child frames to instantiate this. More...
 
PANEL_SELECTION_FILTERm_selectionFilterPanel
 AUI panel for changing the selection tool filter controls. More...
 
APPEARANCE_CONTROLSm_appearancePanel
 AUI panel for controlling layer and object visibility and appearance. More...
 
BOARDm_Pcb
 
PCB_DISPLAY_OPTIONS m_DisplayOptions
 
PCB_ORIGIN_TRANSFORMS m_OriginTransforms
 
PCBNEW_SETTINGSm_Settings
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
 prevents opening same file multiple times. More...
 
bool m_showPageLimits
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
int m_UndoRedoCountMax
 
bool m_PolarCoords
 
bool m_showBorderAndTitleBlock
 
long m_firstRunDialogSetting
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
ACTION_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
wxFindReplaceData * m_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_MsgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 The current canvas type. More...
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_Ident
 
wxPoint m_FramePos
 
wxSize m_FrameSize
 
wxPoint m_NormalFramePos
 
wxSize m_NormalFrameSize
 
wxString m_AboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
bool m_FlagModified
 
bool m_FlagSave
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 
bool m_isClosing
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
bool m_dragSelects
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 

Default style flags used for wxAUI toolbars

More...
 

Private Attributes

ACTION_TOOLBARm_microWaveToolBar
 The auxiliary right vertical tool bar used to access the microwave tools. More...
 

Friends

struct PCB::IFACE
 
class PCB_LAYER_WIDGET
 
class APPEARANCE_CONTROLS
 

Detailed Description

PCB_EDIT_FRAME is the main frame for Pcbnew.

See also class PCB_BASE_FRAME(): Basic class for Pcbnew and GerbView.

Definition at line 78 of file pcb_edit_frame.h.

Member Enumeration Documentation

◆ FETCH_NETLIST_MODE

Function FetchNetlistFromSchematic.

Parameters
aNetlista NETLIST owned by the caller. This function fills it in.
Returns
true if a netlist was fetched.
Enumerator
NO_ANNOTATION 
QUIET_ANNOTATION 
ANNOTATION_DIALOG 

Definition at line 826 of file pcb_edit_frame.h.

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

Function ClearUndoORRedoList (virtual).

this function must remove the aItemCount old commands from aList and delete commands, pickers and picked items if needed Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN

Parameters
aList= the UNDO_REDO_CONTAINER of commands
aItemCount= number of old commands to delete. -1 to remove all old commands this will empty the list of commands. Commands are deleted from the older to the last.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 607 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ PCB_EDIT_FRAME()

PCB_EDIT_FRAME::PCB_EDIT_FRAME ( KIWAY aKiway,
wxWindow *  aParent 
)
protected

◆ ~PCB_EDIT_FRAME()

PCB_EDIT_FRAME::~PCB_EDIT_FRAME ( )
virtual

Definition at line 393 of file pcb_edit_frame.cpp.

394 {
395  // Close modeless dialogs
396  wxWindow* open_dlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
397 
398  if( open_dlg )
399  open_dlg->Close( true );
400 
401  // Shutdown all running tools
402  if( m_toolManager )
404 
405  if( GetBoard() )
407 
408  delete m_selectionFilterPanel;
409  delete m_appearancePanel;
410 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
APPEARANCE_CONTROLS * m_appearancePanel
AUI panel for controlling layer and object visibility and appearance.
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
#define DIALOG_DRC_WINDOW_NAME
Definition: dialog_drc.h:43
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
PANEL_SELECTION_FILTER * m_selectionFilterPanel
AUI panel for changing the selection tool filter controls.
BOARD * GetBoard() const

References DIALOG_DRC_WINDOW_NAME, GetBoard(), and BOARD::RemoveListener().

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_EDIT_FRAME::ActivateGalCanvas ( )
overridevirtual

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 913 of file pcb_edit_frame.cpp.

914 {
916  GetCanvas()->UpdateColors();
917  GetCanvas()->Refresh();
918 }
void ActivateGalCanvas() override
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void UpdateColors()
Updates the color settings in the painter and GAL.

References PCB_BASE_EDIT_FRAME::ActivateGalCanvas().

Referenced by Refresh().

◆ AddLibrary()

bool PCB_BASE_EDIT_FRAME::AddLibrary ( const wxString &  aLibName = wxEmptyString)
inherited

Function AddLibrary Add an existing library to either the global or project library table.

Parameters
aFileNamethe library to add; a file open dialog will be displayed if empty.
Returns
true if successfully added

Definition at line 471 of file footprint_libraries_utils.cpp.

472 {
473  wxFileName fn( aFilename );
474 
475  if( aFilename.IsEmpty() )
476  {
477  if( !LibraryFileBrowser( true, fn,
479  true ) )
480  {
481  return false;
482  }
483  }
484 
485  wxString libPath = fn.GetFullPath();
486  wxString libName = fn.GetName();
487 
488  if( libName.IsEmpty() )
489  return false;
490 
491  bool saveInGlobalTable = false;
492  bool saveInProjectTable = false;
493 
494  if( Prj().IsNullProject() )
495  {
496  saveInGlobalTable = true;
497  }
498  else
499  {
500  wxArrayString libTableNames;
501 
502  libTableNames.Add( _( "Global" ) );
503  libTableNames.Add( _( "Project" ) );
504 
505  switch( SelectSingleOption( this, _( "Select Library Table" ),
506  _( "Choose the Library Table to add the library to:" ), libTableNames ) )
507  {
508  case 0: saveInGlobalTable = true; break;
509  case 1: saveInProjectTable = true; break;
510  default: return false;
511  }
512  }
513 
514  wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
515 
516  // try to use path normalized to an environmental variable or project path
517  wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
518 
519  if( normalizedPath.IsEmpty() )
520  normalizedPath = libPath;
521 
522  try
523  {
524  if( saveInGlobalTable )
525  {
526  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
527  GFootprintTable.InsertRow( row );
529  }
530  else if( saveInProjectTable )
531  {
532  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
533  Prj().PcbFootprintLibs()->InsertRow( row );
534  Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
535  }
536  }
537  catch( const IO_ERROR& ioe )
538  {
539  DisplayError( this, ioe.What() );
540  return false;
541  }
542 
543  auto editor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
544 
545  if( editor )
546  {
547  LIB_ID libID( libName, wxEmptyString );
548  editor->SyncLibraryTree( true );
549  editor->FocusOnLibID( libID );
550  }
551 
552  auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
553 
554  if( viewer )
555  viewer->ReCreateLibraryList();
556 
557  return true;
558 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
FP_LIB_TABLE_ROW.
Definition: fp_lib_table.h:42
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
FP_LIB_TABLE GFootprintTable
!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it.
Component library viewer main window.
static const wxString ShowType(PCB_FILE_T aFileType)
Function ShowType returns a brief name for a plugin, given aFileType enum.
Definition: io_mgr.cpp:81
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Function GuessPluginTypeFromLibPath returns a plugin type given a footprint library's libPath.
Definition: io_mgr.cpp:128
VTBL_ENTRY KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=NULL)
Function Player returns the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:343
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
VTBL_ENTRY bool IsNullProject() const
Checks if this project is a null project (i.e.
Definition: project.cpp:136
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:286
wxString KiCadFootprintLibPathWildcard()
#define _(s)
Definition: 3d_actions.cpp:33
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
int SelectSingleOption(wxWindow *aParent, const wxString &aTitle, const wxString &aMessage, const wxArrayString &aOptions)
Displays a dialog with radioboxes asking the user to select an option.
Definition: confirm.cpp:293
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
const std::string KiCadFootprintLibPathExtension
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalizes a file path to an environmental variable, if possible.
Definition: env_paths.cpp:68
static wxString GetGlobalTableFileName()
Function GetGlobalTableFileName.

References _, DisplayError(), FRAME_FOOTPRINT_EDITOR, FRAME_FOOTPRINT_VIEWER, FP_LIB_TABLE::GetGlobalTableFileName(), GFootprintTable, IO_MGR::GuessPluginTypeFromLibPath(), LIB_TABLE::InsertRow(), PROJECT::IsNullProject(), KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), KIWAY_HOLDER::Kiway(), EDA_DRAW_FRAME::LibraryFileBrowser(), NormalizePath(), PROJECT::PcbFootprintLibs(), Pgm(), KIWAY::Player(), KIWAY_HOLDER::Prj(), LIB_TABLE::Save(), SelectSingleOption(), IO_MGR::ShowType(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::CreateNewLibrary().

◆ AddModuleToBoard()

void PCB_BASE_FRAME::AddModuleToBoard ( MODULE module)
virtualinherited

Adds the given module to the board.

Parameters
module
aDC(can be NULL ) = the current Device Context, to draw the new footprint

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 147 of file pcb_base_frame.cpp.

148 {
149  if( module )
150  {
151  GetBoard()->Add( module, ADD_MODE::APPEND );
152 
153  module->SetFlags( IS_NEW );
154  module->SetPosition( wxPoint( 0, 0 ) ); // cursor in GAL may not be initialized yet
155 
156  // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
157  // built from a board)
158  if( module->IsFlipped() )
159  module->Flip( module->GetPosition(), m_Settings->m_FlipLeftRight );
160 
161  // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
162  // it might be stored in another orientation if the lib is an archive built from a board)
163  module->SetOrientation( 0 );
164  }
165 }
bool IsFlipped() const
function IsFlipped
Definition: class_module.h:302
#define IS_NEW
New item, just created.
Definition: base_struct.h:117
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
void SetFlags(STATUS_FLAGS aMask)
Definition: base_struct.h:232
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Function Flip Flip this object, i.e.
void SetPosition(const wxPoint &aPos) override
void SetOrientation(double aNewAngle)
PCBNEW_SETTINGS * m_Settings
wxPoint GetPosition() const override
Definition: class_module.h:219
BOARD * GetBoard() const

References BOARD::Add(), APPEND, MODULE::Flip(), PCB_BASE_FRAME::GetBoard(), MODULE::GetPosition(), IS_NEW, MODULE::IsFlipped(), PCBNEW_SETTINGS::m_FlipLeftRight, PCB_BASE_FRAME::m_Settings, EDA_ITEM::SetFlags(), MODULE::SetOrientation(), and MODULE::SetPosition().

Referenced by FOOTPRINT_EDIT_FRAME::AddModuleToBoard().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 372 of file eda_base_frame.cpp.

373 {
374  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
375  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
376 
377  helpMenu->Add( ACTIONS::help );
378  helpMenu->Add( ACTIONS::gettingStarted );
379  helpMenu->Add( ACTIONS::listHotKeys );
380  helpMenu->Add( ACTIONS::getInvolved );
381  helpMenu->Add( ACTIONS::reportBug );
382 
383  helpMenu->AppendSeparator();
384  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, about_xpm );
385 
386  aMenuBar->Append( helpMenu, _( "&Help" ) );
387 }
static TOOL_ACTION listHotKeys
Definition: actions.h:175
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:43
static TOOL_ACTION reportBug
Definition: actions.h:177
const BITMAP_OPAQUE about_xpm[1]
Definition: about.cpp:84
COMMON_CONTROL.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:174
static TOOL_ACTION getInvolved
Definition: actions.h:176
static TOOL_ACTION gettingStarted
Definition: actions.h:173

References _, about_xpm, ACTIONS::getInvolved, ACTIONS::gettingStarted, TOOL_MANAGER::GetTool(), ACTIONS::help, ACTIONS::listHotKeys, TOOLS_HOLDER::m_toolManager, and ACTIONS::reportBug.

Referenced by EDA_3D_VIEWER::CreateMenuBar(), LIB_VIEW_FRAME::ReCreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), LIB_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), and ReCreateMenuBar().

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

Function CreateBasicMenu.

Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. zoom and grid)

Definition at line 430 of file eda_draw_frame.cpp.

431 {
432  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
433  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
434 
435  aMenu.AddSeparator( 1000 );
437  aMenu.AddItem( ACTIONS::zoomIn, SELECTION_CONDITIONS::ShowAlways, 1000 );
438  aMenu.AddItem( ACTIONS::zoomOut, SELECTION_CONDITIONS::ShowAlways, 1000 );
440 
441  aMenu.AddSeparator( 1000 );
442 
443  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
444  zoomMenu->SetTool( commonTools );
445  aToolMenu.AddSubMenu( zoomMenu );
446 
447  auto gridMenu = std::make_shared<GRID_MENU>( this );
448  gridMenu->SetTool( commonTools );
449  aToolMenu.AddSubMenu( gridMenu );
450 
451  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
452  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
453 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Function GetMenu.
Definition: tool_menu.cpp:46
static TOOL_ACTION zoomFitScreen
Definition: actions.h:94
COMMON_TOOLS.
Definition: common_tools.h:38
void AddSeparator(int aOrder=ANY_ORDER)
Adds a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
static TOOL_ACTION zoomCenter
Definition: actions.h:93
static TOOL_ACTION zoomIn
Definition: actions.h:89
static TOOL_ACTION zoomOut
Definition: actions.h:90

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, SELECTION_CONDITIONS::ShowAlways(), ACTIONS::zoomCenter, ACTIONS::zoomFitScreen, ACTIONS::zoomIn, and ACTIONS::zoomOut.

Referenced by PICKER_TOOL::Init(), PL_EDIT_TOOL::Init(), PL_DRAWING_TOOLS::Init(), PCB_VIEWER_TOOLS::Init(), PL_SELECTION_TOOL::Init(), EE_SELECTION_TOOL::Init(), and SELECTION_TOOL::Init().

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  textUpper,
const wxString &  textLower,
COLOR4D  color,
int  pad = 6 
)
inherited

Append a message to the message panel.

This helper method checks to make sure the message panel exists in the frame and appends a message to it using the message panel AppendMessage() method.

Parameters
textUpper- The message upper text.
textLower- The message lower text.
color- A color ID from the KiCad color list (see colors.h).
pad- Number of spaces to pad between messages (default = 4).

Definition at line 592 of file eda_draw_frame.cpp.

594 {
595  if( m_messagePanel )
596  m_messagePanel->AppendMessage( textUpper, textLower, color, pad );
597 }
int color
Definition: DXF_plotter.cpp:61
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, COLOR4D aColor, int aPad=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:110

References EDA_MSG_PANEL::AppendMessage(), color, and EDA_DRAW_FRAME::m_messagePanel.

Referenced by PCB_BASE_FRAME::Compile_Ratsnest(), LIB_EDIT_FRAME::DisplayCmpDoc(), GERBER_FILE_IMAGE::DisplayImageInfo(), SCH_EDIT_FRAME::importFile(), SCH_EDIT_FRAME::LoadSheetFromFile(), SCH_PRINTOUT::OnPrintPage(), DIALOG_SCH_SHEET_PROPS::onSheetFilenameChanged(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::SaveEEFile(), SavePcbFile(), and LIB_VIEW_FRAME::updatePreviewSymbol().

◆ ArchiveModulesOnBoard()

void PCB_EDIT_FRAME::ArchiveModulesOnBoard ( bool  aStoreInNewLib,
const wxString &  aLibName = wxEmptyString,
wxString *  aLibPath = NULL 
)

Function ArchiveModulesOnBoard Save modules in a library:

Parameters
aStoreInNewLibtrue : save modules in a existing lib. Existing footprints will be kept or updated. This lib should be in fp lib table, and is type is .pretty false: save modules in a new lib. It it is an existing lib, previous footprints will be removed
aLibNameoptional library name to create, stops dialog call. must be called with aStoreInNewLib as true

Definition at line 614 of file footprint_libraries_utils.cpp.

616 {
617  if( GetBoard()->GetFirstModule() == NULL )
618  {
619  DisplayInfoMessage( this, _( "No footprints to archive!" ) );
620  return;
621  }
622 
623  wxString footprintName;
624 
625  if( !aStoreInNewLib )
626  {
627  // The footprints are saved in an existing .pretty library in the fp lib table
628  PROJECT& prj = Prj();
629  wxString last_nickname = prj.GetRString( PROJECT::PCB_LIB_NICKNAME );
630  wxString nickname = SelectLibrary( last_nickname );
631 
632  if( !nickname ) // Aborted
633  return;
634 
635  prj.SetRString( PROJECT::PCB_LIB_NICKNAME, nickname );
636 
637  try
638  {
639  FP_LIB_TABLE* tbl = prj.PcbFootprintLibs();
640 
641  for( auto curr_fp : GetBoard()->Modules() )
642  {
643  if( !curr_fp->GetFPID().GetLibItemName().empty() ) // Can happen with old boards.
644  tbl->FootprintSave( nickname, curr_fp, false );
645  }
646  }
647  catch( const IO_ERROR& ioe )
648  {
649  DisplayError( this, ioe.What() );
650  }
651  }
652  else
653  {
654  // The footprints are saved in a new .pretty library.
655  // If this library already exists, all previous footprints will be deleted
656  wxString libPath = CreateNewLibrary( aLibName );
657 
658  if( libPath.IsEmpty() ) // Aborted
659  return;
660 
661 
662  if( aLibPath ) *aLibPath = libPath;
663 
665  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
666 
667  for( auto curr_fp : GetBoard()->Modules() )
668  {
669  try
670  {
671  if( !curr_fp->GetFPID().GetLibItemName().empty() ) // Can happen with old boards.
672  pi->FootprintSave( libPath, curr_fp );
673  }
674  catch( const IO_ERROR& ioe )
675  {
676  DisplayError( this, ioe.What() );
677  }
678  }
679  }
680 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
PROJECT holds project specific data.
Definition: project.h:61
RELEASER releases a PLUGIN in the context of a potential thrown exception, through its destructor.
Definition: io_mgr.h:580
#define NULL
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
wxString CreateNewLibrary(const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)
If a library name is given, creates a new footprint library in the project folder with the given name...
VTBL_ENTRY void SetRString(RSTRING_T aStringId, const wxString &aString)
Function SetRString stores a "retained string", which is any session and project specific string iden...
Definition: project.cpp:214
VTBL_ENTRY FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:286
VTBL_ENTRY const wxString & GetRString(RSTRING_T aStringId)
Function GetRString returns a "retained string", which is any session and project specific string ide...
Definition: project.cpp:229
#define _(s)
Definition: 3d_actions.cpp:33
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Function PluginFind returns a PLUGIN which the caller can use to import, export, save,...
Definition: io_mgr.cpp:62
wxString SelectLibrary(const wxString &aNicknameExisting)
Function SelectLibrary puts up a dialog and allows the user to pick a library, for unspecified use.
BOARD * GetBoard() const
SAVE_T FootprintSave(const wxString &aNickname, const MODULE *aFootprint, bool aOverwrite=true)
Function FootprintSave.
PCB_FILE_T
Enum PCB_FILE_T is a set of file types that the IO_MGR knows about, and for which there has been a pl...
Definition: io_mgr.h:54
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
S-expression Pcbnew file format.
Definition: io_mgr.h:57

References _, PCB_BASE_EDIT_FRAME::CreateNewLibrary(), DisplayError(), DisplayInfoMessage(), FP_LIB_TABLE::FootprintSave(), PCB_BASE_FRAME::GetBoard(), PROJECT::GetRString(), IO_MGR::KICAD_SEXP, NULL, PROJECT::PCB_LIB_NICKNAME, PROJECT::PcbFootprintLibs(), IO_MGR::PluginFind(), KIWAY_HOLDER::Prj(), PCB_BASE_FRAME::SelectLibrary(), PROJECT::SetRString(), and IO_ERROR::What().

Referenced by ArchiveModulesOnBoard(), importFile(), and Process_Special_Functions().

◆ canCloseWindow()

bool PCB_EDIT_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 822 of file pcb_edit_frame.cpp.

823 {
824  // Shutdown blocks must be determined and vetoed as early as possible
825  if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
826  && IsContentModified() )
827  {
828  return false;
829  }
830 
831  if( IsContentModified() )
832  {
833  wxFileName fileName = GetBoard()->GetFileName();
834  wxString msg = _( "Save changes to \"%s\" before closing?" );
835 
836  if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ),
837  [&]() -> bool
838  {
840  } ) )
841  {
842  return false;
843  }
844  }
845 
846  // Close modeless dialogs. They're trouble when they get destroyed after the frame and/or
847  // board.
848  wxWindow* open_dlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
849 
850  if( open_dlg )
851  open_dlg->Close( true );
852 
853  return true;
854 }
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
const wxString & GetFileName() const
Definition: class_board.h:244
bool IsContentModified() override
Get if the current board has been modified but not saved.
#define DIALOG_DRC_WINDOW_NAME
Definition: dialog_drc.h:43
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:40
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
bool Files_io_from_id(int aId)
Function Files_io_from_id Read and write board files.
BOARD * GetBoard() const

References _, DIALOG_DRC_WINDOW_NAME, Format(), GetBoard(), BOARD::GetFileName(), HandleUnsavedChanges(), ID_SAVE_BOARD, and KIPLATFORM::APP::SupportsShutdownBlockReason().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 948 of file eda_base_frame.cpp.

949 {
950  SetUserUnits( aUnits );
952 
953  wxCommandEvent e( UNITS_CHANGED );
954  ProcessEventLocally( e );
955 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

References EDA_BASE_FRAME::SetUserUnits(), and EDA_BASE_FRAME::unitsChangeRefresh().

Referenced by COMMON_TOOLS::ImperialUnits(), COMMON_TOOLS::MetricUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

void EDA_BASE_FRAME::CheckForAutoSaveFile ( const wxFileName &  aFileName)
inherited

Check if an auto save file exists for aFileName and takes the appropriate action depending on the user input.

If an auto save file exists for aFileName, the user is prompted if they wish to replace file aFileName with the auto saved file. If the user chooses to replace the file, the backup file of aFileName is removed, aFileName is renamed to the backup file name, and the auto save file is renamed to aFileName. If user chooses to keep the existing version of aFileName, the auto save file is removed.

Parameters
aFileNameA wxFileName object containing the file name to check.

Definition at line 846 of file eda_base_frame.cpp.

847 {
848  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
849 
850  wxFileName autoSaveFileName = aFileName;
851 
852  // Check for auto save file.
853  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
854 
855  wxLogTrace( traceAutoSave,
856  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
857 
858  if( !autoSaveFileName.FileExists() )
859  return;
860 
861  wxString msg = wxString::Format( _(
862  "Well this is potentially embarrassing!\n"
863  "It appears that the last time you were editing the file\n"
864  "\"%s\"\n"
865  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
866  GetChars( aFileName.GetFullName() )
867  );
868 
869  int response = wxMessageBox( msg, Pgm().App().GetAppName(), wxYES_NO | wxICON_QUESTION, this );
870 
871  // Make a backup of the current file, delete the file, and rename the auto save file to
872  // the file name.
873  if( response == wxYES )
874  {
875  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
876  {
877  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
878  Pgm().App().GetAppName(), wxOK | wxICON_EXCLAMATION, this );
879  }
880  }
881  else
882  {
883  wxLogTrace( traceAutoSave,
884  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
885 
886  // Remove the auto save file when using the previous file as is.
887  wxRemoveFile( autoSaveFileName.GetFullPath() );
888  }
889 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
static wxString GetAutoSaveFilePrefix()
static const wxChar * GetChars(const wxString &s)
Function GetChars returns a wxChar* to the actual wxChar* data within a wxString, and is helpful for ...
Definition: macros.h:153
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33

References _, Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), GetChars(), Pgm(), and traceAutoSave.

Referenced by SCH_EDIT_FRAME::OpenProjectFiles(), and OpenProjectFiles().

◆ Clear_Pcb()

bool PCB_EDIT_FRAME::Clear_Pcb ( bool  aQuery,
bool  aFinal = false 
)

Function Clear_Pcb delete all and reinitialize the current board.

Parameters
aQuery= true to prompt user for confirmation, false to initialize silently
aFinal= if true, we are clearing the board to exit, so don't run more events

Definition at line 43 of file initpcb.cpp.

44 {
45  if( GetBoard() == NULL )
46  return false;
47 
48  if( aQuery && !GetBoard()->IsEmpty() )
49  {
50  if( !IsOK( this,
51  _( "Current Board will be lost and this operation cannot be undone. Continue?" ) ) )
52  return false;
53  }
54 
55  // Release the lock file, if exists
56  ReleaseFile();
57 
58  // Clear undo and redo lists because we want a full deletion
60  GetScreen()->ClrModify();
61 
62  if( !aFinal )
63  {
64  // delete the old BOARD and create a new BOARD so that the default
65  // layer names are put into the BOARD.
66  SetBoard( new BOARD() );
67 
68  // clear filename, to avoid overwriting an old file
69  GetBoard()->SetFileName( wxEmptyString );
70 
72 
74 
75  // Enable all layers (SetCopperLayerCount() will adjust the copper layers enabled)
76  GetBoard()->SetEnabledLayers( LSET().set() );
77 
78  // Default copper layers count set to 2: double layer board
80 
81  // Update display (some options depend on the board setup)
82  GetBoard()->SetVisibleLayers( LSET().set() );
86  UpdateTitle();
87 
88  Zoom_Automatique( false );
89  }
90 
91  return true;
92 }
void UpdateTitle()
Function UpdateTitle sets the main window title bar text.
APPEARANCE_CONTROLS * m_appearancePanel
AUI panel for controlling layer and object visibility and appearance.
void SetCopperLayerCount(int aCount)
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Re create the layer Box by clearing the old list, and building le new one, from the new layers names ...
void ReleaseFile()
Release the current file marked in use.
void OnBoardChanged()
Updates the panel contents from the application and board models
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:49
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.
LSET is a set of PCB_LAYER_IDs.
void ResetNetHighLight()
Function ResetNetHighLight Reset all high light data to the init state.
#define NULL
void SetVisibleLayers(LSET aLayerMask)
Function SetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
void SetFileName(const wxString &aFileName)
Definition: class_board.h:242
void SetBoard(BOARD *aBoard) override
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
#define _(s)
Definition: 3d_actions.cpp:33
void ClrModify()
Definition: base_screen.h:101
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
BOARD * GetBoard() const
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:283
virtual void ClearUndoRedoList()
Function ClearUndoRedoList clear undo and redo list, using ClearUndoORRedoList() picked items are del...
void SetEnabledLayers(LSET aLayerMask)
Function SetEnabledLayers is a proxy function that calls the correspondent function in m_BoardSetting...
void ReCreateAuxiliaryToolbar() override

References _, EDA_BASE_FRAME::ClearUndoRedoList(), BASE_SCREEN::ClrModify(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetScreen(), BASE_SCREEN::InitDataPoints(), IsOK(), PCB_BASE_EDIT_FRAME::m_appearancePanel, NULL, APPEARANCE_CONTROLS::OnBoardChanged(), ReCreateAuxiliaryToolbar(), ReCreateLayerBox(), EDA_DRAW_FRAME::ReleaseFile(), BOARD::ResetNetHighLight(), SetBoard(), BOARD::SetCopperLayerCount(), BOARD::SetEnabledLayers(), BOARD::SetFileName(), BOARD::SetVisibleLayers(), UpdateTitle(), and EDA_DRAW_FRAME::Zoom_Automatique().

Referenced by Files_io_from_id(), and OpenProjectFiles().

◆ ClearFileHistory()

void EDA_BASE_FRAME::ClearFileHistory ( FILE_HISTORY aFileHistory = nullptr)
inherited

Removes all files from the file history.

Parameters
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used

Definition at line 743 of file eda_base_frame.cpp.

744 {
745  if( !aFileHistory )
746  aFileHistory = m_fileHistory;
747 
748  wxASSERT( aFileHistory );
749 
750  aFileHistory->ClearFileHistory();
751 
752  // Update the menubar to update the file history menu
753  if( GetMenuBar() )
754  {
755  ReCreateMenuBar();
756  GetMenuBar()->Refresh();
757  }
758 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References FILE_HISTORY::ClearFileHistory(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnClearDrlFileHistory(), KICAD_MANAGER_FRAME::OnClearFileHistory(), PL_EDITOR_FRAME::OnClearFileHistory(), OnClearFileHistory(), SCH_EDIT_FRAME::OnClearFileHistory(), GERBVIEW_FRAME::OnClearGbrFileHistory(), GERBVIEW_FRAME::OnClearJobFileHistory(), and GERBVIEW_FRAME::OnClearZipFileHistory().

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

void PCB_BASE_EDIT_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  whichList,
int  aItemCount = -1 
)
overridevirtualinherited

Function ClearUndoORRedoList free the undo or redo list from List element Wrappers are deleted.

datas pointed by wrappers are deleted if not in use in schematic i.e. when they are copy of a schematic item or they are no more in use (DELETED)

Parameters
whichList= the UNDO_REDO_CONTAINER to clear
aItemCount= the count of items to remove. < 0 for all items items are removed from the beginning of the list. So this function can be called to remove old commands

Reimplemented from EDA_BASE_FRAME.

Definition at line 598 of file undo_redo.cpp.

599 {
600  if( aItemCount == 0 )
601  return;
602 
603  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
604  unsigned icnt = list.m_CommandsList.size();
605 
606  if( aItemCount > 0 )
607  icnt = aItemCount;
608 
609  for( unsigned ii = 0; ii < icnt; ii++ )
610  {
611  if( list.m_CommandsList.size() == 0 )
612  break;
613 
614  PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
615  list.m_CommandsList.erase( list.m_CommandsList.begin() );
616 
617  curr_cmd->ClearListAndDeleteItems();
618  delete curr_cmd; // Delete command
619  }
620 }
UNDO_REDO_CONTAINER m_undoList
UNDO_REDO_CONTAINER is a holder to handle alist of undo (or redo) command.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
PICKED_ITEMS_LIST is a holder to handle information on schematic or board items.
UNDO_REDO_CONTAINER m_redoList
void ClearListAndDeleteItems()
Function ClearListAndDeleteItems deletes the list of pickers, AND the data pointed by m_PickedItem or...

References PICKED_ITEMS_LIST::ClearListAndDeleteItems(), and UNDO_REDO_CONTAINER::m_CommandsList.

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

void PCB_EDIT_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overridevirtual

Called after the preferences dialog is run.

Reimplemented from PCB_BASE_FRAME.

Definition at line 1598 of file pcb_edit_frame.cpp.

1599 {
1600  PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1601 
1604 
1605  if( aTextVarsChanged )
1607 
1608  // Update the environment variables in the Python interpreter
1609  if( aEnvVarsChanged )
1611 
1612  Layout();
1613  SendSizeEvent();
1614 }
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void UpdateAllItems(int aUpdateFlags)
Updates all items in the view according to the given flags.
Definition: view.cpp:1435
Item needs to be redrawn.
Definition: view_item.h:63
void PythonSyncEnvironmentVariables()
Synchronize the environment variables from KiCad's environment into the Python interpreter.
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
APPEARANCE_CONTROLS * GetAppearancePanel()
void OnColorThemeChanged()
Updates the colors on all the widgets from the new chosen color theme

References KIGFX::ALL, and PCB_BASE_FRAME::CommonSettingsChanged().

◆ Compile_Ratsnest()

void PCB_BASE_FRAME::Compile_Ratsnest ( bool  aDisplayStatus)
inherited

Function Compile_Ratsnest Create the entire board ratsnest.

Must be called after a board change (changes for pads, footprints or a read netlist ).

Parameters
aDC= the current device context (can be NULL)
aDisplayStatus: if true, display the computation results

Definition at line 44 of file pcbnew/ratsnest/ratsnest.cpp.

45 {
46  GetBoard()->GetConnectivity()->RecalculateRatsnest();
47  ClearMsgPanel();
48 
49  if( aDisplayStatus )
50  {
51  std::shared_ptr<CONNECTIVITY_DATA> conn = m_Pcb->GetConnectivity();
52  wxString msg;
53 
54  msg.Printf( wxT( " %d" ), conn->GetPadCount() );
55  AppendMsgPanel( _( "Pads" ), msg, RED );
56 
57  msg.Printf( wxT( " %d" ), conn->GetNetCount() - 1 /* Don't include "No Net" in count */ );
58  AppendMsgPanel( _( "Nets" ), msg, CYAN );
59 
60  SetMsgPanel( m_Pcb );
61  }
62 }
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:345
Definition: color4d.h:58
virtual void ClearMsgPanel()
Clear all messages from the message panel.
Definition: color4d.h:59
void AppendMsgPanel(const wxString &textUpper, const wxString &textLower, COLOR4D color, int pad=6)
Append a message to the message panel.
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const

References _, EDA_DRAW_FRAME::AppendMsgPanel(), EDA_DRAW_FRAME::ClearMsgPanel(), CYAN, PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), PCB_BASE_FRAME::m_Pcb, RED, and EDA_DRAW_FRAME::SetMsgPanel().

Referenced by DIALOG_GLOBAL_DELETION::AcceptPcbDelete(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), ExportToGenCAD(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), OpenProjectFiles(), PCBNEW_CONTROL::Paste(), and PANEL_SETUP_LAYERS::TransferDataFromWindow().

◆ config()

APP_SETTINGS_BASE * EDA_BASE_FRAME::config ( ) const
virtualinherited

Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 642 of file eda_base_frame.cpp.

643 {
644  // KICAD_MANAGER_FRAME overrides this
645  return Kiface().KifaceSettings();
646 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:103
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

References Kiface(), and KIFACE_I::KifaceSettings().

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), GERBVIEW_FRAME::ActivateGalCanvas(), BM2CMP_FRAME::BM2CMP_FRAME(), CVPCB_MAINFRAME::CVPCB_MAINFRAME(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_GRID_SETTINGS::DIALOG_GRID_SETTINGS(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), SIM_PLOT_FRAME::doCloseWindow(), SCH_BASE_FRAME::eeconfig(), FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME(), GERBVIEW_FRAME::GERBVIEW_FRAME(), DISPLAY_FOOTPRINTS_FRAME::GetAutoZoom(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), LIB_VIEW_FRAME::LIB_VIEW_FRAME(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupTools(), LIB_VIEW_FRAME::setupTools(), GERBVIEW_FRAME::setupTools(), LIB_EDIT_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), ZOOM_MENU::ZOOM_MENU(), and BM2CMP_FRAME::~BM2CMP_FRAME().

◆ ConfigBaseName()

wxString EDA_BASE_FRAME::ConfigBaseName ( )
inlineoverridevirtualinherited
Returns
a base name prefix used in Load/Save settings to build the full name of keys used in config. This is usually the name of the frame set by CTOR, except for frames shown in multiple modes in which case the m_configName must be set to the base name so that a single config can be used.

Reimplemented from TOOLS_HOLDER.

Definition at line 423 of file eda_base_frame.h.

424  {
425  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
426  return baseCfgName;
427  }
wxString m_configName

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER * PCB_BASE_FRAME::CreateAndShow3D_Frame ( )
inherited

Shows the 3D view frame.

If it does not exist, it is created. If it exists, it is bring to the foreground

Definition at line 411 of file pcb_base_frame.cpp.

412 {
413  EDA_3D_VIEWER* draw3DFrame = Get3DViewerFrame();
414 
415  if( !draw3DFrame )
416  draw3DFrame = new EDA_3D_VIEWER( &Kiway(), this, _( "3D Viewer" ) );
417 
418  // Raising the window does not show the window on Windows if iconized. This should work
419  // on any platform.
420  if( draw3DFrame->IsIconized() )
421  draw3DFrame->Iconize( false );
422 
423  draw3DFrame->Raise();
424  draw3DFrame->Show( true );
425 
426  // Raising the window does not set the focus on Linux. This should work on any platform.
427  if( wxWindow::FindFocus() != draw3DFrame )
428  draw3DFrame->SetFocus();
429 
430  return draw3DFrame;
431 }
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
#define _(s)
Definition: 3d_actions.cpp:33
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
Definition: eda_3d_viewer.h:65
EDA_3D_VIEWER * Get3DViewerFrame()

References _, PCB_BASE_FRAME::Get3DViewerFrame(), and KIWAY_HOLDER::Kiway().

Referenced by PCB_VIEWER_TOOLS::Show3DViewer().

◆ CreateNewLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewLibrary ( const wxString &  aLibName = wxEmptyString,
const wxString &  aProposedName = wxEmptyString 
)
inherited

If a library name is given, creates a new footprint library in the project folder with the given name.

If no library name is given it prompts user for a library path, then creates a new footprint library at that location. If library exists, user is warned about that, and is given a chance to abort the new creation, and in that case existing library is first deleted.

Parameters
aProposedNameis the inital path and filename shown in the file chooser dialog
Returns
wxString - the newly created library path if library was successfully created, else wxEmptyString because user aborted or error.

Definition at line 378 of file footprint_libraries_utils.cpp.

380 {
381  // Kicad cannot write legacy format libraries, only .pretty new format
382  // because the legacy format cannot handle current features.
383  // The footprint library is actually a directory
384 
385  wxString initialPath = aProposedName.IsEmpty() ? Prj().GetProjectPath() : aProposedName;
386  wxFileName fn;
387  bool doAdd = false;
388 
389  if( aLibName.IsEmpty() )
390  {
391  fn = initialPath;
392 
393  if( !LibraryFileBrowser( false, fn,
395  {
396  return wxEmptyString;
397  }
398 
399  doAdd = true;
400  }
401  else
402  {
403  fn = aLibName;
404 
405  if( !fn.IsAbsolute() )
406  {
407  fn.SetName( aLibName );
408  fn.MakeAbsolute( initialPath );
409  }
410 
411  // Enforce the .pretty extension:
412  fn.SetExt( KiCadFootprintLibPathExtension );
413  }
414 
415  // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
417  wxString libPath = fn.GetFullPath();
418 
419  try
420  {
421  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
422 
423  bool writable = false;
424  bool exists = false;
425 
426  try
427  {
428  writable = pi->IsFootprintLibWritable( libPath );
429  exists = true; // no exception was thrown, lib must exist.
430  }
431  catch( const IO_ERROR& )
432  { }
433 
434  if( exists )
435  {
436  if( !writable )
437  {
438  wxString msg = wxString::Format( _( "Library \"%s\" is read only." ), libPath );
439  ShowInfoBarError( msg );
440  return wxEmptyString;
441  }
442  else
443  {
444  wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
445  KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
446  dlg.SetOKLabel( _( "Overwrite" ) );
447  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
448 
449  if( dlg.ShowModal() == wxID_CANCEL )
450  return wxEmptyString;
451 
452  pi->FootprintLibDelete( libPath );
453  }
454  }
455 
456  pi->FootprintLibCreate( libPath );
457  }
458  catch( const IO_ERROR& ioe )
459  {
460  DisplayError( this, ioe.What() );
461  return wxEmptyString;
462  }
463 
464  if( doAdd )
465  AddLibrary( libPath );
466 
467  return libPath;
468 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:44
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:124
RELEASER releases a PLUGIN in the context of a potential thrown exception, through its destructor.
Definition: io_mgr.h:580
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool AddLibrary(const wxString &aLibName=wxEmptyString)
Function AddLibrary Add an existing library to either the global or project library table.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false)
void ShowInfoBarError(const wxString &aErrorMsg)
wxString KiCadFootprintLibPathWildcard()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Function PluginFind returns a PLUGIN which the caller can use to import, export, save,...
Definition: io_mgr.cpp:62
PCB_FILE_T
Enum PCB_FILE_T is a set of file types that the IO_MGR knows about, and for which there has been a pl...
Definition: io_mgr.h:54
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76
const std::string KiCadFootprintLibPathExtension
S-expression Pcbnew file format.
Definition: io_mgr.h:57

References _, PCB_BASE_EDIT_FRAME::AddLibrary(), DisplayError(), KIDIALOG::DoNotShowCheckbox(), Format(), PROJECT::GetProjectPath(), IO_MGR::KICAD_SEXP, KiCadFootprintLibPathExtension, KiCadFootprintLibPathWildcard(), EDA_DRAW_FRAME::LibraryFileBrowser(), IO_MGR::PluginFind(), KIWAY_HOLDER::Prj(), EDA_BASE_FRAME::ShowInfoBarError(), KIDIALOG::ShowModal(), and IO_ERROR::What().

Referenced by ArchiveModulesOnBoard().

◆ CreateNewModule()

MODULE * PCB_BASE_FRAME::CreateNewModule ( const wxString &  aModuleName)
inherited

Function CreateNewModule Creates a new module or footprint, at position 0,0 The new module contains only 2 texts: a reference and a value: Reference = REF** Value = "VAL**" or Footprint name in lib Note: they are dummy texts, which will be replaced by the actual texts when the fooprint is placed on a board and a netlist is read.

Parameters
aModuleName= name of the new footprint in library
Returns
a reference to the new module

Definition at line 1003 of file footprint_libraries_utils.cpp.

1004 {
1005  wxString moduleName = aModuleName;
1006 
1007  // Ask for the new module name
1008  if( moduleName.IsEmpty() )
1009  {
1010  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
1011  moduleName );
1012  dlg.SetTextValidator( MODULE_NAME_CHAR_VALIDATOR( &moduleName ) );
1013 
1014  if( dlg.ShowModal() != wxID_OK )
1015  return NULL; //Aborted by user
1016  }
1017 
1018  moduleName.Trim( true );
1019  moduleName.Trim( false );
1020 
1021  if( moduleName.IsEmpty() )
1022  {
1023  DisplayInfoMessage( this, _( "No footprint name defined." ) );
1024  return NULL;
1025  }
1026 
1027  // Creates the new module and add it to the head of the linked list of modules
1028  MODULE* module = new MODULE( GetBoard() );
1029 
1030  // Update parameters: timestamp ...
1031  module->SetLastEditTime();
1032 
1033  // Update its name in lib
1034  module->SetFPID( LIB_ID( wxEmptyString, moduleName ) );
1035 
1036  PCB_LAYER_ID txt_layer;
1037  wxPoint default_pos;
1039 
1040  module->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
1041  module->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
1042  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
1043  module->Reference().SetLayer( txt_layer );
1044  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
1045  module->Reference().SetPosition( default_pos );
1046  default_pos.y += settings.GetTextSize( txt_layer ).y;
1047 
1048  module->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
1049  module->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
1050  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
1051  module->Value().SetLayer( txt_layer );
1052  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1053  module->Value().SetPosition( default_pos );
1054  default_pos.y += settings.GetTextSize( txt_layer ).y;
1055 
1056  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
1057  {
1058  TEXTE_MODULE* textItem = new TEXTE_MODULE( module );
1059  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
1060  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
1061  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
1062  textItem->SetLayer( txt_layer );
1063  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1064  textItem->SetPosition( default_pos );
1065  default_pos.y += settings.GetTextSize( txt_layer ).y;
1066  module->GraphicalItems().push_back( textItem );
1067  }
1068 
1069  if( module->GetReference().IsEmpty() )
1070  module->SetReference( moduleName );
1071 
1072  if( module->GetValue().IsEmpty() )
1073  module->SetValue( moduleName );
1074 
1075  module->RunOnChildren(
1076  [&] ( BOARD_ITEM* aChild )
1077  {
1078  if( aChild->Type() == PCB_MODULE_TEXT_T )
1079  {
1080  TEXTE_MODULE* textItem = static_cast<TEXTE_MODULE*>( aChild );
1081  PCB_LAYER_ID layer = textItem->GetLayer();
1082 
1083  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
1084  textItem->SetTextSize( settings.GetTextSize( layer ) );
1085  textItem->SetItalic( settings.GetTextItalic( layer ) );
1086  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
1087  }
1088  } );
1089 
1090  SetMsgPanel( module );
1091  return module;
1092 }
void SetKeepUpright(bool aKeepUpright)
TEXTE_MODULE & Reference()
Definition: class_module.h:492
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project Overloaded in FOOTPRINT_EDIT_FRAME.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction)
Function RunOnChildren.
virtual void SetLayer(PCB_LAYER_ID aLayer)
Function SetLayer sets the layer this item is on.
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
void SetItalic(bool isItalic)
Definition: eda_text.h:179
void SetVisible(bool aVisible)
Definition: eda_text.h:185
const wxString GetValue() const
Function GetValue.
Definition: class_module.h:476
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:238
DRAWINGS & GraphicalItems()
Definition: class_module.h:191
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int GetTextThickness(PCB_LAYER_ID aLayer) const
Function GetTextThickness Returns the default text thickness from the layer class for the given layer...
const wxString GetReference() const
Function GetReference.
Definition: class_module.h:451
bool GetTextUpright(PCB_LAYER_ID aLayer) const
bool GetTextItalic(PCB_LAYER_ID aLayer) const
PCB_LAYER_ID
A quick note on layer IDs:
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:121
#define NULL
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:491
void SetLastEditTime(timestamp_t aTime)
Definition: class_module.h:357
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
void SetReference(const wxString &aReference)
Function SetReference.
Definition: class_module.h:461
virtual void SetPosition(const wxPoint &aPos) override
class TEXTE_MODULE, text in a footprint
Definition: typeinfo.h:93
#define _(s)
Definition: 3d_actions.cpp:33
void SetValue(const wxString &aValue)
Function SetValue.
Definition: class_module.h:485
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:158
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
void SetFPID(const LIB_ID &aFPID)
Definition: class_module.h:229
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Function GetTextSize Returns the default text size from the layer class for the given layer.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193
BOARD_DESIGN_SETTINGS contains design settings for a BOARD object.

References _, DisplayInfoMessage(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetDesignSettings(), BOARD_ITEM::GetLayer(), MODULE::GetReference(), BOARD_DESIGN_SETTINGS::GetTextItalic(), BOARD_DESIGN_SETTINGS::GetTextSize(), BOARD_DESIGN_SETTINGS::GetTextThickness(), BOARD_DESIGN_SETTINGS::GetTextUpright(), MODULE::GetValue(), MODULE::GraphicalItems(), BOARD_DESIGN_SETTINGS::m_DefaultFPTextItems, NULL, PCB_MODULE_TEXT_T, MODULE::Reference(), MODULE::RunOnChildren(), MODULE::SetFPID(), EDA_TEXT::SetItalic(), TEXTE_MODULE::SetKeepUpright(), MODULE::SetLastEditTime(), BOARD_ITEM::SetLayer(), EDA_DRAW_FRAME::SetMsgPanel(), TEXTE_MODULE::SetPosition(), MODULE::SetReference(), EDA_TEXT::SetText(), EDA_TEXT::SetTextSize(), EDA_TEXT::SetTextThickness(), WX_TEXT_ENTRY_DIALOG::SetTextValidator(), MODULE::SetValue(), EDA_TEXT::SetVisible(), EDA_ITEM::Type(), MODULE::Value(), and wxPoint::y.

Referenced by MICROWAVE_TOOL::createBaseFootprint(), and MICROWAVE_TOOL::createMicrowaveInductor().

◆ CreateServer()

void EDA_DRAW_FRAME::CreateServer ( int  service,
bool  local = true 
)
inherited

Definition at line 49 of file eda_dde.cpp.

50 {
51  wxIPV4address addr;
52 
53  // Set the port number
54  addr.Service( service );
55 
56  // Listen on localhost only if requested
57  if( local )
58  addr.Hostname( HOSTNAME );
59 
60  delete m_socketServer;
61  m_socketServer = new wxSocketServer( addr );
62 
63  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
64  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
65  m_socketServer->Notify( true );
66 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer

References HOSTNAME(), ID_EDA_SOCKET_EVENT_SERV, and EDA_DRAW_FRAME::m_socketServer.

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const
inherited

Definition at line 99 of file tools_holder.cpp.

100 {
101  if( m_toolStack.empty() )
102  return ACTIONS::selectionTool.GetName();
103  else
104  return m_toolStack.back();
105 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:56
static TOOL_ACTION selectionTool
Definition: actions.h:149

References TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by TOOL_MANAGER::processEvent().

◆ Destroy()

◆ DismissModal()

void KIWAY_PLAYER::DismissModal ( bool  aRetVal,
const wxString &  aResult = wxEmptyString 
)
inherited

Definition at line 161 of file kiway_player.cpp.

162 {
163  m_modal_ret_val = aRetVal;
164  m_modal_string = aResult;
165 
166  if( m_modal_loop )
167  {
168  m_modal_loop->Exit();
169  m_modal_loop = 0; // this marks it as dismissed.
170  }
171 
172  Show( false );
173 }
bool m_modal_ret_val
Definition: kiway_player.h:205
wxString m_modal_string
Definition: kiway_player.h:204
WX_EVENT_LOOP * m_modal_loop
Definition: kiway_player.h:202

References KIWAY_PLAYER::m_modal_loop, KIWAY_PLAYER::m_modal_ret_val, and KIWAY_PLAYER::m_modal_string.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), FOOTPRINT_VIEWER_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::doCloseWindow(), FOOTPRINT_WIZARD_FRAME::ExportSelectedFootprint(), LIB_VIEW_FRAME::FinishModal(), and LIB_VIEW_FRAME::OnCloseWindow().

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )
overridevirtualinherited

Function DisplayGridMsg()

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 505 of file pcb_base_frame.cpp.

506 {
507  wxString line;
508  wxString gridformatter;
509 
510  switch( m_userUnits )
511  {
512  case EDA_UNITS::INCHES: gridformatter = "grid X %.6f Y %.6f"; break;
513  case EDA_UNITS::MILLIMETRES: gridformatter = "grid X %.6f Y %.6f"; break;
514  default: gridformatter = "grid X %f Y %f"; break;
515  }
516 
517  double grid_x = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x );
518  double grid_y = To_User_Unit( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y );
519  line.Printf( gridformatter, grid_x, grid_y );
520 
521  SetStatusText( line, 4 );
522 }
double To_User_Unit(EDA_UNITS aUnit, double aValue, bool aUseMils)
Function To_User_Unit convert aValue in internal units to the appropriate user units defined by aUnit...
Definition: base_units.cpp:92
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS m_userUnits

References PCB_BASE_FRAME::GetCanvas(), INCHES, EDA_BASE_FRAME::m_userUnits, MILLIMETRES, and To_User_Unit().

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

void EDA_DRAW_FRAME::DisplayToolMsg ( const wxString &  msg)
overridevirtualinherited

Reimplemented from TOOLS_HOLDER.

Definition at line 465 of file eda_draw_frame.cpp.

466 {
467  SetStatusText( msg, 6 );
468 }

Referenced by EDIT_TOOL::Duplicate(), and PCBNEW_CONTROL::Paste().

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 493 of file eda_draw_frame.cpp.

494 {
495  wxString msg;
496 
497  switch( m_userUnits )
498  {
499  case EDA_UNITS::INCHES: msg = _( "Inches" ); break;
500  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
501  default: msg = _( "Units" ); break;
502  }
503 
504  SetStatusText( msg, 5 );
505 }
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits

References _, INCHES, EDA_BASE_FRAME::m_userUnits, and MILLIMETRES.

Referenced by EDA_DRAW_FRAME::UpdateGridSelectBox(), SCH_BASE_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ doAutoSave()

bool PCB_EDIT_FRAME::doAutoSave ( )
overrideprotectedvirtual

Function doAutoSave performs auto save when the board has been modified and not saved within the auto save interval.

Returns
true if the auto save was successful.

Reimplemented from EDA_BASE_FRAME.

Definition at line 952 of file pcbnew/files.cpp.

953 {
954  wxFileName tmpFileName;
955 
956  if( GetBoard()->GetFileName().IsEmpty() )
957  {
958  tmpFileName = wxFileName( wxStandardPaths::Get().GetDocumentsDir(), wxT( "noname" ),
960  GetBoard()->SetFileName( tmpFileName.GetFullPath() );
961  }
962  else
963  {
964  tmpFileName = Prj().AbsolutePath( GetBoard()->GetFileName() );
965  }
966 
967  wxFileName autoSaveFileName = tmpFileName;
968 
969  // Auto save file name is the board file name prepended with autosaveFilePrefix string.
970  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + autoSaveFileName.GetName() );
971 
972  if( !autoSaveFileName.IsOk() )
973  return false;
974 
975  // If the board file path is not writable, try writing to a platform specific temp file
976  // path. If that path isn't writabe, give up.
977  if( !autoSaveFileName.IsDirWritable() )
978  {
979  autoSaveFileName.SetPath( wxFileName::GetTempDir() );
980 
981  if( !autoSaveFileName.IsOk() || !autoSaveFileName.IsDirWritable() )
982  return false;
983  }
984 
985  wxLogTrace( traceAutoSave, "Creating auto save file <" + autoSaveFileName.GetFullPath() + ">" );
986 
987  if( SavePcbFile( autoSaveFileName.GetFullPath(), false, false ) )
988  {
989  GetScreen()->SetModify();
990  GetBoard()->SetFileName( tmpFileName.GetFullPath() );
991  UpdateTitle();
992  m_autoSaveState = false;
993 
994  if( !Kiface().IsSingle() &&
995  GetSettingsManager()->GetCommonSettings()->m_Backup.backup_on_autosave )
996  {
998  }
999 
1000  return true;
1001  }
1002 
1003  GetBoard()->SetFileName( tmpFileName.GetFullPath() );
1004 
1005  return false;
1006 }
void UpdateTitle()
Function UpdateTitle sets the main window title bar text.
SETTINGS_MANAGER * GetSettingsManager() const
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
const std::string KiCadPcbFileExtension
VTBL_ENTRY const wxString AbsolutePath(const wxString &aFileName) const
Function AbsolutePath fixes up aFileName if it is relative to the project's directory to be an absolu...
Definition: project.cpp:272
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void SetFileName(const wxString &aFileName)
Definition: class_board.h:242
static wxString GetAutoSaveFilePrefix()
bool SavePcbFile(const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
Function SavePcbFile writes the board data structures to a aFileName Creates backup when requested an...
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
static REPORTER & GetInstance()
Definition: reporter.cpp:105
BOARD * GetBoard() const
void SetModify()
Definition: base_screen.h:100

References PROJECT::AbsolutePath(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), PCB_BASE_FRAME::GetBoard(), NULL_REPORTER::GetInstance(), PCB_BASE_FRAME::GetScreen(), EDA_BASE_FRAME::GetSettingsManager(), KiCadPcbFileExtension, Kiface(), EDA_BASE_FRAME::m_autoSaveState, KIWAY_HOLDER::Prj(), SavePcbFile(), BOARD::SetFileName(), BASE_SCREEN::SetModify(), traceAutoSave, SETTINGS_MANAGER::TriggerBackupIfNeeded(), and UpdateTitle().

Referenced by OnExportSTEP().

◆ doCloseWindow()

void PCB_EDIT_FRAME::doCloseWindow ( )
overrideprotectedvirtual

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 856 of file pcb_edit_frame.cpp.

857 {
858  // On Windows 7 / 32 bits, on OpenGL mode only, Pcbnew crashes
859  // when closing this frame if a footprint was selected, and the footprint editor called
860  // to edit this footprint, and when closing pcbnew if this footprint is still selected
861  // See https://bugs.launchpad.net/kicad/+bug/1655858
862  // I think this is certainly a OpenGL event fired after frame deletion, so this workaround
863  // avoid the crash (JPC)
864  GetCanvas()->SetEvtHandlerEnabled( false );
865 
866  GetCanvas()->StopDrawing();
867 
868  // Delete the auto save file if it exists.
869  wxFileName fn = GetBoard()->GetFileName();
870 
871  // Auto save file name is the normal file name prefixed with 'GetAutoSaveFilePrefix()'.
872  fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
873 
874  // When the auto save feature does not have write access to the board file path, it falls
875  // back to a platform specific user temporary file path.
876  if( !fn.IsOk() || !fn.IsDirWritable() )
877  fn.SetPath( wxFileName::GetTempDir() );
878 
879  wxLogTrace( traceAutoSave, "Deleting auto save file <" + fn.GetFullPath() + ">" );
880 
881  // Remove the auto save file on a normal close of Pcbnew.
882  if( fn.FileExists() && !wxRemoveFile( fn.GetFullPath() ) )
883  {
884  wxString msg = wxString::Format( _( "The auto save file \"%s\" could not be removed!" ),
885  fn.GetFullPath() );
886  wxMessageBox( msg, Pgm().App().GetAppName(), wxOK | wxICON_ERROR, this );
887  }
888 
889  // Make sure local settings are persisted
891 
892  // Do not show the layer manager during closing to avoid flicker
893  // on some platforms (Windows) that generate useless redraw of items in
894  // the Layer Manger
896  m_auimgr.GetPane( "LayersManager" ).Show( false );
897 
898  // Unlink the old project if needed
899  GetBoard()->ClearProject();
900 
901  // Delete board structs and undo/redo lists, to avoid crash on exit
902  // when deleting some structs (mainly in undo/redo lists) too late
903  Clear_Pcb( false, true );
904 
905  // do not show the window because ScreenPcb will be deleted and we do not
906  // want any paint event
907  Show( false );
908 
910 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:104
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
wxAuiManager m_auimgr
const wxString & GetFileName() const
Definition: class_board.h:244
void doCloseWindow() override
bool m_show_layer_manager_tools
void SaveProjectSettings() override
Function SaveProjectSettings saves changes to the project settings to the project (....
void ClearProject()
static wxString GetAutoSaveFilePrefix()
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const
bool Clear_Pcb(bool aQuery, bool aFinal=false)
Function Clear_Pcb delete all and reinitialize the current board.
Definition: initpcb.cpp:43
void StopDrawing()
Function StopDrawing() Prevents the GAL canvas from further drawing till it is recreated or StartDraw...

References _, BOARD::ClearProject(), PCB_BASE_EDIT_FRAME::doCloseWindow(), Format(), GetBoard(), BOARD::GetFileName(), Pgm(), and traceAutoSave.

◆ DoGenFootprintsPositionFile()

int PCB_EDIT_FRAME::DoGenFootprintsPositionFile ( const wxString &  aFullFileName,
bool  aUnitsMM,
bool  aForceSmdItems,
bool  aTopSide,
bool  aBottomSide,
bool  aFormatCSV = false 
)

Function DoGenFootprintsPositionFile Creates an ascii footprint position file.

Parameters
aFullFileName= the full file name of the file to create
aUnitsMM= false to use inches, true to use mm in coordinates
aForceSmdItems= true to force all footprints with smd pads in list = false to put only footprints with option "INSERT" in list
aTopSidetrue to list footprints on front (top) side,
aBottomSidetrue to list footprints on back (bottom) side, if aTopSide and aTopSide are true, list footprints on both sides
aFormatCSV= true to use a comma separated file (CSV) format; defautl = false
Returns
the number of footprints found on aSide side, or -1 if the file could not be created

Definition at line 469 of file gen_footprints_placefile.cpp.

472 {
473  FILE * file = NULL;
474 
475  if( !aFullFileName.IsEmpty() )
476  {
477  file = wxFopen( aFullFileName, wxT( "wt" ) );
478 
479  if( file == NULL )
480  return -1;
481  }
482 
483  std::string data;
484  PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, aForceSmdItems, aTopSide, aBottomSide,
485  aFormatCSV );
486  data = exporter.GenPositionData();
487 
488  // if aFullFileName is empty, the file is not created, only the
489  // count of footprints to place is returned
490  if( file )
491  {
492  // Creates a footprint position file
493  // aSide = 0 -> Back (bottom) side)
494  // aSide = 1 -> Front (top) side)
495  // aSide = 2 -> both sides
496  fputs( data.c_str(), file );
497  fclose( file );
498  }
499 
500  return exporter.GetFootprintCount();
501 }
#define NULL
The ASCII format of the kicad place file is:
BOARD * GetBoard() const

References PLACE_FILE_EXPORTER::GenPositionData(), PCB_BASE_FRAME::GetBoard(), PLACE_FILE_EXPORTER::GetFootprintCount(), and NULL.

Referenced by DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles().

◆ DoGenFootprintsReport()

bool PCB_EDIT_FRAME::DoGenFootprintsReport ( const wxString &  aFullFilename,
bool  aUnitsMM 
)

Function DoGenFootprintsReport Creates an ascii footprint report file giving some infos on footprints and board outlines.

Parameters
aFullFilename= the full file name of the file to create
aUnitsMM= false to use inches, true to use mm in coordinates
Returns
true if OK, false if error

Definition at line 537 of file gen_footprints_placefile.cpp.

538 {
539  FILE* rptfile = wxFopen( aFullFilename, wxT( "wt" ) );
540 
541  if( rptfile == NULL )
542  return false;
543 
544  std::string data;
545  PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, false, true, true, false );
546  data = exporter.GenReportData();
547 
548  fputs( data.c_str(), rptfile );
549  fclose( rptfile );
550 
551  return true;
552 }
#define NULL
The ASCII format of the kicad place file is:
BOARD * GetBoard() const

References PLACE_FILE_EXPORTER::GenReportData(), PCB_BASE_FRAME::GetBoard(), and NULL.

Referenced by GenFootprintsReport().

◆ DoUpdatePCBFromNetlist()

void PCB_EDIT_FRAME::DoUpdatePCBFromNetlist ( NETLIST aNetlist,
bool  aUseTimestamps 
)

Function DoUpdatePCBFromNetlist An automated version of UpdatePCBFromNetlist which skips the UI dialog.

Parameters
aNetlist
aUseTimestamps

Definition at line 1395 of file pcb_edit_frame.cpp.

1396 {
1397  BOARD_NETLIST_UPDATER updater( this, GetBoard() );
1398  updater.SetLookupByTimestamp( aUseTimestamps );
1399  updater.SetDeleteUnusedComponents( false );
1400  updater.SetReplaceFootprints( true );
1401  updater.SetDeleteSinglePadNets( false );
1402  updater.SetWarnPadNoNetInNetlist( false );
1403  updater.UpdateNetlist( aNetlist );
1404 }
BOARD_NETLIST_UPDATER updates the BOARD with a new netlist.
BOARD * GetBoard() const

References GetBoard(), BOARD_NETLIST_UPDATER::SetDeleteSinglePadNets(), BOARD_NETLIST_UPDATER::SetDeleteUnusedComponents(), BOARD_NETLIST_UPDATER::SetLookupByTimestamp(), BOARD_NETLIST_UPDATER::SetReplaceFootprints(), BOARD_NETLIST_UPDATER::SetWarnPadNoNetInNetlist(), and BOARD_NETLIST_UPDATER::UpdateNetlist().

Referenced by importFile().

◆ Edit_Zone_Params()

void PCB_EDIT_FRAME::Edit_Zone_Params ( ZONE_CONTAINER zone_container)

Function Edit_Zone_Params Edit params (layer, clearance, ...) for a zone outline.

Definition at line 47 of file zones_by_polygon.cpp.

48 {
49  int dialogResult;
50  ZONE_SETTINGS zoneInfo = GetZoneSettings();
51 
52  BOARD_COMMIT commit( this );
53 
54  // Save initial zones configuration, for undo/redo, before adding new zone
55  // note the net name and the layer can be changed, so we must save all zones
59 
60  if( aZone->GetIsRuleArea() )
61  {
62  // edit a rule area on a copper layer
63  zoneInfo << *aZone;
64  dialogResult = InvokeRuleAreaEditor( this, &zoneInfo );
65  }
66  else if( IsCopperLayer( aZone->GetLayer() ) )
67  {
68  // edit a zone on a copper layer
69  zoneInfo << *aZone;
70  dialogResult = InvokeCopperZonesEditor( this, &zoneInfo );
71  }
72  else
73  {
74  zoneInfo << *aZone;
75  dialogResult = InvokeNonCopperZonesEditor( this, &zoneInfo );
76  }
77 
78  if( dialogResult == wxID_CANCEL )
79  {
82  return;
83  }
84 
85  SetZoneSettings( zoneInfo );
86  OnModify();
87 
88  if( dialogResult == ZONE_EXPORT_VALUES )
89  {
91  commit.Stage( s_PickedList );
92  commit.Push( _( "Modify zone properties" ) );
93  s_PickedList.ClearItemsList(); // s_ItemsListPicker is no more owner of picked items
94  return;
95  }
96 
97  wxBusyCursor dummy;
98 
99  // Undraw old zone outlines
100  for( ZONE_CONTAINER* zone : GetBoard()->Zones() )
101  GetCanvas()->GetView()->Update( zone );
102 
103  zoneInfo.ExportSetting( *aZone );
104 
105  NETINFO_ITEM* net = GetBoard()->FindNet( zoneInfo.m_NetcodeSelection );
106 
107  if( net ) // net == NULL should not occur
108  aZone->SetNetCode( net->GetNet() );
109 
110  // Combine zones if possible
112 
114 
115  // refill zones with the new properties applied
116  std::vector<ZONE_CONTAINER*> zones_to_refill;
117 
118  for( unsigned i = 0; i < s_PickedList.GetCount(); ++i )
119  {
120  ZONE_CONTAINER* zone = dyn_cast<ZONE_CONTAINER*>( s_PickedList.GetPickedItem( i ) );
121 
122  if( zone == nullptr )
123  {
124  wxASSERT_MSG( false, "Expected a zone after zone properties edit" );
125  continue;
126  }
127 
128  // aZone won't be filled if the layer set was modified, but it needs to be updated
129  if( zone->IsFilled() || zone == aZone )
130  zones_to_refill.push_back( zone );
131  }
132 
133  commit.Stage( s_PickedList );
134 
135  if( zones_to_refill.size() )
136  {
137  ZONE_FILLER filler( GetBoard(), &commit );
138  wxString title = wxString::Format( _( "Refill %d Zones" ), (int) zones_to_refill.size() );
139  filler.InstallNewProgressReporter( this, title, 4 );
140 
141  if( !filler.Fill( zones_to_refill ) )
142  {
143  commit.Revert();
144  return;
145  }
146  }
147 
148  commit.Push( _( "Modify zone properties" ) );
149  GetBoard()->GetConnectivity()->RecalculateRatsnest();
150 
151  s_PickedList.ClearItemsList(); // s_ItemsListPicker is no longer owner of picked items
152 }
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
void OnModify() override
Function OnModify must be called after a board change to set the modified flag.
ZONE_CONTAINER handles a list of polygons defining a copper zone.
Definition: class_zone.h:61
bool IsFilled() const
Definition: class_zone.h:214
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags) override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:93
void UpdateCopyOfZonesList(PICKED_ITEMS_LIST &aPickList, PICKED_ITEMS_LIST &aAuxiliaryList, BOARD *aPcb)
Function UpdateCopyOfZonesList Check a pick list to remove zones identical to their copies and set th...
bool OnAreaPolygonModified(PICKED_ITEMS_LIST *aModifiedZonesList, ZONE_CONTAINER *modified_area)
Function OnAreaPolygonModified Process an area that has been modified, by normalizing its polygon and...
int InvokeNonCopperZonesEditor(PCB_BASE_FRAME *aParent, ZONE_SETTINGS *aSettings)
Function InvokeNonCopperZonesEditor invokes up a modal dialog window for non-copper zone editing.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
#define ZONE_EXPORT_VALUES
Definition: zones.h:37
unsigned GetCount() const
Function GetCount.
static PICKED_ITEMS_LIST s_AuxiliaryList
int SaveCopyOfZones(PICKED_ITEMS_LIST &aPickList, BOARD *aPcb, int aNetCode, LAYER_NUM aLayer)
Function SaveCopyOfZones creates a copy of zones having a given netcode on a given layer,...
int m_NetcodeSelection
Definition: zone_settings.h:93
const ZONE_SETTINGS & GetZoneSettings() const
void SetNetCode(int aNetCode)
Definition: netinfo.h:225
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Function GetConnectivity() returns list of missing connections between components/tracks.
Definition: class_board.h:345
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
Function GetPickedItem.
void ExportSetting(ZONE_CONTAINER &aTarget, bool aFullExport=true) const
Function ExportSetting copy settings to a given zone.
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
int InvokeRuleAreaEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
Function InvokeRuleAreaEditor invokes up a modal dialog window for copper zone editing.
ZONE_SETTINGS handles zones parameters.
Definition: zone_settings.h:67
NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:65
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
int GetNet() const
Function GetNet.
Definition: netinfo.h:223
#define _(s)
Definition: 3d_actions.cpp:33
static PICKED_ITEMS_LIST s_PickedList
void ClearItemsList()
Function ClearItemsList deletes only the list of pickers, NOT the picked data itself.
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
int InvokeCopperZonesEditor(PCB_BASE_FRAME *aCaller, ZONE_SETTINGS *aSettings)
Function InvokeCopperZonesEditor invokes up a modal dialog window for copper zone editing.
void SetZoneSettings(const ZONE_SETTINGS &aSettings)
BOARD * GetBoard() const
void ClearListAndDeleteItems()
Function ClearListAndDeleteItems deletes the list of pickers, AND the data pointed by m_PickedItem or...

References _, PICKED_ITEMS_LIST::ClearItemsList(), PICKED_ITEMS_LIST::ClearListAndDeleteItems(), dummy(), ZONE_SETTINGS::ExportSetting(), ZONE_FILLER::Fill(), BOARD::FindNet(), Format(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOARD::GetConnectivity(), PICKED_ITEMS_LIST::GetCount(), ZONE_CONTAINER::GetIsRuleArea(), ZONE_CONTAINER::GetLayer(), NETINFO_ITEM::GetNet(), PICKED_ITEMS_LIST::GetPickedItem(), PCB_DRAW_PANEL_GAL::GetView(), PCB_BASE_FRAME::GetZoneSettings(), ZONE_FILLER::InstallNewProgressReporter(), InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), IsCopperLayer(), ZONE_CONTAINER::IsFilled(), ZONE_SETTINGS::m_NetcodeSelection, BOARD::OnAreaPolygonModified(), OnModify(), BOARD_COMMIT::Push(), BOARD_COMMIT::Revert(), s_AuxiliaryList, s_PickedList, SaveCopyOfZones(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_BASE_FRAME::SetZoneSettings(), BOARD_COMMIT::Stage(), UNDEFINED_LAYER, KIGFX::PCB_VIEW::Update(), UpdateCopyOfZonesList(), and ZONE_EXPORT_VALUES.

Referenced by OnEditItemRequest().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 222 of file eda_draw_frame.cpp.

223 {
224  if( m_messagePanel )
226 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:216

References EDA_MSG_PANEL::EraseMsgBox(), and EDA_DRAW_FRAME::m_messagePanel.

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ Exchange_Module()

void PCB_EDIT_FRAME::Exchange_Module ( MODULE aSrc,
MODULE aDest,
BOARD_COMMIT aCommit,
bool  deleteExtraTexts = true,
bool  resetTextLayers = true,
bool  resetTextEffects = true,
bool  resetFabricationAttrs = true,
bool  reset3DModels = true 
)

Function Exchange_Module Replaces OldModule by NewModule, using OldModule settings: position, orientation, pad netnames ...) OldModule is deleted or put in undo list.

Parameters
aSrc= footprint to replace
aDest= footprint to put
aCommit= commit that should store the changes

Definition at line 476 of file dialog_exchange_footprints.cpp.

480 {
481  aDest->SetParent( GetBoard() );
482 
483  PlaceModule( aDest, false );
484 
485  // PlaceModule will move the module to the cursor position, which we don't want. Copy
486  // the original position across.
487  aDest->SetPosition( aSrc->GetPosition() );
488 
489  if( aDest->GetLayer() != aSrc->GetLayer() )
490  aDest->Flip( aDest->GetPosition(), m_Settings->m_FlipLeftRight );
491 
492  if( aDest->GetOrientation() != aSrc->GetOrientation() )
493  aDest->SetOrientation( aSrc->GetOrientation() );
494 
495  aDest->SetLocked( aSrc->IsLocked() );
496 
497  for( D_PAD* pad : aDest->Pads() )
498  {
499  D_PAD* oldPad = aSrc->FindPadByName( pad->GetName() );
500 
501  if( oldPad )
502  {
504  pad->SetNetCode( oldPad->GetNetCode() );
505  pad->SetPinFunction( oldPad->GetPinFunction() );
506  }
507  }
508 
509  // Copy reference
510  processTextItem( aSrc->Reference(), aDest->Reference(),
511  // never reset reference text
512  false,
513  resetTextLayers, resetTextEffects );
514 
515  // Copy value
516  processTextItem( aSrc->Value(), aDest->Value(),
517  // reset value text only when it is a proxy for the footprint ID
518  // (cf replacing value "MountingHole-2.5mm" with "MountingHole-4.0mm")
519  aSrc->GetValue() == aSrc->GetFPID().GetLibItemName(),
520  resetTextLayers, resetTextEffects );
521 
522  // Copy fields in accordance with the reset* flags
523  for( BOARD_ITEM* item : aSrc->GraphicalItems() )
524  {
525  TEXTE_MODULE* srcItem = dyn_cast<TEXTE_MODULE*>( item );
526 
527  if( srcItem )
528  {
529  TEXTE_MODULE* destItem = getMatchingTextItem( srcItem, aDest );
530 
531  if( destItem )
532  processTextItem( *srcItem, *destItem, false, resetTextLayers, resetTextEffects );
533  else if( !deleteExtraTexts )
534  aDest->Add( new TEXTE_MODULE( *srcItem ) );
535  }
536  }
537 
538  if( !resetFabricationAttrs )
539  aDest->SetAttributes( aSrc->GetAttributes() );
540 
541  // Copy 3D model settings in accordance with the reset* flag
542  if( !reset3DModels )
543  aDest->Models() = aSrc->Models(); // Linked list of 3D models.
544 
545  // Updating other parameters
546  const_cast<KIID&>( aDest->m_Uuid ) = aSrc->m_Uuid;
547  aDest->SetProperties( aSrc->GetProperties() );
548  aDest->SetPath( aSrc->GetPath() );
549  aDest->CalculateBoundingBox();
550 
551  aCommit.Remove( aSrc );
552  aCommit.Add( aDest );
553 
554  aDest->ClearFlags();
555 }
int GetAttributes() const
Definition: class_module.h:269
double GetOrientation() const
Definition: class_module.h:224
const UTF8 & GetLibItemName() const
Definition: lib_id.h:114
TEXTE_MODULE & Reference()
Definition: class_module.h:492
int GetNetCode() const
Function GetNetCode.
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
COMMIT & Add(EDA_ITEM *aItem)
Adds a new item to the model
Definition: commit.h:78
void CalculateBoundingBox()
Function CalculateBoundingBox calculates the bounding box in board coordinates.
PADS & Pads()
Definition: class_module.h:181
const wxString GetValue() const
Function GetValue.
Definition: class_module.h:476
bool GetLocalRatsnestVisible() const
const LIB_ID & GetFPID() const
Definition: class_module.h:228
void SetLocalRatsnestVisible(bool aVisible)
const KIID_PATH & GetPath() const
Definition: class_module.h:237
DRAWINGS & GraphicalItems()
Definition: class_module.h:191
const wxString & GetPinFunction() const
Definition: class_pad.h:138
virtual void SetParent(EDA_ITEM *aParent)
Definition: base_struct.h:196
D_PAD * FindPadByName(const wxString &aPadName) const
Function FindPadByName returns a D_PAD* with a matching name.
TEXTE_MODULE & Value()
read/write accessors:
Definition: class_module.h:491
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Function Flip Flip this object, i.e.
COMMIT & Remove(EDA_ITEM *aItem)
Removes a new item from the model
Definition: commit.h:90
void SetPosition(const wxPoint &aPos) override
bool IsLocked() const override
Function IsLocked.
Definition: class_module.h:311
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
void SetOrientation(double aNewAngle)
const KIID m_Uuid
Definition: base_struct.h:162
TEXTE_MODULE * getMatchingTextItem(TEXTE_MODULE *aRefItem, MODULE *aModule)
PCBNEW_SETTINGS * m_Settings
std::list< MODULE_3D_SETTINGS > & Models()
Definition: class_module.h:214
void SetLocked(bool isLocked) override
Function SetLocked sets the MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: class_module.h:321
void SetProperties(const std::map< wxString, wxString > &aProps)
Definition: class_module.h:499
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: base_struct.h:233
const std::map< wxString, wxString > & GetProperties() const
Definition: class_module.h:498
void processTextItem(const TEXTE_MODULE &aSrc, TEXTE_MODULE &aDest, bool resetText, bool resetTextLayers, bool resetTextEffects)
wxPoint GetPosition() const override
Definition: class_module.h:219
void SetPath(const KIID_PATH &aPath)
Definition: class_module.h:238
BOARD * GetBoard() const
void PlaceModule(MODULE *aModule, bool aRecreateRatsnest=true)
Function PlaceModule places aModule at the current cursor position and updates module coordinates wit...
virtual PCB_LAYER_ID GetLayer() const
Function GetLayer returns the primary layer this item is on.
void SetAttributes(int aAttributes)
Definition: class_module.h:270

References COMMIT::Add(), MODULE::Add(), MODULE::CalculateBoundingBox(), EDA_ITEM::ClearFlags(), MODULE::FindPadByName(), MODULE::Flip(), MODULE::GetAttributes(), PCB_BASE_FRAME::GetBoard(), MODULE::GetFPID(), BOARD_ITEM::GetLayer(), LIB_ID::GetLibItemName(), BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible(), getMatchingTextItem(), BOARD_CONNECTED_ITEM::GetNetCode(), MODULE::GetOrientation(), MODULE::GetPath(), D_PAD::GetPinFunction(), MODULE::GetPosition(), MODULE::GetProperties(), MODULE::GetValue(), MODULE::GraphicalItems(), MODULE::IsLocked(), PCBNEW_SETTINGS::m_FlipLeftRight, PCB_BASE_FRAME::m_Settings, EDA_ITEM::m_Uuid, MODULE::Models(), MODULE::Pads(), PCB_BASE_FRAME::PlaceModule(), processTextItem(), MODULE::Reference(), COMMIT::Remove(), MODULE::SetAttributes(), BOARD_CONNECTED_ITEM::SetLocalRatsnestVisible(), MODULE::SetLocked(), MODULE::SetOrientation(), EDA_ITEM::SetParent(), MODULE::SetPath(), MODULE::SetPosition(), MODULE::SetProperties(), and MODULE::Value().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS::processModule(), BOARD_NETLIST_UPDATER::replaceComponent(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ ExecuteRemoteCommand()

void PCB_EDIT_FRAME::ExecuteRemoteCommand ( const char *  cmdline)
overridevirtual

Execute a remote command send by Eeschema via a socket, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) this is a virtual function called by EDA_DRAW_FRAME::OnSockRequest().

Parameters
cmdline= received command from socket

Reimplemented from EDA_DRAW_FRAME.

Definition at line 62 of file pcbnew/cross-probing.cpp.

63 {
64  char line[1024];
65  wxString msg;
66  wxString modName;
67  char* idcmd;
68  char* text;
69  int netcode = -1;
70  bool multiHighlight = false;
71  MODULE* module = NULL;
72  D_PAD* pad = NULL;
73  BOARD* pcb = GetBoard();
74 
75  CROSS_PROBING_SETTINGS& crossProbingSettings = GetPcbNewSettings()->m_CrossProbing;
76 
78  KIGFX::RENDER_SETTINGS* renderSettings = view->GetPainter()->GetSettings();
79 
80  strncpy( line, cmdline, sizeof(line) - 1 );
81  line[sizeof(line) - 1] = 0;
82 
83  idcmd = strtok( line, " \n\r" );
84  text = strtok( NULL, "\"\n\r" );
85 
86  if( idcmd == NULL )
87  return;
88 
89  if( strcmp( idcmd, "$NET:" ) == 0 )
90  {
91  if( !crossProbingSettings.auto_highlight )
92  return;
93 
94  wxString net_name = FROM_UTF8( text );
95 
96  NETINFO_ITEM* netinfo = pcb->FindNet( net_name );
97 
98  if( netinfo )
99  {
100  netcode = netinfo->GetNet();
101 
102  MSG_PANEL_ITEMS items;
103  netinfo->GetMsgPanelInfo( this, items );
104  SetMsgPanel( items );
105  }
106  }
107  if( strcmp( idcmd, "$NETS:" ) == 0 )
108  {
109  if( !crossProbingSettings.auto_highlight )
110  return;
111 
112  wxStringTokenizer netsTok = wxStringTokenizer( FROM_UTF8( text ), "," );
113  bool first = true;
114 
115  while( netsTok.HasMoreTokens() )
116  {
117  NETINFO_ITEM* netinfo = pcb->FindNet( netsTok.GetNextToken() );
118 
119  if( netinfo )
120  {
121  if( first )
122  {
123  // TODO: Once buses are included in netlist, show bus name
124  MSG_PANEL_ITEMS items;
125  netinfo->GetMsgPanelInfo( this, items );
126  SetMsgPanel( items );
127  first = false;
128 
129  pcb->SetHighLightNet( netinfo->GetNet() );
130  renderSettings->SetHighlight( true, netinfo->GetNet() );
131  multiHighlight = true;
132  }
133  else
134  {
135  pcb->SetHighLightNet( netinfo->GetNet(), true );
136  renderSettings->SetHighlight( true, netinfo->GetNet(), true );
137  }
138  }
139  }
140 
141  netcode = -1;
142  }
143  else if( strcmp( idcmd, "$PIN:" ) == 0 )
144  {
145  wxString pinName = FROM_UTF8( text );
146 
147  text = strtok( NULL, " \n\r" );
148 
149  if( text && strcmp( text, "$PART:" ) == 0 )
150  text = strtok( NULL, "\"\n\r" );
151 
152  modName = FROM_UTF8( text );
153 
154  module = pcb->FindModuleByReference( modName );
155 
156  if( module )
157  pad = module->FindPadByName( pinName );
158 
159  if( pad )
160  netcode = pad->GetNetCode();
161 
162  if( module == NULL )
163  msg.Printf( _( "%s not found" ), modName );
164  else if( pad == NULL )
165  msg.Printf( _( "%s pin %s not found" ), modName, pinName );
166  else
167  msg.Printf( _( "%s pin %s found" ), modName, pinName );
168 
169  SetStatusText( msg );
170  }
171  else if( strcmp( idcmd, "$PART:" ) == 0 )
172  {
173  pcb->ResetNetHighLight();
174 
175  modName = FROM_UTF8( text );
176 
177  module = pcb->FindModuleByReference( modName );
178 
179  if( module )
180  msg.Printf( _( "%s found" ), modName );
181  else
182  msg.Printf( _( "%s not found" ), modName );
183 
184  SetStatusText( msg );
185  }
186  else if( strcmp( idcmd, "$SHEET:" ) == 0 )
187  {
188  msg.Printf( _( "Selecting all from sheet \"%s\"" ), FROM_UTF8( text ) );
189  wxString sheetUIID( FROM_UTF8( text ) );
190  SetStatusText( msg );
192  static_cast<void*>( &sheetUIID ) );
193  return;
194  }
195  else if( strcmp( idcmd, "$CLEAR" ) == 0 )
196  {
197  if( renderSettings->IsHighlightEnabled() )
198  {
199  renderSettings->SetHighlight( false );
200  view->UpdateAllLayersColor();
201  }
202 
203  if( pcb->IsHighLightNetON() )
204  {
205  pcb->ResetNetHighLight();
206  SetMsgPanel( pcb );
207  }
208 
209  GetCanvas()->Refresh();
210  return;
211  }
212 
213  BOX2I bbox = { { 0, 0 }, { 0, 0 } };
214 
215  if( module )
216  {
217  bbox = module->GetBoundingBox();
218 
219  if( pad )
220  m_toolManager->RunAction( PCB_ACTIONS::highlightItem, true, (void*) pad );
221  else
222  m_toolManager->RunAction( PCB_ACTIONS::highlightItem, true, (void*) module );
223  }
224  else if( netcode > 0 || multiHighlight )
225  {
226  if( !multiHighlight )
227  {
228  renderSettings->SetHighlight( ( netcode >= 0 ), netcode );
229  pcb->SetHighLightNet( netcode );
230  }
231  else
232  {
233  // Just pick the first one for area calculation
234  netcode = *pcb->GetHighLightNetCodes().begin();
235  }
236 
237  pcb->HighLightON();
238 
239  auto merge_area = [netcode, &bbox]( BOARD_CONNECTED_ITEM* aItem )
240  {
241  if( aItem->GetNetCode() == netcode )
242  {
243  if( bbox.GetWidth() == 0 )
244  bbox = aItem->GetBoundingBox();
245  else
246  bbox.Merge( aItem->GetBoundingBox() );
247  }
248  };
249 
250  if( crossProbingSettings.center_on_items )
251  {
252  for( auto zone : pcb->Zones() )
253  merge_area( zone );
254 
255  for( auto track : pcb->Tracks() )
256  merge_area( track );
257 
258  for( auto mod : pcb->Modules() )
259  for( auto mod_pad : mod->Pads() )
260  merge_area( mod_pad );
261  }
262  }
263  else
264  {
265  renderSettings->SetHighlight( false );
266  }
267 
268  if( crossProbingSettings.center_on_items && bbox.GetWidth() > 0 && bbox.GetHeight() > 0 )
269  {
270  auto bbSize = bbox.Inflate( bbox.GetWidth() * 0.2f ).GetSize();
271  auto screenSize = view->ToWorld( GetCanvas()->GetClientSize(), false );
272  screenSize.x = std::max( 10.0, screenSize.x );
273  screenSize.y = std::max( 10.0, screenSize.y );
274  double ratio = std::max( fabs( bbSize.x / screenSize.x ),
275  fabs( bbSize.y / screenSize.y ) );
276 
277  // Try not to zoom on every cross-probe; it gets very noisy
278  if( crossProbingSettings.zoom_to_fit && ( ratio < 0.5 || ratio > 1.0 ) )
279  view->SetScale( view->GetScale() / ratio );
280 
281  view->SetCenter( bbox.Centre() );
282  }
283 
284  view->UpdateAllLayersColor();
285  // Ensure the display is refreshed, because in some installs the refresh is done only
286  // when the gal canvas has the focus, and that is not the case when crossprobing from
287  // Eeschema:
288  GetCanvas()->Refresh();
289 }
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:289
int GetNetCode() const
Function GetNetCode.
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:114
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
void HighLightON(bool aValue=true)
Enable or disable net highlighting.
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Function ToWorld() Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:474
static TOOL_ACTION highlightItem
Definition: pcb_actions.h:434
bool IsHighLightNetON() const
Function IsHighLightNetON.
Definition: class_board.h:400
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Function RunAction() Runs the specified action.
Definition: tool_manager.h:140
PCBNEW_SETTINGS * GetPcbNewSettings()
bool IsHighlightEnabled() const
Function IsHighlightEnabled Returns current highlight setting.
BOARD_CONNECTED_ITEM is a base class derived from BOARD_ITEM for items that can be connected and have...
PAINTER * GetPainter() const
Function GetPainter() Returns the painter object used by the view for drawing VIEW_ITEMS.
Definition: view.h:199
Cross-probing behavior.
Definition: app_settings.h:30
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
D_PAD * FindPadByName(const wxString &aPadName) const
Function FindPadByName returns a D_PAD* with a matching name.
void ResetNetHighLight()
Function ResetNetHighLight Reset all high light data to the init state.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:603
#define NULL
MODULES & Modules()
Definition: class_board.h:249
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
coord_type GetWidth() const
Definition: box2.h:197
void SetHighLightNet(int aNetCode, bool aMulti=false)
Function SetHighLightNet Select the netcode to be highlighted.
BOX2< Vec > & Merge(const BOX2< Vec > &aRect)
Function Merge modifies the position and size of the rectangle in order to contain aRect.
Definition: box2.h:386
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
bool zoom_to_fit
Zoom to fit items (ignored if center_on_items is off)
Definition: app_settings.h:33
const std::set< int > & GetHighLightNetCodes() const
Function GetHighLightNetCode.
Definition: class_board.h:383
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Function SetScale() Sets the scaling factor, zooming around a given anchor point.
Definition: view.cpp:577
virtual RENDER_SETTINGS * GetSettings()=0
Function GetAdapter Returns pointer to current settings that are going to be used when drawing items.
bool auto_highlight
Automatically turn on highlight mode in the target frame.
Definition: app_settings.h:34
NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:65
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302
ZONE_CONTAINERS & Zones()
Definition: class_board.h:254
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:50
void SetHighlight(bool aEnabled, int aNetcode=-1, bool aMulti=false)
Function SetHighlight Turns on/off highlighting - it may be done for the active layer or the specifie...
Vec Centre() const
Definition: box2.h:79
int GetNet() const
Function GetNet.
Definition: netinfo.h:223
static TOOL_ACTION selectOnSheetFromEeschema
Selects all components on sheet from Eeschema crossprobing.
Definition: pcb_actions.h:86
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
#define _(s)
Definition: 3d_actions.cpp:33
coord_type GetHeight() const
Definition: box2.h:198
MODULE * FindModuleByReference(const wxString &aReference) const
Function FindModuleByReference searches for a MODULE within this board with the given reference desig...
std::vector< MSG_PANEL_ITEM > MSG_PANEL_ITEMS
Definition: msgpanel.h:102
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:78
BOARD * GetBoard() const
CROSS_PROBING_SETTINGS m_CrossProbing
Definition: app_settings.h:157
VIEW.
Definition: view.h:61
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo returns the information about the NETINFO_ITEM in aList to display in the me...
void UpdateAllLayersColor()
Function UpdateAllLayersColor() Applies the new coloring scheme to all layers.
Definition: view.cpp:794
double GetScale() const
Function GetScale()
Definition: view.h:257
bool center_on_items
Automatically pan to cross-probed items.
Definition: app_settings.h:32
TRACKS & Tracks()
Definition: class_board.h:246

References _, CROSS_PROBING_SETTINGS::auto_highlight, CROSS_PROBING_SETTINGS::center_on_items, BOX2< Vec >::Centre(), BOARD::FindModuleByReference(), BOARD::FindNet(), MODULE::FindPadByName(), FROM_UTF8(), PCB_BASE_FRAME::GetBoard(), MODULE::GetBoundingBox(), PCB_BASE_FRAME::GetCanvas(), BOX2< Vec >::GetHeight(), BOARD::GetHighLightNetCodes(), NETINFO_ITEM::GetMsgPanelInfo(), NETINFO_ITEM::GetNet(), BOARD_CONNECTED_ITEM::GetNetCode(), KIGFX::VIEW::GetPainter(), PCB_BASE_FRAME::GetPcbNewSettings(), KIGFX::VIEW::GetScale(), KIGFX::PAINTER::GetSettings(), TOOLS_HOLDER::GetToolManager(), TOOL_MANAGER::GetView(), BOX2< Vec >::GetWidth(), PCB_ACTIONS::highlightItem, BOARD::HighLightON(), BOX2< Vec >::Inflate(), KIGFX::RENDER_SETTINGS::IsHighlightEnabled(), BOARD::IsHighLightNetON(), APP_SETTINGS_BASE::m_CrossProbing, TOOLS_HOLDER::m_toolManager, BOX2< Vec >::Merge(), BOARD::Modules(), NULL, EDA_DRAW_PANEL_GAL::Refresh(), BOARD::ResetNetHighLight(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectOnSheetFromEeschema, KIGFX::VIEW::SetCenter(), KIGFX::RENDER_SETTINGS::SetHighlight(), BOARD::SetHighLightNet(), EDA_DRAW_FRAME::SetMsgPanel(), KIGFX::VIEW::SetScale(), KIGFX::VIEW::ToWorld(), BOARD::Tracks(), KIGFX::VIEW::UpdateAllLayersColor(), VECTOR2< T >::x, BOARD::Zones(), and CROSS_PROBING_SETTINGS::zoom_to_fit.

Referenced by KiwayMailIn().

◆ Export_IDF3()

bool PCB_EDIT_FRAME::Export_IDF3 ( BOARD aPcb,
const wxString &  aFullFileName,
bool  aUseThou,
double  aXRef,
double  aYRef 
)

Function Export_IDF3 Creates an IDF3 compliant BOARD (*.emn) and LIBRARY (*.emp) file.

Function Export_IDF3 generates IDFv3 compliant board (*.emn) and library (*.emp) files representing the user's PCB design.

Parameters
aPcb= a pointer to the board to be exported to IDF
aFullFileName= the full filename of the export file
aUseThou= set to true if the desired IDF unit is thou (mil)
aXRef= the board Reference Point in mm, X value
aYRef= the board Reference Point in mm, Y value
Returns
true if OK

Definition at line 575 of file pcbnew/exporters/export_idf.cpp.

577 {
578  IDF3_BOARD idfBoard( IDF3::CAD_ELEC );
579 
580  // Switch the locale to standard C (needed to print floating point numbers)
581  LOCALE_IO toggle;
582 
583  resolver = Prj().Get3DCacheManager()->GetResolver();
584 
585  bool ok = true;
586  double scale = MM_PER_IU; // we must scale internal units to mm for IDF
587  IDF3::IDF_UNIT idfUnit;
588 
589  if( aUseThou )
590  {
591  idfUnit = IDF3::UNIT_THOU;
592  idfBoard.SetUserPrecision( 1 );
593  }
594  else
595  {
596  idfUnit = IDF3::UNIT_MM;
597  idfBoard.SetUserPrecision( 5 );
598  }
599 
600  wxFileName brdName = aPcb->GetFileName();
601 
602  idfBoard.SetUserScale( scale );
603  idfBoard.SetBoardThickness( aPcb->GetDesignSettings().GetBoardThickness() * scale );
604  idfBoard.SetBoardName( TO_UTF8( brdName.GetFullName() ) );
605  idfBoard.SetBoardVersion( 0 );
606  idfBoard.SetLibraryVersion( 0 );
607 
608  std::ostringstream ostr;
609  ostr << "KiCad " << TO_UTF8( GetBuildVersion() );
610  idfBoard.SetIDFSource( ostr.str() );
611 
612  try
613  {
614  // set up the board reference point
615  idfBoard.SetUserOffset( -aXRef, aYRef );
616 
617  // Export the board outline
618  idf_export_outline( aPcb, idfBoard );
619 
620  // Output the drill holes and module (library) data.
621  for( auto module : aPcb->Modules() )
622  idf_export_module( aPcb, module, idfBoard );
623 
624  if( !idfBoard.WriteFile( aFullFileName, idfUnit, false ) )
625  {
626  wxString msg;
627  msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( idfBoard.GetError().c_str() );
628  wxMessageBox( msg );
629 
630  ok = false;
631  }
632  }
633  catch( const IO_ERROR& ioe )
634  {
635  wxString msg;
636  msg << _( "IDF Export Failed:\n" ) << ioe.What();
637  wxMessageBox( msg );
638 
639  ok = false;
640  }
641  catch( const std::exception& e )
642  {
643  wxString msg;
644  msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( e.what() );
645  wxMessageBox( msg );
646  ok = false;
647  }
648 
649  return ok;
650 }
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:114
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
static void idf_export_module(BOARD *aPcb, MODULE *aModule, IDF3_BOARD &aIDFBoard)
Function idf_export_module retrieves information from all board modules, adds drill holes to the DRIL...
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:537
static FILENAME_RESOLVER * resolver
static void idf_export_outline(BOARD *aPcb, IDF3_BOARD &aIDFBoard)
Function idf_export_outline retrieves line segment information from the edge layer and compiles the d...
const wxString & GetFileName() const
Definition: class_board.h:244
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:100
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
MODULES & Modules()
Definition: class_board.h:249
wxString GetBuildVersion()
Get the full KiCad version string.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const int scale
#define _(s)
Definition: 3d_actions.cpp:33
#define UNIT_MM
Definition: units_scales.h:31
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References _, FROM_UTF8(), BOARD_DESIGN_SETTINGS::GetBoardThickness(), GetBuildVersion(), BOARD::GetDesignSettings(), BOARD::GetFileName(), idf_export_module(), idf_export_outline(), BOARD::Modules(), KIWAY_HOLDER::Prj(), resolver, scale, TO_UTF8, UNIT_MM, and IO_ERROR::What().

Referenced by OnExportIDF3().

◆ ExportSpecctraFile()

bool PCB_EDIT_FRAME::ExportSpecctraFile ( const wxString &  aFullFilename)

Function ExportSpecctraFile will export the current BOARD to a specctra dsn file.

See http://www.autotraxeda.com/docs/SPECCTRA/SPECCTRA.pdf for the specification.

Returns
true if OK

Definition at line 82 of file specctra_export.cpp.

83 {
84  SPECCTRA_DB db;
85  bool ok = true;
86  wxString errorText;
87 
88  BASE_SCREEN* screen = GetScreen();
89  bool wasModified = screen->IsModify();
90 
91  db.SetPCB( SPECCTRA_DB::MakePCB() );
92 
93  LOCALE_IO toggle; // Switch the locale to standard C
94 
95  // DSN Images (=KiCad MODULES and pads) must be presented from the
96  // top view. So we temporarily flip any modules which are on the back
97  // side of the board to the front, and record this in the MODULE's flag field.
98  db.FlipMODULEs( GetBoard() );
99 
100  try
101  {
103  db.FromBOARD( GetBoard() );
104  db.ExportPCB( aFullFilename, true );
105 
106  // if an exception is thrown by FromBOARD or ExportPCB(), then
107  // ~SPECCTRA_DB() will close the file.
108  }
109  catch( const IO_ERROR& ioe )
110  {
111  ok = false;
112 
113  // copy the error string to safe place, ioe is in this scope only.
114  errorText = ioe.What();
115  }
116 
117  // done assuredly, even if an exception was thrown and caught.
118  db.RevertMODULEs( GetBoard() );
119 
120  // The two calls below to MODULE::Flip(), both set the
121  // modified flag, yet their actions cancel each other out, so it should
122  // be ok to clear the modify flag.
123  if( !wasModified )
124  screen->ClrModify();
125 
126  if( ok )
127  {
128  SetStatusText( wxString( _( "BOARD exported OK." ) ) );
129  }
130  else
131  {
132  DisplayErrorMessage( this,
133  _( "Unable to export, please fix and try again" ),
134  errorText );
135  }
136 
137  return ok;
138 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:252
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
void SetPCB(PCB *aPcb)
Function SetPCB deletes any existing PCB and replaces it with the given one.
Definition: specctra.h:3884
void FlipMODULEs(BOARD *aBoard)
Function FlipMODULEs flips the modules which are on the back side of the board to the front.
void SynchronizeNetsAndNetClasses()
Function SynchronizeNetsAndNetClasses copies NETCLASS info to each NET, based on NET membership in a ...
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
BASE_SCREEN handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:43
bool IsModify() const
Definition: base_screen.h:104
SPECCTRA_DB holds a DSN data tree, usually coming from a DSN file.
Definition: specctra.h:3607
void RevertMODULEs(BOARD *aBoard)
Function RevertMODULEs flips the modules which were on the back side of the board back to the back.
void FromBOARD(BOARD *aBoard)
Function FromBOARD adds the entire BOARD to the PCB but does not write it out.
void ExportPCB(const wxString &aFilename, bool aNameChange=false)
Function ExportPCB writes the internal PCB instance out as a SPECTRA DSN format file.
Definition: specctra.cpp:3442
#define _(s)
Definition: 3d_actions.cpp:33
void ClrModify()
Definition: base_screen.h:101
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References _, BASE_SCREEN::ClrModify(), DisplayErrorMessage(), DSN::SPECCTRA_DB::ExportPCB(), DSN::SPECCTRA_DB::FlipMODULEs(), DSN::SPECCTRA_DB::FromBOARD(), GetBoard(), BASE_SCREEN::IsModify(), DSN::SPECCTRA_DB::MakePCB(), DSN::SPECCTRA_DB::RevertMODULEs(), DSN::SPECCTRA_DB::SetPCB(), BOARD::SynchronizeNetsAndNetClasses(), and IO_ERROR::What().

Referenced by ExportSpecctraDSN().

◆ ExportSVG()

void PCB_EDIT_FRAME::ExportSVG ( wxCommandEvent &  event)

Function SVG_Print Shows the Export to SVG file dialog.

Definition at line 1163 of file pcb_edit_frame.cpp.

1164 {
1165  InvokeExportSVG( this, GetBoard() );
1166 }
bool InvokeExportSVG(PCB_EDIT_FRAME *aCaller, BOARD *aBoard)
Function InvokeExportSVG shows the Export SVG dialog.
BOARD * GetBoard() const

References GetBoard(), and InvokeExportSVG().

◆ ExportToGenCAD()

void PCB_EDIT_FRAME::ExportToGenCAD ( wxCommandEvent &  event)

Function ExportToGenCAD creates a file in GenCAD 1.4 format from the current board.

Definition at line 222 of file export_gencad.cpp.

223 {
224  // Build default output file name
225  wxString path = GetLastPath( LAST_PATH_GENCAD );
226 
227  if( path.IsEmpty() )
228  {
229  wxFileName brdFile = GetBoard()->GetFileName();
230  brdFile.SetExt( "cad" );
231  path = brdFile.GetFullPath();
232  }
233 
234  DIALOG_GENCAD_EXPORT_OPTIONS optionsDialog( this, path );
235 
236  if( optionsDialog.ShowModal() == wxID_CANCEL )
237  return;
238 
239  path = optionsDialog.GetFileName();
240  SetLastPath( LAST_PATH_GENCAD, path );
241  FILE* file = wxFopen( path, "wt" );
242 
243  if( !file )
244  {
245  DisplayError( this, wxString::Format( _( "Unable to create \"%s\"" ),
246  optionsDialog.GetFileName() ) );
247  return;
248  }
249 
250  // Get options
251  flipBottomPads = optionsDialog.GetOption( FLIP_BOTTOM_PADS );
252  uniquePins = optionsDialog.GetOption( UNIQUE_PIN_NAMES );
253  individualShapes = optionsDialog.GetOption( INDIVIDUAL_SHAPES );
254  storeOriginCoords = optionsDialog.GetOption( STORE_ORIGIN_COORDS );
255 
256  // Switch the locale to standard C (needed to print floating point numbers)
257  LOCALE_IO toggle;
258 
259  // Update some board data, to ensure a reliable gencad export
261 
262  // Save the auxiliary origin for the rest of the module
264  GencadOffsetX = optionsDialog.GetOption( USE_AUX_ORIGIN ) ? auxOrigin.x : 0;
265  GencadOffsetY = optionsDialog.GetOption( USE_AUX_ORIGIN ) ? auxOrigin.y : 0;
266 
267  // No idea on *why* this should be needed... maybe to fix net names?
268  Compile_Ratsnest( true );
269 
270  /* Temporary modification of footprints that are flipped (i.e. on bottom
271  * layer) to convert them to non flipped footprints.
272  * This is necessary to easily export shapes to GenCAD,
273  * that are given as normal orientation (non flipped, rotation = 0))
274  * these changes will be undone later
275  */
276  BOARD* pcb = GetBoard();
277 
278  for( MODULE* module : pcb->Modules() )
279  {
280  module->SetFlag( 0 );
281 
282  if( module->GetLayer() == B_Cu )
283  {
284  module->Flip( module->GetPosition(), Settings().m_FlipLeftRight );
285  module->SetFlag( 1 );
286  }
287  }
288 
289  /* Gencad has some mandatory and some optional sections: some importer
290  * need the padstack section (which is optional) anyway. Also the
291  * order of the section *is* important */
292 
293  CreateHeaderInfoData( file, this ); // Gencad header
294  CreateBoardSection( file, pcb ); // Board perimeter
295 
296  CreatePadsShapesSection( file, pcb ); // Pads and padstacks
297  CreateArtworksSection( file ); // Empty but mandatory
298 
299  /* Gencad splits a component info in shape, component and device.
300  * We don't do any sharing (it would be difficult since each module is
301  * customizable after placement) */
302  CreateShapesSection( file, pcb );
303  CreateComponentsSection( file, pcb );
304  CreateDevicesSection( file, pcb );
305 
306  // In a similar way the netlist is split in net, track and route
307  CreateSignalsSection( file, pcb );
308  CreateTracksInfoData( file, pcb );
309  CreateRoutesSection( file, pcb );
310 
311  fclose( file );
312 
313  // Undo the footprints modifications (flipped footprints)
314  for( auto module : pcb->Modules() )
315  {
316  if( module->GetFlag() )
317  {
318  module->Flip( module->GetPosition(), Settings().m_FlipLeftRight );
319  module->SetFlag( 0 );
320  }
321  }
322 
323  componentShapes.clear();
324  shapeNames.clear();
325 }
static void CreateBoardSection(FILE *aFile, BOARD *aPcb)
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
static void CreateShapesSection(FILE *aFile, BOARD *aPcb)
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: common.h:216
void Compile_Ratsnest(bool aDisplayStatus)
Function Compile_Ratsnest Create the entire board ratsnest.
static void CreateRoutesSection(FILE *aFile, BOARD *aPcb)
static void CreateSignalsSection(FILE *aFile, BOARD *aPcb)
static bool uniquePins
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Function GetDesignSettings.
Definition: class_board.h:537
static int GencadOffsetY
static bool flipBottomPads
const wxString & GetFileName() const
Definition: class_board.h:244
static void CreateTracksInfoData(FILE *aFile, BOARD *aPcb)
wxString GetLastPath(LAST_PATH_TYPE aType)
Get the last path for a particular type.
static void CreateArtworksSection(FILE *aFile)
static void CreateComponentsSection(FILE *aFile, BOARD *aPcb)
static bool individualShapes
MODULES & Modules()
Definition: class_board.h:249
static void CreatePadsShapesSection(FILE *aFile, BOARD *aPcb)
static bool storeOriginCoords
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
static bool CreateHeaderInfoData(FILE *aFile, PCB_EDIT_FRAME *frame)
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
static void CreateDevicesSection(FILE *aFile, BOARD *aPcb)
#define _(s)
Definition: 3d_actions.cpp:33
PCBNEW_SETTINGS & Settings()
EDA_RECT ComputeBoundingBox(bool aBoardEdgesOnly=false) const
Function ComputeBoundingBox calculates the bounding box containing all board items (or board edge seg...
static int GencadOffsetX
BOARD * GetBoard() const
static std::map< MODULE *, int > componentShapes
static std::map< int, wxString > shapeNames
wxPoint m_AuxOrigin
origin for plot exports
void SetLastPath(LAST_PATH_TYPE aType, const wxString &aLastPath)
Set the path of the last file successfully read.

References _, B_Cu, PCB_BASE_FRAME::Compile_Ratsnest(), componentShapes, BOARD::ComputeBoundingBox(), CreateArtworksSection(), CreateBoardSection(), CreateComponentsSection(), CreateDevicesSection(), CreateHeaderInfoData(), CreatePadsShapesSection(), CreateRoutesSection(), CreateShapesSection(), CreateSignalsSection(), CreateTracksInfoData(), DisplayError(), FLIP_BOTTOM_PADS, flipBottomPads, Format(), GencadOffsetX, GencadOffsetY, PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), DIALOG_GENCAD_EXPORT_OPTIONS::GetFileName(), BOARD::GetFileName(), GetLastPath(), DIALOG_GENCAD_EXPORT_OPTIONS::GetOption(), INDIVIDUAL_SHAPES, individualShapes, LAST_PATH_GENCAD, BOARD_DESIGN_SETTINGS::m_AuxOrigin, PCBNEW_SETTINGS::m_FlipLeftRight, PCB_BASE_FRAME::m_Pcb, BOARD::Modules(), SetLastPath(), PCB_BASE_FRAME::Settings(), shapeNames, STORE_ORIGIN_COORDS, storeOriginCoords, UNIQUE_PIN_NAMES, uniquePins, USE_AUX_ORIGIN, wxPoint::x, and wxPoint::y.

◆ ExportVRML_File()

bool PCB_EDIT_FRAME::ExportVRML_File ( const wxString &  aFullFileName,
double  aMMtoWRMLunit,
bool  aExport3DFiles,
bool  aUseRelativePaths,
bool  aUsePlainPCB,
const wxString &  a3D_Subdir,
double  aXRef,
double  aYRef 
)

Function ExportVRML_File Creates the file(s) exporting current BOARD to a VRML file.

Note
When copying 3D shapes files, the new filename is build from the full path name, changing the separators by underscore. This is needed because files with the same shortname can exist in different directories
ExportVRML_File generates coordinates in board units (BIU) inside the file.
Todo:
Use mm inside the file. A general scale transform is applied to the whole file (1.0 to have the actual WRML unit im mm, 0.001 to have the actual WRML unit in meters.
Note
For 3D models built by a 3D modeler, the unit is 0,1 inches. A specific scale is applied to 3D models to convert them to internal units.
Parameters
aFullFileName= the full filename of the file to create
aMMtoWRMLunit= the VRML scaling factor: 1.0 to export in mm. 0.001 for meters
aExport3DFiles= true to copy 3D shapes in the subir a3D_Subdir
aUseRelativePathsset to true to use relative paths instead of absolute paths in the board VRML file URLs.
aUsePlainPCBset to true to export a board with no copper or silkskreen; this is useful for generating a VRML file which can be converted to a STEP model.
a3D_Subdir= sub directory where 3D shapes files are copied. This is only used when aExport3DFiles == true
aXRef= X value of PCB (0,0) reference point
aYRef= Y value of PCB (0,0) reference point
Returns
true if Ok.

Definition at line 1570 of file export_vrml.cpp.

1574 {
1575  BOARD* pcb = GetBoard();
1576  bool ok = true;
1577  BOARD_COMMIT commit( this ); // We may need to modify the board (for instance to
1578  // fill zones), so make sure we can revert.
1579 
1580  USE_INLINES = aExport3DFiles;
1581  USE_DEFS = true;
1582  USE_RELPATH = aUseRelativePaths;
1583 
1584  cache = Prj().Get3DCacheManager();
1585  PROJ_DIR = Prj().GetProjectPath();
1586  SUBDIR_3D = a3D_Subdir;
1587  MODEL_VRML model3d;
1588  model_vrml = &model3d;
1589  model3d.SetScale( aMMtoWRMLunit );
1590 
1591  if( USE_INLINES )
1592  {
1593  BOARD_SCALE = MM_PER_IU / 2.54;
1594  model3d.SetOffset( -aXRef / 2.54, aYRef / 2.54 );
1595  }
1596  else
1597  {
1598  BOARD_SCALE = MM_PER_IU;
1599  model3d.SetOffset( -aXRef, aYRef );
1600  }
1601 
1602  // plain PCB or else PCB with copper and silkscreen
1603  model3d.m_plainPCB = aUsePlainPCB;
1604 
1605  try
1606  {
1607  // Preliminary computation: the z value for each layer
1608  compute_layer_Zs( model3d, pcb );
1609 
1610  // board edges and cutouts
1611  export_vrml_board( model3d, pcb );
1612 
1613  // Drawing and text on the board
1614  if( !aUsePlainPCB )
1615  export_vrml_drawings( model3d, pcb );
1616 
1617  // Export vias and trackage
1618  export_vrml_tracks( model3d, pcb );
1619 
1620  // Export zone fills
1621  if( !aUsePlainPCB )
1622  export_vrml_zones( model3d, pcb, &commit );
1623 
1624  if( USE_INLINES )
1625  {
1626  // check if the 3D Subdir exists - create if not
1627  wxFileName subdir( SUBDIR_3D, "" );
1628 
1629  if( ! subdir.DirExists() )
1630  {
1631  if( !wxDir::Make( subdir.GetFullPath() ) )
1632  throw( std::runtime_error( "Could not create 3D model subdirectory" ) );
1633  }
1634 
1635  OPEN_OSTREAM( output_file, TO_UTF8( aFullFileName ) );
1636 
1637  if( output_file.fail() )
1638  {
1639  std::ostringstream ostr;
1640  ostr << "Could not open file '" << TO_UTF8( aFullFileName ) << "'";
1641  throw( std::runtime_error( ostr.str().c_str() ) );
1642  }
1643 
1644  output_file.imbue( std::locale( "C" ) );
1645 
1646  // Begin with the usual VRML boilerplate
1647  wxString fn = aFullFileName;
1648  fn.Replace( "\\" , "/" );
1649  output_file << "#VRML V2.0 utf8\n";
1650  output_file << "WorldInfo {\n";
1651  output_file << " title \"" << TO_UTF8( fn ) << " - Generated by Pcbnew\"\n";
1652  output_file << "}\n";
1653  output_file << "Transform {\n";
1654  output_file << " scale " << std::setprecision( PRECISION );
1655  output_file << WORLD_SCALE << " ";
1656  output_file << WORLD_SCALE << " ";
1657  output_file << WORLD_SCALE << "\n";
1658  output_file << " children [\n";
1659 
1660  // Export footprints
1661  for( MODULE* module : pcb->Modules() )
1662  export_vrml_module( model3d, pcb, module, &output_file );
1663 
1664  // write out the board and all layers
1665  write_layers( model3d, pcb, TO_UTF8( aFullFileName ), &output_file );
1666 
1667  // Close the outer 'transform' node
1668  output_file << "]\n}\n";
1669 
1670  CLOSE_STREAM( output_file );
1671  }
1672  else
1673  {
1674  // Export footprints
1675  for( MODULE* module : pcb->Modules() )
1676  export_vrml_module( model3d, pcb, module, NULL );
1677 
1678  // write out the board and all layers
1679  write_layers( model3d, pcb, TO_UTF8( aFullFileName ), NULL );
1680  }
1681  }
1682  catch( const std::exception& e )
1683  {
1684  wxString msg;
1685  msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( e.what() );
1686  wxMessageBox( msg );
1687 
1688  ok = false;
1689  }
1690 
1691  commit.Revert();
1692  return ok;
1693 }
static double BOARD_SCALE
Definition: export_vrml.cpp:66
static S3D_CACHE * cache
Definition: export_vrml.cpp:61
static wxString FROM_UTF8(const char *cstring)
function FROM_UTF8 converts a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:114
static double WORLD_SCALE
Definition: export_vrml.cpp:65
static bool USE_INLINES
Definition: export_vrml.cpp:62
static MODEL_VRML * model_vrml
void SetOffset(double aXoff, double aYoff)
static void compute_layer_Zs(MODEL_VRML &aModel, BOARD *pcb)
bool SetScale(double aWorldScale)
VTBL_ENTRY const wxString GetProjectPath() const
Function GetProjectPath returns the full path of the project.
Definition: project.cpp:124
static void export_vrml_zones(MODEL_VRML &aModel, BOARD *aPcb, COMMIT *aCommit)
static void export_vrml_module(MODEL_VRML &aModel, BOARD *aPcb, MODULE *aModule, std::ostream *aOutputFile)
#define TO_UTF8(wxstring)
Macro TO_UTF8 converts a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:100
#define NULL
MODULES & Modules()
Definition: class_board.h:249
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
static bool USE_RELPATH
Definition: export_vrml.cpp:64
#define OPEN_OSTREAM(var, name)
static wxString SUBDIR_3D
Definition: export_vrml.cpp:68
static void export_vrml_tracks(MODEL_VRML &aModel, BOARD *pcb)
static void export_vrml_board(MODEL_VRML &aModel, BOARD *aPcb)
static void export_vrml_drawings(MODEL_VRML &aModel, BOARD *pcb)
static void write_layers(MODEL_VRML &aModel, BOARD *aPcb, const char *aFileName, OSTREAM *aOutputFile)
static wxString PROJ_DIR
Definition: export_vrml.cpp:69
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
#define _(s)
Definition: 3d_actions.cpp:33
static const int PRECISION
Definition: export_vrml.cpp:67
static bool USE_DEFS
Definition: export_vrml.cpp:63
#define CLOSE_STREAM(var)
BOARD * GetBoard() const

References _, BOARD_SCALE, cache, CLOSE_STREAM, compute_layer_Zs(), export_vrml_board(), export_vrml_drawings(), export_vrml_module(), export_vrml_tracks(), export_vrml_zones(), FROM_UTF8(), PCB_BASE_FRAME::GetBoard(), PROJECT::GetProjectPath(), MODEL_VRML::m_plainPCB, model_vrml, BOARD::Modules(), NULL, OPEN_OSTREAM, PRECISION, KIWAY_HOLDER::Prj(), PROJ_DIR, BOARD_COMMIT::Revert(), MODEL_VRML::SetOffset(), MODEL_VRML::SetScale(), SUBDIR_3D, TO_UTF8, USE_DEFS, USE_INLINES, USE_RELPATH, WORLD_SCALE, and write_layers().

Referenced by ExportVRML(), and OnExportVRML().

◆ FetchNetlistFromSchematic()

bool PCB_EDIT_FRAME::FetchNetlistFromSchematic ( NETLIST aNetlist,
FETCH_NETLIST_MODE  aMode 
)

Definition at line 1360 of file pcb_edit_frame.cpp.

1361 {
1362  if( !TestStandalone( )) {
1363  DisplayError( this, _( "Cannot update the PCB because Pcbnew is opened in stand-alone "
1364  "mode. In order to create or update PCBs from schematics, you "
1365  "must launch the KiCad project manager and create a project." ) );
1366  return false; //Not in standalone mode
1367  }
1368 
1369  Raise(); //Show
1370  std::string payload;
1371 
1372  if( aMode == NO_ANNOTATION )
1373  payload = "no-annotate";
1374  else if( aMode == QUIET_ANNOTATION )
1375  payload = "quiet-annotate";
1376 
1377  Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_GET_NETLIST, payload, this );
1378 
1379  try
1380  {
1381  auto lineReader = new STRING_LINE_READER( payload, _( "Eeschema netlist" ) );
1382  KICAD_NETLIST_READER netlistReader( lineReader, &aNetlist );
1383  netlistReader.LoadNetlist();
1384  }
1385  catch( const IO_ERROR& )
1386  {
1387  assert( false ); // should never happen
1388  return false;
1389  }
1390 
1391  return true;
1392 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
KIWAY & Kiway() const
Function Kiway returns a reference to the KIWAY that this object has an opportunity to participate in...
Definition: kiway_holder.h:56
KICAD_NETLIST_READER read the new s-expression based KiCad netlist format.
bool TestStandalone(void)
Test if standalone mode.
VTBL_ENTRY void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=NULL)
Function ExpressMail send aPayload to aDestination from aSource.
Definition: kiway.cpp:437
#define _(s)
Definition: 3d_actions.cpp:33
STRING_LINE_READER is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:254
Struct IO_ERROR is a class used to hold an error message and may be used when throwing exceptions con...
Definition: ki_exception.h:76

References _, DisplayError(), KIWAY::ExpressMail(), FRAME_SCH, Kiway, KICAD_NETLIST_READER::LoadNetlist(), and MAIL_SCH_GET_NETLIST.

Referenced by importFile(), KiwayMailIn(), DRC_TOOL::RunTests(), and PCB_EDITOR_CONTROL::UpdatePCBFromSchematic().

◆ Files_io()

void PCB_EDIT_FRAME::Files_io ( wxCommandEvent &  event)

Function Files_io.

Parameters
eventis the command event handler. do nothing else than call Files_io_from_id with the wxCommandEvent id

Definition at line 255 of file pcbnew/files.cpp.

256 {
257  int id = event.GetId();
258  Files_io_from_id( id );
259 }
bool Files_io_from_id(int aId)
Function Files_io_from_id Read and write board files.

References Files_io_from_id().

◆ Files_io_from_id()

bool PCB_EDIT_FRAME::Files_io_from_id ( int  aId)

Function Files_io_from_id Read and write board files.

Parameters
aIdis an event ID ciming from file command events: ID_LOAD_FILE ID_MENU_RECOVER_BOARD_AUTOSAVE ID_NEW_BOARD ID_SAVE_BOARD ID_COPY_BOARD_AS ID_SAVE_BOARD_AS Files_io_from_id prepare parameters and calls the specialized function

Definition at line 262 of file pcbnew/files.cpp.

263 {
264  wxString msg;
265 
266  switch( id )
267  {
268  case ID_LOAD_FILE:
269  {
270  int open_ctl = 0;
271  wxString fileName = Prj().AbsolutePath( GetBoard()->GetFileName() );
272 
273  return AskLoadBoardFileName( this, &open_ctl, &fileName, true )
274  && OpenProjectFiles( std::vector<wxString>( 1, fileName ), open_ctl );
275  }
276 
278  {
279  int open_ctl = 1;
280  wxString fileName; // = Prj().AbsolutePath( GetBoard()->GetFileName() );
281 
282  return AskLoadBoardFileName( this, &open_ctl, &fileName, false )
283  && OpenProjectFiles( std::vector<wxString>( 1, fileName ), open_ctl );
284  }
285 
287  {
288  wxFileName currfn = Prj().AbsolutePath( GetBoard()->GetFileName() );
289  wxFileName fn = currfn;
290 
291  wxString rec_name = GetAutoSaveFilePrefix() + fn.GetName();
292  fn.SetName( rec_name );
293 
294  if( !fn.FileExists() )
295  {
296  msg.Printf( _( "Recovery file \"%s\" not found." ), fn.GetFullPath() );
297  DisplayInfoMessage( this, msg );
298  return false;
299  }
300 
301  msg.Printf( _( "OK to load recovery file \"%s\"" ), fn.GetFullPath() );
302 
303  if( !IsOK( this, msg ) )
304  return false;
305 
306  GetScreen()->ClrModify(); // do not prompt the user for changes
307 
308  if( OpenProjectFiles( std::vector<wxString>( 1, fn.GetFullPath() ) ) )
309  {
310  // Re-set the name since name or extension was changed
311  GetBoard()->SetFileName( currfn.GetFullPath() );
312  UpdateTitle();
313  return true;
314  }
315  return false;
316  }
317 
318  case ID_NEW_BOARD:
319  {
320  if( IsContentModified() )
321  {
322  wxFileName fileName = GetBoard()->GetFileName();
323  wxString saveMsg =
324  _( "Current board will be closed, save changes to \"%s\" before continuing?" );
325 
326  if( !HandleUnsavedChanges( this, wxString::Format( saveMsg, fileName.GetFullName() ),
327  [&]()->bool { return Files_io_from_id( ID_SAVE_BOARD ); } ) )
328  return false;
329  }
330  else if( !GetBoard()->IsEmpty() )
331  {
332  if( !IsOK( this, _( "Current Board will be closed. Continue?" ) ) )
333  return false;
334  }
335 
337 
338  GetBoard()->ClearProject();
339 
341 
342  mgr->SaveProject( mgr->Prj().GetProjectFullName() );
343  mgr->UnloadProject( &mgr->Prj() );
344 
345  if( !Clear_Pcb( false ) )
346  return false;
347 
348  onBoardLoaded();
349 
351 
352  OnModify();
353  return true;
354  }
355 
356  case ID_SAVE_BOARD:
357  if( !GetBoard()->GetFileName().IsEmpty() )
358  return SavePcbFile( Prj().AbsolutePath( GetBoard()->GetFileName() ) );
359 
361 
362  case ID_COPY_BOARD_AS:
363  case ID_SAVE_BOARD_AS:
364  {
365  bool addToHistory = false;
366  wxString orig_name;
367  wxFileName::SplitPath( GetBoard()->GetFileName(), nullptr, nullptr, &orig_name,
368  nullptr );
369 
370  if( orig_name.IsEmpty() )
371  {
372  addToHistory = true;
373  orig_name = _( "noname" );
374  }
375 
376  wxString pro_dir = wxPathOnly( Prj().GetProjectFullName() );
377  wxFileName fn( pro_dir, orig_name, KiCadPcbFileExtension );
378  wxString filename = fn.GetFullPath();
379 
380  bool createProject = false;
381 
382  if( AskSaveBoardFileName( this, &filename, &createProject ) )
383  {
384  if( id == ID_COPY_BOARD_AS )
385  return SavePcbCopy( filename, createProject );
386  else
387  return SavePcbFile( filename, addToHistory, createProject );
388  }
389  return false;
390  }
391 
392  default:
393  return false;
394  }
395 }
void UpdateTitle()
Function UpdateTitle sets the main window title bar text.
void OnModify() override
Function OnModify must be called after a board change to set the modified flag.
bool HandleUnsavedChanges(wxWindow *aParent, const wxString &aMessage, const std::function< bool()> &aSaveFunction)
Display a dialog with Save, Cancel and Discard Changes buttons.
Definition: confirm.cpp:201
PROJECT & Prj() const
A helper while we are not MDI-capable – return the one and only project.
SETTINGS_MANAGER * GetSettingsManager() const
bool LoadProjectSettings()
Load the current project's file configuration settings which are pertinent to this PCB_EDIT_FRAME ins...
bool SavePcbCopy(const wxString &aFileName, bool aCreateProject=false)
Function SavePcbCopy writes the board data structures to a aFileName but unlike SavePcbFile,...
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:88
const std::string KiCadPcbFileExtension
const wxString & GetFileName() const
Definition: class_board.h:244
VTBL_ENTRY const wxString AbsolutePath(const wxString &aFileName) const
Function AbsolutePath fixes up aFileName if it is relative to the project's directory to be an absolu...
Definition: project.cpp:272
bool AskSaveBoardFileName(PCB_EDIT_FRAME *aParent, wxString *aFileName, bool *aCreateProject)
Puts up a wxFileDialog asking for a BOARD filename to save.
bool IsContentModified() override
Get if the current board has been modified but not saved.
bool OpenProjectFiles(const std::vector< wxString > &aFileSet, int aCtl=0) override
Function OpenProjectFiles (was LoadOnePcbFile) loads a KiCad board (.kicad_pcb) from aFileName.
void onBoardLoaded()
Updates the state of the GUI after a new board is loaded or created.
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
bool AskLoadBoardFileName(wxWindow *aParent, int *aCtl, wxString *aFileName, bool aKicadFilesOnly)
Function AskLoadBoardFileName puts up a wxFileDialog asking for a BOARD filename to open.
void SaveProjectSettings() override
Function SaveProjectSettings saves changes to the project settings to the project (....
void SetFileName(const wxString &aFileName)
Definition: class_board.h:242
VTBL_ENTRY const wxString GetProjectFullName() const
Function GetProjectFullName returns the full path and name of the project.
Definition: project.cpp:118
void ClearProject()
static wxString GetAutoSaveFilePrefix()
bool SavePcbFile(const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
Function SavePcbFile writes the board data structures to a aFileName Creates backup when requested an...
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, CPTREE &aTree)
Function Format outputs a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:201
#define _(s)
Definition: 3d_actions.cpp:33
bool UnloadProject(PROJECT *aProject, bool aSave=true)
Saves, unloads and unregisters the given PROJECT.
bool SaveProject(const wxString &aFullPath=wxEmptyString)
Saves a loaded project.
void ClrModify()
Definition: base_screen.h:101
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool Files_io_from_id(int aId)
Function Files_io_from_id Read and write board files.
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:267
bool Clear_Pcb(bool aQuery, bool aFinal=false)
Function Clear_Pcb delete all and reinitialize the current board.
Definition: initpcb.cpp:43
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:283
bool IsEmpty() const
Definition: class_board.h:292

References _, PROJECT::AbsolutePath(), AskLoadBoardFileName(), AskSaveBoardFileName(), Clear_Pcb(), BOARD::ClearProject(), BASE_SCREEN::ClrModify(), DisplayInfoMessage(), Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), PROJECT::GetProjectFullName(), PCB_BASE_FRAME::GetScreen(), EDA_BASE_FRAME::GetSettingsManager(), HandleUnsavedChanges(), ID_COPY_BOARD_AS, ID_IMPORT_NON_KICAD_BOARD, ID_LOAD_FILE, ID_MENU_RECOVER_BOARD_AUTOSAVE, ID_NEW_BOARD, ID_SAVE_BOARD, ID_SAVE_BOARD_AS, IsContentModified(), BOARD::IsEmpty(), IsOK(), KI_FALLTHROUGH, KiCadPcbFileExtension, LoadProjectSettings(), onBoardLoaded(), OnModify(), OpenProjectFiles(), KIWAY_HOLDER::Prj(), SETTINGS_MANAGER::Prj(), SavePcbCopy(), SavePcbFile(), SETTINGS_MANAGER::SaveProject(), SaveProjectSettings(), BOARD::SetFileName(), SETTINGS_MANAGER::UnloadProject(), and UpdateTitle().

Referenced by Files_io(), PCB_EDITOR_CONTROL::New(), PCB_EDITOR_CONTROL::Open(), PCB_EDITOR_CONTROL::Save(), PCB_EDITOR_CONTROL::SaveAs(), and PCB_EDITOR_CONTROL::SaveCopyAs().

◆ findPythonConsole()

static wxWindow* PCB_EDIT_FRAME::findPythonConsole ( )
inlinestaticprotected
Returns
a pointer to the python console frame, or NULL if not exist

Definition at line 191 of file pcb_edit_frame.h.

192  {
193  return FindWindowByName( pythonConsoleNameId() );
194  }
static const wxChar * pythonConsoleNameId()
Has meaning only if KICAD_SCRIPTING_WXPYTHON option is not defined.

References pythonConsoleNameId().

Referenced by setupUIConditions().

◆ fixEagleNets()

bool PCB_EDIT_FRAME::fixEagleNets ( const std::unordered_map< wxString, wxString > &  aRemap)
protected

Rematch orphaned zones and vias to schematic nets.

Definition at line 1136 of file pcbnew/files.cpp.

1137 {
1138  bool result = true;
1139  BOARD* board = GetBoard();
1140 
1141  // perform netlist matching to prevent orphaned zones.
1142  for( auto zone : board->Zones() )
1143  {
1144  auto it = aRemap.find( zone->GetNet()->GetNetname() );
1145 
1146  if( it != aRemap.end() )
1147  {
1148  NETINFO_ITEM* net = board->FindNet( it->second );
1149 
1150  if( !net )
1151  {
1152  wxFAIL;
1153  result = false;
1154  continue;
1155  }
1156 
1157  zone->SetNet( net );
1158  }
1159  }
1160 
1161 
1162  // perform netlist matching to prevent orphaned tracks/vias.
1163  for( auto track : board->Tracks() )
1164  {
1165  auto it = aRemap.find( track->GetNet()->GetNetname() );
1166 
1167  if( it != aRemap.end() )
1168  {
1169  NETINFO_ITEM* net = board->FindNet( it->second );
1170 
1171  if( !net )
1172  {
1173  wxFAIL;
1174  result = false;
1175  continue;
1176  }
1177 
1178  track->SetNet( net );
1179  }
1180  }
1181 
1182  return result;
1183 }
NETINFO_ITEM * FindNet(int aNetcode) const
Function FindNet searches for a net with the given netcode.
NETINFO_ITEM handles the data for a net.
Definition: netinfo.h:65
ZONE_CONTAINERS & Zones()
Definition: class_board.h:254
BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:178
BOARD * GetBoard() const
TRACKS & Tracks()
Definition: class_board.h:246

References BOARD::FindNet(), PCB_BASE_FRAME::GetBoard(), BOARD::Tracks(), and BOARD::Zones().

Referenced by importFile().

◆ FocusOnItem()

void PCB_BASE_FRAME::FocusOnItem ( BOARD_ITEM aItem)
inherited

Definition at line 174 of file pcb_base_frame.cpp.

175 {
176  static KIID lastBrightenedItemID( niluuid );
177 
178  BOARD_ITEM* lastItem = GetBoard()->GetItem( lastBrightenedItemID );
179 
180  if( lastItem && lastItem != aItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
181  {
182  lastItem->ClearBrightened();
183 
184  if( lastItem->Type() == PCB_MODULE_T )
185  {
186  static_cast<MODULE*>( lastItem )->RunOnChildren( [&]( BOARD_ITEM* child )
187  {
188  child->ClearBrightened();
189  });
190  }
191  else if( lastItem->Type() == PCB_GROUP_T )
192  {
193  static_cast<PCB_GROUP*>( lastItem )->RunOnChildren( [&] ( BOARD_ITEM* child )
194  {
195  child->ClearBrightened();
196  });
197  }
198 
199  GetCanvas()->GetView()->Update( lastItem );
200  lastBrightenedItemID = niluuid;
201  GetCanvas()->Refresh();
202  }
203 
204  if( aItem )
205  {
206  aItem->SetBrightened();
207 
208  if( aItem->Type() == PCB_MODULE_T )
209  {
210  static_cast<MODULE*>( aItem )->RunOnChildren( [&]( BOARD_ITEM* child )
211  {
212  child->SetBrightened();
213  });
214  }
215  else if( aItem->Type() == PCB_GROUP_T )
216  {
217  static_cast<PCB_GROUP*>( aItem )->RunOnChildren( [&] ( BOARD_ITEM* child )
218  {
219  child->SetBrightened();
220  });
221  }
222 
223  GetCanvas()->GetView()->Update( aItem );
224  lastBrightenedItemID = aItem->m_Uuid;
225  FocusOnLocation( aItem->GetFocusPosition() );
226  GetCanvas()->Refresh();
227  }
228 }
virtual void Update(VIEW_ITEM *aItem, int aUpdateFlags) override
For dynamic VIEWs, informs the associated VIEW that the graphical representation of this item has cha...
Definition: pcb_view.cpp:93
BOARD_ITEM is a base class for any item which can be embedded within the BOARD container class,...
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:109
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual const wxPoint GetFocusPosition() const
Function GetFocusPosition similar to GetPosition, but allows items to return their visual center rath...
Definition: base_struct.h:345
void SetBrightened()
Definition: base_struct.h:209
BOARD_ITEM * GetItem(const KIID &aID)
void ClearBrightened()
Definition: base_struct.h:212
Definition: common.h:68
class MODULE, a footprint
Definition: typeinfo.h:89
static DELETED_BOARD_ITEM * GetInstance()
KIID niluuid(0)
virtual KIGFX::PCB_VIEW * GetView() const override
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=NULL) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
const KIID m_Uuid
Definition: base_struct.h:162
BOARD * GetBoard() const
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor...
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193

References EDA_ITEM::ClearBrightened(), EDA_DRAW_FRAME::FocusOnLocation(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), EDA_ITEM::GetFocusPosition(), DELETED_BOARD_ITEM::GetInstance(), BOARD::GetItem(), PCB_DRAW_PANEL_GAL::GetView(), EDA_ITEM::m_Uuid, niluuid, PCB_GROUP_T, PCB_MODULE_T, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), EDA_ITEM::Type(), and KIGFX::PCB_VIEW::Update().

Referenced by SELECTION_TOOL::Main(), DIALOG_DRC::OnCancelClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), and DIALOG_DRC::~DIALOG_DRC().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint aPos)
inherited

Useful to focus on a particular location, in find functions Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested.

Parameters
aPosis the point to go to.

Definition at line 767 of file eda_draw_frame.cpp.

768 {
769  bool centerView = false;
770  BOX2D r = GetCanvas()->GetView()->GetViewport();
771 
772  // Center if we're off the current view, or within 10% of its edge
773  r.Inflate( - (int) r.GetWidth() / 10 );
774 
775  if( !r.Contains( aPos ) )
776  centerView = true;
777 
778  // Center if we're behind an obscuring dialog, or within 10% of its edge
779  wxWindow* dialog = findDialog( GetChildren() );
780 
781  if( dialog )
782  {
783  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
784  dialog->GetSize() );
785  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
786 
787  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
788  centerView = true;
789  }
790 
791  if( centerView )
792  {
793  // If a dialog partly obscures the window, then center on the uncovered area.
794  if( dialog )
795  {
796  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
797  dialog->GetSize() );
798  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
799  }
800  else
801  GetCanvas()->GetView()->SetCenter( aPos );
802  }
803 
805 }
BOX2D GetViewport() const
Function GetViewport() Returns the current viewport visible area rectangle.
Definition: view.cpp:537
KIGFX::VIEW_CONTROLS * GetViewControls() const
Function GetViewControls() Returns a pointer to the VIEW_CONTROLS instance used in the panel.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetCenter(const VECTOR2D &aCenter)
Function SetCenter() Sets the center point of the VIEW (i.e.
Definition: view.cpp:603
coord_type GetWidth() const
Definition: box2.h:197
bool Contains(const Vec &aPoint) const
Function Contains.
Definition: box2.h:151
wxWindow * findDialog(wxWindowList &aList)
virtual KIGFX::VIEW * GetView() const
Function GetView() Returns a pointer to the VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Moves the graphic crosshair cursor to the requested position expressed in world coordinates.
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:302

References BOX2< Vec >::Contains(), findDialog(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), BOX2< Vec >::Inflate(), KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().

Referenced by SELECTION_TOOL::findCallback(), SCH_EDITOR_CONTROL::FindNext(), PCB_BASE_FRAME::FocusOnItem(), SCH_EDIT_FRAME::FocusOnItem(), and DIALOG_FIND::search().

◆ GenD356File()

void PCB_EDIT_FRAME::GenD356File ( wxCommandEvent &  event)

Definition at line 363 of file export_d356.cpp.

364 {
365  wxFileName fn = GetBoard()->GetFileName();
366  wxString msg, ext, wildcard;
367 
368  ext = IpcD356FileExtension;
369  wildcard = IpcD356FileWildcard();
370  fn.SetExt( ext );
371 
372  wxString pro_dir = wxPathOnly( Prj().GetProjectFullName() );
373 
374  wxFileDialog dlg( this, _( "Export D-356 Test File" ), pro_dir,
375  fn.GetFullName(), wildcard,
376  wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
377 
378  if( dlg.ShowModal() == wxID_CANCEL )
379  return;
380 
381  IPC356D_WRITER writer( GetBoard(), this );
382 
383  writer.Write( dlg.GetPath() );
384 }
const wxString & GetFileName() const
Definition: class_board.h:244
Wrapper to expose an API for writing IPC-D356 files.
Definition: export_d356.h:53
PROJECT & Prj() const
Function Prj returns a reference to the PROJECT "associated with" this KIWAY.
const std::string IpcD356FileExtension
wxString IpcD356FileWildcard()
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const

References _, PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), IpcD356FileExtension, IpcD356FileWildcard(), KIWAY_HOLDER::Prj(), and IPC356D_WRITER::Write().

Referenced by PCB_EDITOR_CONTROL::GenerateFabFiles().

◆ GenFootprintsReport()

void PCB_EDIT_FRAME::GenFootprintsReport ( wxCommandEvent &  event)

Function GenFootprintsReport Calls DoGenFootprintsReport to create a footprint reprot file See DoGenFootprintsReport for file format.

Definition at line 504 of file gen_footprints_placefile.cpp.

505 {
506  wxFileName fn;
507 
508  wxString boardFilePath = ( (wxFileName) GetBoard()->GetFileName() ).GetPath();
509  wxDirDialog dirDialog( this, _( "Select Output Directory" ), boardFilePath );
510 
511  if( dirDialog.ShowModal() == wxID_CANCEL )
512  return;
513 
514  fn = GetBoard()->GetFileName();
515  fn.SetPath( dirDialog.GetPath() );
516  fn.SetExt( wxT( "rpt" ) );
517 
518  bool unitMM = GetUserUnits() != EDA_UNITS::INCHES;
519  bool success = DoGenFootprintsReport( fn.GetFullPath(), unitMM );
520 
521  wxString msg;
522  if( success )
523  {
524  msg.Printf( _( "Footprint report file created:\n\"%s\"" ), fn.GetFullPath() );
525  wxMessageBox( msg, _( "Footprint Report" ), wxICON_INFORMATION );
526  }
527 
528  else
529  {
530  msg.Printf( _( "Unable to create \"%s\"" ), fn.GetFullPath() );
531  DisplayError( this, msg );
532  }
533 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:239
const wxString & GetFileName() const
Definition: class_board.h:244
bool DoGenFootprintsReport(const wxString &aFullFilename, bool aUnitsMM)
Function DoGenFootprintsReport Creates an ascii footprint report file giving some infos on footprints...
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References _, DisplayError(), DoGenFootprintsReport(), PCB_BASE_FRAME::GetBoard(), BOARD::GetFileName(), EDA_BASE_FRAME::GetUserUnits(), and INCHES.

Referenced by PCB_EDITOR_CONTROL::GenerateFabFiles().

◆ Get3DViewerFrame()

EDA_3D_VIEWER * PCB_BASE_FRAME::Get3DViewerFrame ( )
inherited
Returns
a reference to the child 3D viewer frame, when exists, or NULL

Definition at line 78 of file pcb_base_frame.cpp.

79 {
80  return dynamic_cast<EDA_3D_VIEWER*>( FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) ) );
81 }
#define QUALIFIED_VIEWER3D_FRAMENAME(parent)
Definition: eda_3d_viewer.h:51

References QUALIFIED_VIEWER3D_FRAMENAME.

Referenced by PCB_BASE_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CreateAndShow3D_Frame(), OpenProjectFiles(), PCB_BASE_FRAME::Update3DView(), and FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME().

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

Definition at line 573 of file eda_base_frame.h.

573 { return m_AboutTitle; }
wxString m_AboutTitle

References EDA_BASE_FRAME::m_AboutTitle.

Referenced by DIALOG_ABOUT::DIALOG_ABOUT(), and COMMON_CONTROL::ReportBug().

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const
inlinevirtualinherited

Definition at line 376 of file pcb_base_frame.h.

377  {
378  return GetScreen()->m_Active_Layer;
379  }
PCB_LAYER_ID m_Active_Layer
Definition: pcb_screen.h:37
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.

References PCB_BASE_FRAME::GetScreen(), and PCB_SCREEN::m_Active_Layer.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_BASE_FRAME::GetCollectorsGuide(), PCB_INSPECTION_TOOL::InspectClearance(), PCBNEW_CONTROL::LayerAlphaDec(), PCBNEW_CONTROL::LayerAlphaInc(), PCBNEW_CONTROL::LayerNext(), PCBNEW_CONTROL::LayerPrev(), PCBNEW_CONTROL::LayerToggle(), ROUTER_TOOL::MainLoop(), DIALOG_FOOTPRINT_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_BOARD_EDITOR::OnAddField(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::OnLayerChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_LAYER_WIDGET::onPopupSelection(), PCB_DRAW_PANEL_GAL::OnShow(), FOOTPRINT_EDIT_FRAME::OnUpdateLayerSelectBox(), OnUpdateLayerSelectBox(), DRAWING_TOOL::PlaceText(), PrepareLayerIndicator(), SaveProjectSettings(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_BASE_FRAME::SwitchLayer(), SwitchLayer(), ROUTER_TOOL::switchLayerOnViaPlacement(), and FOOTPRINT_EDIT_FRAME::UpdateUserInterface().

◆ GetAppearancePanel()

APPEARANCE_CONTROLS* PCB_EDIT_FRAME::GetAppearancePanel ( )
inline

Definition at line 467 of file pcb_edit_frame.h.

467 { return m_appearancePanel; }
APPEARANCE_CONTROLS * m_appearancePanel
AUI panel for controlling layer and object visibility and appearance.

References PCB_BASE_EDIT_FRAME::m_appearancePanel.

Referenced by DIALOG_DRC::OnDRCItemSelected().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited
Returns
the string to prepend to a file name for automatic save.

Definition at line 195 of file eda_base_frame.h.

196  {
197  return wxT( "_autosave-" );
198  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), SCH_EDIT_FRAME::doAutoSave(), doAutoSave(), SCH_EDIT_FRAME::doCloseWindow(), Files_io_from_id(), OnExportSTEP(), SCH_EDIT_FRAME::SaveEEFile(), and SavePcbFile().

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 334 of file eda_base_frame.h.

334 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAutoZoom()

virtual bool PCB_BASE_FRAME::GetAutoZoom ( )
inlinevirtualinherited

Always returns false.

Should be overriden in derived classes which support autozoom.

Reimplemented in DISPLAY_FOOTPRINTS_FRAME, and FOOTPRINT_VIEWER_FRAME.

Definition at line 418 of file pcb_base_frame.h.

418 { return false; }

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const
inherited

Definition at line 273 of file pcb_base_frame.cpp.

274 {
275  wxASSERT( m_Pcb );
277 }
BOARD * m_Pcb
Definition: