The main frame for Pcbnew. More...

#include <pcb_edit_frame.h>

Inheritance diagram for PCB_EDIT_FRAME:

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 }
	Specifies whether we are interacting with the undo or redo stacks. 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 () const override
	Get if the current board has been modified but not saved. 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 (const COLOR4D &aColor) override

void	Process_Config (wxCommandEvent &event)

bool	GetActionPluginButtonVisible (const wxString &aPluginPath, bool aPluginDefault)
	Return true if button visibility action plugin setting was set to true or it is unset and plugin defaults to true. More...

std::vector< ACTION_PLUGIN * >	GetOrderedActionPlugins ()
	Return ordered list of plugins in sequence in which they should appear on toolbar or in settings. More...

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, bool aUseAuxOrigin)
	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_CONTAINER *	GetModel () 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=nullptr)
	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 (PCB_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 (PCB_DIMENSION_BASE *aDimension)

void	InstallNetlistFrame ()

bool	FetchNetlistFromSchematic (NETLIST &aNetlist, const wxString &aAnnotateMessage)

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...

SELECTION &	GetCurrentSelection () override
	Get the current selection from the canvas area. More...

TOOL_ACTION *	GetExportNetlistAction ()

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...

wxString	CreateNewProjectLibrary (const wxString &aLibName=wxEmptyString, const wxString &aProposedName=wxEmptyString)

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_SETTINGS *	GetColorSettings () 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_CONTROLS *	GetAppearancePanel ()

virtual void	OnLayerAlphaChanged ()
	Notify the frame that the layer Alpha is being changed. More...

EDA_3D_VIEWER_FRAME *	Get3DViewerFrame ()

virtual void	Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr)
	Update the 3D view, if the viewer is opened by this frame. More...

FOOTPRINT *	LoadFootprint (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_INFO &	GetPageSettings () 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_TRANSFORMS &	GetOriginTransforms () override
	Return a reference to the default ORIGIN_TRANSFORMS object. More...

const TITLE_BLOCK &	GetTitleBlock () const override

void	SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override

virtual BOARD_DESIGN_SETTINGS &	GetDesignSettings () const
	Returns the BOARD_DESIGN_SETTINGS for the open project. More...

PCBNEW_SETTINGS &	Settings ()

void	SetDrawBgColor (const COLOR4D &aColor) override

const PCB_DISPLAY_OPTIONS &	GetDisplayOptions () 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_SETTINGS &	GetZoneSettings () const

void	SetZoneSettings (const ZONE_SETTINGS &aSettings)

virtual const PCB_PLOT_PARAMS &	GetPlotSettings () const
	Return the PCB_PLOT_PARAMS for the BOARD owned by this frame. More...

virtual void	SetPlotSettings (const PCB_PLOT_PARAMS &aSettings)

BOARD *	GetBoard () const

EDA_ITEM *	GetItem (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_SCREEN *	GetScreen () const override
	Return a pointer to a BASE_SCREEN or one of its derivatives. More...

EDA_3D_VIEWER_FRAME *	CreateAndShow3D_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...

FOOTPRINT *	GetFootprintFromBoardByReference ()

FOOTPRINT *	CreateNewFootprint (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)

FOOTPRINT *	SelectFootprintFromLibTree (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_SETTINGS *	GetPcbNewSettings () const

FOOTPRINT_EDITOR_SETTINGS *	GetFootprintEditorSettings () const

virtual MAGNETIC_SETTINGS *	GetMagneticItemsSettings ()

void	DisplayGridMsg () override
	Display the current grid pane on the status bar. More...

PCB_DRAW_PANEL_GAL *	GetCanvas () 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...

void	ScriptingConsoleEnableDisable ()
	Toggles the scripting console visibility. More...

bool	IsScriptingConsoleVisible ()
	Gets the current visibility of the scripting console window. 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) override
	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	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_OPTIONS &	GetGalDisplayOptions ()
	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)

void	CreateServer (int service, bool local=true)

void	OnSockRequest (wxSocketEvent &evt)

void	OnSockRequestServer (wxSocketEvent &evt)

EDA_UNITS	GetUserUnits () const
	Return the user units currently in use. More...

void	SetUserUnits (EDA_UNITS aUnits)

void	ChangeUserUnits (EDA_UNITS aUnits)

SETTINGS_MANAGER *	GetSettingsManager () const

bool	ProcessEvent (wxEvent &aEvent) override
	Override the default process event handler to implement the auto save feature. More...

virtual void	OnCharHook (wxKeyEvent &aKeyEvent)
	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

FRAME_T	GetFrameType () const

virtual const SEARCH_STACK &	sys_search ()
	Return a SEARCH_STACK pertaining to entire program. More...

virtual wxString	help_name ()

void	OnKicadAbout (wxCommandEvent &event)

void	OnPreferences (wxCommandEvent &event)
	Displays the preferences and settings of all opened editors paged dialog. More...

void	PrintMsg (const wxString &text)

void	CreateInfoBar ()

void	FinishAUIInitialization ()

WX_INFOBAR *	GetInfoBar ()

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_BASE *	config () 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_SETTINGS *	GetWindowSettings (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_HISTORY &	GetFileHistory ()
	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_LIST *	PopCommandFromUndoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual PICKED_ITEMS_LIST *	PopCommandFromRedoList ()
	Return the last command to undo and remove it from list, nothing is deleted. More...

virtual int	GetUndoCommandCount () const

virtual int	GetRedoCommandCount () const

int	GetMaxUndoItems () const

bool	NonUserClose (bool aForce)

virtual void	HandleSystemColorChange ()
	Update the UI in response to a change in the system colors. More...

TOOL_MANAGER *	GetToolManager () 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

KIWAY &	Kiway () const
	Return a reference to the KIWAY that this object has an opportunity to participate in. More...

PROJECT &	Prj () 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_SELECTOR *	m_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	buildActionPluginMenus (ACTION_MENU *aActionMenu)
	Fill action menu with all registered action plugins. More...

void	AddActionPluginTools ()
	Append action plugin buttons to main toolbar. More...

void	RunActionPlugin (ACTION_PLUGIN *aActionPlugin)
	Execute action plugin's Run() method and updates undo buffer. More...

void	OnActionPluginMenu (wxCommandEvent &aEvent)
	Launched by the menu when an action is called. More...

void	OnActionPluginButton (wxCommandEvent &aEvent)
	Launched by the button when an action is called. 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_TABLE *	selectLibTable (bool aOptional=false)
	Prompts a user to select global or project library tables. More...

wxString	createNewLibrary (const wxString &aLibName, const wxString &aProposedName, FP_LIB_TABLE *aTable)
	Create a new library in the given table (presumed to be either the global or project library table). 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...

FOOTPRINT *	loadFootprint (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...

void	ensureWindowIsOnScreen ()

Static Protected Member Functions
static wxString	GetAutoSaveFilePrefix ()

Protected Attributes
LAYER_TOOLBAR_ICON_VALUES	m_prevIconVal

int	m_rotationAngle

bool	m_undoRedoBlocked

PANEL_SELECTION_FILTER *	m_selectionFilterPanel

APPEARANCE_CONTROLS *	m_appearancePanel

BOARD *	m_pcb

PCB_DISPLAY_OPTIONS	m_displayOptions

PCB_ORIGIN_TRANSFORMS	m_originTransforms

PCBNEW_SETTINGS *	m_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_TOOLBAR *	m_mainToolBar

ACTION_TOOLBAR *	m_auxiliaryToolBar

ACTION_TOOLBAR *	m_drawToolBar

ACTION_TOOLBAR *	m_optionsToolBar

wxFindReplaceData *	m_findReplaceData

wxArrayString	m_findStringHistoryList

wxArrayString	m_replaceStringHistoryList

EDA_MSG_PANEL *	m_messagePanel

int	m_msgFrameHeight

COLOR_SETTINGS *	m_colorSettings
	The current canvas type. More...

EDA_DRAW_PANEL_GAL::GAL_TYPE	m_canvasType

bool	m_modal

WX_EVENT_LOOP *	m_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

int	m_displayIndex

wxPoint	m_normalFramePos

wxSize	m_normalFrameSize

wxString	m_aboutTitle

wxAuiManager	m_auimgr

wxString	m_perspective

WX_INFOBAR *	m_infoBar

wxString	m_configName

SETTINGS_MANAGER *	m_settingsManager

FILE_HISTORY *	m_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, UIUpdateHandler >	m_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_MANAGER *	m_toolManager

ACTIONS *	m_actions

TOOL_DISPATCHER *	m_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_ACTION *	m_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 69 of file pcb_edit_frame.h.

Member Enumeration Documentation

◆ HOLDER_TYPE

enum KIWAY_HOLDER::HOLDER_TYPE

inherited

Enumerator
DIALOG
FRAME
PANEL

Definition at line 39 of file kiway_holder.h.

39 { DIALOG, FRAME, PANEL };

KIWAY_HOLDER::DIALOG

Definition: kiway_holder.h:39

KIWAY_HOLDER::PANEL

Definition: kiway_holder.h:39

KIWAY_HOLDER::FRAME

Definition: kiway_holder.h:39

◆ UNDO_REDO_LIST

enum EDA_BASE_FRAME::UNDO_REDO_LIST

inherited

Specifies whether we are interacting with the undo or redo stacks.

Enumerator
UNDO_LIST
REDO_LIST

Definition at line 109 of file eda_base_frame.h.

     {
         UNDO_LIST,
         REDO_LIST
     };

Constructor & Destructor Documentation

◆ ~PCB_EDIT_FRAME()

PCB_EDIT_FRAME::~PCB_EDIT_FRAME ( )

virtual

Definition at line 377 of file pcb_edit_frame.cpp.

 {
     // Close modeless dialogs
     wxWindow* open_dlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
 
     if( open_dlg )
         open_dlg->Close( true );
 
     // Shutdown all running tools
     if( m_toolManager )
         m_toolManager->ShutdownAllTools();
 
     if( GetBoard() )
         GetBoard()->RemoveListener( m_appearancePanel );
 
     delete m_selectionFilterPanel;
     delete m_appearancePanel;
     delete m_exportNetlistAction;
 }

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

aBoard is the BOARD to put into the frame.

Reimplemented from PCB_BASE_EDIT_FRAME.

Definition at line 895 of file pcb_edit_frame.cpp.

 {
     PCB_BASE_EDIT_FRAME::ActivateGalCanvas();
     GetCanvas()->UpdateColors();
     GetCanvas()->Refresh();
 }

References PCB_BASE_EDIT_FRAME::ActivateGalCanvas().

Referenced by Refresh(), and RunActionPlugin().

◆ AddActionPluginTools()

void PCB_EDIT_FRAME::AddActionPluginTools ( )

protected

Append action plugin buttons to main toolbar.

Definition at line 397 of file pcbnew_action_plugins.cpp.

 {
     bool need_separator = true;
     const std::vector<ACTION_PLUGIN*>& orderedPlugins = GetOrderedActionPlugins();
 
     for( ACTION_PLUGIN* ap : orderedPlugins )
     {
         if( GetActionPluginButtonVisible( ap->GetPluginPath(), ap->GetShowToolbarButton() ) )
         {
             if( need_separator )
             {
                 m_mainToolBar->AddScaledSeparator( this );
                 need_separator = false;
             }
 
             // Add button
             wxBitmap bitmap;
 
             if ( ap->iconBitmap.IsOk() )
                 bitmap = KiScaledBitmap( ap->iconBitmap, this );
             else
                 bitmap = KiScaledBitmap( BITMAPS::puzzle_piece, this );
 
             wxAuiToolBarItem* button = m_mainToolBar->AddTool( wxID_ANY, wxEmptyString,
                                                                bitmap, ap->GetName() );
 
             Connect( button->GetId(), wxEVT_COMMAND_MENU_SELECTED,
                      wxCommandEventHandler( PCB_EDIT_FRAME::OnActionPluginButton ) );
 
             // Link action plugin to button
             ACTION_PLUGINS::SetActionButton( ap, button->GetId() );
         }
     }
 }

References ACTION_TOOLBAR::AddScaledSeparator(), GetActionPluginButtonVisible(), GetOrderedActionPlugins(), KiScaledBitmap(), EDA_DRAW_FRAME::m_mainToolBar, OnActionPluginButton(), puzzle_piece, and ACTION_PLUGINS::SetActionButton().

Referenced by ReCreateHToolbar().

◆ AddFootprintToBoard()

void PCB_BASE_FRAME::AddFootprintToBoard ( FOOTPRINT * aFootprint )

virtualinherited

Add the given footprint to the board.

Parameters

aDC	is the current Device Context, to draw the new footprint (can be NULL ).

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 177 of file pcb_base_frame.cpp.

 {
     if( aFootprint )
     {
         GetBoard()->Add( aFootprint, ADD_MODE::APPEND );
 
         aFootprint->SetFlags( IS_NEW );
         aFootprint->SetPosition( wxPoint( 0, 0 ) ); // cursor in GAL may not be initialized yet
 
         // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
         // built from a board)
         if( aFootprint->IsFlipped() )
             aFootprint->Flip( aFootprint->GetPosition(), m_settings->m_FlipLeftRight );
 
         // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
         // it might be stored in another orientation if the lib is an archive built from a board)
         aFootprint->SetOrientation( 0 );
     }
 }

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

aFileName the library to add; a file open dialog will be displayed if empty.

Returns: true if successfully added.

Definition at line 539 of file footprint_libraries_utils.cpp.

 {
     if( aTable == nullptr )
         aTable = selectLibTable();
 
     if( aTable == nullptr )
         return wxEmptyString;
 
     bool isGlobal = ( aTable == &GFootprintTable );
 
     wxFileName fn( aFilename );
 
     if( aFilename.IsEmpty() )
     {
         if( !LibraryFileBrowser( true, fn, KiCadFootprintLibPathWildcard(),
                                  KiCadFootprintLibPathExtension, true, isGlobal,
                                  PATHS::GetDefaultUserFootprintsPath() ) )
         {
             return false;
         }
     }
 
     wxString libPath = fn.GetFullPath();
     wxString libName = fn.GetName();
 
     if( libName.IsEmpty() )
         return false;
 
     wxString type = IO_MGR::ShowType( IO_MGR::GuessPluginTypeFromLibPath( libPath ) );
 
     // try to use path normalized to an environmental variable or project path
     wxString normalizedPath = NormalizePath( libPath, &Pgm().GetLocalEnvVariables(), &Prj() );
 
     if( normalizedPath.IsEmpty() )
         normalizedPath = libPath;
 
     try
     {
         FP_LIB_TABLE_ROW* row = new FP_LIB_TABLE_ROW( libName, normalizedPath, type, wxEmptyString );
         aTable->InsertRow( row );
 
         if( isGlobal )
             GFootprintTable.Save( FP_LIB_TABLE::GetGlobalTableFileName() );
         else
             Prj().PcbFootprintLibs()->Save( Prj().FootprintLibTblName() );
     }
     catch( const IO_ERROR& ioe )
     {
         DisplayError( this, ioe.What() );
         return false;
     }
 
     auto editor = (FOOTPRINT_EDIT_FRAME*) Kiway().Player( FRAME_FOOTPRINT_EDITOR, false );
 
     if( editor )
     {
         LIB_ID libID( libName, wxEmptyString );
         editor->SyncLibraryTree( true );
         editor->FocusOnLibID( libID );
     }
 
     auto viewer = (FOOTPRINT_VIEWER_FRAME*) Kiway().Player( FRAME_FOOTPRINT_VIEWER, false );
 
     if( viewer )
         viewer->ReCreateLibraryList();
 
     return true;
 }

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 440 of file eda_base_frame.cpp.

 {
     COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
     ACTION_MENU*    helpMenu = new ACTION_MENU( false, commonControl );
 
     helpMenu->Add( ACTIONS::help );
     helpMenu->Add( ACTIONS::gettingStarted );
     helpMenu->Add( ACTIONS::listHotKeys );
     helpMenu->Add( ACTIONS::getInvolved );
     helpMenu->Add( ACTIONS::donate );
     helpMenu->Add( ACTIONS::reportBug );
 
     helpMenu->AppendSeparator();
     helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
 
     aMenuBar->Append( helpMenu, _( "&Help" ) );
 }

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_FRAME::CreateMenuBar(), KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), SYMBOL_VIEWER_FRAME::ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_VIEWER_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::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 488 of file eda_draw_frame.cpp.

 {
     COMMON_TOOLS*     commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
     CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
 
     aMenu.AddSeparator( 1000 );
 
     auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
     zoomMenu->SetTool( commonTools );
     aToolMenu.AddSubMenu( zoomMenu );
 
     auto gridMenu = std::make_shared<GRID_MENU>( this );
     gridMenu->SetTool( commonTools );
     aToolMenu.AddSubMenu( gridMenu );
 
     aMenu.AddMenu( zoomMenu.get(),   SELECTION_CONDITIONS::ShowAlways, 1000 );
     aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
 }

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

aTextUpper	The message upper text.
aTextLower	The message lower text.
aPadding	Number of spaces to pad between messages.

Definition at line 642 of file eda_draw_frame.cpp.

 {
     if( m_messagePanel )
         m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
 }

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().

◆ buildActionPluginMenus()

void PCB_EDIT_FRAME::buildActionPluginMenus ( ACTION_MENU * aActionMenu )

protected

Fill action menu with all registered action plugins.

Definition at line 375 of file pcbnew_action_plugins.cpp.

 {
     if( !actionMenu ) // Should not occur.
         return;
 
     for( int ii = 0; ii < ACTION_PLUGINS::GetActionsCount(); ii++ )
     {
         wxMenuItem* item;
         ACTION_PLUGIN* ap = ACTION_PLUGINS::GetAction( ii );
         const wxBitmap& bitmap = ap->iconBitmap.IsOk() ? ap->iconBitmap :
                                                          KiBitmap( BITMAPS::puzzle_piece );
 
         item = AddMenuItem( actionMenu, wxID_ANY,  ap->GetName(), ap->GetDescription(), bitmap );
 
         Connect( item->GetId(), wxEVT_COMMAND_MENU_SELECTED,
                  wxCommandEventHandler( PCB_EDIT_FRAME::OnActionPluginMenu ) );
 
         ACTION_PLUGINS::SetActionMenu( ii, item->GetId() );
     }
 }

References AddMenuItem(), ACTION_PLUGINS::GetAction(), ACTION_PLUGINS::GetActionsCount(), ACTION_PLUGIN::GetDescription(), ACTION_PLUGIN::GetName(), ACTION_PLUGIN::iconBitmap, KiBitmap(), OnActionPluginMenu(), puzzle_piece, and ACTION_PLUGINS::SetActionMenu().

Referenced by ReCreateMenuBar().

◆ canCloseWindow()

bool PCB_EDIT_FRAME::canCloseWindow ( wxCloseEvent & aCloseEvent )

overrideprotectedvirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 803 of file pcb_edit_frame.cpp.

 {
     // Shutdown blocks must be determined and vetoed as early as possible
     if( KIPLATFORM::APP::SupportsShutdownBlockReason() && aEvent.GetId() == wxEVT_QUERY_END_SESSION
             && IsContentModified() )
     {
         return false;
     }
 
     if( IsContentModified() )
     {
         wxFileName fileName = GetBoard()->GetFileName();
         wxString msg = _( "Save changes to '%s' before closing?" );
 
         if( !HandleUnsavedChanges( this, wxString::Format( msg, fileName.GetFullName() ),
                                    [&]() -> bool
                                    {
                                        return Files_io_from_id( ID_SAVE_BOARD );
                                    } ) )
         {
             return false;
         }
     }
 
     // Close modeless dialogs.  They're trouble when they get destroyed after the frame and/or
     // board.
     wxWindow* open_dlg = wxWindow::FindWindowByName( DIALOG_DRC_WINDOW_NAME );
 
     if( open_dlg )
         open_dlg->Close( true );
 
     return PCB_BASE_EDIT_FRAME::canCloseWindow( aEvent );
 }

References _, PCB_BASE_FRAME::canCloseWindow(), 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 1181 of file eda_base_frame.cpp.

 {
     SetUserUnits( aUnits );
     unitsChangeRefresh();
 
     wxCommandEvent e( UNITS_CHANGED );
     ProcessEventLocally( e );
 }

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

aFileName A wxFileName object containing the file name to check.

Definition at line 1069 of file eda_base_frame.cpp.

 {
     wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
 
     wxFileName autoSaveFileName = aFileName;
 
     // Check for auto save file.
     autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
 
     wxLogTrace( traceAutoSave,
                 wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
 
     if( !autoSaveFileName.FileExists() )
         return;
 
     wxString msg = wxString::Format( _(
             "Well this is potentially embarrassing!\n"
             "It appears that the last time you were editing the file\n"
             "\"%s\"\n"
             "it was not saved properly.  Do you wish to restore the last saved edits you made?" ),
             aFileName.GetFullName()
         );
 
     int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
                                  this );
 
     // Make a backup of the current file, delete the file, and rename the auto save file to
     // the file name.
     if( response == wxYES )
     {
         if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
         {
             wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
                           Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
         }
     }
     else
     {
         wxLogTrace( traceAutoSave,
                     wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
 
         // Remove the auto save file when using the previous file as is.
         wxRemoveFile( autoSaveFileName.GetFullPath() );
     }
 }

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

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

Definition at line 43 of file initpcb.cpp.

 {
     if( GetBoard() == nullptr )
         return false;
 
     if( aQuery && !GetBoard()->IsEmpty() )
     {
         if( !IsOK( this, _( "Current Board will be lost and this operation cannot be undone. "
                             "Continue?" ) ) )
         {
             return false;
         }
     }
 
     // Release the lock file, if exists
     ReleaseFile();
 
     // Clear undo and redo lists because we want a full deletion
     ClearUndoRedoList();
     GetScreen()->SetContentModified( false );
 
     if( !aFinal )
     {
         // delete the old BOARD and create a new BOARD so that the default
         // layer names are put into the BOARD.
         SetBoard( new BOARD() );
 
         // clear filename, to avoid overwriting an old file
         GetBoard()->SetFileName( wxEmptyString );
 
         GetScreen()->InitDataPoints( GetPageSizeIU() );
 
         GetBoard()->ResetNetHighLight();
 
         // Enable all layers (SetCopperLayerCount() will adjust the copper layers enabled)
         GetBoard()->SetEnabledLayers( LSET().set() );
 
         // Default copper layers count set to 2: double layer board
         GetBoard()->SetCopperLayerCount( 2 );
 
         // Update display (some options depend on the board setup)
         GetBoard()->SetVisibleLayers( LSET().set() );
         ReCreateLayerBox();
         ReCreateAuxiliaryToolbar();
         m_appearancePanel->OnBoardChanged();
         UpdateTitle();
 
         Zoom_Automatique( false );
     }
 
     return true;
 }

References _, EDA_BASE_FRAME::ClearUndoRedoList(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetScreen(), BASE_SCREEN::InitDataPoints(), IsOK(), PCB_BASE_EDIT_FRAME::m_appearancePanel, APPEARANCE_CONTROLS::OnBoardChanged(), ReCreateAuxiliaryToolbar(), ReCreateLayerBox(), EDA_DRAW_FRAME::ReleaseFile(), BOARD::ResetNetHighLight(), SetBoard(), BASE_SCREEN::SetContentModified(), 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

aFileHistory The FILE_HISTORY in use. If null, the main application file history is used

Definition at line 956 of file eda_base_frame.cpp.

 {
     if( !aFileHistory )
         aFileHistory = m_fileHistory;
 
     wxASSERT( aFileHistory );
 
     aFileHistory->ClearFileHistory();
 
     // Update the menubar to update the file history menu
     if( GetMenuBar() )
     {
         ReCreateMenuBar();
         GetMenuBar()->Refresh();
     }
 }

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()

void EDA_DRAW_FRAME::ClearMsgPanel ( )

virtualinherited

Clear all messages from the message panel.

Reimplemented in SYMBOL_EDIT_FRAME.

Definition at line 650 of file eda_draw_frame.cpp.

 {
     if( m_messagePanel )
         m_messagePanel->EraseMsgBox();
 }

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

Referenced by GERBVIEW_CONTROL::ClearAllLayers(), GERBVIEW_CONTROL::ClearLayer(), GERBER_FILE_IMAGE::DisplayImageInfo(), SYMBOL_EDIT_FRAME::DisplaySymbolDatasheet(), DIALOG_GENDRILL::GenDrillAndMapFiles(), GERBVIEW_FRAME::LoadGerberJobFile(), DIALOG_BOM::OnRunGenerator(), GERBVIEW_CONTROL::ReloadAllLayers(), NETLIST_DIALOG::TransferDataFromWindow(), EE_INSPECTION_TOOL::UpdateMessagePanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), SYMBOL_VIEWER_FRAME::updatePreviewSymbol(), and GERBVIEW_FRAME::UpdateTitleAndInfo().

◆ 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

whichList	the UNDO_REDO_CONTAINER to clear.
aItemCount	the count of items to remove. < 0 for all items.

Reimplemented from EDA_BASE_FRAME.

Definition at line 555 of file undo_redo.cpp.

 {
     if( aItemCount == 0 )
         return;
 
     UNDO_REDO_CONTAINER& list = whichList == UNDO_LIST ? m_undoList : m_redoList;
     unsigned             icnt = list.m_CommandsList.size();
 
     if( aItemCount > 0 )
         icnt = aItemCount;
 
     for( unsigned ii = 0; ii < icnt; ii++ )
     {
         if( list.m_CommandsList.size() == 0 )
             break;
 
         PICKED_ITEMS_LIST* curr_cmd = list.m_CommandsList[0];
         list.m_CommandsList.erase( list.m_CommandsList.begin() );
 
         curr_cmd->ClearListAndDeleteItems();
         delete curr_cmd;    // Delete command
     }
 }

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

◆ ClearUndoRedoList()

void EDA_BASE_FRAME::ClearUndoRedoList ( )

virtualinherited

Clear the undo and redo list using ClearUndoORRedoList()

Picked items are deleted by ClearUndoORRedoList() according to their status.

Definition at line 1132 of file eda_base_frame.cpp.

 {
     ClearUndoORRedoList( UNDO_LIST );
     ClearUndoORRedoList( REDO_LIST );
 }

References EDA_BASE_FRAME::ClearUndoORRedoList(), EDA_BASE_FRAME::REDO_LIST, and EDA_BASE_FRAME::UNDO_LIST.

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), Clear_Pcb(), SYMBOL_EDIT_FRAME::emptyScreen(), SCH_EDIT_FRAME::importFile(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), SYMBOL_EDIT_FRAME::LoadSymbolFromCurrentLib(), PL_EDITOR_FRAME::OnNewDrawingSheet(), SCH_EDIT_FRAME::OpenProjectFiles(), SCH_EDITOR_CONTROL::rescueProject(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), and EDA_BASE_FRAME::~EDA_BASE_FRAME().

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

 {
     PCB_BASE_EDIT_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
 
     GetAppearancePanel()->OnColorThemeChanged();
 
     // Netclass definitions could have changed, either by us or by Eeschema
     DRC_TOOL*   drcTool = m_toolManager->GetTool<DRC_TOOL>();
     WX_INFOBAR* infobar = GetInfoBar();
 
     try
     {
         drcTool->GetDRCEngine()->InitEngine( GetDesignRulesPath() );
         infobar->Hide();
     }
     catch( PARSE_ERROR& )
     {
         wxHyperlinkCtrl* button = new wxHyperlinkCtrl( infobar, wxID_ANY, _( "Edit design rules" ),
                                                        wxEmptyString );
 
         button->Bind( wxEVT_COMMAND_HYPERLINK, std::function<void( wxHyperlinkEvent& aEvent )>(
                 [&]( wxHyperlinkEvent& aEvent )
                 {
                     ShowBoardSetupDialog( _( "Custom Rules" ) );
                 } ) );
 
         infobar->RemoveAllButtons();
         infobar->AddButton( button );
         infobar->AddCloseButton();
         infobar->ShowMessage( _( "Could not compile custom design rules." ), wxICON_ERROR );
     }
 
     // Update the environment variables in the Python interpreter
     if( aEnvVarsChanged )
         PythonSyncEnvironmentVariables();
 
     Layout();
     SendSizeEvent();
 }

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

aDC	is the current device context (can be NULL).
aDisplayStatus	if 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 40 of file ratsnest.cpp.

 {
     GetBoard()->GetConnectivity()->RecalculateRatsnest();
 
     if( aDisplayStatus )
         SetMsgPanel( m_pcb );
 }

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 797 of file eda_base_frame.cpp.

 {
     // KICAD_MANAGER_FRAME overrides this
     return Kiface().KifaceSettings();
 }

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 357 of file eda_base_frame.h.

     {
         wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
         return baseCfgName;
     }

References EDA_BASE_FRAME::m_configName.

Referenced by EDA_BASE_FRAME::SaveWindowSettings().

◆ CreateAndShow3D_Frame()

EDA_3D_VIEWER_FRAME * 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 436 of file pcb_base_frame.cpp.

 {
     EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
 
     if( !draw3DFrame )
         draw3DFrame = new EDA_3D_VIEWER_FRAME( &Kiway(), this, _( "3D Viewer" ) );
 
     // Raising the window does not show the window on Windows if iconized. This should work
     // on any platform.
     if( draw3DFrame->IsIconized() )
          draw3DFrame->Iconize( false );
 
     draw3DFrame->Raise();
     draw3DFrame->Show( true );
 
     // Raising the window does not set the focus on Linux.  This should work on any platform.
     if( wxWindow::FindFocus() != draw3DFrame )
         draw3DFrame->SetFocus();
 
     // Allocate a slice of time to display the 3D frame
     // a call to wxSafeYield() should be enough (and better), but on Linux we need
     // to call wxYield()
     // otherwise the activity messages are not displayed during the first board loading
     wxYield();
 
     // Note, the caller is responsible to load/update the board 3D view.
     // after frame creation the board is not automatically created.
 
     return draw3DFrame;
 }

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 822 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_infoBar = new WX_INFOBAR( GetToolCanvas() );
 #else
     m_infoBar = new WX_INFOBAR( this, &m_auimgr );
 
     m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( "InfoBar" ).Top().Layer(1) );
 #endif
 }

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

aFootprintName is the name of the new footprint in library.

Definition at line 1091 of file footprint_libraries_utils.cpp.

 {
     wxString footprintName = aFootprintName;
 
     // Ask for the new footprint name
     if( footprintName.IsEmpty() )
     {
         WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
                                   footprintName );
         dlg.SetTextValidator( FOOTPRINT_NAME_VALIDATOR( &footprintName ) );
 
         if( dlg.ShowModal() != wxID_OK )
             return nullptr;    //Aborted by user
     }
 
     footprintName.Trim( true );
     footprintName.Trim( false );
 
     if( footprintName.IsEmpty() )
     {
         DisplayInfoMessage( this, _( "No footprint name defined." ) );
         return nullptr;
     }
 
     // Creates the new footprint and add it to the head of the linked list of footprints
     FOOTPRINT* footprint = new FOOTPRINT( GetBoard() );
 
     // Update parameters: timestamp ...
     footprint->SetLastEditTime();
 
     // Update its name in lib
     footprint->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
 
     PCB_LAYER_ID txt_layer;
     wxPoint default_pos;
     BOARD_DESIGN_SETTINGS& settings = GetDesignSettings();
 
     footprint->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
     footprint->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
     txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
     footprint->Reference().SetLayer( txt_layer );
     default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
     footprint->Reference().SetPosition( default_pos );
     default_pos.y += settings.GetTextSize( txt_layer ).y;
 
     footprint->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
     footprint->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
     txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
     footprint->Value().SetLayer( txt_layer );
     default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
     footprint->Value().SetPosition( default_pos );
     default_pos.y += settings.GetTextSize( txt_layer ).y;
 
     for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
     {
         FP_TEXT* textItem = new FP_TEXT( footprint );
         textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
         textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
         txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
         textItem->SetLayer( txt_layer );
         default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
         textItem->SetPosition( default_pos );
         default_pos.y += settings.GetTextSize( txt_layer ).y;
         footprint->GraphicalItems().push_back( textItem );
     }
 
     if( footprint->GetReference().IsEmpty() )
         footprint->SetReference( footprintName );
 
     if( footprint->GetValue().IsEmpty() )
         footprint->SetValue( footprintName );
 
     footprint->RunOnChildren(
             [&] ( BOARD_ITEM* aChild )
             {
                 if( aChild->Type() == PCB_FP_TEXT_T )
                 {
                     FP_TEXT*     textItem = static_cast<FP_TEXT*>( aChild );
                     PCB_LAYER_ID layer = textItem->GetLayer();
 
                     textItem->SetTextThickness( settings.GetTextThickness( layer ) );
                     textItem->SetTextSize( settings.GetTextSize( layer ) );
                     textItem->SetItalic( settings.GetTextItalic( layer ) );
                     textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
                 }
             } );
 
     SetMsgPanel( footprint );
     return footprint;
 }

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

aProposedName is 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 385 of file footprint_libraries_utils.cpp.

 {
     FP_LIB_TABLE* table  = selectLibTable();
 
     return createNewLibrary( aLibName, aProposedName, table );
 }

References PCB_BASE_EDIT_FRAME::createNewLibrary(), and PCB_BASE_EDIT_FRAME::selectLibTable().

Referenced by ExportFootprintsToLibrary().

◆ createNewLibrary()

wxString PCB_BASE_EDIT_FRAME::createNewLibrary	(	const wxString &	aLibName,
		const wxString &	aProposedName,
		FP_LIB_TABLE *	aTable
	)

protectedinherited

Create a new library in the given table (presumed to be either the global or project library table).

Definition at line 394 of file footprint_libraries_utils.cpp.

 {
     // Kicad cannot write legacy format libraries, only .pretty new format because the legacy
     // format cannot handle current features.
     // The footprint library is actually a directory.
 
     if( aTable == nullptr )
         return wxEmptyString;
 
     wxString   initialPath = aProposedName.IsEmpty() ? Prj().GetProjectPath() : aProposedName;
     wxFileName fn;
     bool       doAdd = false;
     bool       isGlobal = ( aTable == &GFootprintTable );
 
     if( aLibName.IsEmpty() )
     {
         fn = initialPath;
 
         if( !LibraryFileBrowser( false, fn, KiCadFootprintLibPathWildcard(),
                                  KiCadFootprintLibPathExtension, false, isGlobal,
                                  PATHS::GetDefaultUserFootprintsPath() ) )
         {
             return wxEmptyString;
         }
 
         doAdd = true;
     }
     else
     {
         fn = aLibName;
 
         if( !fn.IsAbsolute() )
         {
             fn.SetName( aLibName );
             fn.MakeAbsolute( initialPath );
         }
 
         // Enforce the .pretty extension:
         fn.SetExt( KiCadFootprintLibPathExtension );
     }
 
     // We can save fp libs only using IO_MGR::KICAD_SEXP format (.pretty libraries)
     IO_MGR::PCB_FILE_T piType  = IO_MGR::KICAD_SEXP;
     wxString           libPath = fn.GetFullPath();
 
     try
     {
         PLUGIN::RELEASER pi( IO_MGR::PluginFind( piType ) );
 
         bool writable = false;
         bool exists   = false;
 
         try
         {
             writable = pi->IsFootprintLibWritable( libPath );
             exists   = true;    // no exception was thrown, lib must exist.
         }
         catch( const IO_ERROR& )
         {
             // best efforts....
         }
 
         if( exists )
         {
             if( !writable )
             {
                 wxString msg = wxString::Format( _( "Library %s is read only." ), libPath );
                 ShowInfoBarError( msg );
                 return wxEmptyString;
             }
             else
             {
                 wxString msg = wxString::Format( _( "Library %s already exists." ), libPath );
                 KIDIALOG dlg( this, msg, _( "Confirmation" ), wxOK | wxCANCEL | wxICON_WARNING );
                 dlg.SetOKLabel( _( "Overwrite" ) );
                 dlg.DoNotShowCheckbox( __FILE__, __LINE__ );
 
                 if( dlg.ShowModal() == wxID_CANCEL )
                     return wxEmptyString;
 
                 pi->FootprintLibDelete( libPath );
             }
         }
 
         pi->FootprintLibCreate( libPath );
     }
     catch( const IO_ERROR& ioe )
     {
         DisplayError( this, ioe.What() );
         return wxEmptyString;
     }
 
     if( doAdd )
         AddLibrary( libPath, aTable );
 
     return libPath;
 }

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(), EDA_BASE_FRAME::ShowInfoBarError(), KIDIALOG::ShowModal(), and IO_ERROR::What().

Referenced by PCB_BASE_EDIT_FRAME::CreateNewLibrary(), and PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary().

◆ CreateNewProjectLibrary()

wxString PCB_BASE_EDIT_FRAME::CreateNewProjectLibrary	(	const wxString &	aLibName = `wxEmptyString`,
		const wxString &	aProposedName = `wxEmptyString`
	)

inherited

Definition at line 378 of file footprint_libraries_utils.cpp.

 {
     return createNewLibrary( aLibName, aProposedName, Prj().PcbFootprintLibs() );
 }

References PCB_BASE_EDIT_FRAME::createNewLibrary(), and KIWAY_HOLDER::Prj().

Referenced by OpenProjectFiles().

◆ CreateServer()

void KIWAY_PLAYER::CreateServer	(	int	service,
		bool	local = `true`
	)

inherited

Definition at line 43 of file eda_dde.cpp.

 {
     wxIPV4address addr;
 
     // Set the port number
     addr.Service( service );
 
     // Listen on localhost only if requested
     if( local )
         addr.Hostname( HOSTNAME );
 
     delete m_socketServer;
     m_socketServer = new wxSocketServer( addr );
 
     m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
     m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
     m_socketServer->Notify( true );
 }

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

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

◆ CurrentToolName()

std::string TOOLS_HOLDER::CurrentToolName ( ) const

inherited

Definition at line 100 of file tools_holder.cpp.

 {
     if( m_toolStack.empty() )
         return ACTIONS::selectionTool.GetName();
     else
         return m_toolStack.back();
 }

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

Referenced by TOOL_MANAGER::processEvent(), and TOOLS_HOLDER::ShowChangedLanguage().

◆ Destroy()

bool KIWAY_PLAYER::Destroy ( )

overrideinherited

Our version of Destroy() which is virtual from wxWidgets.

Definition at line 154 of file kiway_player.cpp.

 {
     return EDA_BASE_FRAME::Destroy();
 }

◆ DismissModal()

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

inherited

Definition at line 166 of file kiway_player.cpp.

 {
     m_modal_ret_val = aRetVal;
     m_modal_string  = aResult;
 
     if( m_modal_loop )
     {
         m_modal_loop->Exit();
         m_modal_loop = nullptr;      // this marks it as dismissed.
     }
 
     Show( false );
 }

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 535 of file pcb_base_frame.cpp.

 {
     wxString line;
 
     line.Printf( "grid X %s  Y %s",
                  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().x ),
                  MessageTextFromValue( m_userUnits, GetCanvas()->GetGAL()->GetGridSize().y ) );
 
     SetStatusText( line, 4 );
 }

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

 {
     SetStatusText( msg, 6 );
 }

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

 {
     wxString msg;
 
     switch( m_userUnits )
     {
     case EDA_UNITS::INCHES:      msg = _( "inches" ); break;
     case EDA_UNITS::MILS:        msg = _( "mils" );   break;
     case EDA_UNITS::MILLIMETRES: msg = _( "mm" );     break;
     default:                     msg = _( "Units" );  break;
     }
 
     SetStatusText( msg, 5 );
 }

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

 {
     wxFileName tmpFileName;
 
     // Don't run autosave if content has not been modified
     if( !IsContentModified() )
         return true;
 
     wxString title = GetTitle();    // Save frame title, that can be modified by the save process
 
     if( GetBoard()->GetFileName().IsEmpty() )
     {
         tmpFileName = wxFileName( PATHS::GetDefaultUserProjectsPath(), NAMELESS_PROJECT,
                                   KiCadPcbFileExtension );
         GetBoard()->SetFileName( tmpFileName.GetFullPath() );
     }
     else
     {
         tmpFileName = Prj().AbsolutePath( GetBoard()->GetFileName() );
     }
 
     wxFileName autoSaveFileName = tmpFileName;
 
     // Auto save file name is the board file name prepended with autosaveFilePrefix string.
     autoSaveFileName.SetName( GetAutoSaveFilePrefix() + autoSaveFileName.GetName() );
 
     if( !autoSaveFileName.IsOk() )
         return false;
 
     // If the board file path is not writable, try writing to a platform specific temp file
     // path.  If that path isn't writable, give up.
     if( !autoSaveFileName.IsDirWritable() )
     {
         autoSaveFileName.SetPath( wxFileName::GetTempDir() );
 
         if( !autoSaveFileName.IsOk() || !autoSaveFileName.IsDirWritable() )
             return false;
     }
 
     wxLogTrace( traceAutoSave, "Creating auto save file <" + autoSaveFileName.GetFullPath() + ">" );
 
     if( SavePcbFile( autoSaveFileName.GetFullPath(), false, false ) )
     {
         GetScreen()->SetContentModified();
         GetBoard()->SetFileName( tmpFileName.GetFullPath() );
         UpdateTitle();
         m_autoSaveState = false;
 
         if( !Kiface().IsSingle() &&
             GetSettingsManager()->GetCommonSettings()->m_Backup.backup_on_autosave )
         {
             GetSettingsManager()->TriggerBackupIfNeeded( NULL_REPORTER::GetInstance() );
         }
 
         SetTitle( title );      // Restore initial frame title
 
         return true;
     }
 
     GetBoard()->SetFileName( tmpFileName.GetFullPath() );
 
     SetTitle( title );      // Restore initial frame title
 
     return false;
 }

References PROJECT::AbsolutePath(), EDA_BASE_FRAME::GetAutoSaveFilePrefix(), PCB_BASE_FRAME::GetBoard(), PATHS::GetDefaultUserProjectsPath(), NULL_REPORTER::GetInstance(), PCB_BASE_FRAME::GetScreen(), EDA_BASE_FRAME::GetSettingsManager(), IsContentModified(), KiCadPcbFileExtension, Kiface(), EDA_BASE_FRAME::m_autoSaveState, NAMELESS_PROJECT, KIWAY_HOLDER::Prj(), SavePcbFile(), BASE_SCREEN::SetContentModified(), BOARD::SetFileName(), 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 838 of file pcb_edit_frame.cpp.

 {
     // On Windows 7 / 32 bits, on OpenGL mode only, Pcbnew crashes
     // when closing this frame if a footprint was selected, and the footprint editor called
     // to edit this footprint, and when closing pcbnew if this footprint is still selected
     // See https://bugs.launchpad.net/kicad/+bug/1655858
     // I think this is certainly a OpenGL event fired after frame deletion, so this workaround
     // avoid the crash (JPC)
     GetCanvas()->SetEvtHandlerEnabled( false );
 
     GetCanvas()->StopDrawing();
 
     // Delete the auto save file if it exists.
     wxFileName fn = GetBoard()->GetFileName();
 
     // Auto save file name is the normal file name prefixed with 'GetAutoSaveFilePrefix()'.
     fn.SetName( GetAutoSaveFilePrefix() + fn.GetName() );
 
     // When the auto save feature does not have write access to the board file path, it falls
     // back to a platform specific user temporary file path.
     if( !fn.IsOk() || !fn.IsDirWritable() )
         fn.SetPath( wxFileName::GetTempDir() );
 
     wxLogTrace( traceAutoSave, "Deleting auto save file <" + fn.GetFullPath() + ">" );
 
     // Remove the auto save file on a normal close of Pcbnew.
     if( fn.FileExists() && !wxRemoveFile( fn.GetFullPath() ) )
     {
         wxString msg = wxString::Format( _( "The auto save file '%s' could not be removed!" ),
                                          fn.GetFullPath() );
         wxMessageBox( msg, Pgm().App().GetAppName(), wxOK | wxICON_ERROR, this );
     }
 
     // Make sure local settings are persisted
     SaveProjectSettings();
 
     // Do not show the layer manager during closing to avoid flicker
     // on some platforms (Windows) that generate useless redraw of items in
     // the Layer Manager
     if( m_show_layer_manager_tools )
         m_auimgr.GetPane( "LayersManager" ).Show( false );
 
     // Unlink the old project if needed
     GetBoard()->ClearProject();
 
     // Delete board structs and undo/redo lists, to avoid crash on exit
     // when deleting some structs (mainly in undo/redo lists) too late
     Clear_Pcb( false, true );
 
     // do not show the window because ScreenPcb will be deleted and we do not
     // want any paint event
     Show( false );
 
     PCB_BASE_EDIT_FRAME::doCloseWindow();
 }

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,
		bool	aUseAuxOrigin
	)

Create an ASCII footprint position file.

Parameters

aFullFileName	the full file name of the file to create.
aUnitsMM	false to use inches, true to use mm in coordinates.
aForceSmdItems	true to force all footprints with smd pads in list, false to put only footprints with option "INSERT" in list
aTopSide	true to list footprints on front (top) side.
aBottomSide	true to list footprints on back (bottom) side, if aTopSide and aTopSide are true, list footprints on both sides.
aFormatCSV	true to use a comma separated file (CSV) format; default = false

Returns: the number of footprints found on aSide side or -1 if the file could not be created.

Definition at line 478 of file gen_footprints_placefile.cpp.

 {
     FILE * file = nullptr;
 
     if( !aFullFileName.IsEmpty() )
     {
         file = wxFopen( aFullFileName, wxT( "wt" ) );
 
         if( file == nullptr )
             return -1;
     }
 
     std::string data;
     PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, aForceSmdItems, aTopSide, aBottomSide,
                                   aFormatCSV, aUseAuxOrigin );
     data = exporter.GenPositionData();
 
     // if aFullFileName is empty, the file is not created, only the
     // count of footprints to place is returned
     if( file )
     {
         // Creates a footprint position file
         // aSide = 0 -> Back (bottom) side)
         // aSide = 1 -> Front (top) side)
         // aSide = 2 -> both sides
         fputs( data.c_str(), file );
         fclose( file );
     }
 
     return exporter.GetFootprintCount();
 }

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

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

aFullFilename	the full file name of the file to create
aUnitsMM	false to use inches, true to use mm in coordinates

Returns: true if OK, false if error

Definition at line 547 of file gen_footprints_placefile.cpp.

 {
     FILE* rptfile = wxFopen( aFullFilename, wxT( "wt" ) );
 
     if( rptfile == nullptr )
         return false;
 
     std::string data;
     PLACE_FILE_EXPORTER exporter( GetBoard(), aUnitsMM, false, true, true, false, true );
     data = exporter.GenReportData();
 
     fputs( data.c_str(), rptfile );
     fclose( rptfile );
 
     return true;
 }

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

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.

 {
     int               dialogResult;
     ZONE_SETTINGS     zoneInfo = GetZoneSettings();
     PICKED_ITEMS_LIST pickedList;    // zones for undo/redo command
     PICKED_ITEMS_LIST deletedList;   // zones that have been deleted when combined
     BOARD_COMMIT      commit( this );
 
     // Save initial zones configuration, for undo/redo, before adding new zone
     // note the net name and the layer can be changed, so we must save all zones
     deletedList.ClearListAndDeleteItems();
     pickedList.ClearListAndDeleteItems();
     SaveCopyOfZones( pickedList, GetBoard(), -1, UNDEFINED_LAYER );
 
     if( aZone->GetIsRuleArea() )
     {
         // edit a rule area on a copper layer
         zoneInfo << *aZone;
         dialogResult = InvokeRuleAreaEditor( this, &zoneInfo );
     }
     else if( IsCopperLayer( aZone->GetLayer() ) )
     {
         // edit a zone on a copper layer
         zoneInfo << *aZone;
         dialogResult = InvokeCopperZonesEditor( this, &zoneInfo );
     }
     else
     {
         zoneInfo << *aZone;
         dialogResult = InvokeNonCopperZonesEditor( this, &zoneInfo );
     }
 
     if( dialogResult == wxID_CANCEL )
     {
         deletedList.ClearListAndDeleteItems();
         pickedList.ClearListAndDeleteItems();
         return;
     }
 
     SetZoneSettings( zoneInfo );
     OnModify();
 
     if( dialogResult == ZONE_EXPORT_VALUES )
     {
         UpdateCopyOfZonesList( pickedList, deletedList, GetBoard() );
         commit.Stage( pickedList );
         commit.Push( _( "Modify zone properties" ) );
         pickedList.ClearItemsList(); // s_ItemsListPicker is no more owner of picked items
         return;
     }
 
     wxBusyCursor dummy;
 
     // Undraw old zone outlines
     for( ZONE* zone : GetBoard()->Zones() )
         GetCanvas()->GetView()->Update( zone );
 
     zoneInfo.ExportSetting( *aZone );
 
     NETINFO_ITEM* net = GetBoard()->FindNet( zoneInfo.m_NetcodeSelection );
 
     if( net )   // net == NULL should not occur
         aZone->SetNetCode( net->GetNetCode() );
 
     // Combine zones if possible
     GetBoard()->OnAreaPolygonModified( &deletedList, aZone );
 
     UpdateCopyOfZonesList( pickedList, deletedList, GetBoard() );
 
     // refill zones with the new properties applied
     std::vector<ZONE*> zones_to_refill;
 
     for( unsigned i = 0; i < pickedList.GetCount(); ++i )
     {
         ZONE* zone = dyn_cast<ZONE*>( pickedList.GetPickedItem( i ) );
 
         if( zone == nullptr )
         {
             wxASSERT_MSG( false, "Expected a zone after zone properties edit" );
             continue;
         }
 
         // aZone won't be filled if the layer set was modified, but it needs to be updated
         if( zone->IsFilled() || zone == aZone )
             zones_to_refill.push_back( zone );
     }
 
     commit.Stage( pickedList );
 
     // Only auto-refill zones here if in user preferences
     if( Settings().m_AutoRefillZones )
     {
         std::lock_guard<KISPINLOCK> lock( GetBoard()->GetConnectivity()->GetLock() );
 
         if( zones_to_refill.size() )
         {
             ZONE_FILLER filler( GetBoard(), &commit );
             wxString    title = wxString::Format( _( "Refill %d Zones" ),
                                                   (int) zones_to_refill.size() );
             filler.InstallNewProgressReporter( this, title, 4 );
 
             if( !filler.Fill( zones_to_refill ) )
             {
                 // User has already OK'ed dialog so we're going to go ahead and commit even if the
                 // fill was cancelled.
             }
         }
     }
 
     commit.Push( _( "Modify zone properties" ) );
     GetBoard()->GetConnectivity()->RecalculateRatsnest();
 
     pickedList.ClearItemsList();  // s_ItemsListPicker is no longer owner of picked items
 }

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().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )

protectedinherited

Definition at line 638 of file eda_base_frame.cpp.

 {
     wxDisplay display( wxDisplay::GetFromWindow( this ) );
     wxRect    clientSize = display.GetClientArea();
     wxPoint   pos        = GetPosition();
     wxSize    size       = GetWindowSize();
 
     wxLogTrace( traceDisplayLocation,
                 "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d", clientSize.x, clientSize.y,
                 clientSize.width, clientSize.height );
 
     if( pos.y < clientSize.y )
     {
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d", pos.y,
                     clientSize.y );
         pos.y = clientSize.y;
     }
 
     if( pos.x < clientSize.x )
     {
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d", pos.x,
                     clientSize.x );
         pos.x = clientSize.x;
     }
 
     if( pos.x + size.x - clientSize.x > clientSize.width )
     {
         int newWidth = clientSize.width - ( pos.x - clientSize.x );
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d",
                     pos.x + size.x, clientSize.width, newWidth );
         size.x = newWidth;
     }
 
     if( pos.y + size.y - clientSize.y > clientSize.height )
     {
         int newHeight = clientSize.height - ( pos.y - clientSize.y );
         wxLogTrace( traceDisplayLocation,
                     "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d",
                     pos.y + size.y, clientSize.height, newHeight );
         size.y = newHeight;
     }
 
     wxLogTrace( traceDisplayLocation, "Updating window position (%d, %d) with size (%d, %d)",
                 pos.x, pos.y, size.x, size.y );
 
     SetSize( pos.x, pos.y, size.x, size.y );
 }

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )

inherited

Definition at line 283 of file eda_draw_frame.cpp.

 {
     if( m_messagePanel )
         m_messagePanel->EraseMsgBox();
 }

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

aExisting	footprint to replace.
aNew	footprint to put.
aCommit	commit that should store the changes.

Definition at line 485 of file dialog_exchange_footprints.cpp.

 {
     PCB_GROUP* parentGroup = aExisting->GetParentGroup();
 
     if( parentGroup )
     {
         parentGroup->RemoveItem( aExisting );
         parentGroup->AddItem( aNew );
     }
 
     aNew->SetParent( GetBoard() );
 
     PlaceFootprint( aNew, false );
 
     // PlaceFootprint will move the footprint to the cursor position, which we don't want.  Copy
     // the original position across.
     aNew->SetPosition( aExisting->GetPosition() );
 
     if( aNew->GetLayer() != aExisting->GetLayer() )
         aNew->Flip( aNew->GetPosition(), m_settings->m_FlipLeftRight );
 
     if( aNew->GetOrientation() != aExisting->GetOrientation() )
         aNew->SetOrientation( aExisting->GetOrientation() );
 
     aNew->SetLocked( aExisting->IsLocked() );
 
     for( PAD* pad : aNew->Pads() )
     {
         PAD* oldPad = aExisting->FindPadByName( pad->GetName() );
 
         if( oldPad )
         {
             pad->SetLocalRatsnestVisible( oldPad->GetLocalRatsnestVisible() );
             pad->SetPinFunction( oldPad->GetPinFunction() );
             pad->SetLocked( oldPad->IsLocked() );
         }
 
         pad->SetNetCode( oldPad ? oldPad->GetNetCode() : NETINFO_LIST::UNCONNECTED );
     }
 
     // Copy reference
     processTextItem( aExisting->Reference(), aNew->Reference(),
                      // never reset reference text
                      false,
                      resetTextLayers, resetTextEffects );
 
     // Copy value
     processTextItem( aExisting->Value(), aNew->Value(),
                      // reset value text only when it is a proxy for the footprint ID
                      // (cf replacing value "MountingHole-2.5mm" with "MountingHole-4.0mm")
                      aExisting->GetValue() == aExisting->GetFPID().GetLibItemName(),
                      resetTextLayers, resetTextEffects );
 
     // Copy fields in accordance with the reset* flags
     for( BOARD_ITEM* item : aExisting->GraphicalItems() )
     {
         FP_TEXT* srcItem = dyn_cast<FP_TEXT*>( item );
 
         if( srcItem )
         {
             FP_TEXT* destItem = getMatchingTextItem( srcItem, aNew );
 
             if( destItem )
                 processTextItem( *srcItem, *destItem, false, resetTextLayers, resetTextEffects );
             else if( !deleteExtraTexts )
                 aNew->Add( new FP_TEXT( *srcItem ) );
         }
     }
 
     if( !resetFabricationAttrs )
         aNew->SetAttributes( aExisting->GetAttributes() );
 
     // Copy 3D model settings in accordance with the reset* flag
     if( !reset3DModels )
         aNew->Models() = aExisting->Models();  // Linked list of 3D models.
 
     // Updating other parameters
     const_cast<KIID&>( aNew->m_Uuid ) = aExisting->m_Uuid;
     aNew->SetProperties( aExisting->GetProperties() );
     aNew->SetPath( aExisting->GetPath() );
 
     aCommit.Remove( aExisting );
     aCommit.Add( aNew );
 
     aNew->ClearFlags();
 }

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::replaceFootprint(), and FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard().

◆ ExecuteRemoteCommand()

void PCB_EDIT_FRAME::ExecuteRemoteCommand ( const char * cmdline )

overridevirtual

Execute a remote command send by Eeschema via a socket, port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242).

This is a virtual function called by EDA_DRAW_FRAME::OnSockRequest().

Parameters

cmdline is the received command from socket.

Reimplemented from KIWAY_PLAYER.

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

 {
     char        line[1024];
     wxString    msg;
     wxString    modName;
     char*       idcmd;
     char*       text;
     int         netcode = -1;
     bool        multiHighlight = false;
     FOOTPRINT*  footprint = nullptr;
     PAD*        pad = nullptr;
     BOARD*      pcb = GetBoard();
 
     CROSS_PROBING_SETTINGS& crossProbingSettings = GetPcbNewSettings()->m_CrossProbing;
 
     KIGFX::VIEW*            view = m_toolManager->GetView();
     KIGFX::RENDER_SETTINGS* renderSettings = view->GetPainter()->GetSettings();
 
     strncpy( line, cmdline, sizeof(line) - 1 );
     line[sizeof(line) - 1] = 0;
 
     idcmd = strtok( line, " \n\r" );
     text  = strtok( nullptr, "\"\n\r" );
 
     if( idcmd == nullptr )
         return;
 
     if( strcmp( idcmd, "$NET:" ) == 0 )
     {
         if( !crossProbingSettings.auto_highlight )
             return;
 
         wxString net_name = FROM_UTF8( text );
 
         NETINFO_ITEM* netinfo = pcb->FindNet( net_name );
 
         if( netinfo )
         {
             netcode = netinfo->GetNetCode();
 
             MSG_PANEL_ITEMS items;
             netinfo->GetMsgPanelInfo( this, items );
             SetMsgPanel( items );
         }
     }
 
     if( strcmp( idcmd, "$NETS:" ) == 0 )
     {
         if( !crossProbingSettings.auto_highlight )
             return;
 
         wxStringTokenizer netsTok = wxStringTokenizer( FROM_UTF8( text ), "," );
         bool first = true;
 
         while( netsTok.HasMoreTokens() )
         {
             NETINFO_ITEM* netinfo = pcb->FindNet( netsTok.GetNextToken() );
 
             if( netinfo )
             {
                 if( first )
                 {
                     // TODO: Once buses are included in netlist, show bus name
                     MSG_PANEL_ITEMS items;
                     netinfo->GetMsgPanelInfo( this, items );
                     SetMsgPanel( items );
                     first = false;
 
                     pcb->SetHighLightNet( netinfo->GetNetCode() );
                     renderSettings->SetHighlight( true, netinfo->GetNetCode() );
                     multiHighlight = true;
                 }
                 else
                 {
                     pcb->SetHighLightNet( netinfo->GetNetCode(), true );
                     renderSettings->SetHighlight( true, netinfo->GetNetCode(), true );
                 }
             }
         }
 
         netcode = -1;
     }
     else if( strcmp( idcmd, "$PIN:" ) == 0 )
     {
         wxString pinName = FROM_UTF8( text );
 
         text = strtok( nullptr, " \n\r" );
 
         if( text && strcmp( text, "$PART:" ) == 0 )
             text = strtok( nullptr, "\"\n\r" );
 
         modName = FROM_UTF8( text );
 
         footprint = pcb->FindFootprintByReference( modName );
 
         if( footprint )
             pad = footprint->FindPadByName( pinName );
 
         if( pad )
             netcode = pad->GetNetCode();
 
         if( footprint == nullptr )
             msg.Printf( _( "%s not found" ), modName );
         else if( pad == nullptr )
             msg.Printf( _( "%s pin %s not found" ), modName, pinName );
         else
             msg.Printf( _( "%s pin %s found" ), modName, pinName );
 
         SetStatusText( msg );
     }
     else if( strcmp( idcmd, "$PART:" ) == 0 )
     {
         pcb->ResetNetHighLight();
 
         modName = FROM_UTF8( text );
 
         footprint = pcb->FindFootprintByReference( modName );
 
         if( footprint )
             msg.Printf( _( "%s found" ), modName );
         else
             msg.Printf( _( "%s not found" ), modName );
 
         SetStatusText( msg );
     }
     else if( strcmp( idcmd, "$SHEET:" ) == 0 )
     {
         msg.Printf( _( "Selecting all from sheet \"%s\"" ), FROM_UTF8( text ) );
         wxString sheetUIID( FROM_UTF8( text ) );
         SetStatusText( msg );
         GetToolManager()->RunAction( PCB_ACTIONS::selectOnSheetFromEeschema, true,
                                      static_cast<void*>( &sheetUIID ) );
         return;
     }
     else if( strcmp( idcmd, "$CLEAR" ) == 0 )
     {
         if( renderSettings->IsHighlightEnabled() )
         {
             renderSettings->SetHighlight( false );
             view->UpdateAllLayersColor();
         }
 
         if( pcb->IsHighLightNetON() )
         {
             pcb->ResetNetHighLight();
             SetMsgPanel( pcb );
         }
 
         GetCanvas()->Refresh();
         return;
     }
 
     BOX2I bbox = { { 0, 0 }, { 0, 0 } };
 
     if( footprint )
     {
         bbox = footprint->GetBoundingBox( true, false ); // No invisible text in bbox calc
 
         if( pad )
             m_toolManager->RunAction( PCB_ACTIONS::highlightItem, true, (void*) pad );
         else
             m_toolManager->RunAction( PCB_ACTIONS::highlightItem, true, (void*) footprint );
     }
     else if( netcode > 0 || multiHighlight )
     {
         if( !multiHighlight )
         {
             renderSettings->SetHighlight( ( netcode >= 0 ), netcode );
             pcb->SetHighLightNet( netcode );
         }
         else
         {
             // Just pick the first one for area calculation
             netcode = *pcb->GetHighLightNetCodes().begin();
         }
 
         pcb->HighLightON();
 
         auto merge_area =
             [netcode, &bbox]( BOARD_CONNECTED_ITEM* aItem )
             {
             if( aItem->GetNetCode() == netcode )
             {
                 if( bbox.GetWidth() == 0 )
                     bbox = aItem->GetBoundingBox();
                 else
                     bbox.Merge( aItem->GetBoundingBox() );
             }
         };
 
         if( crossProbingSettings.center_on_items )
         {
             for( ZONE* zone : pcb->Zones() )
                 merge_area( zone );
 
             for( PCB_TRACK* track : pcb->Tracks() )
                 merge_area( track );
 
             for( FOOTPRINT* fp : pcb->Footprints() )
             {
                 for( PAD* p : fp->Pads() )
                     merge_area( p );
             }
         }
     }
     else
     {
         renderSettings->SetHighlight( false );
     }
 
     if( crossProbingSettings.center_on_items && bbox.GetWidth() > 0 && bbox.GetHeight() > 0 )
     {
         if( crossProbingSettings.zoom_to_fit )
         {
 //#define DEFAULT_PCBNEW_CODE // Un-comment for normal full zoom KiCad algorithm
  #ifdef DEFAULT_PCBNEW_CODE
             auto bbSize     = bbox.Inflate( bbox.GetWidth() * 0.2f ).GetSize();
             auto screenSize = view->ToWorld( GetCanvas()->GetClientSize(), false );
 
             // The "fabs" on x ensures the right answer when the view is flipped
             screenSize.x = std::max( 10.0, fabs( screenSize.x ) );
             screenSize.y = std::max( 10.0, screenSize.y );
             double ratio = std::max( fabs( bbSize.x / screenSize.x ),
                                      fabs( bbSize.y / screenSize.y ) );
 
             // Try not to zoom on every cross-probe; it gets very noisy
             if( crossProbingSettings.zoom_to_fit && ( ratio < 0.5 || ratio > 1.0 ) )
                 view->SetScale( view->GetScale() / ratio );
  #endif // DEFAULT_PCBNEW_CODE
 
 #ifndef DEFAULT_PCBNEW_CODE  // Do the scaled zoom
             auto bbSize     = bbox.Inflate( bbox.GetWidth() * 0.2f ).GetSize();
             auto screenSize = view->ToWorld( GetCanvas()->GetClientSize(), false );
 
             // This code tries to come up with a zoom factor that doesn't simply zoom in
             // to the cross probed component, but instead shows a reasonable amount of the
             // circuit around it to provide context.  This reduces or eliminates the need
             // to manually change the zoom because it's too close.
 
             // Using the default text height as a constant to compare against, use the
             // height of the bounding box of visible items for a footprint to figure out
             // if this is a big footprint (like a processor) or a small footprint (like a resistor).
             // This ratio is not useful by itself as a scaling factor.  It must be "bent" to
             // provide good scaling at varying component sizes.  Bigger components need less
             // scaling than small ones.
             double currTextHeight = Millimeter2iu( DEFAULT_TEXT_SIZE );
 
             double compRatio     = bbSize.y / currTextHeight; // Ratio of component to text height
 
             // This will end up as the scaling factor we apply to "ratio".
             double compRatioBent = 1.0;
 
             // This is similar to the original KiCad code that scaled the zoom to make sure
             // components were visible on screen.  It's simply a ratio of screen size to
             // component size, and its job is to zoom in to make the component fullscreen.
             // Earlier in the code the component BBox is given a 20% margin to add some
             // breathing room. We compare the height of this enlarged component bbox to the
             // default text height.  If a component will end up with the sides clipped, we
             // adjust later to make sure it fits on screen.
             //
             // The "fabs" on x ensures the right answer when the view is flipped
             screenSize.x = std::max( 10.0, fabs( screenSize.x ) );
             screenSize.y = std::max( 10.0, screenSize.y );
             double ratio = std::max( -1.0, fabs( bbSize.y / screenSize.y ) );
 
             // Original KiCad code for how much to scale the zoom
             double kicadRatio = std::max( fabs( bbSize.x / screenSize.x ),
                                           fabs( bbSize.y / screenSize.y ) );
 
             // LUT to scale zoom ratio to provide reasonable schematic context.  Must work
             // with footprints of varying sizes (e.g. 0402 package and 200 pin BGA).
             // "first" is used as the input and "second" as the output
             //
             // "first" = compRatio (footprint height / default text height)
             // "second" = Amount to scale ratio by
             std::vector<std::pair<double, double>> lut{
                 { 1, 8 },
                 { 1.5, 5 },
                 { 3, 3 },
                 { 4.5, 2.5 },
                 { 8, 2.0 },
                 { 12, 1.7 },
                 { 16, 1.5 },
                 { 24, 1.3 },
                 { 32, 1.0 },
             };
 
 
             std::vector<std::pair<double, double>>::iterator it;
 
             compRatioBent = lut.back().second; // Large component default
 
             if( compRatio >= lut.front().first )
             {
                 // Use LUT to do linear interpolation of "compRatio" within "first", then
                 // use that result to linearly interpolate "second" which gives the scaling
                 // factor needed.
 
                 for( it = lut.begin(); it < lut.end() - 1; it++ )
                 {
                     if( it->first <= compRatio && next( it )->first >= compRatio )
                     {
                         double diffx = compRatio - it->first;
                         double diffn = next( it )->first - it->first;
 
                         compRatioBent =
                                 it->second + ( next( it )->second - it->second ) * diffx / diffn;
                         break; // We have our interpolated value
                     }
                 }
             }
             else
             {
                 compRatioBent = lut.front().second; // Small component default
             }
 
             // If the width of the part we're probing is bigger than what the screen width will be
             // after the zoom, then punt and use the KiCad zoom algorithm since it guarantees the
             // part's width will be encompassed within the screen.  This will apply to parts that
             // are much wider than they are tall.
 
             if( bbSize.x > screenSize.x * ratio * compRatioBent )
             {
                 // Use standard KiCad zoom algorithm for parts too wide to fit screen/
                 ratio = kicadRatio;
                 compRatioBent = 1.0; // Reset so we don't modify the "KiCad" ratio
                 wxLogTrace( "CROSS_PROBE_SCALE",
                             "Part TOO WIDE for screen.  Using normal KiCad zoom ratio: %1.5f",
                             ratio );
             }
 
             // Now that "compRatioBent" holds our final scaling factor we apply it to the original
             // fullscreen zoom ratio to arrive at the final ratio itself.
             ratio *= compRatioBent;
 
             bool alwaysZoom = false; // DEBUG - allows us to minimize zooming or not
 
             // Try not to zoom on every cross-probe; it gets very noisy
             if( ( ratio < 0.5 || ratio > 1.0 ) || alwaysZoom )
                 view->SetScale( view->GetScale() / ratio );
 #endif // ifndef DEFAULT_PCBNEW_CODE
         }
 
         view->SetCenter( bbox.Centre() );
     }
 
     view->UpdateAllLayersColor();
 
     // Ensure the display is refreshed, because in some installs the refresh is done only
     // when the gal canvas has the focus, and that is not the case when crossprobing from
     // Eeschema:
     GetCanvas()->Refresh();
 }

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(), 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.

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

Parameters

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

Returns: true if OK.

Definition at line 591 of file export_idf.cpp.

 {
     IDF3_BOARD idfBoard( IDF3::CAD_ELEC );
 
     // Switch the locale to standard C (needed to print floating point numbers)
     LOCALE_IO toggle;
 
     resolver = Prj().Get3DCacheManager()->GetResolver();
 
     bool ok = true;
     double scale = MM_PER_IU;   // we must scale internal units to mm for IDF
     IDF3::IDF_UNIT idfUnit;
 
     if( aUseThou )
     {
         idfUnit = IDF3::UNIT_THOU;
         idfBoard.SetUserPrecision( 1 );
     }
     else
     {
         idfUnit = IDF3::UNIT_MM;
         idfBoard.SetUserPrecision( 5 );
     }
 
     wxFileName brdName = aPcb->GetFileName();
 
     idfBoard.SetUserScale( scale );
     idfBoard.SetBoardThickness( aPcb->GetDesignSettings().GetBoardThickness() * scale );
     idfBoard.SetBoardName( TO_UTF8( brdName.GetFullName() ) );
     idfBoard.SetBoardVersion( 0 );
     idfBoard.SetLibraryVersion( 0 );
 
     std::ostringstream ostr;
     ostr << "KiCad " << TO_UTF8( GetBuildVersion() );
     idfBoard.SetIDFSource( ostr.str() );
 
     try
     {
         // set up the board reference point
         idfBoard.SetUserOffset( -aXRef, aYRef );
 
         // Export the board outline
         idf_export_outline( aPcb, idfBoard );
 
         // Output the drill holes and footprint (library) data.
         for( FOOTPRINT* footprint : aPcb->Footprints() )
             idf_export_footprint( aPcb, footprint, idfBoard );
 
         if( !idfBoard.WriteFile( aFullFileName, idfUnit, false ) )
         {
             wxString msg;
             msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( idfBoard.GetError().c_str() );
             wxMessageBox( msg );
 
             ok = false;
         }
     }
     catch( const IO_ERROR& ioe )
     {
         wxString msg;
         msg << _( "IDF Export Failed:\n" ) << ioe.What();
         wxMessageBox( msg );
 
         ok = false;
     }
     catch( const std::exception& e )
     {
         wxString msg;
         msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( e.what() );
         wxMessageBox( msg );
         ok = false;
     }
 
     return ok;
 }

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 = `nullptr`
	)

Save footprints in a library:

Parameters

aStoreInNewLib	true 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.
aLibName	optional library name to create, stops dialog call. Must be called with aStoreInNewLib as true.

Definition at line 662 of file footprint_libraries_utils.cpp.

 {
     if( GetBoard()->GetFirstFootprint() == nullptr )
     {
         DisplayInfoMessage( this, _( "No footprints to export!" ) );
         return;
     }
 
     wxString footprintName;
 
     auto resetReference =
             []( FOOTPRINT* aFootprint )
             {
                 aFootprint->SetReference( "REF**" );
             };
 
     if( !aStoreInNewLib )
     {
         // The footprints are saved in an existing .pretty library in the fp lib table
         PROJECT& prj = Prj();
         wxString last_nickname = prj.GetRString( PROJECT::PCB_LIB_NICKNAME );
         wxString nickname = SelectLibrary( last_nickname );
 
         if( !nickname )     // Aborted
             return;
 
         prj.SetRString( PROJECT::PCB_LIB_NICKNAME, nickname );
 
         for( FOOTPRINT* footprint : GetBoard()->Footprints() )
         {
             try
             {
                 FP_LIB_TABLE* tbl = prj.PcbFootprintLibs();
 
                 if( !footprint->GetFPID().GetLibItemName().empty() )    // Handle old boards.
                 {
                     FOOTPRINT* fpCopy = static_cast<FOOTPRINT*>( footprint->Duplicate() );
 
                     resetReference( fpCopy );
                     tbl->FootprintSave( nickname, fpCopy, true );
 
                     delete fpCopy;
                 }
             }
             catch( const IO_ERROR& ioe )
             {
                 DisplayError( this, ioe.What() );
             }
         }
     }
     else
     {
         // The footprints are saved in a new .pretty library.
         // If this library already exists, all previous footprints will be deleted
         wxString libPath = CreateNewLibrary( aLibName );
 
         if( libPath.IsEmpty() )     // Aborted
             return;
 
         if( aLibPath )
             *aLibPath = libPath;
 
         IO_MGR::PCB_FILE_T piType = IO_MGR::KICAD_SEXP;
         PLUGIN::RELEASER   pi( IO_MGR::PluginFind( piType ) );
 
         for( FOOTPRINT* footprint : GetBoard()->Footprints() )
         {
             try
             {
                 if( !footprint->GetFPID().GetLibItemName().empty() )    // Handle old boards.
                 {
                     FOOTPRINT* fpCopy = static_cast<FOOTPRINT*>( footprint->Duplicate() );
 
                     resetReference( fpCopy );
                     pi->FootprintSave( libPath, fpCopy );
 
                     delete fpCopy;
                 }
             }
             catch( const IO_ERROR& ioe )
             {
                 DisplayError( this, ioe.What() );
             }
         }
     }
 }

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

 {
     SPECCTRA_DB     db;
     bool            ok = true;
     wxString        errorText;
 
     BASE_SCREEN*    screen = GetScreen();
     bool            wasModified = screen->IsContentModified();
 
     db.SetPCB( SPECCTRA_DB::MakePCB() );
 
     LOCALE_IO       toggle;     // Switch the locale to standard C
 
     // Build the board outlines *before* flipping footprints
     if( !db.BuiltBoardOutlines( GetBoard() ) )
     {
         wxLogWarning( _( "Board outline is malformed. Run DRC for a full analysis." ) );
     }
 
     // DSN Images (=KiCad FOOTPRINTs and PADs) must be presented from the top view.  So we
     // temporarily flip any footprints which are on the back side of the board to the front,
     // and record this in the FOOTPRINT's flag field.
     db.FlipFOOTPRINTs( GetBoard() );
 
     try
     {
         GetBoard()->SynchronizeNetsAndNetClasses();
         db.FromBOARD( GetBoard() );
         db.ExportPCB( aFullFilename, true );
 
         // if an exception is thrown by FromBOARD or ExportPCB(), then
         // ~SPECCTRA_DB() will close the file.
     }
     catch( const IO_ERROR& ioe )
     {
         ok = false;
 
         // copy the error string to safe place, ioe is in this scope only.
         errorText = ioe.What();
     }
 
     // done assuredly, even if an exception was thrown and caught.
     db.RevertFOOTPRINTs( GetBoard() );
 
     // The two calls below to FOOTPRINT::Flip(), both set the
     // modified flag, yet their actions cancel each other out, so it should
     // be ok to clear the modify flag.
     if( !wasModified )
         screen->SetContentModified( false );
 
     if( ok )
     {
         SetStatusText( wxString( _( "BOARD exported OK." ) ) );
     }
     else
     {
         DisplayErrorMessage( this,
                              _( "Unable to export, please fix and try again" ),
                              errorText );
     }
 
     return ok;
 }

References _, DSN::SPECCTRA_DB::BuiltBoardOutlines(), DisplayErrorMessage(), DSN::SPECCTRA_DB::ExportPCB(), DSN::SPECCTRA_DB::FlipFOOTPRINTs(), DSN::SPECCTRA_DB::FromBOARD(), GetBoard(), BASE_SCREEN::IsContentModified(), DSN::SPECCTRA_DB::MakePCB(), DSN::SPECCTRA_DB::RevertFOOTPRINTs(), BASE_SCREEN::SetContentModified(), 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 1220 of file pcb_edit_frame.cpp.

 {
     InvokeExportSVG( this, GetBoard() );
 }

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 230 of file export_gencad.cpp.

 {
     // Build default output file name
     wxString path = GetLastPath( LAST_PATH_GENCAD );
 
     if( path.IsEmpty() )
     {
         wxFileName brdFile = GetBoard()->GetFileName();
         brdFile.SetExt( "cad" );
         path = brdFile.GetFullPath();
     }
 
     DIALOG_GENCAD_EXPORT_OPTIONS optionsDialog( this, path );
 
     if( optionsDialog.ShowModal() == wxID_CANCEL )
         return;
 
     path = optionsDialog.GetFileName();
     SetLastPath( LAST_PATH_GENCAD, path );
     FILE* file = wxFopen( path, "wt" );
 
     if( !file )
     {
         DisplayError( this, wxString::Format( _( "Failed to create file '%s'." ),
                                               optionsDialog.GetFileName() ) );
         return;
     }
 
     // Get options
     flipBottomPads = optionsDialog.GetOption( FLIP_BOTTOM_PADS );
     uniquePins = optionsDialog.GetOption( UNIQUE_PIN_NAMES );
     individualShapes = optionsDialog.GetOption( INDIVIDUAL_SHAPES );
     storeOriginCoords = optionsDialog.GetOption( STORE_ORIGIN_COORDS );
 
     // Switch the locale to standard C (needed to print floating point numbers)
     LOCALE_IO toggle;
 
     // Update some board data, to ensure a reliable gencad export
     GetBoard()->ComputeBoundingBox();
 
     // Save the auxiliary origin for the rest of the footprint
     wxPoint auxOrigin = m_pcb->GetDesignSettings().m_AuxOrigin;
     GencadOffsetX = optionsDialog.GetOption( USE_AUX_ORIGIN ) ? auxOrigin.x : 0;
     GencadOffsetY = optionsDialog.GetOption( USE_AUX_ORIGIN ) ? auxOrigin.y : 0;
 
     // No idea on *why* this should be needed... maybe to fix net names?
     Compile_Ratsnest( true );
 
     /* Temporary modification of footprints that are flipped (i.e. on bottom
      * layer) to convert them to non flipped footprints.
      *  This is necessary to easily export shapes to GenCAD,
      *  that are given as normal orientation (non flipped, rotation = 0))
      * these changes will be undone later
      */
     BOARD*  pcb = GetBoard();
 
     for( FOOTPRINT* footprint : pcb->Footprints() )
     {
         footprint->SetFlag( 0 );
 
         if( footprint->GetLayer() == B_Cu )
         {
             footprint->Flip( footprint->GetPosition(), false );
             footprint->SetFlag( 1 );
         }
     }
 
     /* Gencad has some mandatory and some optional sections: some importer
      *  need the padstack section (which is optional) anyway. Also the
      *  order of the section *is* important */
 
     CreateHeaderInfoData( file, this );     // Gencad header
     CreateBoardSection( file, pcb );        // Board perimeter
 
     CreatePadsShapesSection( file, pcb );   // Pads and padstacks
     CreateArtworksSection( file );          // Empty but mandatory
 
     /* Gencad splits a component info in shape, component and device.
      *  We don't do any sharing (it would be difficult since each module is
      *  customizable after placement) */
     CreateShapesSection( file, pcb );
     CreateComponentsSection( file, pcb );
     CreateDevicesSection( file, pcb );
 
     // In a similar way the netlist is split in net, track and route
     CreateSignalsSection( file, pcb );
     CreateTracksInfoData( file, pcb );
     CreateRoutesSection( file, pcb );
 
     fclose( file );
 
     // Undo the footprints modifications (flipped footprints)
     for( FOOTPRINT* footprint : pcb->Footprints() )
     {
         if( footprint->GetFlag() )
         {
             footprint->Flip( footprint->GetPosition(), false );
             footprint->SetFlag( 0 );
         }
     }
 
     componentShapes.clear();
     shapeNames.clear();
 }

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, PCB_BASE_FRAME::m_pcb, path, SetLastPath(), 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

aFullFileName	the full filename of the file to create
aMMtoWRMLunit	the VRML scaling factor: 1.0 to export in mm. 0.001 for meters
aExport3DFiles	true to copy 3D shapes in the subir a3D_Subdir
aUseRelativePaths	set to true to use relative paths instead of absolute paths in the board VRML file URLs.
a3D_Subdir	sub directory where 3D shapes files are copied. This is only used when aExport3DFiles == true.
aXRef	X value of PCB (0,0) reference point.
aYRef	Y value of PCB (0,0) reference point.

Returns: true if Ok.

Definition at line 956 of file export_vrml.cpp.

 {
     BOARD*          pcb = GetBoard();
     bool            success  = true;
 
     EXPORTER_PCB_VRML model3d;
     model_vrml = &model3d;
     model3d.m_Pcb = GetBoard();
     model3d.SetScale( aMMtoWRMLunit );
     model3d.m_UseInlineModelsInBrdfile = aExport3DFiles;
     model3d.m_Subdir3DFpModels = a3D_Subdir;
     model3d.m_UseRelPathIn3DModelFilename = aUseRelativePaths;
     model3d.m_Cache3Dmodels = Prj().Get3DCacheManager();
 
     if( model3d.m_UseInlineModelsInBrdfile )
     {
         model3d.m_BoardToVrmlScale = MM_PER_IU / 2.54;
         model3d.SetOffset( -aXRef / 2.54, aYRef / 2.54 );
     }
     else
     {
         model3d.m_BoardToVrmlScale = MM_PER_IU;
         model3d.SetOffset( -aXRef, aYRef );
     }
 
     try
     {
         // Preliminary computation: the z value for each layer
         model3d.ComputeLayer3D_Zpos();
 
         // board edges and cutouts
         model3d.ExportVrmlBoard();
 
         // Draw solder mask layer (negative layer)
         model3d.ExportVrmlSolderMask();
 #if 1
         model3d.ExportVrmlViaHoles();
         model3d.ExportStandardLayers();
 #else
         // Drawing and text on the board
         model3d.ExportVrmlDrawings();
 
         // Export vias and trackage
         model3d.ExportVrmlTracks();
 
         // Export zone fills
         model3d.ExportVrmlZones();
 #endif
         if( model3d.m_UseInlineModelsInBrdfile )
         {
             // Copy fp 3D models in a folder, and link these files in
             // the board .vrml file
             model3d.ExportFp3DModelsAsLinkedFile( aFullFileName );
         }
         else
         {
             // merge footprints in the .vrml board file
             for( FOOTPRINT* footprint : pcb->Footprints() )
                 model3d.ExportVrmlFootprint( footprint, nullptr );
 
             // write out the board and all layers
             model3d.writeLayers( TO_UTF8( aFullFileName ), nullptr );
         }
     }
     catch( const std::exception& e )
     {
         wxString msg;
         msg << _( "IDF Export Failed:\n" ) << FROM_UTF8( e.what() );
         wxMessageBox( msg );
 
         success = false;
     }
 
     return success;
 }

Referenced by ExportVRML(), and OnExportVRML().

◆ FetchNetlistFromSchematic()

bool PCB_EDIT_FRAME::FetchNetlistFromSchematic	(	NETLIST &	aNetlist,
		const wxString &	aAnnotateMessage
	)

Parameters

aNetlist	a NETLIST owned by the caller. This function fills it in.
aAnnotateMessage	a 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 1390 of file pcb_edit_frame.cpp.

 {
     if( !TestStandalone() )
     {
         DisplayErrorMessage( this, _( "Cannot update the PCB because PCB editor is opened in "
                                       "stand-alone mode. In order to create or update PCBs from "
                                       "schematics, you must launch the KiCad project manager and "
                                       "create a project." ) );
         return false;       // Not in standalone mode
     }
 
     Raise();                // Show
 
     std::string payload( aAnnotateMessage );
 
     Kiway().ExpressMail( FRAME_SCH, MAIL_SCH_GET_NETLIST, payload, this );
 
     if( payload == aAnnotateMessage )
     {
         Raise();
         DisplayErrorMessage( this, aAnnotateMessage );
         return false;
     }
 
     try
     {
         auto lineReader = new STRING_LINE_READER( payload, _( "Eeschema netlist" ) );
         KICAD_NETLIST_READER netlistReader( lineReader, &aNetlist );
         netlistReader.LoadNetlist();
     }
     catch( const IO_ERROR& )
     {
         Raise();
         assert( false ); // should never happen
         return false;
     }
 
     return true;
 }

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

event is the command event handler.

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

 {
     int        id = event.GetId();
     Files_io_from_id( id );
 }

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

aId	is an event ID coming from file command events:

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

 {
     wxString   msg;
 
     switch( id )
     {
     case ID_LOAD_FILE:
     {
         int         open_ctl = 0;
         wxString    fileName = Prj().AbsolutePath( GetBoard()->GetFileName() );
 
         return AskLoadBoardFileName( this, &open_ctl, &fileName, true )
                    && OpenProjectFiles( std::vector<wxString>( 1, fileName ), open_ctl );
     }
 
     case ID_IMPORT_NON_KICAD_BOARD:
     {
         int         open_ctl = 1;
         wxString    fileName; // = Prj().AbsolutePath( GetBoard()->GetFileName() );
 
         return AskLoadBoardFileName( this, &open_ctl, &fileName, false )
                    && OpenProjectFiles( std::vector<wxString>( 1, fileName ), open_ctl );
     }
 
     case ID_MENU_RECOVER_BOARD_AUTOSAVE:
     {
         wxFileName currfn = Prj().AbsolutePath( GetBoard()->GetFileName() );
         wxFileName fn = currfn;
 
         wxString rec_name = GetAutoSaveFilePrefix() + fn.GetName();
         fn.SetName( rec_name );
 
         if( !fn.FileExists() )
         {
             msg.Printf( _( "Recovery file '%s' not found." ), fn.GetFullPath() );
             DisplayInfoMessage( this, msg );
             return false;
         }
 
         msg.Printf( _( "OK to load recovery file '%s'?" ), fn.GetFullPath() );
 
         if( !IsOK( this, msg ) )
             return false;
 
         GetScreen()->SetContentModified( false );    // do not prompt the user for changes
 
         if( OpenProjectFiles( std::vector<wxString>( 1, fn.GetFullPath() ) ) )
         {
             // Re-set the name since name or extension was changed
             GetBoard()->SetFileName( currfn.GetFullPath() );
             UpdateTitle();
             return true;
         }
 
         return false;
     }
 
     case ID_NEW_BOARD:
     {
         if( IsContentModified() )
         {
             wxFileName fileName = GetBoard()->GetFileName();
             wxString   saveMsg = _( "Current board will be closed, save changes to '%s' before "
                                     "continuing?" );
 
             if( !HandleUnsavedChanges( this, wxString::Format( saveMsg, fileName.GetFullName() ),
                                        [&]()->bool
                                        {
                                            return Files_io_from_id( ID_SAVE_BOARD );
                                        } ) )
             {
                 return false;
             }
         }
         else if( !GetBoard()->IsEmpty() )
         {
             if( !IsOK( this, _( "Current Board will be closed. Continue?" ) ) )
                 return false;
         }
 
         SaveProjectSettings();
 
         GetBoard()->ClearProject();
 
         SETTINGS_MANAGER* mgr = GetSettingsManager();
 
         mgr->SaveProject( mgr->Prj().GetProjectFullName() );
         mgr->UnloadProject( &mgr->Prj() );
 
         if( !Clear_Pcb( false ) )
             return false;
 
         LoadProjectSettings();
 
         onBoardLoaded();
 
         OnModify();
         return true;
     }
 
     case ID_SAVE_BOARD:
         if( !GetBoard()->GetFileName().IsEmpty() )
             return SavePcbFile( Prj().AbsolutePath( GetBoard()->GetFileName() ) );
 
         KI_FALLTHROUGH;
 
     case ID_COPY_BOARD_AS:
     case ID_SAVE_BOARD_AS:
     {
         bool     addToHistory = ( id == ID_SAVE_BOARD_AS );
         wxString orig_name;
 
         wxFileName::SplitPath( GetBoard()->GetFileName(), nullptr, nullptr, &orig_name, nullptr );
 
         if( orig_name.IsEmpty() )
             orig_name = NAMELESS_PROJECT;
 
         wxFileName savePath( Prj().GetProjectFullName() );
 
         if( !savePath.IsOk() || !savePath.IsDirWritable() )
         {
             savePath = GetMruPath();
 
             if( !savePath.IsOk() || !savePath.IsDirWritable() )
                 savePath = PATHS::GetDefaultUserProjectsPath();
         }
 
         wxFileName  fn( savePath.GetPath(), orig_name, KiCadPcbFileExtension );
         wxString    filename = fn.GetFullPath();
         bool        createProject = false;
 
         if( AskSaveBoardFileName( this, &filename, &createProject ) )
         {
             if( id == ID_COPY_BOARD_AS )
                 return SavePcbCopy( filename, createProject );
             else
                 return SavePcbFile( filename, addToHistory, createProject );
         }
 
         return false;
     }
 
     default:
         return false;
     }
 }

References _, PROJECT::AbsolutePath(), AskLoadBoardFileName(), AskSaveBoardFileName(), Clear_Pcb(), BOARD::ClearProject(), 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(), NAMELESS_PROJECT, onBoardLoaded(), OnModify(), OpenProjectFiles(), KIWAY_HOLDER::Prj(), SETTINGS_MANAGER::Prj(), SavePcbCopy(), SavePcbFile(), SETTINGS_MANAGER::SaveProject(), SaveProjectSettings(), BASE_SCREEN::SetContentModified(), 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().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )

inherited

Definition at line 834 of file eda_base_frame.cpp.

 {
 #if defined( __WXOSX_MAC__ )
     m_auimgr.Update();
 #else
     // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
     // hiding it.
     m_auimgr.Update();
 
     // We don't want the infobar displayed right away
     m_auimgr.GetPane( "InfoBar" ).Hide();
     m_auimgr.Update();
 #endif
 }

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 204 of file pcb_base_frame.cpp.

 {
     static KIID lastBrightenedItemID( niluuid );
 
     BOARD_ITEM* lastItem = nullptr;
 
 #if BOOST_VERSION >= 106700
     try
     {
         lastItem = GetBoard()->GetItem( lastBrightenedItemID );
     }
     catch( const boost::uuids::entropy_error& )
     {
         wxLogError( "A Boost UUID entropy exception was thrown in %s:%s.", __FILE__, __FUNCTION__ );
     }
 #else
     lastItem = GetBoard()->GetItem( lastBrightenedItemID );
 #endif
 
     if( lastItem && lastItem != aItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
     {
         lastItem->ClearBrightened();
 
         if( lastItem->Type() == PCB_FOOTPRINT_T )
         {
             static_cast<FOOTPRINT*>( lastItem )->RunOnChildren(
                     [&]( BOARD_ITEM* child )
                     {
                         child->ClearBrightened();
                     } );
         }
         else if( lastItem->Type() == PCB_GROUP_T )
         {
             static_cast<PCB_GROUP*>( lastItem )->RunOnChildren(
                     [&]( BOARD_ITEM* child )
                     {
                         child->ClearBrightened();
                     } );
         }
 
         GetCanvas()->GetView()->Update( lastItem );
         lastBrightenedItemID = niluuid;
         GetCanvas()->Refresh();
     }
 
     if( aItem && aItem != DELETED_BOARD_ITEM::GetInstance() )
     {
         aItem->SetBrightened();
 
         if( aItem->Type() == PCB_FOOTPRINT_T )
         {
             static_cast<FOOTPRINT*>( aItem )->RunOnChildren(
                     [&]( BOARD_ITEM* child )
                     {
                         child->SetBrightened();
                     });
         }
         else if( aItem->Type() == PCB_GROUP_T )
         {
             static_cast<PCB_GROUP*>( aItem )->RunOnChildren(
                     [&]( BOARD_ITEM* child )
                     {
                         child->SetBrightened();
                     });
         }
 
         GetCanvas()->GetView()->Update( aItem );
         lastBrightenedItemID = aItem->m_Uuid;
         FocusOnLocation( aItem->GetFocusPosition() );
         GetCanvas()->Refresh();
     }
 }

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

aPos	is the point to go to.

Definition at line 845 of file eda_draw_frame.cpp.

 {
     bool  centerView = false;
     BOX2D r = GetCanvas()->GetView()->GetViewport();
 
     // Center if we're off the current view, or within 10% of its edge
     r.Inflate( - (int) r.GetWidth() / 10 );
 

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ HOLDER_TYPE

◆ UNDO_REDO_LIST

Constructor & Destructor Documentation

◆ ~PCB_EDIT_FRAME()

◆ PCB_EDIT_FRAME()

Member Function Documentation

◆ ActivateGalCanvas()

◆ AddActionPluginTools()

◆ AddFootprintToBoard()

◆ AddLibrary()

◆ AddStandardHelpMenu()

◆ AddStandardSubMenus()

◆ AppendMsgPanel()

◆ buildActionPluginMenus()

◆ canCloseWindow()

◆ ChangeUserUnits()

◆ CheckForAutoSaveFile()

◆ Clear_Pcb()

◆ ClearFileHistory()

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

◆ ClearUndoRedoList()

◆ CommonSettingsChanged()

◆ Compile_Ratsnest()

◆ config()

◆ ConfigBaseName()

◆ CreateAndShow3D_Frame()

◆ CreateInfoBar()

◆ CreateNewFootprint()

◆ CreateNewLibrary()

◆ createNewLibrary()

◆ CreateNewProjectLibrary()

◆ CreateServer()

◆ CurrentToolName()

◆ Destroy()

◆ DismissModal()

◆ DisplayGridMsg()

◆ DisplayToolMsg()

◆ DisplayUnitsMsg()

◆ doAutoSave()

◆ doCloseWindow()

◆ DoGenFootprintsPositionFile()

◆ DoGenFootprintsReport()

◆ Edit_Zone_Params()

◆ ensureWindowIsOnScreen()

◆ EraseMsgBox()

◆ ExchangeFootprint()

◆ ExecuteRemoteCommand()

◆ Export_IDF3()

◆ ExportFootprintsToLibrary()

◆ ExportSpecctraFile()

◆ ExportSVG()

◆ ExportToGenCAD()

◆ ExportVRML_File()

◆ FetchNetlistFromSchematic()

◆ Files_io()

◆ Files_io_from_id()

◆ FinishAUIInitialization()

◆ FocusOnItem()

◆ FocusOnLocation()