KiCad PCB EDA Suite
PCB_EDIT_FRAME Class Reference

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  UNDO_REDO_LIST { UNDO_LIST, REDO_LIST }
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...
 
enum  HOLDER_TYPE { DIALOG, FRAME, PANEL }
 

Public Member Functions

virtual ~PCB_EDIT_FRAME ()
 
void LoadFootprints (NETLIST &aNetlist, REPORTER &aReporter)
 Load the footprints for each SCH_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 HardRedraw () override
 Rebuild the GAL and redraws the screen. 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). More...
 
void KiwayMailIn (KIWAY_EXPRESS &aEvent) override
 Receive KIWAY_EXPRESS messages from other players. More...
 
void ToPlotter (int aID)
 Open a dialog frame to create plot and drill files relative to the current board. More...
 
void ExportSVG (wxCommandEvent &event)
 Show the Export to SVG file dialog. More...
 
void OnUpdateLayerSelectBox (wxUpdateUIEvent &aEvent)
 
bool LayerManagerShown ()
 
void OnUpdateSelectViaSize (wxUpdateUIEvent &aEvent)
 
void OnUpdateSelectTrackWidth (wxUpdateUIEvent &aEvent)
 
void OnUpdateSelectAutoWidth (wxUpdateUIEvent &aEvent)
 
void RunEeschema ()
 
void UpdateTrackWidthSelectBox (wxChoice *aTrackWidthSelectBox, bool aEdit=true)
 
void UpdateViaSizeSelectBox (wxChoice *aViaSizeSelectBox, bool aEdit=true)
 
COLOR4D GetGridColor () override
 
void SetGridColor (COLOR4D aColor) override
 
void Process_Config (wxCommandEvent &event)
 
void SaveProjectSettings () override
 Save 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
 Save 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 ReCreateOptToolbar () override
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
void UpdateToolbarControlSizes () override
 Update the sizes of any controls in the toolbars of the frame. More...
 
void ReCreateLayerBox (bool aForceResizeToolbar=true)
 Recreate the layer box by clearing the old list and building a new one from the new layer names and colors. More...
 
void OnModify () override
 Must be called after a board change to set the modified flag. More...
 
void SetActiveLayer (PCB_LAYER_ID aLayer) override
 Change the currently active layer to aLayer and also update the APPEARANCE_CONTROLS. More...
 
void OnDisplayOptionsChanged () override
 
bool IsElementVisible (GAL_LAYER_ID aElement) const
 Test whether a given element category is visible. More...
 
void SetElementVisibility (GAL_LAYER_ID aElement, bool aNewState)
 Change the visibility of an element category. More...
 
void ActivateGalCanvas () override
 Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD. More...
 
void ShowBoardSetupDialog (const wxString &aInitialPage=wxEmptyString)
 
void PrepareLayerIndicator (bool aForceRebuild=false)
 
void ToggleLayersManager ()
 
int DoGenFootprintsPositionFile (const wxString &aFullFileName, bool aUnitsMM, bool aForceSmdItems, bool aTopSide, bool aBottomSide, bool aFormatCSV=false)
 Create an ASCII footprint position file. More...
 
void GenFootprintsReport (wxCommandEvent &event)
 Call DoGenFootprintsReport to create a footprint report file. More...
 
bool DoGenFootprintsReport (const wxString &aFullFilename, bool aUnitsMM)
 Create 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)
 Call Files_io_from_id with the wxCommandEvent id. More...
 
bool Files_io_from_id (int aId)
 Read and write board files according to aId. More...
 
bool OpenProjectFiles (const std::vector< wxString > &aFileSet, int aCtl=0) override
 Load a KiCad board (.kicad_pcb) from aFileName. More...
 
bool SavePcbFile (const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
 Write the board data structures to a aFileName. More...
 
bool SavePcbCopy (const wxString &aFileName, bool aCreateProject=false)
 Write the board data structures to aFileName. More...
 
bool Clear_Pcb (bool aQuery, bool aFinal=false)
 Delete all and reinitialize the current board. More...
 
void SetBoard (BOARD *aBoard) override
 
BOARD_ITEM_CONTAINERGetModel () const override
 
void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
void RecreateCmpFileFromBoard (wxCommandEvent &aEvent)
 Recreates a .cmp file from the current loaded board. More...
 
void ExportFootprintsToLibrary (bool aStoreInNewLib, const wxString &aLibName=wxEmptyString, wxString *aLibPath=NULL)
 Save footprints in a library: More...
 
void RecreateBOMFileFromBoard (wxCommandEvent &aEvent)
 Create a BOM file from the current loaded board. More...
 
void ExportToGenCAD (wxCommandEvent &event)
 Create a file in GenCAD 1.4 format from the current board. More...
 
void OnExportVRML (wxCommandEvent &event)
 Export the current BOARD to a VRML file. More...
 
bool ExportVRML_File (const wxString &aFullFileName, double aMMtoWRMLunit, bool aExport3DFiles, bool aUseRelativePaths, const wxString &a3D_Subdir, double aXRef, double aYRef)
 Create the file(s) exporting current BOARD to a VRML file. More...
 
void OnExportIDF3 (wxCommandEvent &event)
 Export the current BOARD to a IDFv3 board and lib files. More...
 
void OnExportHyperlynx (wxCommandEvent &event)
 Export the current BOARD to a Hyperlynx HYP file. More...
 
bool Export_IDF3 (BOARD *aPcb, const wxString &aFullFileName, bool aUseThou, double aXRef, double aYRef)
 Create an IDF3 compliant BOARD (*.emn) and LIBRARY (*.emp) file. More...
 
void OnExportSTEP (wxCommandEvent &event)
 Export the current BOARD to a STEP assembly. More...
 
bool ExportSpecctraFile (const wxString &aFullFilename)
 Export the current BOARD to a specctra dsn file. More...
 
bool ImportSpecctraSession (const wxString &aFullFilename)
 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 ShowFootprintPropertiesDialog (FOOTPRINT *aFootprint)
 
int ShowExchangeFootprintsDialog (FOOTPRINT *aFootprint, bool aUpdateMode, bool aSelectedMode)
 
void ExchangeFootprint (FOOTPRINT *aExisting, FOOTPRINT *aNew, BOARD_COMMIT &aCommit, bool deleteExtraTexts=true, bool resetTextLayers=true, bool resetTextEffects=true, bool resetFabricationAttrs=true, bool reset3DModels=true)
 Replace aExisting footprint by aNew footprint using the Existing footprint settings (position, orientation, pad netnames ...). More...
 
void OnEditItemRequest (BOARD_ITEM *aItem) override
 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)
 Modify one track segment width or one via diameter (using DRC control). More...
 
void Edit_Zone_Params (ZONE *zone_container)
 Edit params (layer, clearance, ...) for a zone outline. More...
 
void ShowTargetOptionsDialog (PCB_TARGET *aTarget)
 
void ShowDimensionPropertiesDialog (DIMENSION_BASE *aDimension)
 
void InstallNetlistFrame ()
 
bool FetchNetlistFromSchematic (NETLIST &aNetlist, const wxString &aAnnotateMessage)
 
bool ReannotateSchematic (std::string &aNetlist)
 Send a command to Eeschema to re-annotate the schematic. More...
 
bool TestStandalone (void)
 Test if standalone mode. More...
 
bool ReadNetlistFromFile (const wxString &aFilename, NETLIST &aNetlist, REPORTER &aReporter)
 Read 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 SendMessageToEESCHEMA (BOARD_ITEM *objectToSync)
 Send a message to the schematic editor so that it may move its cursor to a symbol with the same reference as the objectToSync. More...
 
void SendCrossProbeNetName (const wxString &aNetName)
 Send a net name to Eeschema for highlighting. More...
 
void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
void UpdateTitle ()
 Set the main window title bar text. More...
 
void InstallPreferences (PAGED_DIALOG *aParent, PANEL_HOTKEYS_EDITOR *aHotkeysPanel) override
 Allow 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 ThemeChanged () override
 Called when light/dark theme is changed. 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...
 
TOOL_ACTIONGetExportNetlistAction ()
 
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, FP_LIB_TABLE *aTable=nullptr)
 Add an existing library to either the global or project library table. More...
 
void SaveCopyInUndoList (EDA_ITEM *aItemToCopy, UNDO_REDO aTypeCommand) override
 Create a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &aItemsList, UNDO_REDO aCommandType) override
 Create a new entry in undo list of commands. More...
 
void RestoreCopyFromRedoList (wxCommandEvent &aEvent)
 Redo the last edit: More...
 
void RestoreCopyFromUndoList (wxCommandEvent &aEvent)
 Undo the last edit: More...
 
void RollbackFromUndo ()
 Perform an undo of the last edit without logging a corresponding redo. More...
 
void PutDataInPreviousState (PICKED_ITEMS_LIST *aList)
 Used in undo or redo command. More...
 
bool UndoRedoBlocked () const
 Check if the undo and redo operations are currently blocked. More...
 
void UndoRedoBlock (bool aBlock=true)
 Enable/disable undo and redo operations. More...
 
void SetGridVisibility (bool aVisible) override
 Override this function in the PCB_BASE_EDIT_FRAME to refill the layer widget. More...
 
void SetObjectVisible (GAL_LAYER_ID aLayer, bool aVisible=true)
 
int GetRotationAngle () const
 Return the angle used for rotate operations. More...
 
void SetRotationAngle (int aRotationAngle)
 Set the angle used for rotate operations. More...
 
void ShowTextPropertiesDialog (BOARD_ITEM *aText)
 
void ShowGraphicItemPropertiesDialog (BOARD_ITEM *aItem)
 
COLOR_SETTINGSGetColorSettings () const override
 Helper to retrieve the current color settings. More...
 
void ClearUndoORRedoList (UNDO_REDO_LIST whichList, int aItemCount=-1) override
 Free the undo or redo list from List element. More...
 
wxString GetDesignRulesPath ()
 Return the absolute path to the design rules file for the currently-loaded board. More...
 
APPEARANCE_CONTROLSGetAppearancePanel ()
 
virtual void OnLayerAlphaChanged ()
 Notify the frame that the layer Alpha is being changed. More...
 
EDA_3D_VIEWERGet3DViewerFrame ()
 
virtual void Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
 Update the 3D view, if the viewer is opened by this frame. More...
 
FOOTPRINTLoadFootprint (const LIB_ID &aFootprintId)
 Attempt to load aFootprintId from the footprint library table. More...
 
EDA_RECT GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
 Calculate the bounding box containing all board items (or board edge segments). More...
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Returns bbox of document with option to not include some items. More...
 
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 wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const wxPoint & GetAuxOrigin () 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. More...
 
PCBNEW_SETTINGSSettings ()
 
void SetDrawBgColor (COLOR4D aColor) override
 
const PCB_DISPLAY_OPTIONSGetDisplayOptions () const
 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, bool aRefresh=true)
 Updates the current display options from the given options struct. More...
 
const ZONE_SETTINGSGetZoneSettings () const
 
void SetZoneSettings (const ZONE_SETTINGS &aSettings)
 
virtual const PCB_PLOT_PARAMSGetPlotSettings () const
 Return 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) const 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 ()
 
wxString SelectLibrary (const wxString &aNicknameExisting)
 Put up a dialog and allows the user to pick a library, for unspecified use. More...
 
FOOTPRINTGetFootprintFromBoardByReference ()
 
FOOTPRINTCreateNewFootprint (const wxString &aFootprintName)
 Creates a new footprint, at position 0,0. More...
 
void PlaceFootprint (FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
 Places aFootprint at the current cursor position and updates footprint coordinates with the new position. More...
 
void ShowPadPropertiesDialog (PAD *aPad)
 
FOOTPRINTSelectFootprintFromLibTree (LIB_ID aPreselect=LIB_ID())
 Open a dialog to select a footprint. More...
 
virtual void AddFootprintToBoard (FOOTPRINT *aFootprint)
 Add the given footprint to the board. More...
 
wxString SelectFootprintFromLibBrowser ()
 Launch the footprint viewer to select the name of a footprint to load. More...
 
void Compile_Ratsnest (bool aDisplayStatus)
 Create the entire board ratsnest. More...
 
PCB_LAYER_ID SelectOneLayer (PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
 Show the dialog box for a layer selection. More...
 
virtual PCB_LAYER_ID GetActiveLayer () const
 
SEVERITY GetSeverity (int aErrorCode) const override
 
PCBNEW_SETTINGSGetPcbNewSettings () const
 
FOOTPRINT_EDITOR_SETTINGSGetFootprintEditorSettings () const
 
virtual MAGNETIC_SETTINGSGetMagneticItemsSettings ()
 
void DisplayGridMsg () override
 Display the current grid pane on the status bar. 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
 
void GetUnitPair (EDA_UNITS &aPrimaryUnit, EDA_UNITS &aSecondaryUnits)
 Get the pair or units in current use. More...
 
wxPoint GetNearestGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize location to aPosition. More...
 
wxPoint GetNearestHalfGridPosition (const wxPoint &aPosition) const
 Return the nearest aGridSize / 2 location to aPosition. More...
 
virtual COLOR4D GetDrawBgColor () const
 
bool ShowPageLimits () const
 
void SetShowPageLimits (bool aShow)
 
bool LibraryFileBrowser (bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
 
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 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. More...
 
void AddStandardSubMenus (TOOL_MENU &aMenu)
 Construct a "basic" menu for a tool, containing only items that apply to all tools (e.g. More...
 
void PrintDrawingSheet (const RENDER_SETTINGS *aSettings, BASE_SCREEN *aScreen, double aMils2Iu, const wxString &aFilename, const wxString &aSheetLayer=wxEmptyString)
 Prints the drawing-sheet (frame and title block). 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 &aTextUpper, const wxString &aTextLower, int aPadding=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)
 
void SetMsgPanel (const wxString &aTextUpper, const wxString &aTextLower, int aPadding=6)
 Helper function that erases the msg panel and then appends a single message. More...
 
virtual void UpdateMsgPanel ()
 Redraw the message panel. More...
 
virtual void PrintPage (const RENDER_SETTINGS *aSettings)
 Print the page pointed by current screen, set by the calling print function. 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 check tools. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handle command-line arguments in a frame-specific way. More...
 
virtual bool ShowModal (wxString *aResult=nullptr, wxWindow *aResultantFocusWindow=nullptr)
 Show 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. More...
 
void SetModal (bool aIsModal)
 
bool IsDismissed ()
 
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 (int aID, const ACTION_CONDITIONS &aConditions) override
 Register a UI update handler for the control with ID aID. More...
 
virtual void RegisterUIUpdateHandler (const TOOL_ACTION &aAction, const ACTION_CONDITIONS &aConditions)
 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 UnregisterUIUpdateHandler (int aID) override
 Unregister a UI handler for a given ID that was registered using RegisterUIUpdateHandler. More...
 
virtual void UnregisterUIUpdateHandler (const TOOL_ACTION &aAction)
 Unregister a UI handler for an action 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)
 
void CreateInfoBar ()
 
void FinishAUIInitialization ()
 
WX_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
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)
 Load window settings from the given settings object. More...
 
void SaveWindowSettings (WINDOW_SETTINGS *aCfg)
 Save window settings to the given settings object. More...
 
virtual WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg)
 Return a pointer to the window settings for this frame. More...
 
wxString ConfigBaseName () override
 Get the configuration base name. More...
 
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 ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 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)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
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
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

static void HandleUpdateUIEvent (wxUpdateUIEvent &aEvent, EDA_BASE_FRAME *aFrame, ACTION_CONDITIONS aCond)
 Handle 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_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
 Switch currently used canvas (Cairo / OpenGL). More...
 
void onBoardLoaded ()
 Update the state of the GUI after a new board is loaded or created. More...
 
bool doAutoSave () override
 Perform auto save when the board has been modified and not saved within the auto save interval. More...
 
bool isAutoSaveRequired () const override
 Return 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...
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
void doCloseWindow () override
 
 PCB_EDIT_FRAME (KIWAY *aKiway, wxWindow *aParent)
 
void onSize (wxSizeEvent &aEvent)
 
int inferLegacyEdgeClearance (BOARD *aBoard)
 
FP_LIB_TABLEselectLibTable (bool aOptional=false)
 Prompts a user to select global or project library tables. More...
 
void handleActivateEvent (wxActivateEvent &aEvent) override
 Handle a window activation event. More...
 
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...
 
FOOTPRINTloadFootprint (const LIB_ID &aFootprintId)
 Attempts to load aFootprintId from the footprint library table. More...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
void resolveCanvasType ()
 Determines the Canvas type to load (with prompt if required) and initializes m_canvasType. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting ()
 Returns the canvas type stored in the application settings. More...
 
bool saveCanvasTypeSetting (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Stores the canvas type in the application settings. More...
 
void onActivate (wxActivateEvent &aEvent)
 
void kiway_express (KIWAY_EXPRESS &aEvent)
 event handler, routes to derivative specific virtual KiwayMailIn() More...
 
void language_change (wxCommandEvent &event)
 An event handler called on a language menu selection. More...
 
void onAutoSaveTimer (wxTimerEvent &aEvent)
 Handle the auto save timer event. More...
 
void onSystemColorChange (wxSysColourChangedEvent &aEvent)
 
void initExitKey ()
 Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id. 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 GetAutoSaveFilePrefix ()
 

Protected Attributes

LAYER_TOOLBAR_ICON_VALUES m_prevIconVal
 
int m_rotationAngle
 
bool m_undoRedoBlocked
 
PANEL_SELECTION_FILTERm_selectionFilterPanel
 
APPEARANCE_CONTROLSm_appearancePanel
 
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
 
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
 The current canvas type. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 < Points to nested event_loop. NULL means not modal and dismissed. More...
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
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
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
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

TOOL_ACTIONm_exportNetlistAction
 The export board netlist tool action object. More...
 

Friends

struct PCB::IFACE
 
class APPEARANCE_CONTROLS
 

Detailed Description

The main frame for Pcbnew.

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

Definition at line 72 of file pcb_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE
inherited
Enumerator
DIALOG 
FRAME 
PANEL 

Definition at line 42 of file kiway_holder.h.

◆ UNDO_REDO_LIST

Remove the aItemCount of 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. Commands are deleted from the older to the last.

Parameters
aList= the UNDO_REDO_CONTAINER of commands.
aItemCountnumber of old commands to delete. -1 to remove all old commands this will empty the list of commands.
Enumerator
UNDO_LIST 
REDO_LIST 

Definition at line 524 of file eda_base_frame.h.

Constructor & Destructor Documentation

◆ ~PCB_EDIT_FRAME()

PCB_EDIT_FRAME::~PCB_EDIT_FRAME ( )
virtual

Definition at line 386 of file pcb_edit_frame.cpp.

387 {
388  // Close modeless dialogs
389  wxWindow* open_dlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
390 
391  if( open_dlg )
392  open_dlg->Close( true );
393 
394  // Shutdown all running tools
395  if( m_toolManager )
397 
398  if( GetBoard() )
400 
401  delete m_selectionFilterPanel;
402  delete m_appearancePanel;
403 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
APPEARANCE_CONTROLS * m_appearancePanel
void RemoveListener(BOARD_LISTENER *aListener)
Remove the specified listener.
Definition: board.cpp:2020
#define DIALOG_DRC_WINDOW_NAME
Definition: dialog_drc.h:41
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
PANEL_SELECTION_FILTER * m_selectionFilterPanel
BOARD * GetBoard() const

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

◆ PCB_EDIT_FRAME()

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

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_EDIT_FRAME::ActivateGalCanvas ( )
overridevirtual

Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.

Parameters
aBoardis the BOARD to put into the frame.

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 896 of file pcb_edit_frame.cpp.

897 {
899  GetCanvas()->UpdateColors();
900  GetCanvas()->Refresh();
901 }
void ActivateGalCanvas() override
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
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()
Update the color settings in the painter and GAL.

References PCB_BASE_EDIT_FRAME::ActivateGalCanvas().

Referenced by Refresh().

◆ AddFootprintToBoard()

void PCB_BASE_FRAME::AddFootprintToBoard ( FOOTPRINT aFootprint)
virtualinherited

Add the given footprint to the board.

Parameters
aDCis the current Device Context, to draw the new footprint (can be NULL ).

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 158 of file pcb_base_frame.cpp.

159 {
160  if( aFootprint )
161  {
162  GetBoard()->Add( aFootprint, ADD_MODE::APPEND );
163 
164  aFootprint->SetFlags( IS_NEW );
165  aFootprint->SetPosition( wxPoint( 0, 0 ) ); // cursor in GAL may not be initialized yet
166 
167  // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
168  // built from a board)
169  if( aFootprint->IsFlipped() )
170  aFootprint->Flip( aFootprint->GetPosition(), m_settings->m_FlipLeftRight );
171 
172  // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
173  // it might be stored in another orientation if the lib is an archive built from a board)
174  aFootprint->SetOrientation( 0 );
175  }
176 }
PCBNEW_SETTINGS * m_settings
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
Definition: board.cpp:563
void SetFlags(STATUS_FLAGS aMask)
Definition: eda_item.h:203
void SetOrientation(double aNewAngle)
Definition: footprint.cpp:1557
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: footprint.cpp:1367
bool IsFlipped() const
Definition: footprint.h:266
wxPoint GetPosition() const override
Definition: footprint.h:182
BOARD * GetBoard() const
void SetPosition(const wxPoint &aPos) override
Definition: footprint.cpp:1438
#define IS_NEW
New item, just created.
Definition: eda_item.h:107

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

Referenced by FOOTPRINT_EDIT_FRAME::AddFootprintToBoard().

◆ AddLibrary()

bool PCB_BASE_EDIT_FRAME::AddLibrary ( const wxString &  aLibName = wxEmptyString,
FP_LIB_TABLE aTable = nullptr 
)
inherited

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 522 of file footprint_libraries_utils.cpp.

523 {
524  if( aTable == nullptr )
525  {
526  aTable = selectLibTable();
527 
528  if( aTable == nullptr )
529  {
530  return wxEmptyString;
531  }
532  }
533 
534  bool isGlobal = ( aTable == &GFootprintTable );
535 
536  wxFileName fn( aFilename );
537 
538  if( aFilename.IsEmpty() )
539  {
541  KiCadFootprintLibPathExtension, true, isGlobal,
543  {
544  return false;
545  }
546  }
547 
548  wxString libPath = fn.GetFullPath();
549  wxString libName = fn.GetName();
550 
551  if( libName.IsEmpty() )
552  return false;
553 
554 
555  wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
556 
557  // try to use path normalized to an environmental variable or project path
558  wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
559 
560  if( normalizedPath.IsEmpty() )
561  normalizedPath = libPath;
562 
563  try
564  {
565  auto row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
566  aTable->InsertRow( row );
567 
568  if( isGlobal )
569  {
571  }
572  else
573  {
574  Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
575  }
576  }
577  catch( const IO_ERROR& ioe )
578  {
579  DisplayError( this, ioe.What() );
580  return false;
581  }
582 
584 
585  if( editor )
586  {
587  LIB_ID libID( libName, wxEmptyString );
588  editor->SyncLibraryTree( true );
589  editor->FocusOnLibID( libID );
590  }
591 
592  auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
593 
594  if( viewer )
595  viewer->ReCreateLibraryList();
596 
597  return true;
598 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:56
FP_LIB_TABLE GFootprintTable
!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it.
Definition: cvpcb.cpp:120
Hold a record identifying a library accessed by the appropriate footprint library PLUGIN object in th...
Definition: fp_lib_table.h:40
bool InsertRow(LIB_TABLE_ROW *aRow, bool doReplace=false)
Adds aRow if it does not already exist or if doReplace is true.
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
Component library viewer main window.
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:357
static const wxString ShowType(PCB_FILE_T aFileType)
Return a brief name for a plugin given aFileType enum.
Definition: io_mgr.cpp:77
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
static PCB_FILE_T GuessPluginTypeFromLibPath(const wxString &aLibPath)
Return a plugin type given a footprint library's libPath.
Definition: io_mgr.cpp:124
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:285
wxString KiCadFootprintLibPathWildcard()
static wxString GetDefaultUserFootprintsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:108
FP_LIB_TABLE * selectLibTable(bool aOptional=false)
Prompts a user to select global or project library tables.
void Save(const wxString &aFileName) const
Write this library table to aFileName in s-expression form.
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
const std::string KiCadFootprintLibPathExtension
wxString NormalizePath(const wxFileName &aFilePath, const ENV_VAR_MAP *aEnvVars, const wxString &aProjectPath)
Normalize a file path to an environmental variable, if possible.
Definition: env_paths.cpp:67
static wxString GetGlobalTableFileName()

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

Referenced by PCB_BASE_EDIT_FRAME::CreateNewLibrary().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 417 of file eda_base_frame.cpp.

418 {
419  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
420  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
421 
422  helpMenu->Add( ACTIONS::help );
423  helpMenu->Add( ACTIONS::gettingStarted );
424  helpMenu->Add( ACTIONS::listHotKeys );
425  helpMenu->Add( ACTIONS::getInvolved );
426  helpMenu->Add( ACTIONS::donate );
427  helpMenu->Add( ACTIONS::reportBug );
428 
429  helpMenu->AppendSeparator();
430  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
431 
432  aMenuBar->Append( helpMenu, _( "&Help" ) );
433 }
static TOOL_ACTION listHotKeys
Definition: actions.h:180
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:47
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:183
static TOOL_ACTION donate
Definition: actions.h:181
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
static TOOL_ACTION help
Definition: actions.h:179
static TOOL_ACTION getInvolved
Definition: actions.h:182
static TOOL_ACTION gettingStarted
Definition: actions.h:178

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

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

◆ AddStandardSubMenus()

void EDA_DRAW_FRAME::AddStandardSubMenus ( TOOL_MENU aMenu)
inherited

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

zoom and grid).

Definition at line 443 of file eda_draw_frame.cpp.

444 {
445  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
446  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
447 
448  aMenu.AddSeparator( 1000 );
449 
450  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
451  zoomMenu->SetTool( commonTools );
452  aToolMenu.AddSubMenu( zoomMenu );
453 
454  auto gridMenu = std::make_shared<GRID_MENU>( this );
455  gridMenu->SetTool( commonTools );
456  aToolMenu.AddSubMenu( gridMenu );
457 
458  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
459  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
460 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
Handles action that are shared between different applications.
Definition: common_tools.h:37
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157

References CONDITIONAL_MENU::AddSeparator(), TOOL_MENU::AddSubMenu(), TOOL_MENU::GetMenu(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::m_toolManager, and SELECTION_CONDITIONS::ShowAlways().

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

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  aTextUpper,
const wxString &  aTextLower,
int  aPadding = 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
aTextUpperThe message upper text.
aTextLowerThe message lower text.
aPaddingNumber of spaces to pad between messages.

Definition at line 594 of file eda_draw_frame.cpp.

596 {
597  if( m_messagePanel )
598  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
599 }
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Function AppendMessage appends a message to the message panel.
Definition: msgpanel.cpp:119

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

Referenced by GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), and SYMBOL_VIEWER_FRAME::updatePreviewSymbol().

◆ canCloseWindow()

bool PCB_EDIT_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overrideprotectedvirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 804 of file pcb_edit_frame.cpp.

805 {
806  // Shutdown blocks must be determined and vetoed as early as possible
807  if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
808  && IsContentModified() )
809  {
810  return false;
811  }
812 
813  if( IsContentModified() )
814  {
815  wxFileName fileName = GetBoard()->GetFileName();
816  wxString msg = _( "Save changes to \"%s\" before closing?" );
817 
818  if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ),
819  [&]() -> bool
820  {
822  } ) )
823  {
824  return false;
825  }
826  }
827 
828  // Close modeless dialogs. They're trouble when they get destroyed after the frame and/or
829  // board.
830  wxWindow* open_dlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
831 
832  if( open_dlg )
833  open_dlg->Close( true );
834 
835  return true;
836 }
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:207
const wxString & GetFileName() const
Definition: board.h:300
bool IsContentModified() override
Get if the current board has been modified but not saved.
#define DIALOG_DRC_WINDOW_NAME
Definition: dialog_drc.h:41
bool SupportsShutdownBlockReason()
Whether or not the window supports setting a shutdown block reason.
Definition: gtk/app.cpp:65
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
#define _(s)
Definition: 3d_actions.cpp:33
bool Files_io_from_id(int aId)
Read and write board files according to aId.
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 1084 of file eda_base_frame.cpp.

1085 {
1086  SetUserUnits( aUnits );
1088 
1089  wxCommandEvent e( UNITS_CHANGED );
1090  ProcessEventLocally( e );
1091 }
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::SwitchUnits(), 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 972 of file eda_base_frame.cpp.

973 {
974  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
975 
976  wxFileName autoSaveFileName = aFileName;
977 
978  // Check for auto save file.
979  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
980 
981  wxLogTrace( traceAutoSave,
982  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
983 
984  if( !autoSaveFileName.FileExists() )
985  return;
986 
987  wxString msg = wxString::Format( _(
988  "Well this is potentially embarrassing!\n"
989  "It appears that the last time you were editing the file\n"
990  "\"%s\"\n"
991  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
992  aFileName.GetFullName()
993  );
994 
995  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
996  this );
997 
998  // Make a backup of the current file, delete the file, and rename the auto save file to
999  // the file name.
1000  if( response == wxYES )
1001  {
1002  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1003  {
1004  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1005  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1006  }
1007  }
1008  else
1009  {
1010  wxLogTrace( traceAutoSave,
1011  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1012 
1013  // Remove the auto save file when using the previous file as is.
1014  wxRemoveFile( autoSaveFileName.GetFullPath() );
1015  }
1016 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33

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

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

◆ Clear_Pcb()

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

Delete all and reinitialize the current board.

Parameters
aQuerytrue to prompt user for confirmation, false to initialize silently.
aFinalif true, we are clearing the board to exit, so don't run more events.Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
aBoardis the BOARD to put into the frame.

Definition at line 42 of file initpcb.cpp.

43 {
44  if( GetBoard() == NULL )
45  return false;
46 
47  if( aQuery && !GetBoard()->IsEmpty() )
48  {
49  if( !IsOK( this, _( "Current Board will be lost and this operation cannot be undone. "
50  "Continue?" ) ) )
51  {
52  return false;
53  }
54  }
55 
56  // Release the lock file, if exists
57  ReleaseFile();
58 
59  // Clear undo and redo lists because we want a full deletion
61  GetScreen()->ClrModify();
62 
63  if( !aFinal )
64  {
65  // delete the old BOARD and create a new BOARD so that the default
66  // layer names are put into the BOARD.
67  SetBoard( new BOARD() );
68 
69  // clear filename, to avoid overwriting an old file
70  GetBoard()->SetFileName( wxEmptyString );
71 
73 
75 
76  // Enable all layers (SetCopperLayerCount() will adjust the copper layers enabled)
77  GetBoard()->SetEnabledLayers( LSET().set() );
78 
79  // Default copper layers count set to 2: double layer board
81 
82  // Update display (some options depend on the board setup)
83  GetBoard()->SetVisibleLayers( LSET().set() );
87  UpdateTitle();
88 
89  Zoom_Automatique( false );
90  }
91 
92  return true;
93 }
void UpdateTitle()
Set the main window title bar text.
APPEARANCE_CONTROLS * m_appearancePanel
void SetCopperLayerCount(int aCount)
Definition: board.cpp:441
void ReCreateLayerBox(bool aForceResizeToolbar=true)
Recreate the layer box by clearing the old list and building a new one from the new layer names and c...
void ReleaseFile()
Release the current file marked in use.
void InitDataPoints(const wxSize &aPageSizeInternalUnits)
Definition: base_screen.cpp:47
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()
Reset all high light data to the init state.
Definition: board.cpp:2044
#define NULL
void SetVisibleLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings changes the bit-mask of vis...
Definition: board.cpp:473
void SetFileName(const wxString &aFileName)
Definition: board.h:298
void SetBoard(BOARD *aBoard) override
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
#define _(s)
Definition: 3d_actions.cpp:33
void ClrModify()
Definition: base_screen.h:60
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:296
virtual void ClearUndoRedoList()
Clear the undo and redo list using ClearUndoORRedoList()
void SetEnabledLayers(LSET aLayerMask)
A proxy function that calls the correspondent function in m_BoardSettings Changes the bit-mask of ena...
Definition: board.cpp:467
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 869 of file eda_base_frame.cpp.

870 {
871  if( !aFileHistory )
872  aFileHistory = m_fileHistory;
873 
874  wxASSERT( aFileHistory );
875 
876  aFileHistory->ClearFileHistory();
877 
878  // Update the menubar to update the file history menu
879  if( GetMenuBar() )
880  {
881  ReCreateMenuBar();
882  GetMenuBar()->Refresh();
883  }
884 }
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

Free the undo or redo list from List element.

Wrappers are deleted. Data 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). Items are removed from the beginning of the list so this function can be called to remove old commands.

Parameters
whichListthe UNDO_REDO_CONTAINER to clear.
aItemCountthe count of items to remove. < 0 for all items.

Reimplemented from EDA_BASE_FRAME.

Definition at line 552 of file undo_redo.cpp.

553 {
554  if( aItemCount == 0 )
555  return;
556 
557  UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
558  unsigned icnt = list.m_CommandsList.size();
559 
560  if( aItemCount > 0 )
561  icnt = aItemCount;
562 
563  for( unsigned ii = 0; ii < icnt; ii++ )
564  {
565  if( list.m_CommandsList.size() == 0 )
566  break;
567 
568  PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
569  list.m_CommandsList.erase( list.m_CommandsList.begin() );
570 
571  curr_cmd->ClearListAndDeleteItems();
572  delete curr_cmd; // Delete command
573  }
574 }
UNDO_REDO_CONTAINER m_undoList
A holder to handle a list of undo (or redo) commands.
std::vector< PICKED_ITEMS_LIST * > m_CommandsList
A holder to handle information on schematic or board items.
UNDO_REDO_CONTAINER m_redoList
void ClearListAndDeleteItems()
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...

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 1667 of file pcb_edit_frame.cpp.

1668 {
1669  PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
1670 
1672 
1673  // Netclass definitions could have changed, either by us or by Eeschema
1674  DRC_TOOL* drcTool = m_toolManager->GetTool<DRC_TOOL>();
1675  WX_INFOBAR* infobar = GetInfoBar();
1676 
1677  try
1678  {
1679  drcTool->GetDRCEngine()->InitEngine( GetDesignRulesPath() );
1680  infobar->Hide();
1681  }
1682  catch( PARSE_ERROR& )
1683  {
1684  wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, _( "Edit design rules" ),
1685  wxEmptyString );
1686 
1687  button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
1688  [&]( wxHyperlinkEvent& aEvent )
1689  {
1690  ShowBoardSetupDialog( _( "Custom Rules" ) );
1691  } ) );
1692 
1693  infobar->RemoveAllButtons();
1694  infobar->AddButton( button );
1695  infobar->AddCloseButton();
1696  infobar->ShowMessage( _( "Could not compile custom design rules." ), wxICON_ERROR );
1697  }
1698 
1699  // Update the environment variables in the Python interpreter
1700  if( aEnvVarsChanged )
1702 
1703  Layout();
1704  SendSizeEvent();
1705 }
wxString GetDesignRulesPath()
Return the absolute path to the design rules file for the currently-loaded board.
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
APPEARANCE_CONTROLS * GetAppearancePanel()
void ShowBoardSetupDialog(const wxString &aInitialPage=wxEmptyString)
void PythonSyncEnvironmentVariables()
Synchronize the environment variables from KiCad's environment into the Python interpreter.
std::shared_ptr< DRC_ENGINE > GetDRCEngine()
Definition: drc_tool.h:90
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:71
A filename or source description, a problem input line, a line number, a byte offset,...
Definition: ki_exception.h:118
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
#define _(s)
Definition: 3d_actions.cpp:33
WX_INFOBAR * GetInfoBar()
void OnColorThemeChanged()
Update the widget when the active board layer is changed.

References _, PCB_BASE_FRAME::CommonSettingsChanged(), and DRC_TOOL::GetDRCEngine().

◆ Compile_Ratsnest()

void PCB_BASE_FRAME::Compile_Ratsnest ( bool  aDisplayStatus)
inherited

Create the entire board ratsnest.

Function Compile_Ratsnest Create the entire board ratsnest.

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

Parameters
aDCis the current device context (can be NULL).
aDisplayStatusif true, display the computation results.

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 41 of file ratsnest.cpp.

42 {
43  GetBoard()->GetConnectivity()->RecalculateRatsnest();
44 
45  if( aDisplayStatus )
46  {
47  SetMsgPanel( m_pcb );
48  }
49 }
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
Return a list of missing connections between components/tracks.
Definition: board.h:416
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), BOARD::GetConnectivity(), PCB_BASE_FRAME::m_pcb, and EDA_DRAW_FRAME::SetMsgPanel().

Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::doGlobalDeletions(), ExportToGenCAD(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), OpenProjectFiles(), PCB_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 SYMBOL_EDIT_FRAME, KICAD_MANAGER_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 710 of file eda_base_frame.cpp.

711 {
712  // KICAD_MANAGER_FRAME overrides this
713  return Kiface().KifaceSettings();
714 }
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_i.h:92
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.

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

Referenced by GERBVIEW_FRAME::ActivateGalCanvas(), PCB_BASE_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(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), EDA_DRAW_FRAME::OnUpdateSelectZoom(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), DISPLAY_FOOTPRINTS_FRAME::SetAutoZoom(), PCB_BASE_EDIT_FRAME::SetBoard(), EDA_DRAW_FRAME::SetGridVisibility(), PL_EDITOR_FRAME::setupTools(), SYMBOL_VIEWER_FRAME::setupTools(), CVPCB_MAINFRAME::setupTools(), GERBVIEW_FRAME::setupTools(), SCH_EDIT_FRAME::setupTools(), SIM_PLOT_FRAME::SIM_PLOT_FRAME(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_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

Get the configuration base name.

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 configuration can be used.

Returns
a base name prefix used in Load/Save settings to build the full name of keys used in configuration.

Reimplemented from TOOLS_HOLDER.

Definition at line 338 of file eda_base_frame.h.

339  {
340  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
341  return baseCfgName;
342  }
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 brought to the foreground.

Definition at line 417 of file pcb_base_frame.cpp.

418 {
419  EDA_3D_VIEWER* draw3DFrame = Get3DViewerFrame();
420 
421  if( !draw3DFrame )
422  draw3DFrame = new EDA_3D_VIEWER( &Kiway(), this, _( "3D Viewer" ) );
423 
424  // Raising the window does not show the window on Windows if iconized. This should work
425  // on any platform.
426  if( draw3DFrame->IsIconized() )
427  draw3DFrame->Iconize( false );
428 
429  draw3DFrame->Raise();
430  draw3DFrame->Show( true );
431 
432  // Raising the window does not set the focus on Linux. This should work on any platform.
433  if( wxWindow::FindFocus() != draw3DFrame )
434  draw3DFrame->SetFocus();
435 
436  return draw3DFrame;
437 }
KIWAY & Kiway() const
Return 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:66
EDA_3D_VIEWER * Get3DViewerFrame()

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

Referenced by PCB_VIEWER_TOOLS::Show3DViewer().

◆ CreateInfoBar()

void EDA_BASE_FRAME::CreateInfoBar ( )
inherited

Definition at line 735 of file eda_base_frame.cpp.

736 {
737 #if defined( __WXOSX_MAC__ )
739 #else
740  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
741 
742  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
743 #endif
744 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:71
WX_INFOBAR * m_infoBar

References TOOLS_HOLDER::GetToolCanvas(), EDA_BASE_FRAME::m_auimgr, and EDA_BASE_FRAME::m_infoBar.

◆ CreateNewFootprint()

FOOTPRINT * PCB_BASE_FRAME::CreateNewFootprint ( const wxString &  aFootprintName)
inherited

Creates a new footprint, at position 0,0.

The new footprint 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 footprint is placed on a board and a netlist is read.
Parameters
aFootprintNameis the name of the new footprint in library.

Definition at line 1083 of file footprint_libraries_utils.cpp.

1084 {
1085  wxString footprintName = aFootprintName;
1086 
1087  // Ask for the new footprint name
1088  if( footprintName.IsEmpty() )
1089  {
1090  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
1091  footprintName );
1092  dlg.SetTextValidator( FOOTPRINT_NAME_VALIDATOR( &footprintName ) );
1093 
1094  if( dlg.ShowModal() != wxID_OK )
1095  return nullptr; //Aborted by user
1096  }
1097 
1098  footprintName.Trim( true );
1099  footprintName.Trim( false );
1100 
1101  if( footprintName.IsEmpty() )
1102  {
1103  DisplayInfoMessage( this, _( "No footprint name defined." ) );
1104  return nullptr;
1105  }
1106 
1107  // Creates the new footprint and add it to the head of the linked list of footprints
1108  FOOTPRINT* footprint = new FOOTPRINT( GetBoard() );
1109 
1110  // Update parameters: timestamp ...
1111  footprint->SetLastEditTime();
1112 
1113  // Update its name in lib
1114  footprint->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
1115 
1116  PCB_LAYER_ID txt_layer;
1117  wxPoint default_pos;
1119 
1120  footprint->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
1121  footprint->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
1122  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
1123  footprint->Reference().SetLayer( txt_layer );
1124  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
1125  footprint->Reference().SetPosition( default_pos );
1126  default_pos.y += settings.GetTextSize( txt_layer ).y;
1127 
1128  footprint->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
1129  footprint->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
1130  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
1131  footprint->Value().SetLayer( txt_layer );
1132  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1133  footprint->Value().SetPosition( default_pos );
1134  default_pos.y += settings.GetTextSize( txt_layer ).y;
1135 
1136  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
1137  {
1138  FP_TEXT* textItem = new FP_TEXT( footprint );
1139  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
1140  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
1141  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
1142  textItem->SetLayer( txt_layer );
1143  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1144  textItem->SetPosition( default_pos );
1145  default_pos.y += settings.GetTextSize( txt_layer ).y;
1146  footprint->GraphicalItems().push_back( textItem );
1147  }
1148 
1149  if( footprint->GetReference().IsEmpty() )
1150  footprint->SetReference( footprintName );
1151 
1152  if( footprint->GetValue().IsEmpty() )
1153  footprint->SetValue( footprintName );
1154 
1155  footprint->RunOnChildren(
1156  [&] ( BOARD_ITEM* aChild )
1157  {
1158  if( aChild->Type() == PCB_FP_TEXT_T )
1159  {
1160  FP_TEXT* textItem = static_cast<FP_TEXT*>( aChild );
1161  PCB_LAYER_ID layer = textItem->GetLayer();
1162 
1163  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
1164  textItem->SetTextSize( settings.GetTextSize( layer ) );
1165  textItem->SetItalic( settings.GetTextItalic( layer ) );
1166  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
1167  }
1168  } );
1169 
1170  SetMsgPanel( footprint );
1171  return footprint;
1172 }
void SetReference(const wxString &aReference)
Definition: footprint.h:435
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
virtual void SetPosition(const wxPoint &aPos) override
Definition: fp_text.h:93
const wxString & GetValue() const
Definition: footprint.h:448
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:194
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
void SetItalic(bool isItalic)
Definition: eda_text.h:186
A KICAD version of wxTextEntryDialog which supports the various improvments/work-arounds from DIALOG_...
void SetVisible(bool aVisible)
Definition: eda_text.h:192
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:244
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
Return the default text thickness from the layer class for the given layer.
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:462
bool GetTextUpright(PCB_LAYER_ID aLayer) const
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
FP_TEXT & Reference()
Definition: footprint.h:463
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
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
const wxString & GetReference() const
Definition: footprint.h:426
DRAWINGS & GraphicalItems()
Definition: footprint.h:167
void SetValue(const wxString &aValue)
Definition: footprint.h:456
void SetFPID(const LIB_ID &aFPID)
Definition: footprint.h:191
void SetKeepUpright(bool aKeepUpright)
Definition: fp_text.h:115
#define _(s)
Definition: 3d_actions.cpp:33
void SetLastEditTime(timestamp_t aTime)
Definition: footprint.h:330
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invoke a function on all BOARD_ITEMs that belong to the footprint (pads, drawings,...
Definition: footprint.cpp:1175
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:166
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:280
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163
Container for design settings for a BOARD object.

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

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

◆ 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 initial path and filename shown in the file chooser dialog.
Returns
The newly created library path if library was successfully created, else wxEmptyString because user aborted or error.

Definition at line 376 of file footprint_libraries_utils.cpp.

378 {
379  // Kicad cannot write legacy format libraries, only .pretty new format
380  // because the legacy format cannot handle current features.
381  // The footprint library is actually a directory
382 
383  FP_LIB_TABLE* table = selectLibTable();
384 
385  if( table == nullptr )
386  {
387  return wxEmptyString;
388  }
389 
390  wxString initialPath = aProposedName.IsEmpty() ? Prj().GetProjectPath() : aProposedName;
391  wxFileName fn;
392  bool doAdd = false;
393  bool isGlobal = ( table == &GFootprintTable );
394 
395  if( aLibName.IsEmpty() )
396  {
397  fn = initialPath;
398 
400  KiCadFootprintLibPathExtension, false, isGlobal,
402  {
403  return wxEmptyString;
404  }
405 
406  doAdd = true;
407  }
408  else
409  {
410  fn = aLibName;
411 
412  if( !fn.IsAbsolute() )
413  {
414  fn.SetName( aLibName );
415  fn.MakeAbsolute( initialPath );
416  }
417 
418  // Enforce the .pretty extension:
419  fn.SetExt( KiCadFootprintLibPathExtension );
420  }
421 
422  // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
424  wxString libPath = fn.GetFullPath();
425 
426  try
427  {
428  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
429 
430  bool writable = false;
431  bool exists = false;
432 
433  try
434  {
435  writable = pi->IsFootprintLibWritable( libPath );
436  exists = true; // no exception was thrown, lib must exist.
437  }
438  catch( const IO_ERROR& )
439  { }
440 
441  if( exists )
442  {
443  if( !writable )
444  {
445  wxString msg = wxString::Format( _( "Library \"%s\" is read only." ), libPath );
446  ShowInfoBarError( msg );
447  return wxEmptyString;
448  }
449  else
450  {
451  wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
452  KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
453  dlg.SetOKLabel( _( "Overwrite" ) );
454  dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
455 
456  if( dlg.ShowModal() == wxID_CANCEL )
457  return wxEmptyString;
458 
459  pi->FootprintLibDelete( libPath );
460  }
461  }
462 
463  pi->FootprintLibCreate( libPath );
464  }
465  catch( const IO_ERROR& ioe )
466  {
467  DisplayError( this, ioe.What() );
468  return wxEmptyString;
469  }
470 
471  if( doAdd )
472  AddLibrary( libPath, table );
473 
474  return libPath;
475 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
FP_LIB_TABLE GFootprintTable
!!!!!!!!!!!!!! This code is obsolete because of the merge into pcbnew, don't bother with it.
Definition: cvpcb.cpp:120
Helper class to create more flexible dialogs, including 'do not show again' checkbox handling.
Definition: confirm.h:45
bool LibraryFileBrowser(bool doOpen, wxFileName &aFilename, const wxString &wildcard, const wxString &ext, bool isDirectory=false, bool aIsGlobal=false, const wxString &aGlobalPath=wxEmptyString)
virtual const wxString GetProjectPath() const
Return the full path of the project.
Definition: project.cpp:123
Releases a PLUGIN in the context of a potential thrown exception through its destructor.
Definition: io_mgr.h:550
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
bool AddLibrary(const wxString &aLibName=wxEmptyString, FP_LIB_TABLE *aTable=nullptr)
Add an existing library to either the global or project library table.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
wxString KiCadFootprintLibPathWildcard()
static wxString GetDefaultUserFootprintsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:108
FP_LIB_TABLE * selectLibTable(bool aOptional=false)
Prompts a user to select global or project library tables.
#define _(s)
Definition: 3d_actions.cpp:33
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Return a PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: io_mgr.cpp:58
void ShowInfoBarError(const wxString &aErrorMsg, bool aShowCloseButton=false)
Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left o...
PCB_FILE_T
The set of file types that the IO_MGR knows about, and for which there has been a plugin written.
Definition: io_mgr.h:52
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
const std::string KiCadFootprintLibPathExtension
S-expression Pcbnew file format.
Definition: io_mgr.h:55

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

Referenced by ExportFootprintsToLibrary(), and OpenProjectFiles().

◆ CreateServer()

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

Definition at line 48 of file eda_dde.cpp.

49 {
50  wxIPV4address addr;
51 
52  // Set the port number
53  addr.Service( service );
54 
55  // Listen on localhost only if requested
56  if( local )
57  addr.Hostname( HOSTNAME );
58 
59  delete m_socketServer;
60  m_socketServer = new wxSocketServer( addr );
61 
62  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
63  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
64  m_socketServer->Notify( true );
65 }
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:163
static TOOL_ACTION selectionTool
Definition: actions.h:156

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:199
wxString m_modal_string
Definition: kiway_player.h:198
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:196

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

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

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )
overridevirtualinherited

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 511 of file pcb_base_frame.cpp.

512 {
513  wxString line;
514 
515  line.Printf( "grid X %s Y %s",
516  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x ),
517  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y ) );
518 
519  SetStatusText( line, 4 );
520 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:90
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References PCB_BASE_FRAME::GetCanvas(), EDA_BASE_FRAME::m_userUnits, and MessageTextFromValue().

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 463 of file eda_draw_frame.cpp.

464 {
465  SetStatusText( msg, 6 );
466 }

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

◆ DisplayUnitsMsg()

void EDA_DRAW_FRAME::DisplayUnitsMsg ( )
inherited

Display current unit pane in the status bar.

Definition at line 480 of file eda_draw_frame.cpp.

481 {
482  wxString msg;
483 
484  switch( m_userUnits )
485  {
486  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
487  case EDA_UNITS::MILS: msg = _( "mils" ); break;
488  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
489  default: msg = _( "Units" ); break;
490  }
491 
492  SetStatusText( msg, 5 );
493 }
#define _(s)
Definition: 3d_actions.cpp:33
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

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

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

◆ doAutoSave()

bool PCB_EDIT_FRAME::doAutoSave ( )
overrideprotectedvirtual

Perform 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 1119 of file pcbnew/files.cpp.

1120 {
1121  wxFileName tmpFileName;
1122 
1123  if( GetBoard()->GetFileName().IsEmpty() )
1124  {
1125  tmpFileName = wxFileName( PATHS::GetDefaultUserProjectsPath(), wxT( "noname" ),
1127  GetBoard()->SetFileName( tmpFileName.GetFullPath() );
1128  }
1129  else
1130  {
1131  tmpFileName = Prj().AbsolutePath( GetBoard()->GetFileName() );
1132  }
1133 
1134  wxFileName autoSaveFileName = tmpFileName;
1135 
1136  // Auto save file name is the board file name prepended with autosaveFilePrefix string.
1137  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + autoSaveFileName.GetName() );
1138 
1139  if( !autoSaveFileName.IsOk() )
1140  return false;
1141 
1142  // If the board file path is not writable, try writing to a platform specific temp file
1143  // path. If that path isn't writable, give up.
1144  if( !autoSaveFileName.IsDirWritable() )
1145  {
1146  autoSaveFileName.SetPath( wxFileName::GetTempDir() );
1147 
1148  if( !autoSaveFileName.IsOk() || !autoSaveFileName.IsDirWritable() )
1149  return false;
1150  }
1151 
1152  wxLogTrace( traceAutoSave, "Creating auto save file <" + autoSaveFileName.GetFullPath() + ">" );
1153 
1154  if( SavePcbFile( autoSaveFileName.GetFullPath(), false, false ) )
1155  {
1156  GetScreen()->SetModify();
1157  GetBoard()->SetFileName( tmpFileName.GetFullPath() );
1158  UpdateTitle();
1159  m_autoSaveState = false;
1160 
1161  if( !Kiface().IsSingle() &&
1162  GetSettingsManager()->GetCommonSettings()->m_Backup.backup_on_autosave )
1163  {
1165  }
1166 
1167  return true;
1168  }
1169 
1170  GetBoard()->SetFileName( tmpFileName.GetFullPath() );
1171 
1172  return false;
1173 }
void UpdateTitle()
Set 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
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Definition: project.cpp:271
bool TriggerBackupIfNeeded(REPORTER &aReporter) const
Calls BackupProject if a new backup is needed according to the current backup policy.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
KIFACE_I & Kiface()
Global KIFACE_I "get" accessor.
void SetFileName(const wxString &aFileName)
Definition: board.h:298
static wxString GetAutoSaveFilePrefix()
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:130
bool SavePcbFile(const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
Write the board data structures to a aFileName.
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:59

References PROJECT::AbsolutePath(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), PCB_BASE_FRAME::GetBoard(), PATHS::GetDefaultUserProjectsPath(), 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 839 of file pcb_edit_frame.cpp.

840 {
841  // On Windows 7 / 32 bits, on OpenGL mode only, Pcbnew crashes
842  // when closing this frame if a footprint was selected, and the footprint editor called
843  // to edit this footprint, and when closing pcbnew if this footprint is still selected
844  // See https://bugs.launchpad.net/kicad/+bug/1655858
845  // I think this is certainly a OpenGL event fired after frame deletion, so this workaround
846  // avoid the crash (JPC)
847  GetCanvas()->SetEvtHandlerEnabled( false );
848 
849  GetCanvas()->StopDrawing();
850 
851  // Delete the auto save file if it exists.
852  wxFileName fn = GetBoard()->GetFileName();
853 
854  // Auto save file name is the normal file name prefixed with 'GetAutoSaveFilePrefix()'.
855  fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
856 
857  // When the auto save feature does not have write access to the board file path, it falls
858  // back to a platform specific user temporary file path.
859  if( !fn.IsOk() || !fn.IsDirWritable() )
860  fn.SetPath( wxFileName::GetTempDir() );
861 
862  wxLogTrace( traceAutoSave, "Deleting auto save file <" + fn.GetFullPath() + ">" );
863 
864  // Remove the auto save file on a normal close of Pcbnew.
865  if( fn.FileExists() && !wxRemoveFile( fn.GetFullPath() ) )
866  {
867  wxString msg = wxString::Format( _( "The auto save file \"%s\" could not be removed!" ),
868  fn.GetFullPath() );
869  wxMessageBox( msg, Pgm().App().GetAppName(), wxOK | wxICON_ERROR, this );
870  }
871 
872  // Make sure local settings are persisted
874 
875  // Do not show the layer manager during closing to avoid flicker
876  // on some platforms (Windows) that generate useless redraw of items in
877  // the Layer Manger
879  m_auimgr.GetPane( "LayersManager" ).Show( false );
880 
881  // Unlink the old project if needed
882  GetBoard()->ClearProject();
883 
884  // Delete board structs and undo/redo lists, to avoid crash on exit
885  // when deleting some structs (mainly in undo/redo lists) too late
886  Clear_Pcb( false, true );
887 
888  // do not show the window because ScreenPcb will be deleted and we do not
889  // want any paint event
890  Show( false );
891 
893 }
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
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
const wxString & GetFileName() const
Definition: board.h:300
void doCloseWindow() override
bool m_show_layer_manager_tools
void SaveProjectSettings() override
Save changes to the project settings to the project (.pro) file.
void ClearProject()
Definition: board.cpp:169
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
#define _(s)
Definition: 3d_actions.cpp:33
BOARD * GetBoard() const
bool Clear_Pcb(bool aQuery, bool aFinal=false)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:42
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

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 
)

Create an ASCII footprint position file.

Parameters
aFullFileNamethe full file name of the file to create.
aUnitsMMfalse to use inches, true to use mm in coordinates.
aForceSmdItemstrue 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.
aFormatCSVtrue to use a comma separated file (CSV) format; default = false
Returns
the number of footprints found on aSide side or -1 if the file could not be created.

Definition at line 467 of file gen_footprints_placefile.cpp.

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

Create an ASCII footprint report file giving some infos on footprints and board outlines.

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

Definition at line 535 of file gen_footprints_placefile.cpp.

536 {
537  FILE* rptfile = wxFopen( aFullFilename, wxT( "wt" ) );
538 
539  if( rptfile == NULL )
540  return false;
541 
542  std::string data;
543  PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, false, true, true, false );
544  data = exporter.GenReportData();
545 
546  fputs( data.c_str(), rptfile );
547  fclose( rptfile );
548 
549  return true;
550 }
#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().

◆ Edit_Zone_Params()

void PCB_EDIT_FRAME::Edit_Zone_Params ( ZONE zone_container)

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

Definition at line 40 of file edit_zone_helpers.cpp.

41 {
42  int dialogResult;
43  ZONE_SETTINGS zoneInfo = GetZoneSettings();
44  PICKED_ITEMS_LIST pickedList; // zones for undo/redo command
45  PICKED_ITEMS_LIST deletedList; // zones that have been deleted when combined
46  BOARD_COMMIT commit( this );
47 
48  // Save initial zones configuration, for undo/redo, before adding new zone
49  // note the net name and the layer can be changed, so we must save all zones
50  deletedList.ClearListAndDeleteItems();
51  pickedList.ClearListAndDeleteItems();
52  SaveCopyOfZones( pickedList, GetBoard(), -1, UNDEFINED_LAYER );
53 
54  if( aZone->GetIsRuleArea() )
55  {
56  // edit a rule area on a copper layer
57  zoneInfo << *aZone;
58  dialogResult = InvokeRuleAreaEditor( this, &zoneInfo );
59  }
60  else if( IsCopperLayer( aZone->GetLayer() ) )
61  {
62  // edit a zone on a copper layer
63  zoneInfo << *aZone;
64  dialogResult = InvokeCopperZonesEditor( this, &zoneInfo );
65  }
66  else
67  {
68  zoneInfo << *aZone;
69  dialogResult = InvokeNonCopperZonesEditor( this, &zoneInfo );
70  }
71 
72  if( dialogResult == wxID_CANCEL )
73  {
74  deletedList.ClearListAndDeleteItems();
75  pickedList.ClearListAndDeleteItems();
76  return;
77  }
78 
79  SetZoneSettings( zoneInfo );
80  OnModify();
81 
82  if( dialogResult == ZONE_EXPORT_VALUES )
83  {
84  UpdateCopyOfZonesList( pickedList, deletedList, GetBoard() );
85  commit.Stage( pickedList );
86  commit.Push( _( "Modify zone properties" ) );
87  pickedList.ClearItemsList(); // s_ItemsListPicker is no more owner of picked items
88  return;
89  }
90 
91  wxBusyCursor dummy;
92 
93  // Undraw old zone outlines
94  for( ZONE* zone : GetBoard()->Zones() )
95  GetCanvas()->GetView()->Update( zone );
96 
97  zoneInfo.ExportSetting( *aZone );
98 
99  NETINFO_ITEM* net = GetBoard()->FindNet( zoneInfo.m_NetcodeSelection );
100 
101  if( net ) // net == NULL should not occur
102  aZone->SetNetCode( net->GetNetCode() );
103 
104  // Combine zones if possible
105  GetBoard()->OnAreaPolygonModified( &deletedList, aZone );
106 
107  UpdateCopyOfZonesList( pickedList, deletedList, GetBoard() );
108 
109  // refill zones with the new properties applied
110  std::vector<ZONE*> zones_to_refill;
111 
112  for( unsigned i = 0; i < pickedList.GetCount(); ++i )
113  {
114  ZONE* zone = dyn_cast<ZONE*>( pickedList.GetPickedItem( i ) );
115 
116  if( zone == nullptr )
117  {
118  wxASSERT_MSG( false, "Expected a zone after zone properties edit" );
119  continue;
120  }
121 
122  // aZone won't be filled if the layer set was modified, but it needs to be updated
123  if( zone->IsFilled() || zone == aZone )
124  zones_to_refill.push_back( zone );
125  }
126 
127  commit.Stage( pickedList );
128 
129  // Only auto-refill zones here if in user preferences
130  if( Settings().m_AutoRefillZones )
131  {
132  std::lock_guard<KISPINLOCK> lock( GetBoard()->GetConnectivity()->GetLock() );
133 
134  if( zones_to_refill.size() )
135  {
136  ZONE_FILLER filler( GetBoard(), &commit );
137  wxString title =
138  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  // User has already OK'ed dialog so we're going to go ahead and commit even if the
144  // fill was cancelled.
145  }
146  }
147  }
148 
149  commit.Push( _( "Modify zone properties" ) );
150  GetBoard()->GetConnectivity()->RecalculateRatsnest();
151 
152  pickedList.ClearItemsList(); // s_ItemsListPicker is no longer owner of picked items
153 }
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
Definition: board.cpp:1289
void OnModify() override
Must be called after a board change to set the modified flag.
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...
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.
static LIB_PART * dummy()
Used to draw a dummy shape when a LIB_PART is not found in library.
Definition: sch_symbol.cpp:69
bool IsFilled() const
Definition: zone.h:231
#define ZONE_EXPORT_VALUES
Definition: zones.h:37
unsigned GetCount() const
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
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:92
void ExportSetting(ZONE &aTarget, bool aFullExport=true) const
Function ExportSetting copy settings to a given zone.
bool OnAreaPolygonModified(PICKED_ITEMS_LIST *aModifiedZonesList, ZONE *modified_area)
Process an area that has been modified, by normalizing its polygon and merging the intersecting polyg...
const ZONE_SETTINGS & GetZoneSettings() const
void SetNetCode(int aNetCode)
Definition: netinfo.h:114
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:416
EDA_ITEM * GetPickedItem(unsigned int aIdx) const
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
A holder to handle information on schematic or board items.
virtual KIGFX::PCB_VIEW * GetView() const override
Return 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
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
Handle the data for a net.
Definition: netinfo.h:64
#define _(s)
Definition: 3d_actions.cpp:33
PCBNEW_SETTINGS & Settings()
void ClearItemsList()
Delete only the list of pickers NOT the picked data itself.
bool IsCopperLayer(LAYER_NUM aLayerId)
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()
Delete the list of pickers AND the data pointed by #m_PickedItem or #m_PickedItemLink according to th...
int GetNetCode() const
Definition: netinfo.h:113

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::GetIsRuleArea(), ZONE::GetLayer(), NETINFO_ITEM::GetNetCode(), PICKED_ITEMS_LIST::GetPickedItem(), PCB_DRAW_PANEL_GAL::GetView(), PCB_BASE_FRAME::GetZoneSettings(), ZONE_FILLER::InstallNewProgressReporter(), InvokeCopperZonesEditor(), InvokeNonCopperZonesEditor(), InvokeRuleAreaEditor(), IsCopperLayer(), ZONE::IsFilled(), ZONE_SETTINGS::m_NetcodeSelection, BOARD::OnAreaPolygonModified(), OnModify(), BOARD_COMMIT::Push(), SaveCopyOfZones(), BOARD_CONNECTED_ITEM::SetNetCode(), PCB_BASE_FRAME::Settings(), 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 232 of file eda_draw_frame.cpp.

233 {
234  if( m_messagePanel )
236 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:223

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExchangeFootprint()

void PCB_EDIT_FRAME::ExchangeFootprint ( FOOTPRINT aExisting,
FOOTPRINT aNew,
BOARD_COMMIT aCommit,
bool  deleteExtraTexts = true,
bool  resetTextLayers = true,
bool  resetTextEffects = true,
bool  resetFabricationAttrs = true,
bool  reset3DModels = true 
)

Replace aExisting footprint by aNew footprint using the Existing footprint settings (position, orientation, pad netnames ...).

The aExisting footprint is deleted or put in undo list.

Parameters
aExistingfootprint to replace.
aNewfootprint to put.
aCommitcommit that should store the changes.

Definition at line 483 of file dialog_exchange_footprints.cpp.

487 {
488  PCB_GROUP* parentGroup = aExisting->GetParentGroup();
489 
490  if( parentGroup )
491  {
492  parentGroup->RemoveItem( aExisting );
493  parentGroup->AddItem( aNew );
494  }
495 
496  aNew->SetParent( GetBoard() );
497 
498  PlaceFootprint( aNew, false );
499 
500  // PlaceFootprint will move the footprint to the cursor position, which we don't want. Copy
501  // the original position across.
502  aNew->SetPosition( aExisting->GetPosition() );
503 
504  if( aNew->GetLayer() != aExisting->GetLayer() )
505  aNew->Flip( aNew->GetPosition(), m_settings->m_FlipLeftRight );
506 
507  if( aNew->GetOrientation() != aExisting->GetOrientation() )
508  aNew->SetOrientation( aExisting->GetOrientation() );
509 
510  aNew->SetLocked( aExisting->IsLocked() );
511 
512  for( PAD* pad : aNew->Pads() )
513  {
514  PAD* oldPad = aExisting->FindPadByName( pad->GetName() );
515 
516  if( oldPad )
517  {
518  pad->SetLocalRatsnestVisible( oldPad->GetLocalRatsnestVisible() );
519  pad->SetPinFunction( oldPad->GetPinFunction() );
520  pad->SetLocked( oldPad->IsLocked() );
521  }
522 
523  pad->SetNetCode( oldPad ? oldPad->GetNetCode() : NETINFO_LIST::UNCONNECTED );
524  }
525 
526  // Copy reference
527  processTextItem( aExisting->Reference(), aNew->Reference(),
528  // never reset reference text
529  false,
530  resetTextLayers, resetTextEffects );
531 
532  // Copy value
533  processTextItem( aExisting->Value(), aNew->Value(),
534  // reset value text only when it is a proxy for the footprint ID
535  // (cf replacing value "MountingHole-2.5mm" with "MountingHole-4.0mm")
536  aExisting->GetValue() == aExisting->GetFPID().GetLibItemName(),
537  resetTextLayers, resetTextEffects );
538 
539  // Copy fields in accordance with the reset* flags
540  for( BOARD_ITEM* item : aExisting->GraphicalItems() )
541  {
542  FP_TEXT* srcItem = dyn_cast<FP_TEXT*>( item );
543 
544  if( srcItem )
545  {
546  FP_TEXT* destItem = getMatchingTextItem( srcItem, aNew );
547 
548  if( destItem )
549  processTextItem( *srcItem, *destItem, false, resetTextLayers, resetTextEffects );
550  else if( !deleteExtraTexts )
551  aNew->Add( new FP_TEXT( *srcItem ) );
552  }
553  }
554 
555  if( !resetFabricationAttrs )
556  aNew->SetAttributes( aExisting->GetAttributes() );
557 
558  // Copy 3D model settings in accordance with the reset* flag
559  if( !reset3DModels )
560  aNew->Models() = aExisting->Models(); // Linked list of 3D models.
561 
562  // Updating other parameters
563  const_cast<KIID&>( aNew->m_Uuid ) = aExisting->m_Uuid;
564  aNew->SetProperties( aExisting->GetProperties() );
565  aNew->SetPath( aExisting->GetPath() );
566 
567  aCommit.Remove( aExisting );
568  aCommit.Add( aNew );
569 
570  aNew->ClearFlags();
571 }
PCB_GROUP * GetParentGroup() const
Definition: board_item.h:93
bool IsLocked() const override
Definition: footprint.h:282
bool AddItem(BOARD_ITEM *aItem)
Add item to group.
Definition: pcb_group.cpp:38
const UTF8 & GetLibItemName() const
Definition: lib_id.h:106
std::list< FP_3DMODEL > & Models()
Definition: footprint.h:178
const wxString & GetValue() const
Definition: footprint.h:448
const KIID_PATH & GetPath() const
Definition: footprint.h:199
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
void SetPath(const KIID_PATH &aPath)
Definition: footprint.h:200
COMMIT & Add(EDA_ITEM *aItem)
Notify observers that aItem has been added.
Definition: commit.h:78
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:50
bool IsLocked() const override
Definition: pad.cpp:138
double GetOrientation() const
Definition: footprint.h:186
bool GetLocalRatsnestVisible() const
PCBNEW_SETTINGS * m_settings
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:166
void SetAttributes(int aAttributes)
Definition: footprint.h:232
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Places aFootprint at the current cursor position and updates footprint coordinates with the new posit...
PADS & Pads()
Definition: footprint.h:164
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:462
FP_TEXT & Reference()
Definition: footprint.h:463
FP_TEXT * getMatchingTextItem(FP_TEXT *aRefItem, FOOTPRINT *aFootprint)
void SetOrientation(double aNewAngle)
Definition: footprint.cpp:1557
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: footprint.cpp:1367
DRAWINGS & GraphicalItems()
Definition: footprint.h:167
bool RemoveItem(BOARD_ITEM *aItem)
Remove item from group.
Definition: pcb_group.cpp:50
const LIB_ID & GetFPID() const
Definition: footprint.h:190
COMMIT & Remove(EDA_ITEM *aItem)
Notify observers that aItem has been removed.
Definition: commit.h:90
PAD * FindPadByName(const wxString &aPadName) const
Return a PAD with a matching name.
Definition: footprint.cpp:957
void processTextItem(const FP_TEXT &aSrc, FP_TEXT &aDest, bool resetText, bool resetTextLayers, bool resetTextEffects)
const KIID m_Uuid
Definition: eda_item.h:525
int GetAttributes() const
Definition: footprint.h:231
void SetLocked(bool isLocked) override
Set the #MODULE_is_LOCKED bit in the m_ModuleStatus.
Definition: footprint.h:292
wxPoint GetPosition() const override
Definition: footprint.h:182
void ClearFlags(STATUS_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:204
const std::map< wxString, wxString > & GetProperties() const
Definition: footprint.h:469
BOARD * GetBoard() const
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Removes an item from the container.
Definition: footprint.cpp:468
void SetProperties(const std::map< wxString, wxString > &aProps)
Definition: footprint.h:470
Definition: pad.h:60
void SetPosition(const wxPoint &aPos) override
Definition: footprint.cpp:1438
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:173
static const int UNCONNECTED
Constant that forces initialization of a netinfo item to the NETINFO_ITEM ORPHANED (typically -1) whe...
Definition: netinfo.h:365
const wxString & GetPinFunction() const
Definition: pad.h:139

References COMMIT::Add(), FOOTPRINT::Add(), PCB_GROUP::AddItem(), EDA_ITEM::ClearFlags(), FOOTPRINT::FindPadByName(), FOOTPRINT::Flip(), FOOTPRINT::GetAttributes(), PCB_BASE_FRAME::GetBoard(), FOOTPRINT::GetFPID(), BOARD_ITEM::GetLayer(), LIB_ID::GetLibItemName(), BOARD_CONNECTED_ITEM::GetLocalRatsnestVisible(), getMatchingTextItem(), BOARD_CONNECTED_ITEM::GetNetCode(), FOOTPRINT::GetOrientation(), BOARD_ITEM::GetParentGroup(), FOOTPRINT::GetPath(), PAD::GetPinFunction(), FOOTPRINT::GetPosition(), FOOTPRINT::GetProperties(), FOOTPRINT::GetValue(), FOOTPRINT::GraphicalItems(), PAD::IsLocked(), FOOTPRINT::IsLocked(), PCBNEW_SETTINGS::m_FlipLeftRight, PCB_BASE_FRAME::m_settings, EDA_ITEM::m_Uuid, FOOTPRINT::Models(), pad, FOOTPRINT::Pads(), PCB_BASE_FRAME::PlaceFootprint(), processTextItem(), FOOTPRINT::Reference(), COMMIT::Remove(), PCB_GROUP::RemoveItem(), FOOTPRINT::SetAttributes(), FOOTPRINT::SetLocked(), FOOTPRINT::SetOrientation(), EDA_ITEM::SetParent(), FOOTPRINT::SetPath(), FOOTPRINT::SetPosition(), FOOTPRINT::SetProperties(), NETINFO_LIST::UNCONNECTED, and FOOTPRINT::Value().

Referenced by DIALOG_EXCHANGE_FOOTPRINTS::processFootprint(), 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
cmdlineis the 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  FOOTPRINT* footprint = nullptr;
72  PAD* pad = nullptr;
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->GetNetCode();
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->GetNetCode() );
130  renderSettings->SetHighlight( true, netinfo->GetNetCode() );
131  multiHighlight = true;
132  }
133  else
134  {
135  pcb->SetHighLightNet( netinfo->GetNetCode(), true );
136  renderSettings->SetHighlight( true, netinfo->GetNetCode(), 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  footprint = pcb->FindFootprintByReference( modName );
155 
156  if( footprint )
157  pad = footprint->FindPadByName( pinName );
158 
159  if( pad )
160  netcode = pad->GetNetCode();
161 
162  if( footprint == 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  footprint = pcb->FindFootprintByReference( modName );
178 
179  if( footprint )
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( footprint )
216  {
217  bbox = footprint->GetBoundingBox( true, false ); // No invisible text in bbox calc
218 
219  if( pad )
221  else
222  m_toolManager->RunAction( PCB_ACTIONS::highlightItem, true, (void*) footprint );
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 =
240  [netcode, &bbox]( BOARD_CONNECTED_ITEM* aItem )
241  {
242  if( aItem->GetNetCode() == netcode )
243  {
244  if( bbox.GetWidth() == 0 )
245  bbox = aItem->GetBoundingBox();
246  else
247  bbox.Merge( aItem->GetBoundingBox() );
248  }
249  };
250 
251  if( crossProbingSettings.center_on_items )
252  {
253  for( ZONE* zone : pcb->Zones() )
254  merge_area( zone );
255 
256  for( TRACK* track : pcb->Tracks() )
257  merge_area( track );
258 
259  for( FOOTPRINT* fp : pcb->Footprints() )
260  {
261  for( PAD* p : fp->Pads() )
262  merge_area( p );
263  }
264  }
265  }
266  else
267  {
268  renderSettings->SetHighlight( false );
269  }
270 
271  if( crossProbingSettings.center_on_items && bbox.GetWidth() > 0 && bbox.GetHeight() > 0 )
272  {
273  if( crossProbingSettings.zoom_to_fit )
274  {
275 //#define DEFAULT_PCBNEW_CODE // Un-comment for normal full zoom KiCad algorithm
276  #ifdef DEFAULT_PCBNEW_CODE
277  auto bbSize = bbox.Inflate( bbox.GetWidth() * 0.2f ).GetSize();
278  auto screenSize = view->ToWorld( GetCanvas()->GetClientSize(), false );
279 
280  // The "fabs" on x ensures the right answer when the view is flipped
281  screenSize.x = std::max( 10.0, fabs( screenSize.x ) );
282  screenSize.y = std::max( 10.0, screenSize.y );
283  double ratio = std::max( fabs( bbSize.x / screenSize.x ), fabs( bbSize.y / screenSize.y ) );
284 
285  // Try not to zoom on every cross-probe; it gets very noisy
286  if( crossProbingSettings.zoom_to_fit && ( ratio < 0.5 || ratio > 1.0 ) )
287  view->SetScale( view->GetScale() / ratio );
288  #endif // DEFAULT_PCBNEW_CODE
289 
290 #ifndef DEFAULT_PCBNEW_CODE // Do the scaled zoom
291  auto bbSize = bbox.Inflate( bbox.GetWidth() * 0.2f ).GetSize();
292  auto screenSize = view->ToWorld( GetCanvas()->GetClientSize(), false );
293 
294  // This code tries to come up with a zoom factor that doesn't simply zoom in
295  // to the cross probed component, but instead shows a reasonable amount of the
296  // circuit around it to provide context. This reduces or eliminates the need
297  // to manually change the zoom because it's too close.
298 
299  // Using the default text height as a constant to compare against, use the
300  // height of the bounding box of visible items for a footprint to figure out
301  // if this is a big footprint (like a processor) or a small footprint (like a resistor).
302  // This ratio is not useful by itself as a scaling factor. It must be "bent" to
303  // provide good scaling at varying component sizes. Bigger components need less
304  // scaling than small ones.
305  double currTextHeight = Millimeter2iu( DEFAULT_TEXT_SIZE );
306 
307  double compRatio = bbSize.y / currTextHeight; // Ratio of component to text height
308  double compRatioBent = 1.0; // This will end up as the scaling factor we apply to "ratio"
309 
310  // This is similar to the original KiCad code that scaled the zoom to make sure components
311  // were visible on screen. It's simply a ratio of screen size to component size, and its
312  // job is to zoom in to make the component fullscreen. Earlier in the code the
313  // component BBox is given a 20% margin to add some breathing room. We compare
314  // the height of this enlarged component bbox to the default text height. If a component
315  // will end up with the sides clipped, we adjust later to make sure it fits on screen.
316  //
317  // The "fabs" on x ensures the right answer when the view is flipped
318  screenSize.x = std::max( 10.0, fabs( screenSize.x ) );
319  screenSize.y = std::max( 10.0, screenSize.y );
320  double ratio = std::max( -1.0, fabs( bbSize.y / screenSize.y ) );
321  // Original KiCad code for how much to scale the zoom
322  double kicadRatio = std::max( fabs( bbSize.x / screenSize.x ),
323  fabs( bbSize.y / screenSize.y ) );
324 
325  // LUT to scale zoom ratio to provide reasonable schematic context. Must work
326  // with footprints of varying sizes (e.g. 0402 package and 200 pin BGA).
327  // "first" is used as the input and "second" as the output
328  //
329  // "first" = compRatio (footprint height / default text height)
330  // "second" = Amount to scale ratio by
331  std::vector<std::pair<double, double>> lut{
332  { 1, 8 },
333  { 1.5, 5 },
334  { 3, 3 },
335  { 4.5, 2.5 },
336  { 8, 2.0 },
337  { 12, 1.7 },
338  { 16, 1.5 },
339  { 24, 1.3 },
340  { 32, 1.0 },
341  };
342 
343 
344  std::vector<std::pair<double, double>>::iterator it;
345 
346  compRatioBent = lut.back().second; // Large component default
347 
348  if( compRatio >= lut.front().first )
349  {
350  // Use LUT to do linear interpolation of "compRatio" within "first", then
351  // use that result to linearly interpolate "second" which gives the scaling
352  // factor needed.
353 
354  for( it = lut.begin(); it < lut.end() - 1; it++ )
355  {
356  if( it->first <= compRatio && next( it )->first >= compRatio )
357  {
358  double diffx = compRatio - it->first;
359  double diffn = next( it )->first - it->first;
360 
361  compRatioBent =
362  it->second + ( next( it )->second - it->second ) * diffx / diffn;
363  break; // We have our interpolated value
364  }
365  }
366  }
367  else
368  compRatioBent = lut.front().second; // Small component default
369 
370  // If the width of the part we're probing is bigger than what the screen width will be
371  // after the zoom, then punt and use the KiCad zoom algorithm since it guarantees the
372  // part's width will be encompassed within the screen. This will apply to parts that are
373  // much wider than they are tall.
374 
375  if( bbSize.x > screenSize.x * ratio * compRatioBent )
376  {
377  ratio = kicadRatio; // Use standard KiCad zoom algorithm for parts too wide to fit screen
378  compRatioBent = 1.0; // Reset so we don't modify the "KiCad" ratio
379  wxLogTrace( "CROSS_PROBE_SCALE",
380  "Part TOO WIDE for screen. Using normal KiCad zoom ratio: %1.5f", ratio );
381  }
382 
383  // Now that "compRatioBent" holds our final scaling factor we apply it to the original
384  // fullscreen zoom ratio to arrive at the final ratio itself.
385  ratio *= compRatioBent;
386 
387  bool alwaysZoom = false; // DEBUG - allows us to minimize zooming or not
388  // Try not to zoom on every cross-probe; it gets very noisy
389  if( ( ratio < 0.5 || ratio > 1.0 ) || alwaysZoom )
390  view->SetScale( view->GetScale() / ratio );
391 #endif // ifndef DEFAULT_PCBNEW_CODE
392  }
393  view->SetCenter( bbox.Centre() );
394  }
395 
396  view->UpdateAllLayersColor();
397  // Ensure the display is refreshed, because in some installs the refresh is done only
398  // when the gal canvas has the focus, and that is not the case when crossprobing from
399  // Eeschema:
400  GetCanvas()->Refresh();
401 }
CITER next(CITER it)
Definition: ptree.cpp:126
NETINFO_ITEM * FindNet(int aNetcode) const
Search for a net with the given netcode.
Definition: board.cpp:1289
KIGFX::VIEW * GetView() const
Definition: tool_manager.h:289
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
ZONES & Zones()
Definition: board.h:311
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
void HighLightON(bool aValue=true)
Enable or disable net highlighting.
Definition: board.cpp:2066
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:451
static TOOL_ACTION highlightItem
Definition: pcb_actions.h:453
bool IsHighLightNetON() const
Definition: board.h:471
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)
Run the specified action.
Definition: tool_manager.h:141
bool IsHighlightEnabled() const
Return current highlight setting.
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:207
Cross-probing behavior.
Definition: app_settings.h:30
void ResetNetHighLight()
Reset all high light data to the init state.
Definition: board.cpp:2044
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:580
#define NULL
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
FOOTPRINTS & Footprints()
Definition: board.h:305
Handle a list of polygons defining a copper zone.
Definition: zone.h:57
PAD * FindPadByName(const wxString &aPadName) const
Return a PAD with a matching name.
Definition: footprint.cpp:957
void SetHighLightNet(int aNetCode, bool aMulti=false)
Select the netcode to be highlighted.
Definition: board.cpp:2053
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
Definition: board.h:456
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
Definition: view.cpp:554
virtual RENDER_SETTINGS * GetSettings()=0
Return a 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
Handle the data for a net.
Definition: netinfo.h:64
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
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:157
void SetHighlight(bool aEnabled, int aNetcode=-1, bool aMulti=false)
Turns on/off highlighting.
Vec Centre() const
Definition: box2.h:79
static TOOL_ACTION selectOnSheetFromEeschema
Select all components on sheet from Eeschema crossprobing.
Definition: pcb_actions.h:87
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
#define _(s)
Definition: 3d_actions.cpp:33
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: footprint.cpp:631
PCBNEW_SETTINGS * GetPcbNewSettings() const
coord_type GetHeight() const
Definition: box2.h:198
std::vector< MSG_PANEL_ITEM > MSG_PANEL_ITEMS
Definition: msgpanel.h:97
#define DEFAULT_TEXT_SIZE
Ratio of the font height to the baseline of the text above the wire.
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
BOARD * GetBoard() const
CROSS_PROBING_SETTINGS m_CrossProbing
Definition: app_settings.h:167
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:67
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Return the information about the NETINFO_ITEM in aList to display in the message panel.
Definition: pad.h:60
void UpdateAllLayersColor()
Apply the new coloring scheme to all layers.
Definition: view.cpp:773
double GetScale() const
Definition: view.h:263
bool center_on_items
Automatically pan to cross-probed items.
Definition: app_settings.h:32
static constexpr int Millimeter2iu(double mm)
TRACKS & Tracks()
Definition: board.h:302
Definition: track.h:83
FOOTPRINT * FindFootprintByReference(const wxString &aReference) const
Search for a FOOTPRINT within this board with the given reference designator.
Definition: board.cpp:1310
int GetNetCode() const
Definition: netinfo.h:113

References _, CROSS_PROBING_SETTINGS::auto_highlight, CROSS_PROBING_SETTINGS::center_on_items, BOX2< Vec >::Centre(), DEFAULT_TEXT_SIZE, BOARD::FindFootprintByReference(), BOARD::FindNet(), FOOTPRINT::FindPadByName(), BOARD::Footprints(), FROM_UTF8(), PCB_BASE_FRAME::GetBoard(), FOOTPRINT::GetBoundingBox(), PCB_BASE_FRAME::GetCanvas(), BOX2< Vec >::GetHeight(), BOARD::GetHighLightNetCodes(), NETINFO_ITEM::GetMsgPanelInfo(), NETINFO_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(), Millimeter2iu(), next(), NULL, pad, 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(), text, 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 
)

Create 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
aPcba pointer to the board to be exported to IDF.
aFullFileNamethe full filename of the export file.
aUseThouset to true if the desired IDF unit is thou (mil).
aXRefthe board Reference Point in mm, X value.
aYRefthe board Reference Point in mm, Y value.
Returns
true if OK.

Definition at line 586 of file export_idf.cpp.

588 {
589  IDF3_BOARD idfBoard( IDF3::CAD_ELEC );
590 
591  // Switch the locale to standard C (needed to print floating point numbers)
592  LOCALE_IO toggle;
593 
594  resolver = Prj().Get3DCacheManager()->GetResolver();
595 
596  bool ok = true;
597  double scale = MM_PER_IU; // we must scale internal units to mm for IDF
598  IDF3::IDF_UNIT idfUnit;
599 
600  if( aUseThou )
601  {
602  idfUnit = IDF3::UNIT_THOU;
603  idfBoard.SetUserPrecision( 1 );
604  }
605  else
606  {
607  idfUnit = IDF3::UNIT_MM;
608  idfBoard.SetUserPrecision( 5 );
609  }
610 
611  wxFileName brdName = aPcb->GetFileName();
612 
613  idfBoard.SetUserScale( scale );
614  idfBoard.SetBoardThickness( aPcb->GetDesignSettings().GetBoardThickness() * scale );
615  idfBoard.SetBoardName( TO_UTF8( brdName.GetFullName() ) );
616  idfBoard.SetBoardVersion( 0 );
617  idfBoard.SetLibraryVersion( 0 );
618 
619  std::ostringstream ostr;
620  ostr << "KiCad " << TO_UTF8( GetBuildVersion() );
621  idfBoard.SetIDFSource( ostr.str() );
622 
623  try
624  {
625  // set up the board reference point
626  idfBoard.SetUserOffset( -aXRef, aYRef );
627 
628  // Export the board outline
629  idf_export_outline( aPcb, idfBoard );
630 
631  // Output the drill holes and footprint (library) data.
632  for( FOOTPRINT* footprint : aPcb->Footprints() )
633  idf_export_footprint( aPcb, footprint, idfBoard );
634 
635  if( !idfBoard.WriteFile( aFullFileName, idfUnit, false ) )
636  {
637  wxString msg;
638  msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( idfBoard.GetError().c_str() );
639  wxMessageBox( msg );
640 
641  ok = false;
642  }
643  }
644  catch( const IO_ERROR& ioe )
645  {
646  wxString msg;
647  msg << _( "IDF Export Failed:\n" ) << ioe.What();
648  wxMessageBox( msg );
649 
650  ok = false;
651  }
652  catch( const std::exception& e )
653  {
654  wxString msg;
655  msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( e.what() );
656  wxMessageBox( msg );
657  ok = false;
658  }
659 
660  return ok;
661 }
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
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...
Definition: export_idf.cpp:59
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.h:593
const wxString & GetFileName() const
Definition: board.h:300
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
wxString GetBuildVersion()
Get the full KiCad version string.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
FOOTPRINTS & Footprints()
Definition: board.h:305
static void idf_export_footprint(BOARD *aPcb, FOOTPRINT *aFootprint, IDF3_BOARD &aIDFBoard)
Function idf_export_footprint retrieves information from all board footprints, adds drill holes to th...
Definition: export_idf.cpp:281
const int scale
#define _(s)
Definition: 3d_actions.cpp:33
#define UNIT_MM
Definition: units_scales.h:31
static FILENAME_RESOLVER * resolver
Definition: export_idf.cpp:51
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

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

Referenced by OnExportIDF3().

◆ ExportFootprintsToLibrary()

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

Save footprints in a library:

Parameters
aStoreInNewLibtrue to save footprints in a existing library. Existing footprints will be kept or updated. This library should be in fp lib table, and is type is .pretty. False to save footprints in a new library. If 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 654 of file footprint_libraries_utils.cpp.

656 {
657  if( GetBoard()->GetFirstFootprint() == nullptr )
658  {
659  DisplayInfoMessage( this, _( "No footprints to export!" ) );
660  return;
661  }
662 
663  wxString footprintName;
664 
665  auto resetReference =
666  []( FOOTPRINT* aFootprint )
667  {
668  aFootprint->SetReference( "REF**" );
669  };
670 
671  if( !aStoreInNewLib )
672  {
673  // The footprints are saved in an existing .pretty library in the fp lib table
674  PROJECT& prj = Prj();
675  wxString last_nickname = prj.GetRString( PROJECT::PCB_LIB_NICKNAME );
676  wxString nickname = SelectLibrary( last_nickname );
677 
678  if( !nickname ) // Aborted
679  return;
680 
681  prj.SetRString( PROJECT::PCB_LIB_NICKNAME, nickname );
682 
683  for( FOOTPRINT* footprint : GetBoard()->Footprints() )
684  {
685  try
686  {
687  FP_LIB_TABLE* tbl = prj.PcbFootprintLibs();
688 
689  if( !footprint->GetFPID().GetLibItemName().empty() ) // Handle old boards.
690  {
691  FOOTPRINT* fpCopy = static_cast<FOOTPRINT*>( footprint->Duplicate() );
692 
693  resetReference( fpCopy );
694  tbl->FootprintSave( nickname, fpCopy, true );
695 
696  delete fpCopy;
697  }
698  }
699  catch( const IO_ERROR& ioe )
700  {
701  DisplayError( this, ioe.What() );
702  }
703  }
704  }
705  else
706  {
707  // The footprints are saved in a new .pretty library.
708  // If this library already exists, all previous footprints will be deleted
709  wxString libPath = CreateNewLibrary( aLibName );
710 
711  if( libPath.IsEmpty() ) // Aborted
712  return;
713 
714  if( aLibPath )
715  *aLibPath = libPath;
716 
718  PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
719 
720  for( FOOTPRINT* footprint : GetBoard()->Footprints() )
721  {
722  try
723  {
724  if( !footprint->GetFPID().GetLibItemName().empty() ) // Handle old boards.
725  {
726  FOOTPRINT* fpCopy = static_cast<FOOTPRINT*>( footprint->Duplicate() );
727 
728  resetReference( fpCopy );
729  pi->FootprintSave( libPath, fpCopy );
730 
731  delete fpCopy;
732  }
733  }
734  catch( const IO_ERROR& ioe )
735  {
736  DisplayError( this, ioe.What() );
737  }
738  }
739  }
740 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
Container for project specific data.
Definition: project.h:62
Releases a PLUGIN in the context of a potential thrown exception through its destructor.
Definition: io_mgr.h:550
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
PROJECT & Prj() const
Return 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...
virtual void SetRString(RSTRING_T aStringId, const wxString &aString)
Store a "retained string", which is any session and project specific string identified in enum RSTRIN...
Definition: project.cpp:213
virtual FP_LIB_TABLE * PcbFootprintLibs(KIWAY &aKiway)
Return the table of footprint libraries.
Definition: project.cpp:285
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
Definition: project.cpp:228
#define _(s)
Definition: 3d_actions.cpp:33
static PLUGIN * PluginFind(PCB_FILE_T aFileType)
Return a PLUGIN which the caller can use to import, export, save, or load design documents.
Definition: io_mgr.cpp:58
SAVE_T FootprintSave(const wxString &aNickname, const FOOTPRINT *aFootprint, bool aOverwrite=true)
Write aFootprint to an existing library given by aNickname.
wxString SelectLibrary(const wxString &aNicknameExisting)
Put up a dialog and allows the user to pick a library, for unspecified use.
BOARD * GetBoard() const
PCB_FILE_T
The set of file types that the IO_MGR knows about, and for which there has been a plugin written.
Definition: io_mgr.h:52
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:280
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
S-expression Pcbnew file format.
Definition: io_mgr.h:55

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

Referenced by ExportFootprintsToLibrary(), and Process_Special_Functions().

◆ ExportSpecctraFile()

bool PCB_EDIT_FRAME::ExportSpecctraFile ( const wxString &  aFullFilename)

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 83 of file specctra_export.cpp.

84 {
85  SPECCTRA_DB db;
86  bool ok = true;
87  wxString errorText;
88 
89  BASE_SCREEN* screen = GetScreen();
90  bool wasModified = screen->IsModify();
91 
92  db.SetPCB( SPECCTRA_DB::MakePCB() );
93 
94  LOCALE_IO toggle; // Switch the locale to standard C
95 
96  // DSN Images (=KiCad FOOTPRINTs and PADs) must be presented from the top view. So we
97  // temporarily flip any footprints which are on the back side of the board to the front,
98  // and record this in the FOOTPRINT's flag field.
99  db.FlipFOOTPRINTs( GetBoard() );
100 
101  try
102  {
104  db.FromBOARD( GetBoard() );
105  db.ExportPCB( aFullFilename, true );
106 
107  // if an exception is thrown by FromBOARD or ExportPCB(), then
108  // ~SPECCTRA_DB() will close the file.
109  }
110  catch( const IO_ERROR& ioe )
111  {
112  ok = false;
113 
114  // copy the error string to safe place, ioe is in this scope only.
115  errorText = ioe.What();
116  }
117 
118  // done assuredly, even if an exception was thrown and caught.
119  db.RevertFOOTPRINTs( GetBoard() );
120 
121  // The two calls below to FOOTPRINT::Flip(), both set the
122  // modified flag, yet their actions cancel each other out, so it should
123  // be ok to clear the modify flag.
124  if( !wasModified )
125  screen->ClrModify();
126 
127  if( ok )
128  {
129  SetStatusText( wxString( _( "BOARD exported OK." ) ) );
130  }
131  else
132  {
133  DisplayErrorMessage( this,
134  _( "Unable to export, please fix and try again" ),
135  errorText );
136  }
137 
138  return ok;
139 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
Instantiate the current locale within a scope in which you are expecting exceptions to be thrown.
Definition: locale_io.h:40
void SetPCB(PCB *aPcb)
Function SetPCB deletes any existing PCB and replaces it with the given one.
Definition: specctra.h:3904
void SynchronizeNetsAndNetClasses()
Copy NETCLASS info to each NET, based on NET membership in a NETCLASS.
Definition: board.cpp:1434
virtual const wxString What() const
A composite of Problem() and Where()
Definition: exceptions.cpp:29
Handles how to draw a screen (a board, a schematic ...)
Definition: base_screen.h:40
void RevertFOOTPRINTs(BOARD *aBoard)
Function RevertFOOTPRINTs flips the footprints which were on the back side of the board back to the b...
bool IsModify() const
Definition: base_screen.h:63
SPECCTRA_DB holds a DSN data tree, usually coming from a DSN file.
Definition: specctra.h:3632
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:60
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
BOARD * GetBoard() const
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75
void FlipFOOTPRINTs(BOARD *aBoard)
Function FlipFOOTPRINTs flips the footprints which are on the back side of the board to the front.

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

Referenced by ExportSpecctraDSN().

◆ ExportSVG()

void PCB_EDIT_FRAME::ExportSVG ( wxCommandEvent &  event)

Show the Export to SVG file dialog.

Definition at line 1221 of file pcb_edit_frame.cpp.

1222 {
1223  InvokeExportSVG( this, GetBoard() );
1224 }
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)

Create a file in GenCAD 1.4 format from the current board.

Definition at line 226 of file export_gencad.cpp.

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

◆ ExportVRML_File()

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

Create 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
aFullFileNamethe full filename of the file to create
aMMtoWRMLunitthe VRML scaling factor: 1.0 to export in mm. 0.001 for meters
aExport3DFilestrue 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.
a3D_Subdirsub directory where 3D shapes files are copied. This is only used when aExport3DFiles == true.
aXRefX value of PCB (0,0) reference point.
aYRefY value of PCB (0,0) reference point.
Returns
true if Ok.

Definition at line 936 of file export_vrml.cpp.

940 {
941  BOARD* pcb = GetBoard();
942  bool success = true;
943 
944  EXPORTER_PCB_VRML model3d;
945  model_vrml = &model3d;
946  model3d.m_Pcb = GetBoard();
947  model3d.SetScale( aMMtoWRMLunit );
948  model3d.m_UseInlineModelsInBrdfile = aExport3DFiles;
949  model3d.m_Subdir3DFpModels = a3D_Subdir;
950  model3d.m_UseRelPathIn3DModelFilename = aUseRelativePaths;
951  model3d.m_Cache3Dmodels = Prj().Get3DCacheManager();
952 
953  if( model3d.m_UseInlineModelsInBrdfile )
954  {
955  model3d.m_BoardToVrmlScale = MM_PER_IU / 2.54;
956  model3d.SetOffset( -aXRef / 2.54, aYRef / 2.54 );
957  }
958  else
959  {
960  model3d.m_BoardToVrmlScale = MM_PER_IU;
961  model3d.SetOffset( -aXRef, aYRef );
962  }
963 
964  try
965  {
966  // Preliminary computation: the z value for each layer
967  model3d.ComputeLayer3D_Zpos();
968 
969  // board edges and cutouts
970  model3d.ExportVrmlBoard();
971 
972  // Draw solder mask layer (negative layer)
973  model3d.ExportVrmlSolderMask();
974 #if 1
975  model3d.ExportVrmlViaHoles();
976  model3d.ExportStandardLayers();
977 #else
978  // Drawing and text on the board
979  model3d.ExportVrmlDrawings();
980 
981  // Export vias and trackage
982  model3d.ExportVrmlTracks();
983 
984  // Export zone fills
985  model3d.ExportVrmlZones();
986 #endif
987  if( model3d.m_UseInlineModelsInBrdfile )
988  {
989  // Copy fp 3D models in a folder, and link these files in
990  // the board .vrml file
991  model3d.ExportFp3DModelsAsLinkedFile( aFullFileName );
992  }
993  else
994  {
995  // merge footprints in the .vrml board file
996  for( FOOTPRINT* footprint : pcb->Footprints() )
997  model3d.ExportVrmlFootprint( footprint, NULL );
998 
999  // write out the board and all layers
1000  model3d.writeLayers( TO_UTF8( aFullFileName ), NULL );
1001  }
1002  }
1003  catch( const std::exception& e )
1004  {
1005  wxString msg;
1006  msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( e.what() );
1007  wxMessageBox( msg );
1008 
1009  success = false;
1010  }
1011 
1012  return success;
1013 }
void ExportVrmlFootprint(FOOTPRINT *aFootprint, std::ostream *aOutputFile)
static wxString FROM_UTF8(const char *cstring)
Convert a UTF8 encoded C string to a wxString for all wxWidgets build modes.
Definition: macros.h:110
void ExportFp3DModelsAsLinkedFile(const wxString &aFullFileName)
void writeLayers(const char *aFileName, OSTREAM *aOutputFile)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
wxString m_Subdir3DFpModels
#define NULL
bool m_UseRelPathIn3DModelFilename
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void ComputeLayer3D_Zpos()
FOOTPRINTS & Footprints()
Definition: board.h:305
static EXPORTER_PCB_VRML * model_vrml
void ExportVrmlSolderMask()
bool SetScale(double aWorldScale)
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
#define _(s)
Definition: 3d_actions.cpp:33
S3D_CACHE * m_Cache3Dmodels
void SetOffset(double aXoff, double aYoff)
BOARD * GetBoard() const
void ExportStandardLayers()
bool m_UseInlineModelsInBrdfile

References _, EXPORTER_PCB_VRML::ComputeLayer3D_Zpos(), EXPORTER_PCB_VRML::ExportFp3DModelsAsLinkedFile(), EXPORTER_PCB_VRML::ExportStandardLayers(), EXPORTER_PCB_VRML::ExportVrmlBoard(), EXPORTER_PCB_VRML::ExportVrmlFootprint(), EXPORTER_PCB_VRML::ExportVrmlSolderMask(), EXPORTER_PCB_VRML::ExportVrmlViaHoles(), BOARD::Footprints(), FROM_UTF8(), PCB_BASE_FRAME::GetBoard(), EXPORTER_PCB_VRML::m_BoardToVrmlScale, EXPORTER_PCB_VRML::m_Cache3Dmodels, EXPORTER_PCB_VRML::m_Pcb, EXPORTER_PCB_VRML::m_Subdir3DFpModels, EXPORTER_PCB_VRML::m_UseInlineModelsInBrdfile, EXPORTER_PCB_VRML::m_UseRelPathIn3DModelFilename, model_vrml, NULL, KIWAY_HOLDER::Prj(), EXPORTER_PCB_VRML::SetOffset(), EXPORTER_PCB_VRML::SetScale(), TO_UTF8, and EXPORTER_PCB_VRML::writeLayers().

Referenced by ExportVRML(), and OnExportVRML().

◆ FetchNetlistFromSchematic()

bool PCB_EDIT_FRAME::FetchNetlistFromSchematic ( NETLIST aNetlist,
const wxString &  aAnnotateMessage 
)
Parameters
aNetlista NETLIST owned by the caller. This function fills it in.
aAnnotateMessagea message to be shown if annotation must be performed. If empty, annotation will be skipped.
Returns
true if a netlist was fetched.

Definition at line 1406 of file pcb_edit_frame.cpp.

1408 {
1409  if( !TestStandalone() )
1410  {
1411  DisplayErrorMessage( this, _( "Cannot update the PCB because PCB editor is opened in "
1412  "stand-alone mode. In order to create or update PCBs from "
1413  "schematics, you must launch the KiCad project manager and "
1414  "create a project." ) );
1415  return false; // Not in standalone mode
1416  }
1417 
1418  Raise(); // Show
1419 
1420  std::string payload( aAnnotateMessage );
1421 
1422  Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_GET_NETLIST, payload, this );
1423 
1424  if( payload == aAnnotateMessage )
1425  {
1426  Raise();
1427  DisplayErrorMessage( this, aAnnotateMessage );
1428  return false;
1429  }
1430 
1431  try
1432  {
1433  auto lineReader = new STRING_LINE_READER( payload, _( "Eeschema netlist" ) );
1434  KICAD_NETLIST_READER netlistReader( lineReader, &aNetlist );
1435  netlistReader.LoadNetlist();
1436  }
1437  catch( const IO_ERROR& )
1438  {
1439  Raise();
1440  assert( false ); // should never happen
1441  return false;
1442  }
1443 
1444  return true;
1445 }
KIWAY & Kiway() const
Return 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.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:265
virtual void ExpressMail(FRAME_T aDestination, MAIL_T aCommand, std::string &aPayload, wxWindow *aSource=nullptr)
Send aPayload to aDestination from aSource.
Definition: kiway.cpp:451
bool TestStandalone(void)
Test if standalone mode.
#define _(s)
Definition: 3d_actions.cpp:33
Is a LINE_READER that reads from a multiline 8 bit wide std::string.
Definition: richio.h:237
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

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

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

◆ Files_io()

void PCB_EDIT_FRAME::Files_io ( wxCommandEvent &  event)

Call Files_io_from_id with the wxCommandEvent id.

Parameters
eventis the command event handler.

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

300 {
301  int id = event.GetId();
302  Files_io_from_id( id );
303 }
bool Files_io_from_id(int aId)
Read and write board files according to aId.

References Files_io_from_id().

◆ Files_io_from_id()

bool PCB_EDIT_FRAME::Files_io_from_id ( int  aId)

Read and write board files according to aId.

Valid event IDs are:

  • ID_LOAD_FILE
  • ID_MENU_RECOVER_BOARD_AUTOSAVE
  • ID_NEW_BOARD
  • ID_SAVE_BOARD
  • ID_COPY_BOARD_AS
  • ID_SAVE_BOARD_AS
Parameters
aIdis an event ID coming from file command events:

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

307 {
308  wxString msg;
309 
310  switch( id )
311  {
312  case ID_LOAD_FILE:
313  {
314  int open_ctl = 0;
315  wxString fileName = Prj().AbsolutePath( GetBoard()->GetFileName() );
316 
317  return AskLoadBoardFileName( this, &open_ctl, &fileName, true )
318  && OpenProjectFiles( std::vector<wxString>( 1, fileName ), open_ctl );
319  }
320 
322  {
323  int open_ctl = 1;
324  wxString fileName; // = Prj().AbsolutePath( GetBoard()->GetFileName() );
325 
326  return AskLoadBoardFileName( this, &open_ctl, &fileName, false )
327  && OpenProjectFiles( std::vector<wxString>( 1, fileName ), open_ctl );
328  }
329 
331  {
332  wxFileName currfn = Prj().AbsolutePath( GetBoard()->GetFileName() );
333  wxFileName fn = currfn;
334 
335  wxString rec_name = GetAutoSaveFilePrefix() + fn.GetName();
336  fn.SetName( rec_name );
337 
338  if( !fn.FileExists() )
339  {
340  msg.Printf( _( "Recovery file \"%s\" not found." ), fn.GetFullPath() );
341  DisplayInfoMessage( this, msg );
342  return false;
343  }
344 
345  msg.Printf( _( "OK to load recovery file \"%s\"" ), fn.GetFullPath() );
346 
347  if( !IsOK( this, msg ) )
348  return false;
349 
350  GetScreen()->ClrModify(); // do not prompt the user for changes
351 
352  if( OpenProjectFiles( std::vector<wxString>( 1, fn.GetFullPath() ) ) )
353  {
354  // Re-set the name since name or extension was changed
355  GetBoard()->SetFileName( currfn.GetFullPath() );
356  UpdateTitle();
357  return true;
358  }
359 
360  return false;
361  }
362 
363  case ID_NEW_BOARD:
364  {
365  if( IsContentModified() )
366  {
367  wxFileName fileName = GetBoard()->GetFileName();
368  wxString saveMsg = _( "Current board will be closed, save changes to '%s' before "
369  "continuing?" );
370 
371  if( !HandleUnsavedChanges( this, wxString::Format( saveMsg, fileName.GetFullName() ),
372  [&]()->bool
373  {
375  } ) )
376  {
377  return false;
378  }
379  }
380  else if( !GetBoard()->IsEmpty() )
381  {
382  if( !IsOK( this, _( "Current Board will be closed. Continue?" ) ) )
383  return false;
384  }
385 
387 
388  GetBoard()->ClearProject();
389 
391 
392  mgr->SaveProject( mgr->Prj().GetProjectFullName() );
393  mgr->UnloadProject( &mgr->Prj() );
394 
395  if( !Clear_Pcb( false ) )
396  return false;
397 
399 
400  onBoardLoaded();
401 
402  OnModify();
403  return true;
404  }
405 
406  case ID_SAVE_BOARD:
407  if( !GetBoard()->GetFileName().IsEmpty() )
408  return SavePcbFile( Prj().AbsolutePath( GetBoard()->GetFileName() ) );
409 
411 
412  case ID_COPY_BOARD_AS:
413  case ID_SAVE_BOARD_AS:
414  {
415  bool addToHistory = ( id == ID_SAVE_BOARD_AS );
416  wxString orig_name;
417 
418  wxFileName::SplitPath( GetBoard()->GetFileName(), nullptr, nullptr, &orig_name, nullptr );
419 
420  if( orig_name.IsEmpty() )
421  orig_name = _( "noname" );
422 
423  wxFileName savePath( Prj().GetProjectFullName() );
424 
425  if( !savePath.IsOk() || !savePath.IsDirWritable() )
426  {
427  savePath = GetMruPath();
428 
429  if( !savePath.IsOk() || !savePath.IsDirWritable() )
431  }
432 
433  wxFileName fn( savePath.GetPath(), orig_name, KiCadPcbFileExtension );
434  wxString filename = fn.GetFullPath();
435  bool createProject = false;
436 
437  if( AskSaveBoardFileName( this, &filename, &createProject ) )
438  {
439  if( id == ID_COPY_BOARD_AS )
440  return SavePcbCopy( filename, createProject );
441  else
442  return SavePcbFile( filename, addToHistory, createProject );
443  }
444 
445  return false;
446  }
447 
448  default:
449  return false;
450  }
451 }
void UpdateTitle()
Set the main window title bar text.
void OnModify() override
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:207
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)
Write the board data structures to aFileName.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
const std::string KiCadPcbFileExtension
const wxString & GetFileName() const
Definition: board.h:300
virtual const wxString AbsolutePath(const wxString &aFileName) const
Fix up aFileName if it is relative to the project's directory to be an absolute path and filename.
Definition: project.cpp:271
wxString GetMruPath() const
bool AskSaveBoardFileName(PCB_EDIT_FRAME *aParent, wxString *aFileName, bool *aCreateProject)
Put up a wxFileDialog asking for a BOARD filename to save.
bool AskLoadBoardFileName(PCB_EDIT_FRAME *aParent, int *aCtl, wxString *aFileName, bool aKicadFilesOnly)
Show a wxFileDialog asking for a BOARD filename to open.
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
Load a KiCad board (.kicad_pcb) from aFileName.
void onBoardLoaded()
Update the state of the GUI after a new board is loaded or created.
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
void SaveProjectSettings() override
Save changes to the project settings to the project (.pro) file.
void SetFileName(const wxString &aFileName)
Definition: board.h:298
virtual const wxString GetProjectFullName() const
Return the full path and name of the project.
Definition: project.cpp:117
void ClearProject()
Definition: board.cpp:169
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()
static wxString GetDefaultUserProjectsPath()
Gets the default path we point users to create projects.
Definition: paths.cpp:130
bool SavePcbFile(const wxString &aFileName, bool addToHistory=true, bool aChangeProject=true)
Write the board data structures to a aFileName.
#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:60
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
bool Files_io_from_id(int aId)
Read and write board files according to aId.
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:280
bool Clear_Pcb(bool aQuery, bool aFinal=false)
Delete all and reinitialize the current board.
Definition: initpcb.cpp:42
bool IsOK(wxWindow *aParent, const wxString &aMessage)
Display a yes/no dialog with aMessage and returns the user response.
Definition: confirm.cpp:296
bool IsEmpty() const
Definition: board.h:353

References _, PROJECT::AbsolutePath(), AskLoadBoardFileName(), AskSaveBoardFileName(), Clear_Pcb(), BOARD::ClearProject(), BASE_SCREEN::ClrModify(), DisplayInfoMessage(), Format(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), PCB_BASE_FRAME::GetBoard(), PATHS::GetDefaultUserProjectsPath(), BOARD::GetFileName(), EDA_BASE_FRAME::GetMruPath(), 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(), BOARD_EDITOR_CONTROL::New(), BOARD_EDITOR_CONTROL::Open(), BOARD_EDITOR_CONTROL::Save(), BOARD_EDITOR_CONTROL::SaveAs(), and BOARD_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 782 of file pcb_edit_frame.h.

783  {
784  return FindWindowByName( pythonConsoleNameId() );
785  }
static const wxChar * pythonConsoleNameId()
Has meaning only if KICAD_SCRIPTING_WXPYTHON option is not defined.

References pythonConsoleNameId().

Referenced by setupUIConditions().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 747 of file eda_base_frame.cpp.

748 {
749 #if defined( __WXOSX_MAC__ )
750  m_auimgr.Update();
751 #else
752  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
753  // hiding it.
754  m_auimgr.Update();
755 
756  // We don't want the infobar displayed right away
757  m_auimgr.GetPane( "InfoBar" ).Hide();
758  m_auimgr.Update();
759 #endif
760 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnItem()

void PCB_BASE_FRAME::FocusOnItem ( BOARD_ITEM aItem)
inherited
Todo:
The Boost entropy exception does not exist prior to 1.67. Once the minimum Boost version is raise to 1.67 or greater, this version check can be removed.

Definition at line 185 of file pcb_base_frame.cpp.

186 {
187  static KIID lastBrightenedItemID( niluuid );
188 
189  BOARD_ITEM* lastItem = nullptr;
190 
193 #if BOOST_VERSION >= 106700
194  try
195  {
196  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
197  }
198  catch( const boost::uuids::entropy_error& )
199  {
200  wxLogError( "A Boost UUID entropy exception was thrown in %s:%s.", __FILE__, __FUNCTION__ );
201  }
202 #else
203  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
204 #endif
205 
206  if( lastItem && lastItem != aItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
207  {
208  lastItem->ClearBrightened();
209 
210  if( lastItem->Type() == PCB_FOOTPRINT_T )
211  {
212  static_cast<FOOTPRINT*>( lastItem )->RunOnChildren(
213  [&]( BOARD_ITEM* child )
214  {
215  child->ClearBrightened();
216  } );
217  }
218  else if( lastItem->Type() == PCB_GROUP_T )
219  {
220  static_cast<PCB_GROUP*>( lastItem )->RunOnChildren(
221  [&]( BOARD_ITEM* child )
222  {
223  child->ClearBrightened();
224  } );
225  }
226 
227  GetCanvas()->GetView()->Update( lastItem );
228  lastBrightenedItemID = niluuid;
229  GetCanvas()->Refresh();
230  }
231 
232  if( aItem && aItem != DELETED_BOARD_ITEM::GetInstance() )
233  {
234  aItem->SetBrightened();
235 
236  if( aItem->Type() == PCB_FOOTPRINT_T )
237  {
238  static_cast<FOOTPRINT*>( aItem )->RunOnChildren(
239  [&]( BOARD_ITEM* child )
240  {
241  child->SetBrightened();
242  });
243  }
244  else if( aItem->Type() == PCB_GROUP_T )
245  {
246  static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
247  [&]( BOARD_ITEM* child )
248  {
249  child->SetBrightened();
250  });
251  }
252 
253  GetCanvas()->GetView()->Update( aItem );
254  lastBrightenedItemID = aItem->m_Uuid;
255  FocusOnLocation( aItem->GetFocusPosition() );
256  GetCanvas()->Refresh();
257  }
258 }
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:813
KIID niluuid(0)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:82
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:108
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
virtual const wxPoint GetFocusPosition() const
Similar to GetPosition, but allows items to return their visual center rather than their anchor.
Definition: eda_item.h:309
void SetBrightened()
Definition: eda_item.h:180
void ClearBrightened()
Definition: eda_item.h:183
Definition: kiid.h:44
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:92
static DELETED_BOARD_ITEM * GetInstance()
Definition: board_item.h:398
virtual KIGFX::PCB_VIEW * GetView() const override
Return 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...
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
const KIID m_Uuid
Definition: eda_item.h:525
BOARD * GetBoard() const
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:163

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_FOOTPRINT_T, PCB_GROUP_T, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), EDA_ITEM::Type(), and KIGFX::PCB_VIEW::Update().

Referenced by PCB_SELECTION_TOOL::Main(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_DRC::~DIALOG_DRC(), and DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES().

◆ 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 796 of file eda_draw_frame.cpp.

797 {
798  bool centerView = false;
799  BOX2D r = GetCanvas()->GetView()->GetViewport();
800 
801  // Center if we're off the current view, or within 10% of its edge
802  r.Inflate( - (int) r.GetWidth() / 10 );
803 
804  if( !r.Contains( aPos ) )
805  centerView = true;
806 
807  // Center if we're behind an obscuring dialog, or within 10% of its edge
808  wxWindow* dialog = findDialog( GetChildren() );
809 
810  if( dialog )
811  {
812  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
813  dialog->GetSize() );
814  dialogRect.Inflate( dialogRect.GetWidth() / 10 );
815 
816  if( dialogRect.Contains( (wxPoint) GetCanvas()->GetView()->ToScreen( aPos ) ) )
817  centerView = true;
818  }
819 
820  if( centerView )
821  {
822  // If a dialog partly obscures the window, then center on the uncovered area.
823  if( dialog )
824  {
825  wxRect dialogRect( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
826  dialog->GetSize() );
827  GetCanvas()->GetView()->SetCenter( aPos, dialogRect );
828  }
829  else
830  GetCanvas()->GetView()->SetCenter( aPos );
831  }
832 
834 }
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:514
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return 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)
Set the center point of the VIEW (i.e.
Definition: view.cpp:580
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
Return a pointer to the #VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move 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 PCB_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 362 of file export_d356.cpp.

363 {
364  wxFileName fn = GetBoard()->GetFileName();
365  wxString msg, ext, wildcard;
366 
367  ext = IpcD356FileExtension;
368  wildcard = IpcD356FileWildcard();
369  fn.SetExt( ext );
370 
371  wxString pro_dir = wxPathOnly( Prj().GetProjectFullName() );
372 
373  wxFileDialog dlg( this, _( "Export D-356 Test File" ), pro_dir,
374  fn.GetFullName(), wildcard,
375  wxFD_SAVE | wxFD_OVERWRITE_PROMPT );
376 
377  if( dlg.ShowModal() == wxID_CANCEL )
378  return;
379 
380  IPC356D_WRITER writer( GetBoard(), this );
381 
382  writer.Write( dlg.GetPath() );
383 }
const wxString & GetFileName() const
Definition: board.h:300
Wrapper to expose an API for writing IPC-D356 files.
Definition: export_d356.h:53
PROJECT & Prj() const
Return 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 BOARD_EDITOR_CONTROL::GenerateFabFiles().

◆ GenFootprintsReport()

void PCB_EDIT_FRAME::GenFootprintsReport ( wxCommandEvent &  event)

Call DoGenFootprintsReport to create a footprint report file.

Definition at line 502 of file gen_footprints_placefile.cpp.

503 {
504  wxFileName fn;
505 
506  wxString boardFilePath = ( (wxFileName) GetBoard()->GetFileName() ).GetPath();
507  wxDirDialog dirDialog( this, _( "Select Output Directory" ), boardFilePath );
508 
509  if( dirDialog.ShowModal() == wxID_CANCEL )
510  return;
511 
512  fn = GetBoard()->GetFileName();
513  fn.SetPath( dirDialog.GetPath() );
514  fn.SetExt( wxT( "rpt" ) );
515 
516  bool unitMM = GetUserUnits() == EDA_UNITS::MILLIMETRES;
517  bool success = DoGenFootprintsReport( fn.GetFullPath(), unitMM );
518 
519  wxString msg;
520  if( success )
521  {
522  msg.Printf( _( "Footprint report file created:\n\"%s\"" ), fn.GetFullPath() );
523  wxMessageBox( msg, _( "Footprint Report" ), wxICON_INFORMATION );
524  }
525 
526  else
527  {
528  msg.Printf( _( "Unable to create \"%s\"" ), fn.GetFullPath() );
529  DisplayError( this, msg );
530  }
531 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:252
const wxString & GetFileName() const
Definition: board.h:300
bool DoGenFootprintsReport(const wxString &aFullFilename, bool aUnitsMM)
Create an ASCII footprint report file giving some infos on footprints and board outlines.
#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 MILLIMETRES.

Referenced by BOARD_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 85 of file pcb_base_frame.cpp.

86 {
87  return dynamic_cast<EDA_3D_VIEWER*>( FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) ) );
88 }
#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

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const
inlinevirtualinherited

◆ GetAppearancePanel()

◆ GetAutoSaveFilePrefix()

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

Definition at line 582 of file eda_base_frame.h.

583  {
584  return wxT( "_autosave-" );
585  }

Referenced by EDA_BASE_FRAME::CheckForAutoSaveFile(), doAutoSave(), SCH_EDIT_FRAME::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 190 of file eda_base_frame.h.

190 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAutoZoom()