KiCad PCB EDA Suite
FOOTPRINT_VIEWER_FRAME Class Reference

Component library viewer main window. More...

#include <footprint_viewer_frame.h>

Inheritance diagram for FOOTPRINT_VIEWER_FRAME:
PCB_BASE_FRAME EDA_DRAW_FRAME KIWAY_PLAYER EDA_BASE_FRAME TOOLS_HOLDER KIWAY_HOLDER

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

 ~FOOTPRINT_VIEWER_FRAME ()
 
BOARD_ITEM_CONTAINERGetModel () const override
 
SELECTIONGetCurrentSelection () override
 Get the current selection from the canvas area. More...
 
virtual COLOR4D GetGridColor () override
 
MAGNETIC_SETTINGSGetMagneticItemsSettings () override
 
void ReCreateLibraryList ()
 Create or recreate the list of current loaded libraries. More...
 
void OnUpdateFootprintButton (wxUpdateUIEvent &aEvent)
 Update the ID_ADD_FOOTPRINT_TO_BOARD tool state in main toolbar. More...
 
bool ShowModal (wxString *aFootprint, wxWindow *aParent) override
 Run the footprint viewer as a modal dialog. More...
 
COLOR_SETTINGSGetColorSettings () const override
 Helper to retrieve the current color settings. More...
 
EDA_3D_VIEWER_FRAMEGet3DViewerFrame ()
 
FOOTPRINTLoadFootprint (const LIB_ID &aFootprintId)
 Attempt to load aFootprintId from the footprint library table. More...
 
EDA_RECT GetBoardBoundingBox (bool aBoardEdgesOnly=false) const
 Calculate the bounding box containing all board items (or board edge segments). More...
 
const BOX2I GetDocumentExtents (bool aIncludeAllVisible=true) const override
 Returns bbox of document with option to not include some items. More...
 
virtual void SetPageSettings (const PAGE_INFO &aPageSettings) override
 
const PAGE_INFOGetPageSettings () const override
 
const wxSize GetPageSizeIU () const override
 Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view. More...
 
const wxPoint & GetGridOrigin () const override
 Return the absolute coordinates of the origin of the snap grid. More...
 
void SetGridOrigin (const wxPoint &aPoint) override
 
const wxPoint & GetAuxOrigin () const
 
const wxPoint GetUserOrigin () const
 
ORIGIN_TRANSFORMSGetOriginTransforms () override
 Return a reference to the default ORIGIN_TRANSFORMS object. More...
 
const TITLE_BLOCKGetTitleBlock () const override
 
void SetTitleBlock (const TITLE_BLOCK &aTitleBlock) override
 
virtual BOARD_DESIGN_SETTINGSGetDesignSettings () const
 Returns the BOARD_DESIGN_SETTINGS for the open project. More...
 
PCBNEW_SETTINGSSettings ()
 
void SetDrawBgColor (const COLOR4D &aColor) override
 
const PCB_DISPLAY_OPTIONSGetDisplayOptions () const
 Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode). More...
 
void SetDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions, bool aRefresh=true)
 Updates the current display options from the given options struct. More...
 
const ZONE_SETTINGSGetZoneSettings () const
 
void SetZoneSettings (const ZONE_SETTINGS &aSettings)
 
virtual const PCB_PLOT_PARAMSGetPlotSettings () const
 Return the PCB_PLOT_PARAMS for the BOARD owned by this frame. More...
 
virtual void SetPlotSettings (const PCB_PLOT_PARAMS &aSettings)
 
virtual void SetBoard (BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
 Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD. More...
 
BOARDGetBoard () const
 
EDA_ITEMGetItem (const KIID &aId) const override
 Fetch an item by KIID. More...
 
void FocusOnItem (BOARD_ITEM *aItem, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
 
void FocusOnItems (std::vector< BOARD_ITEM * > aItems, PCB_LAYER_ID aLayer=UNDEFINED_LAYER)
 
virtual void ShowChangedLanguage () override
 Redraw the menus and what not in current language. More...
 
virtual void UpdateStatusBar () override
 Update the status bar information. More...
 
PCB_SCREENGetScreen () const override
 Return a pointer to a BASE_SCREEN or one of its derivatives. More...
 
EDA_3D_VIEWER_FRAMECreateAndShow3D_Frame ()
 Shows the 3D view frame. More...
 
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide ()
 
wxString SelectLibrary (const wxString &aNicknameExisting)
 Put up a dialog and allows the user to pick a library, for unspecified use. More...
 
FOOTPRINTGetFootprintFromBoardByReference ()
 
virtual void OnModify ()
 Must be called after a change in order to set the "modify" flag of the current screen and update the date in frame reference. More...
 
FOOTPRINTCreateNewFootprint (const wxString &aFootprintName, bool aQuiet=false)
 Creates a new footprint, at position 0,0. More...
 
void PlaceFootprint (FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
 Places aFootprint at the current cursor position and updates footprint coordinates with the new position. More...
 
void ShowPadPropertiesDialog (PAD *aPad)
 
FOOTPRINTSelectFootprintFromLibTree (LIB_ID aPreselect=LIB_ID())
 Open a dialog to select a footprint. More...
 
virtual void AddFootprintToBoard (FOOTPRINT *aFootprint)
 Add the given footprint to the board. More...
 
wxString SelectFootprintFromLibBrowser ()
 Launch the footprint viewer to select the name of a footprint to load. More...
 
void Compile_Ratsnest (bool aDisplayStatus)
 Create the entire board ratsnest. More...
 
PCB_LAYER_ID SelectOneLayer (PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask=LSET(), wxPoint aDlgPosition=wxDefaultPosition)
 Show the dialog box for a layer selection. More...
 
virtual void SwitchLayer (PCB_LAYER_ID aLayer)
 Change the active layer in the frame. More...
 
virtual void SetActiveLayer (PCB_LAYER_ID aLayer)
 
virtual PCB_LAYER_ID GetActiveLayer () const
 
SEVERITY GetSeverity (int aErrorCode) const override
 
virtual void OnDisplayOptionsChanged ()
 
PCBNEW_SETTINGSGetPcbNewSettings () const
 
FOOTPRINT_EDITOR_SETTINGSGetFootprintEditorSettings () const
 
void DisplayGridMsg () override
 Display the current grid pane on the status bar. More...
 
PCB_DRAW_PANEL_GALGetCanvas () const override
 Return a pointer to GAL-based canvas of given EDA draw frame. More...
 
virtual void ActivateGalCanvas () override
 Use to start up the GAL drawing canvas. 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 ()
 
virtual void ReCreateAuxiliaryToolbar ()
 
virtual void UpdateToolbarControlSizes ()
 Update the sizes of any controls in the toolbars of the frame. More...
 
bool IsGridVisible () const
 
virtual void SetGridVisibility (bool aVisible)
 
virtual void SetGridColor (const COLOR4D &aColor)
 
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...
 
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...
 
void OnMove (wxMoveEvent &aEvent) override
 
virtual void HardRedraw ()
 Rebuild the GAL and redraws the screen. More...
 
virtual void Zoom_Automatique (bool aWarpPointer)
 Redraw the screen with best zoom level and the best centering that shows all the page or the board. More...
 
void FocusOnLocation (const wxPoint &aPos)
 Useful to focus on a particular location, in find functions. 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
 
void DisplayConstraintsMsg (const wxString &msg)
 
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...
 
virtual void SwitchCanvas (EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType)
 Changes the current rendering backend. More...
 
void SetCanvas (EDA_DRAW_PANEL_GAL *aPanel)
 
wxWindow * GetToolCanvas () const override
 Canvas access. More...
 
KIGFX::GAL_DISPLAY_OPTIONSGetGalDisplayOptions ()
 Return a reference to the gal rendering options used by GAL for rendering. More...
 
void RefreshCanvas () override
 
void RecreateToolbars ()
 Rebuild all toolbars, and update the checked state of check tools. More...
 
virtual bool OpenProjectFiles (const std::vector< wxString > &aFileList, int aCtl=0)
 Open a project or set of files given by aFileList. More...
 
virtual void ParseArgs (wxCmdLineParser &aParser)
 Handle command-line arguments in a frame-specific way. More...
 
virtual void KiwayMailIn (KIWAY_EXPRESS &aEvent)
 Receive KIWAY_EXPRESS messages from other players. 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)
 
virtual void ExecuteRemoteCommand (const char *cmdline)
 Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242). More...
 
EDA_UNITS GetUserUnits () const
 Return the user units currently in use. More...
 
void SetUserUnits (EDA_UNITS aUnits)
 
void ChangeUserUnits (EDA_UNITS aUnits)
 
SETTINGS_MANAGERGetSettingsManager () const
 
bool ProcessEvent (wxEvent &aEvent) override
 Override the default process event handler to implement the auto save feature. More...
 
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_STACKsys_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_INFOBARGetInfoBar ()
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton=false, WX_INFOBAR::MESSAGE_TYPE aType=WX_INFOBAR::MESSAGE_TYPE::GENERIC)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarError (const wxString &aErrorMsg, bool aShowCloseButton, std::function< void(void)> aCallback)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an error icon on the left of the infobar, and an optional closebox to the right. More...
 
void ShowInfoBarWarning (const wxString &aWarningMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and a warning icon on the left of the infobar. More...
 
void ShowInfoBarMsg (const wxString &aMsg, bool aShowCloseButton=false)
 Show the WX_INFOBAR displayed on the top of the canvas with a message and an info icon on the left of the infobar. More...
 
virtual APP_SETTINGS_BASEconfig () const
 Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME. More...
 
virtual void InstallPreferences (PAGED_DIALOG *, PANEL_HOTKEYS_EDITOR *)
 Allow a frame to load its preference panels (if any) into the preferences dialog. 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...
 
wxString ConfigBaseName () override
 Get the configuration base name. More...
 
virtual void SaveProjectSettings ()
 Save changes to the project settings to the project (.pro) file. More...
 
void ImportHotkeyConfigFromFile (std::map< std::string, TOOL_ACTION * > aActionMap, const wxString &aDefaultShortname)
 Prompt the user for a hotkey file to read, and read it. More...
 
wxString GetFileFromHistory (int cmdId, const wxString &type, FILE_HISTORY *aFileHistory=nullptr)
 Fetches the file name from the file history list. More...
 
void ClearFileHistory (FILE_HISTORY *aFileHistory=nullptr)
 Removes all files from the file history. More...
 
void UpdateFileHistory (const wxString &FullFileName, FILE_HISTORY *aFileHistory=nullptr)
 Update the list of recently opened files. More...
 
FILE_HISTORYGetFileHistory ()
 Get the frame's main file history. More...
 
void SetMruPath (const wxString &aPath)
 
wxString GetMruPath () const
 
virtual wxString GetCurrentFileName () const
 Get the full filename + path of the currently opened file in the frame. More...
 
void AddStandardHelpMenu (wxMenuBar *aMenuBar)
 Adds the standard KiCad help menu to the menubar. More...
 
bool IsWritable (const wxFileName &aFileName, bool aVerbose=true)
 Checks if aFileName can be written. More...
 
virtual 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...
 
virtual void ThemeChanged ()
 Process light/dark theme change. More...
 
virtual void ProjectChanged ()
 Notification event that the project has changed. More...
 
const wxString & GetAboutTitle () const
 
virtual bool IsContentModified () const
 Get if the contents of the frame have been modified since the last save. More...
 
wxSize GetWindowSize ()
 Get the undecorated window size that can be used for restoring the window size. More...
 
virtual void ClearUndoORRedoList (UNDO_REDO_LIST aList, int aItemCount=-1)
 Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed. More...
 
virtual void ClearUndoRedoList ()
 Clear the undo and redo list using ClearUndoORRedoList() More...
 
virtual void PushCommandToUndoList (PICKED_ITEMS_LIST *aItem)
 Add a command to undo in the undo list. More...
 
virtual void PushCommandToRedoList (PICKED_ITEMS_LIST *aItem)
 Add a command to redo in the redo list. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromUndoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual PICKED_ITEMS_LISTPopCommandFromRedoList ()
 Return the last command to undo and remove it from list, nothing is deleted. More...
 
virtual int GetUndoCommandCount () const
 
virtual int GetRedoCommandCount () const
 
int GetMaxUndoItems () const
 
bool NonUserClose (bool aForce)
 
virtual void HandleSystemColorChange ()
 Update the UI in response to a change in the system colors. More...
 
TOOL_MANAGERGetToolManager () const
 Return the MVC controller. More...
 
virtual void PushTool (const std::string &actionName)
 NB: the definition of "tool" is different at the user level. More...
 
virtual void PopTool (const std::string &actionName)
 
bool ToolStackIsEmpty ()
 
std::string CurrentToolName () const
 
bool IsCurrentTool (const TOOL_ACTION &aAction) const
 
bool GetDoImmediateActions () const
 Indicate that hotkeys should perform an immediate action even if another tool is currently active. More...
 
MOUSE_DRAG_ACTION GetDragAction () const
 Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects. More...
 
bool GetMoveWarpsCursor () const
 Indicate that a move operation should warp the mouse pointer to the origin of the move object. More...
 
HOLDER_TYPE GetType () const
 
KIWAYKiway () const
 Return a reference to the KIWAY that this object has an opportunity to participate in. More...
 
PROJECTPrj () const
 Return a reference to the PROJECT associated with this KIWAY. More...
 
void SetKiway (wxWindow *aDest, KIWAY *aKiway)
 It is only used for debugging, since "this" is not a wxWindow*. More...
 

Static Public Member Functions

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

Protected Member Functions

 FOOTPRINT_VIEWER_FRAME (KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType)
 
void setupUIConditions () override
 Setup the UI conditions for the various actions and their controls in this frame. More...
 
bool canCloseWindow (wxCloseEvent &aCloseEvent) override
 
FOOTPRINTloadFootprint (const LIB_ID &aFootprintId)
 Attempts to load aFootprintId from the footprint library table. More...
 
virtual 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...
 
virtual void SetScreen (BASE_SCREEN *aScreen)
 
void setupUnits (APP_SETTINGS_BASE *aCfg)
 
std::vector< wxWindow * > findDialogs ()
 
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...
 
virtual void handleActivateEvent (wxActivateEvent &aEvent)
 Handle a window activation event. 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...
 
virtual bool isAutoSaveRequired () const
 Return the auto save status of the application. More...
 
virtual bool doAutoSave ()
 This should be overridden by the derived class to handle the auto save feature. 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

MAGNETIC_SETTINGS m_magneticItems
 
BOARDm_pcb
 
PCB_DISPLAY_OPTIONS m_displayOptions
 
PCB_ORIGIN_TRANSFORMS m_originTransforms
 
PCBNEW_SETTINGSm_settings
 
wxSocketServer * m_socketServer
 
std::vector< wxSocketBase * > m_sockets
 interprocess communication More...
 
std::unique_ptr< wxSingleInstanceChecker > m_file_checker
 
bool m_showPageLimits
 
COLOR4D m_gridColor
 
COLOR4D m_drawBgColor
 
int m_undoRedoCountMax
 
bool m_polarCoords
 
bool m_showBorderAndTitleBlock
 
long m_firstRunDialogSetting
 
wxChoice * m_gridSelectBox
 
wxChoice * m_zoomSelectBox
 
ACTION_TOOLBARm_mainToolBar
 
ACTION_TOOLBARm_auxiliaryToolBar
 
ACTION_TOOLBARm_drawToolBar
 
ACTION_TOOLBARm_optionsToolBar
 
wxFindReplaceData * m_findReplaceData
 
wxArrayString m_findStringHistoryList
 
wxArrayString m_replaceStringHistoryList
 
EDA_MSG_PANELm_messagePanel
 
int m_msgFrameHeight
 
COLOR_SETTINGSm_colorSettings
 The current canvas type. More...
 
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
 
bool m_modal
 
WX_EVENT_LOOPm_modal_loop
 < Points to nested event_loop. NULL means not modal and dismissed. More...
 
wxWindow * m_modal_resultant_parent
 
wxString m_modal_string
 
bool m_modal_ret_val
 
FRAME_T m_ident
 
wxPoint m_framePos
 
wxSize m_frameSize
 
bool m_maximizeByDefault
 
int m_displayIndex
 
wxPoint m_normalFramePos
 
wxSize m_normalFrameSize
 
wxString m_aboutTitle
 
wxAuiManager m_auimgr
 
wxString m_perspective
 
WX_INFOBARm_infoBar
 
wxString m_configName
 
SETTINGS_MANAGERm_settingsManager
 
FILE_HISTORYm_fileHistory
 
bool m_hasAutoSave
 
bool m_autoSaveState
 
int m_autoSaveInterval
 
wxTimer * m_autoSaveTimer
 
UNDO_REDO_CONTAINER m_undoList
 
UNDO_REDO_CONTAINER m_redoList
 
wxString m_mruPath
 
EDA_UNITS m_userUnits
 Map containing the UI update handlers registered with wx for each action. More...
 
std::map< int, UIUpdateHandlerm_uiUpdateMap
 Set by the close window event handler after frames are asked if they can close. More...
 
bool m_isClosing
 Set by NonUserClose() to indicate that the user did not request the current close. More...
 
bool m_isNonUserClose
 
TOOL_MANAGERm_toolManager
 
ACTIONSm_actions
 
TOOL_DISPATCHERm_toolDispatcher
 
SELECTION m_dummySelection
 
std::vector< std::string > m_toolStack
 
bool m_immediateActions
 
MOUSE_DRAG_ACTION m_dragAction
 
bool m_moveWarpsCursor
 

Static Protected Attributes

static constexpr int KICAD_AUI_TB_STYLE = wxAUI_TB_DEFAULT_STYLE | wxAUI_TB_PLAIN_BACKGROUND
 < Default style flags used for wxAUI toolbars. More...
 

Private Member Functions

const wxString getCurNickname ()
 
void setCurNickname (const wxString &aNickname)
 
const wxString getCurFootprintName ()
 
void setCurFootprintName (const wxString &aName)
 
void OnSize (wxSizeEvent &event) override
 Recalculate the size of toolbars and display panel when the frame size changes. More...
 
void ReCreateFootprintList ()
 
void OnIterateFootprintList (wxCommandEvent &event)
 
void UpdateTitle ()
 Update the window title with current library information. More...
 
void doCloseWindow () override
 
void CloseFootprintViewer (wxCommandEvent &event)
 
void OnExitKiCad (wxCommandEvent &event)
 
void ReCreateHToolbar () override
 
void ReCreateVToolbar () override
 
void ReCreateOptToolbar () override
 
void ReCreateMenuBar () override
 Recreates the menu bar. More...
 
void OnLibFilter (wxCommandEvent &aEvent)
 
void OnFPFilter (wxCommandEvent &aEvent)
 
void OnCharHook (wxKeyEvent &aEvent) override
 Capture the key event before it is sent to the GUI. More...
 
void selectPrev (wxListBox *aListBox)
 
void selectNext (wxListBox *aListBox)
 
void ClickOnLibList (wxCommandEvent &aEvent)
 
void ClickOnFootprintList (wxCommandEvent &aEvent)
 
void DClickOnFootprintList (wxMouseEvent &aEvent)
 
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...
 
WINDOW_SETTINGSGetWindowSettings (APP_SETTINGS_BASE *aCfg) override
 Return a pointer to the window settings for this frame. More...
 
void CommonSettingsChanged (bool aEnvVarsChanged, bool aTextVarsChanged) override
 Notification event that some of the common (suite-wide) settings have changed. More...
 
void OnActivate (wxActivateEvent &event)
 Called when the frame frame is activate to reload the libraries and component lists that can be changed by the schematic editor or the library editor. More...
 
void AddFootprintToPCB (wxCommandEvent &aEvent)
 Export the current footprint name and close the library browser. More...
 
void SelectAndViewFootprint (int aMode)
 Select and load the next or the previous footprint. More...
 
void Update3DView (bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) override
 Update the 3D view, if the viewer is opened by this frame. More...
 
void SaveCopyInUndoList (EDA_ITEM *, UNDO_REDO) override
 Create a new entry in undo list of commands. More...
 
void SaveCopyInUndoList (const PICKED_ITEMS_LIST &, UNDO_REDO) override
 Creates a new entry in undo list of commands. More...
 
void updateView ()
 

Private Attributes

wxSearchCtrl * m_libFilter
 
wxListBox * m_libList
 
wxSearchCtrl * m_fpFilter
 
wxListBox * m_fpList
 
bool m_autoZoom
 
double m_lastZoom
 

Friends

struct PCB::IFACE
 

Detailed Description

Component library viewer main window.

Definition at line 45 of file footprint_viewer_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.

◆ UNDO_REDO_LIST

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.

Constructor & Destructor Documentation

◆ ~FOOTPRINT_VIEWER_FRAME()

FOOTPRINT_VIEWER_FRAME::~FOOTPRINT_VIEWER_FRAME ( )

Returns
the primary data model.

Definition at line 299 of file footprint_viewer_frame.cpp.

300 {
301  // Shutdown all running tools
302  if( m_toolManager )
304 
305  GetCanvas()->StopDrawing();
306  GetCanvas()->GetView()->Clear();
307  // Be sure any event cannot be fired after frame deletion:
308  GetCanvas()->SetEvtHandlerEnabled( false );
309  m_fpList->Disconnect( wxEVT_LEFT_DCLICK, wxMouseEventHandler( FOOTPRINT_VIEWER_FRAME::DClickOnFootprintList ), nullptr, this );
310 }
void ShutdownAllTools()
Shutdown all tools with a currently registered event loop in this tool manager by waking them up with...
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void Clear()
Remove all items from the view.
Definition: view.cpp:1100
void DClickOnFootprintList(wxMouseEvent &aEvent)
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

References KIGFX::VIEW::Clear(), DClickOnFootprintList(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), m_fpList, TOOLS_HOLDER::m_toolManager, TOOL_MANAGER::ShutdownAllTools(), and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ FOOTPRINT_VIEWER_FRAME()

FOOTPRINT_VIEWER_FRAME::FOOTPRINT_VIEWER_FRAME ( KIWAY aKiway,
wxWindow *  aParent,
FRAME_T  aFrameType 
)
protected

Definition at line 107 of file footprint_viewer_frame.cpp.

108  :
109  PCB_BASE_FRAME( aKiway, aParent, aFrameType, _( "Footprint Library Browser" ),
110  wxDefaultPosition, wxDefaultSize,
111  aFrameType == FRAME_FOOTPRINT_VIEWER_MODAL ? ( aParent ? PARENT_STYLE : MODAL_STYLE )
112  : NONMODAL_STYLE,
115 {
116  wxASSERT( aFrameType == FRAME_FOOTPRINT_VIEWER_MODAL || aFrameType == FRAME_FOOTPRINT_VIEWER );
117 
118  if( aFrameType == FRAME_FOOTPRINT_VIEWER_MODAL )
119  SetModal( true );
120 
121  m_aboutTitle = _( "KiCad Footprint Library Viewer" );
122 
123  // Force the items to always snap
126  m_magneticItems.graphics = true;
127 
128  // Force the frame name used in config. the footprint viewer frame has a name
129  // depending on aFrameType (needed to identify the frame by wxWidgets),
130  // but only one configuration is preferable.
132 
133  // Give an icon
134  wxIcon icon;
135  icon.CopyFromBitmap( KiBitmap( BITMAPS::icon_footprint_browser ) );
136  SetIcon( icon );
137 
138  wxPanel* libPanel = new wxPanel( this );
139  wxSizer* libSizer = new wxBoxSizer( wxVERTICAL );
140 
141  m_libFilter = new wxSearchCtrl( libPanel, ID_MODVIEW_LIB_FILTER, wxEmptyString,
142  wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER );
143  m_libFilter->SetDescriptiveText( _( "Filter" ) );
144  libSizer->Add( m_libFilter, 0, wxEXPAND, 5 );
145 
146  m_libList = new wxListBox( libPanel, ID_MODVIEW_LIB_LIST, wxDefaultPosition, wxDefaultSize,
147  0, nullptr, wxLB_HSCROLL | wxNO_BORDER );
148  libSizer->Add( m_libList, 1, wxEXPAND, 5 );
149 
150  libPanel->SetSizer( libSizer );
151  libPanel->Fit();
152 
153  wxPanel* fpPanel = new wxPanel( this );
154  wxSizer* fpSizer = new wxBoxSizer( wxVERTICAL );
155 
156  m_fpFilter = new wxSearchCtrl( fpPanel, ID_MODVIEW_FOOTPRINT_FILTER, wxEmptyString,
157  wxDefaultPosition, wxDefaultSize, wxTE_PROCESS_ENTER );
158  m_fpFilter->SetDescriptiveText( _( "Filter" ) );
159  m_fpFilter->SetToolTip(
160  _( "Filter on footprint name, keywords, description and pad count.\n"
161  "Search terms are separated by spaces. All search terms must match.\n"
162  "A term which is a number will also match against the pad count." ) );
163  fpSizer->Add( m_fpFilter, 0, wxEXPAND, 5 );
164 
165 #ifdef __WXGTK__
166  // wxSearchCtrl vertical height is not calculated correctly on some GTK setups
167  // See https://gitlab.com/kicad/code/kicad/-/issues/9019
168  m_libFilter->SetMinSize( wxSize( -1, GetTextExtent( wxT( "qb" ) ).y + 10 ) );
169  m_fpFilter->SetMinSize( wxSize( -1, GetTextExtent( wxT( "qb" ) ).y + 10 ) );
170 #endif
171 
172  m_fpList = new wxListBox( fpPanel, ID_MODVIEW_FOOTPRINT_LIST, wxDefaultPosition, wxDefaultSize,
173  0, nullptr, wxLB_HSCROLL | wxNO_BORDER );
174 
175  m_fpList->Connect( wxEVT_LEFT_DCLICK, wxMouseEventHandler( FOOTPRINT_VIEWER_FRAME::DClickOnFootprintList ), nullptr, this );
176  fpSizer->Add( m_fpList, 1, wxEXPAND, 5 );
177 
178  fpPanel->SetSizer( fpSizer );
179  fpPanel->Fit();
180 
181  // Create GAL canvas
183 
184  PCB_DRAW_PANEL_GAL* drawPanel = new PCB_DRAW_PANEL_GAL( this, -1, wxPoint( 0, 0 ), m_frameSize,
186  SetCanvas( drawPanel );
187 
188  SetBoard( new BOARD() );
189 
190  // This board will only be used to hold a footprint for viewing
192 
193  // In viewer, the default net clearance is not known (it depends on the actual board).
194  // So we do not show the default clearance, by setting it to 0
195  // The footprint or pad specific clearance will be shown
197 
198  // Don't show the default board solder mask clearance in the footprint viewer. Only the
199  // footprint or pad clearance setting should be shown if it is not 0.
201 
202  // Ensure all layers and items are visible:
204  SetScreen( new PCB_SCREEN( GetPageSizeIU() ) );
205 
206  GetScreen()->m_Center = true; // Center coordinate origins on screen.
207  LoadSettings( config() );
209 
210  // Call resolveCanvasType after loading settings:
212 
213  // Create the manager and dispatcher & route draw panel events to the dispatcher
215  m_toolManager->SetEnvironment( GetBoard(), drawPanel->GetView(),
216  drawPanel->GetViewControls(), config(), this );
217  m_actions = new PCB_ACTIONS();
219  drawPanel->SetEventDispatcher( m_toolDispatcher );
220 
223  m_toolManager->RegisterTool( new COMMON_TOOLS ); // for std context menus (zoom & grid)
225  m_toolManager->RegisterTool( new PCB_PICKER_TOOL ); // for setting grid origin
228 
229  m_toolManager->GetTool<PCB_VIEWER_TOOLS>()->SetFootprintFrame( true );
230 
232  m_toolManager->InvokeTool( "pcbnew.InteractiveSelection" );
233 
235  ReCreateMenuBar();
239 
241  UpdateTitle();
242 
243  // If a footprint was previously loaded, reload it
244  if( getCurNickname().size() && getCurFootprintName().size() )
245  {
246  LIB_ID id;
247 
249  id.SetLibItemName( getCurFootprintName() );
250 
251  FOOTPRINT* footprint = loadFootprint( id );
252 
253  if( footprint )
254  GetBoard()->Add( footprint );
255  }
256 
257  drawPanel->DisplayBoard( m_pcb );
258 
259  m_auimgr.SetManagedWindow( this );
260 
261  // Horizontal items; layers 4 - 6
262  m_auimgr.AddPane( m_mainToolBar, EDA_PANE().VToolbar().Name( "MainToolbar" ).Top().Layer(6) );
263  m_auimgr.AddPane( m_optionsToolBar, EDA_PANE().VToolbar().Name( "OptToolbar" ).Left().Layer(3) );
264  m_auimgr.AddPane( m_messagePanel, EDA_PANE().Messages().Name( "MsgPanel" ).Bottom().Layer(6) );
265 
266  // Vertical items; layers 1 - 3
267  m_auimgr.AddPane( libPanel, EDA_PANE().Palette().Name( "Libraries" ).Left().Layer(2)
268  .CaptionVisible( false ).MinSize( 100, -1 ).BestSize( 200, -1 ) );
269  m_auimgr.AddPane( fpPanel, EDA_PANE().Palette().Name( "Footprints" ).Left().Layer( 1)
270  .CaptionVisible( false ).MinSize( 100, -1 ).BestSize( 300, -1 ) );
271 
272  m_auimgr.AddPane( GetCanvas(), EDA_PANE().Canvas().Name( "DrawFrame" ).Center() );
273 
274  // after changing something to the aui manager call Update() to reflect the changes
275  m_auimgr.Update();
276 
277  // The canvas should not steal the focus from the list boxes
278  GetCanvas()->SetCanFocus( false );
279  GetCanvas()->GetGAL()->SetAxesEnabled( true );
281 
282  // Restore last zoom. (If auto-zooming we'll adjust when we load the footprint.)
284  wxASSERT( cfg );
286 
287  updateView();
288  setupUnits( config() );
289 
290  if( !IsModal() ) // For modal mode, calling ShowModal() will show this frame
291  {
293  Raise(); // On some window managers, this is needed
294  Show( true );
295  }
296 }
void DisplayBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
Add all items from the current board to the VIEW, so they can be displayed by GAL.
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
void UpdateTitle()
Update the window title with current library information.
#define FOOTPRINT_VIEWER_FRAME_NAME_MODAL
KIGFX::GAL_DISPLAY_OPTIONS & GetGalDisplayOptions()
Return a reference to the gal rendering options used by GAL for rendering.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
ACTION_TOOLBAR * m_optionsToolBar
virtual void SetScreen(BASE_SCREEN *aScreen)
EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void resolveCanvasType()
Determines the Canvas type to load (with prompt if required) and initializes m_canvasType.
void SetVisibleAlls()
Change the bit-mask of visible element categories and layers.
Definition: board.cpp:516
wxAuiManager m_auimgr
#define PARENT_STYLE
ACTION_TOOLBAR * m_mainToolBar
void setupUIConditions() override
Setup the UI conditions for the various actions and their controls in this frame.
double m_FootprintViewerZoom
The last zoom level used (0 for auto)
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
PCB_BASE_FRAME(KIWAY *aKiway, wxWindow *aParent, FRAME_T aFrameType, const wxString &aTitle, const wxPoint &aPos, const wxSize &aSize, long aStyle, const wxString &aFrameName)
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:590
bool InvokeTool(TOOL_ID aToolId)
Call a tool by sending a tool activation event to tool of given ID.
bool m_axesEnabled
Fullscreen crosshair or small cross.
Master controller class:
Definition: tool_manager.h:54
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
Definition: board.cpp:608
void LoadSettings(APP_SETTINGS_BASE *aCfg) override
Load common frame parameters from a configuration file.
FOOTPRINT * loadFootprint(const LIB_ID &aFootprintId)
Attempts to load aFootprintId from the footprint library table.
virtual void ActivateGalCanvas() override
Use to start up the GAL drawing canvas.
void SetClearance(int aClearance)
Definition: netclass.h:125
bool m_Center
Center on screen.
Definition: base_screen.h:96
Handle actions that are shared between different frames in PcbNew.
Definition: pcb_control.h:46
EDA_MSG_PANEL * m_messagePanel
void DClickOnFootprintList(wxMouseEvent &aEvent)
ACTIONS * m_actions
Definition: tools_holder.h:159
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
#define _(s)
#define MODAL_STYLE
virtual void SetBoard(BOARD *aBoard, PROGRESS_REPORTER *aReporter=nullptr)
Set the #m_Pcb member in such as way as to ensure deleting any previous BOARD.
#define FOOTPRINT_VIEWER_FRAME_NAME
wxBitmap KiBitmap(BITMAPS aBitmap, int aHeightTag)
Construct a wxBitmap from an image identifier Returns the image from the active theme if the image ha...
Definition: bitmap.cpp:105
Handle actions that are shared between different applications.
void SetAxesEnabled(bool aAxesEnabled)
Enable drawing the axes.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
Specialization of the wxAuiPaneInfo class for KiCad panels.
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...
Definition: kiway_player.h:173
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:160
Handles action that are shared between different applications.
Definition: common_tools.h:37
Generic tool for picking an item.
void SetModal(bool aIsModal)
Definition: kiway_player.h:174
#define NONMODAL_STYLE
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:97
virtual void SetScale(double aScale, VECTOR2D aAnchor={ 0, 0 })
Set the scaling factor, zooming around a given anchor point.
Definition: view.cpp:552
void SetCanvas(EDA_DRAW_PANEL_GAL *aPanel)
EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting()
Returns the canvas type stored in the application settings.
Gather all the actions that are shared by tools.
Definition: pcb_actions.h:48
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
void ReCreateMenuBar() override
Recreates the menu bar.
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:191
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
void setupUnits(APP_SETTINGS_BASE *aCfg)
void ReCreateLibraryList()
Create or recreate the list of current loaded libraries.
NETCLASS * GetDefault() const
MAGNETIC_OPTIONS pads
PCBNEW_SETTINGS * GetPcbNewSettings() const
The selection tool: currently supports:
PCB_SCREEN * GetScreen() const override
Return a pointer to a BASE_SCREEN or one of its derivatives.
Tool useful for viewing footprints.
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...
MAGNETIC_SETTINGS m_magneticItems
void InitTools()
Initializes all registered tools.
BOARD * GetBoard() const
void SetBoardUse(BOARD_USE aUse)
Set what the board is going to be used for.
Definition: board.h:204
wxString m_aboutTitle
wxString m_configName
MAGNETIC_OPTIONS tracks
void RegisterTool(TOOL_BASE *aTool)
Add a tool to the manager set and sets it up.

References _, PCB_BASE_FRAME::ActivateGalCanvas(), BOARD::Add(), CAPTURE_ALWAYS, PCAD2KICAD::Center, EDA_BASE_FRAME::config(), DClickOnFootprintList(), PCB_DRAW_PANEL_GAL::DisplayBoard(), FOOTPRINT_VIEWER_FRAME_NAME, FPHOLDER, FRAME_FOOTPRINT_VIEWER, FRAME_FOOTPRINT_VIEWER_MODAL, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), getCurFootprintName(), getCurNickname(), BOARD_DESIGN_SETTINGS::GetDefault(), BOARD::GetDesignSettings(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGalDisplayOptions(), PCB_BASE_FRAME::GetPageSizeIU(), PCB_BASE_FRAME::GetPcbNewSettings(), PCB_BASE_FRAME::GetScreen(), TOOL_MANAGER::GetTool(), PCB_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), MAGNETIC_SETTINGS::graphics, icon_footprint_browser, ID_MODVIEW_FOOTPRINT_FILTER, ID_MODVIEW_FOOTPRINT_LIST, ID_MODVIEW_LIB_FILTER, ID_MODVIEW_LIB_LIST, TOOL_MANAGER::InitTools(), TOOL_MANAGER::InvokeTool(), KIWAY_PLAYER::IsModal(), KiBitmap(), PCAD2KICAD::Left, EDA_DRAW_FRAME::loadCanvasTypeSetting(), PCB_BASE_FRAME::loadFootprint(), LoadSettings(), EDA_BASE_FRAME::m_aboutTitle, TOOLS_HOLDER::m_actions, EDA_BASE_FRAME::m_auimgr, KIGFX::GAL_DISPLAY_OPTIONS::m_axesEnabled, EDA_DRAW_FRAME::m_canvasType, BASE_SCREEN::m_Center, EDA_BASE_FRAME::m_configName, PCBNEW_SETTINGS::m_FootprintViewerZoom, m_fpFilter, m_fpList, EDA_BASE_FRAME::m_frameSize, m_libFilter, m_libList, m_magneticItems, EDA_DRAW_FRAME::m_mainToolBar, EDA_DRAW_FRAME::m_messagePanel, EDA_DRAW_FRAME::m_optionsToolBar, PCB_BASE_FRAME::m_pcb, BOARD_DESIGN_SETTINGS::m_SolderMaskMargin, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, MAGNETIC_SETTINGS::pads, ReCreateFootprintList(), ReCreateHToolbar(), ReCreateLibraryList(), ReCreateMenuBar(), ReCreateOptToolbar(), ReCreateVToolbar(), TOOL_MANAGER::RegisterTool(), EDA_DRAW_FRAME::resolveCanvasType(), KIGFX::GAL::SetAxesEnabled(), PCB_BASE_FRAME::SetBoard(), BOARD::SetBoardUse(), EDA_DRAW_FRAME::SetCanvas(), NETCLASS::SetClearance(), TOOL_MANAGER::SetEnvironment(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), LIB_ID::SetLibNickname(), KIWAY_PLAYER::SetModal(), KIGFX::VIEW::SetScale(), EDA_DRAW_FRAME::SetScreen(), setupUIConditions(), EDA_DRAW_FRAME::setupUnits(), BOARD::SetVisibleAlls(), MAGNETIC_SETTINGS::tracks, UpdateTitle(), and updateView().

Member Function Documentation

◆ ActivateGalCanvas()

void PCB_BASE_FRAME::ActivateGalCanvas ( )
overridevirtualinherited

Use to start up the GAL drawing canvas.

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in PCB_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 917 of file pcb_base_frame.cpp.

918 {
920 
921  EDA_DRAW_PANEL_GAL* canvas = GetCanvas();
922  KIGFX::VIEW* view = canvas->GetView();
923 
924  if( m_toolManager )
925  {
926  m_toolManager->SetEnvironment( m_pcb, view, canvas->GetViewControls(), config(), this );
927 
929  }
930 
931  KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( view->GetPainter() );
932  KIGFX::PCB_RENDER_SETTINGS* settings = painter->GetSettings();
933  const PCB_DISPLAY_OPTIONS& displ_opts = GetDisplayOptions();
934 
935  settings->LoadDisplayOptions( displ_opts, ShowPageLimits() );
936  settings->LoadColors( GetColorSettings() );
937 
938  view->RecacheAllItems();
940  canvas->StartDrawing();
941 }
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual APP_SETTINGS_BASE * config() const
Returns the settings object used in SaveSettings(), and is overloaded in KICAD_MANAGER_FRAME.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void RecacheAllItems()
Rebuild GAL display lists.
Definition: view.cpp:1385
Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:241
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:208
bool ShowPageLimits() const
virtual COLOR_SETTINGS * GetColorSettings() const override
Helper to retrieve the current color settings.
PCB specific render settings.
Definition: pcb_painter.h:64
Container for display options like enable/disable some optional drawings.
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
Definition: pcb_painter.h:247
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void ActivateGalCanvas()
Use to start up the GAL drawing canvas.
void StartDrawing()
Begin drawing if it was stopped previously.
TOOL_DISPATCHER * m_toolDispatcher
Definition: tools_holder.h:160
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
void SetEnvironment(EDA_ITEM *aModel, KIGFX::VIEW *aView, KIGFX::VIEW_CONTROLS *aViewControls, APP_SETTINGS_BASE *aSettings, TOOLS_HOLDER *aFrame)
Set the work environment (model, view, view controls and the parent window).
void SetEventDispatcher(TOOL_DISPATCHER *aEventDispatcher)
Set a dispatcher that processes events and forwards them to tools.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
Rendering engine changes.
Definition: tool_base.h:81

References EDA_DRAW_FRAME::ActivateGalCanvas(), EDA_BASE_FRAME::config(), TOOL_BASE::GAL_SWITCH, PCB_BASE_FRAME::GetCanvas(), PCB_BASE_FRAME::GetColorSettings(), PCB_BASE_FRAME::GetDisplayOptions(), KIGFX::VIEW::GetPainter(), KIGFX::PCB_PAINTER::GetSettings(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), PCB_BASE_FRAME::m_pcb, TOOLS_HOLDER::m_toolDispatcher, TOOLS_HOLDER::m_toolManager, KIGFX::VIEW::RecacheAllItems(), TOOL_MANAGER::ResetTools(), TOOL_MANAGER::SetEnvironment(), EDA_DRAW_PANEL_GAL::SetEventDispatcher(), EDA_DRAW_FRAME::ShowPageLimits(), and EDA_DRAW_PANEL_GAL::StartDrawing().

Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_VIEWER_FRAME(), and PCB_DRAW_PANEL_GAL::OnShow().

◆ AddFootprintToBoard()

void PCB_BASE_FRAME::AddFootprintToBoard ( FOOTPRINT aFootprint)
virtualinherited

Add the given footprint to the board.

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

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 177 of file pcb_base_frame.cpp.

178 {
179  if( aFootprint )
180  {
181  GetBoard()->Add( aFootprint, ADD_MODE::APPEND );
182 
183  aFootprint->SetFlags( IS_NEW );
184  aFootprint->SetPosition( wxPoint( 0, 0 ) ); // cursor in GAL may not be initialized yet
185 
186  // Put it on FRONT layer (note that it might be stored flipped if the lib is an archive
187  // built from a board)
188  if( aFootprint->IsFlipped() )
189  aFootprint->Flip( aFootprint->GetPosition(), m_settings->m_FlipLeftRight );
190 
191  // Place it in orientation 0 even if it is not saved with orientation 0 in lib (note that
192  // it might be stored in another orientation if the lib is an archive built from a board)
193  aFootprint->SetOrientation( 0 );
194  }
195 }
#define IS_NEW
New item, just created.
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:152
PCBNEW_SETTINGS * m_settings
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
Definition: board.cpp:608
void SetOrientation(double aNewAngle)
Definition: footprint.cpp:1681
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: footprint.cpp:1491
bool IsFlipped() const
Definition: footprint.h:281
wxPoint GetPosition() const override
Definition: footprint.h:187
BOARD * GetBoard() const
void SetPosition(const wxPoint &aPos) override
Definition: footprint.cpp:1562

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

◆ AddFootprintToPCB()

void FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB ( wxCommandEvent &  aEvent)
private

Export the current footprint name and close the library browser.

Definition at line 703 of file footprint_viewer_frame.cpp.

704 {
705  if( IsModal() )
706  {
707  if( m_fpList->GetSelection() >= 0 )
708  {
709  LIB_ID fpid( getCurNickname(), m_fpList->GetStringSelection() );
710  DismissModal( true, fpid.Format() );
711  }
712  else
713  {
714  DismissModal( false );
715  }
716  }
717  else if( GetBoard()->GetFirstFootprint() )
718  {
719  PCB_EDIT_FRAME* pcbframe = (PCB_EDIT_FRAME*) Kiway().Player( FRAME_PCB_EDITOR, false );
720 
721  if( pcbframe == nullptr ) // happens when the board editor is not active (or closed)
722  {
723  DisplayErrorMessage( this, _( "No board currently open." ) );
724  return;
725  }
726 
727  TOOL_MANAGER* toolMgr = pcbframe->GetToolManager();
728 
729  if( toolMgr->GetTool<BOARD_EDITOR_CONTROL>()->PlacingFootprint() )
730  {
731  DisplayError( this, _( "Previous footprint placement still in progress." ) );
732  return;
733  }
734 
735  toolMgr->RunAction( PCB_ACTIONS::selectionClear, true );
736  BOARD_COMMIT commit( pcbframe );
737 
738  // Create the "new" footprint
739  FOOTPRINT* newFootprint = (FOOTPRINT*) GetBoard()->GetFirstFootprint()->Duplicate();
740  newFootprint->SetParent( pcbframe->GetBoard() );
741  newFootprint->SetLink( niluuid );
742  newFootprint->SetFlags(IS_NEW ); // whatever
743 
744  for( PAD* pad : newFootprint->Pads() )
745  {
746  // Set the pads ratsnest settings to the global settings
747  pad->SetLocalRatsnestVisible( pcbframe->GetDisplayOptions().m_ShowGlobalRatsnest );
748 
749  // Pads in the library all have orphaned nets. Replace with Default.
750  pad->SetNetCode( 0 );
751  }
752 
753  // Put it on FRONT layer,
754  // (Can be stored flipped if the lib is an archive built from a board)
755  if( newFootprint->IsFlipped() )
756  newFootprint->Flip( newFootprint->GetPosition(),
757  pcbframe->Settings().m_FlipLeftRight );
758 
759  KIGFX::VIEW_CONTROLS* viewControls = pcbframe->GetCanvas()->GetViewControls();
760  VECTOR2D cursorPos = viewControls->GetCursorPosition();
761 
762  commit.Add( newFootprint );
763  viewControls->SetCrossHairCursorPosition( VECTOR2D( 0, 0 ), false );
764  pcbframe->PlaceFootprint( newFootprint );
765 
766  newFootprint->SetPosition( wxPoint( 0, 0 ) );
767  viewControls->SetCrossHairCursorPosition( cursorPos, false );
768  commit.Push( wxT( "Insert footprint" ) );
769 
770  pcbframe->Raise();
771  toolMgr->RunAction( PCB_ACTIONS::placeFootprint, true, newFootprint );
772 
773  newFootprint->ClearFlags();
774  }
775 }
static TOOL_ACTION selectionClear
Clear the current selection.
Definition: pcb_actions.h:59
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
KIID niluuid(0)
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:292
#define IS_NEW
New item, just created.
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:152
bool RunAction(const std::string &aActionName, bool aNow=false, T aParam=NULL)
Run the specified action.
Definition: tool_manager.h:143
virtual KIWAY_PLAYER * Player(FRAME_T aFrameType, bool doCreate=true, wxTopLevelWindow *aParent=nullptr)
Return the KIWAY_PLAYER* given a FRAME_T.
Definition: kiway.cpp:393
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:115
void PlaceFootprint(FOOTPRINT *aFootprint, bool aRecreateRatsnest=true)
Places aFootprint at the current cursor position and updates footprint coordinates with the new posit...
PADS & Pads()
Definition: footprint.h:169
Master controller class:
Definition: tool_manager.h:54
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:318
VECTOR2< double > VECTOR2D
Definition: vector2d.h:621
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: footprint.cpp:1491
Handle actions specific to the board editor in PcbNew.
An interface for classes handling user events controlling the view behavior such as zooming,...
#define _(s)
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:153
BOARD_ITEM * Duplicate() const override
Create a copy of this BOARD_ITEM.
Definition: footprint.cpp:1725
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
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...
Definition: kiway_player.h:173
bool IsFlipped() const
Definition: footprint.h:281
void SetLink(const KIID &aLink)
Definition: footprint.h:579
static TOOL_ACTION placeFootprint
Definition: pcb_actions.h:157
bool PlacingFootprint() const
Re-entrancy checker for above.
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)
The main frame for Pcbnew.
PCBNEW_SETTINGS & Settings()
wxPoint GetPosition() const override
Definition: footprint.h:187
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
BOARD * GetBoard() const
Definition: pad.h:57
void SetPosition(const wxPoint &aPos) override
Definition: footprint.cpp:1562
VECTOR2D GetCursorPosition() const
Return the current cursor position in world coordinates.

References _, COMMIT::Add(), EDA_ITEM::ClearFlags(), KIWAY_PLAYER::DismissModal(), DisplayError(), DisplayErrorMessage(), FOOTPRINT::Duplicate(), FOOTPRINT::Flip(), FRAME_PCB_EDITOR, PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), getCurNickname(), KIGFX::VIEW_CONTROLS::GetCursorPosition(), PCB_BASE_FRAME::GetDisplayOptions(), BOARD::GetFirstFootprint(), FOOTPRINT::GetPosition(), TOOL_MANAGER::GetTool(), TOOLS_HOLDER::GetToolManager(), EDA_DRAW_PANEL_GAL::GetViewControls(), IS_NEW, FOOTPRINT::IsFlipped(), KIWAY_PLAYER::IsModal(), KIWAY_HOLDER::Kiway(), PCBNEW_SETTINGS::m_FlipLeftRight, m_fpList, PCB_DISPLAY_OPTIONS::m_ShowGlobalRatsnest, niluuid, pad, FOOTPRINT::Pads(), PCB_ACTIONS::placeFootprint, PCB_BASE_FRAME::PlaceFootprint(), BOARD_EDITOR_CONTROL::PlacingFootprint(), KIWAY::Player(), BOARD_COMMIT::Push(), TOOL_MANAGER::RunAction(), PCB_ACTIONS::selectionClear, KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition(), EDA_ITEM::SetFlags(), FOOTPRINT::SetLink(), EDA_ITEM::SetParent(), FOOTPRINT::SetPosition(), and PCB_BASE_FRAME::Settings().

Referenced by DClickOnFootprintList(), and OnCharHook().

◆ AddStandardHelpMenu()

void EDA_BASE_FRAME::AddStandardHelpMenu ( wxMenuBar *  aMenuBar)
inherited

Adds the standard KiCad help menu to the menubar.

Definition at line 460 of file eda_base_frame.cpp.

461 {
462  COMMON_CONTROL* commonControl = m_toolManager->GetTool<COMMON_CONTROL>();
463  ACTION_MENU* helpMenu = new ACTION_MENU( false, commonControl );
464 
465  helpMenu->Add( ACTIONS::help );
466  helpMenu->Add( ACTIONS::gettingStarted );
467  helpMenu->Add( ACTIONS::listHotKeys );
468  helpMenu->Add( ACTIONS::getInvolved );
469  helpMenu->Add( ACTIONS::donate );
470  helpMenu->Add( ACTIONS::reportBug );
471 
472  helpMenu->AppendSeparator();
473  helpMenu->Add( _( "&About KiCad" ), "", wxID_ABOUT, BITMAPS::about );
474 
475  // Trailing space keeps OSX from hijacking our menu (and disabling everything in it).
476  aMenuBar->Append( helpMenu, _( "&Help" ) + wxS( " " ) );
477 }
static TOOL_ACTION listHotKeys
Definition: actions.h:179
Defines the structure of a menu based on ACTIONs.
Definition: action_menu.h:48
static TOOL_ACTION reportBug
Cursor control event types.
Definition: actions.h:182
static TOOL_ACTION donate
Definition: actions.h:180
#define _(s)
Handle actions that are shared between different applications.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
static TOOL_ACTION help
Definition: actions.h:178
static TOOL_ACTION getInvolved
Definition: actions.h:181
static TOOL_ACTION gettingStarted
Definition: actions.h:177

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(), ReCreateMenuBar(), SYMBOL_EDIT_FRAME::ReCreateMenuBar(), FOOTPRINT_EDIT_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), CVPCB_MAINFRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::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 492 of file eda_draw_frame.cpp.

493 {
494  COMMON_TOOLS* commonTools = m_toolManager->GetTool<COMMON_TOOLS>();
495  CONDITIONAL_MENU& aMenu = aToolMenu.GetMenu();
496 
497  aMenu.AddSeparator( 1000 );
498 
499  auto zoomMenu = std::make_shared<ZOOM_MENU>( this );
500  zoomMenu->SetTool( commonTools );
501  aToolMenu.AddSubMenu( zoomMenu );
502 
503  auto gridMenu = std::make_shared<GRID_MENU>( this );
504  gridMenu->SetTool( commonTools );
505  aToolMenu.AddSubMenu( gridMenu );
506 
507  aMenu.AddMenu( zoomMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
508  aMenu.AddMenu( gridMenu.get(), SELECTION_CONDITIONS::ShowAlways, 1000 );
509 }
static bool ShowAlways(const SELECTION &aSelection)
The default condition function (always returns true).
CONDITIONAL_MENU & GetMenu()
Definition: tool_menu.cpp:46
Handles action that are shared between different applications.
Definition: common_tools.h:37
void AddSeparator(int aOrder=ANY_ORDER)
Add a separator to the menu.
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158

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

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

◆ AppendMsgPanel()

void EDA_DRAW_FRAME::AppendMsgPanel ( const wxString &  aTextUpper,
const wxString &  aTextLower,
int  aPadding = 6 
)
inherited

Append a message to the message panel.

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

Parameters
aTextUpperThe message upper text.
aTextLowerThe message lower text.
aPaddingNumber of spaces to pad between messages.

Definition at line 652 of file eda_draw_frame.cpp.

654 {
655  if( m_messagePanel )
656  m_messagePanel->AppendMessage( aTextUpper, aTextLower, aPadding );
657 }
EDA_MSG_PANEL * m_messagePanel
void AppendMessage(const wxString &aUpperText, const wxString &aLowerText, int aPadding=6)
Append a message to the message panel.
Definition: msgpanel.cpp:94

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

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

◆ canCloseWindow()

bool PCB_BASE_FRAME::canCloseWindow ( wxCloseEvent &  aCloseEvent)
overrideprotectedvirtualinherited

Reimplemented from EDA_BASE_FRAME.

Reimplemented in PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 86 of file pcb_base_frame.cpp.

87 {
88  // Close modeless dialogs. They're trouble when they get destroyed after the frame and/or
89  // board.
90  wxWindow* viewer3D = Get3DViewerFrame();
91 
92  if( viewer3D )
93  viewer3D->Close( true );
94 
95  return true;
96 }
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()

References PCB_BASE_FRAME::Get3DViewerFrame().

Referenced by FOOTPRINT_EDIT_FRAME::canCloseWindow(), and PCB_EDIT_FRAME::canCloseWindow().

◆ ChangeUserUnits()

void EDA_BASE_FRAME::ChangeUserUnits ( EDA_UNITS  aUnits)
inherited

Definition at line 1203 of file eda_base_frame.cpp.

1204 {
1205  SetUserUnits( aUnits );
1207 
1208  wxCommandEvent e( UNITS_CHANGED );
1209  ProcessEventLocally( e );
1210 }
virtual void unitsChangeRefresh()
Called when when the units setting has changed to allow for any derived classes to handle refreshing ...
void SetUserUnits(EDA_UNITS aUnits)

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

Referenced by COMMON_TOOLS::SwitchUnits(), and COMMON_TOOLS::ToggleUnits().

◆ CheckForAutoSaveFile()

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

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

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

Parameters
aFileNameA wxFileName object containing the file name to check.

Reimplemented in SCH_EDIT_FRAME.

Definition at line 1091 of file eda_base_frame.cpp.

1092 {
1093  wxCHECK_RET( aFileName.IsOk(), wxT( "Invalid file name!" ) );
1094 
1095  wxFileName autoSaveFileName = aFileName;
1096 
1097  // Check for auto save file.
1098  autoSaveFileName.SetName( GetAutoSaveFilePrefix() + aFileName.GetName() );
1099 
1100  wxLogTrace( traceAutoSave,
1101  wxT( "Checking for auto save file " ) + autoSaveFileName.GetFullPath() );
1102 
1103  if( !autoSaveFileName.FileExists() )
1104  return;
1105 
1106  wxString msg = wxString::Format( _(
1107  "Well this is potentially embarrassing!\n"
1108  "It appears that the last time you were editing the file\n"
1109  "%s\n"
1110  "it was not saved properly. Do you wish to restore the last saved edits you made?" ),
1111  aFileName.GetFullName()
1112  );
1113 
1114  int response = wxMessageBox( msg, Pgm().App().GetAppDisplayName(), wxYES_NO | wxICON_QUESTION,
1115  this );
1116 
1117  // Make a backup of the current file, delete the file, and rename the auto save file to
1118  // the file name.
1119  if( response == wxYES )
1120  {
1121  if( !wxRenameFile( autoSaveFileName.GetFullPath(), aFileName.GetFullPath() ) )
1122  {
1123  wxMessageBox( _( "The auto save file could not be renamed to the board file name." ),
1124  Pgm().App().GetAppDisplayName(), wxOK | wxICON_EXCLAMATION, this );
1125  }
1126  }
1127  else
1128  {
1129  wxLogTrace( traceAutoSave,
1130  wxT( "Removing auto save file " ) + autoSaveFileName.GetFullPath() );
1131 
1132  // Remove the auto save file when using the previous file as is.
1133  wxRemoveFile( autoSaveFileName.GetFullPath() );
1134  }
1135 }
const wxChar *const traceAutoSave
Flag to enable auto save feature debug tracing.
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
static wxString GetAutoSaveFilePrefix()

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

Referenced by PCB_EDIT_FRAME::OpenProjectFiles().

◆ ClearFileHistory()

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

Removes all files from the file history.

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

Definition at line 976 of file eda_base_frame.cpp.

977 {
978  if( !aFileHistory )
979  aFileHistory = m_fileHistory;
980 
981  wxASSERT( aFileHistory );
982 
983  aFileHistory->ClearFileHistory();
984 
985  // Update the menubar to update the file history menu
986  if( GetMenuBar() )
987  {
988  ReCreateMenuBar();
989  GetMenuBar()->Refresh();
990  }
991 }
void ClearFileHistory()
Clear all entries from the file history.
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

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

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

◆ ClearMsgPanel()

◆ ClearUndoORRedoList()

virtual void EDA_BASE_FRAME::ClearUndoORRedoList ( UNDO_REDO_LIST  aList,
int  aItemCount = -1 
)
inlinevirtualinherited

Remove the aItemCount of old commands from aList and delete commands, pickers and picked items if needed.

Because picked items must be deleted only if they are not in use, this is a virtual pure function that must be created for SCH_SCREEN and PCB_SCREEN. Commands are deleted from the older to the last.

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

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, and PCB_BASE_EDIT_FRAME.

Definition at line 545 of file eda_base_frame.h.

546  { }

Referenced by EDA_BASE_FRAME::ClearUndoRedoList(), EDA_BASE_FRAME::PushCommandToRedoList(), and EDA_BASE_FRAME::PushCommandToUndoList().

◆ ClearUndoRedoList()

◆ ClickOnFootprintList()

void FOOTPRINT_VIEWER_FRAME::ClickOnFootprintList ( wxCommandEvent &  aEvent)
private

Definition at line 648 of file footprint_viewer_frame.cpp.

649 {
650  if( m_fpList->GetCount() == 0 )
651  return;
652 
653  int ii = m_fpList->GetSelection();
654 
655  if( ii < 0 )
656  return;
657 
658  wxString name = m_fpList->GetString( ii );
659 
660  if( getCurFootprintName().CmpNoCase( name ) != 0 )
661  {
663 
664  // Delete the current footprint (MUST reset tools first)
666 
668 
669  LIB_ID id;
671  id.SetLibItemName( getCurFootprintName() );
672 
673  try
674  {
675  GetBoard()->Add( loadFootprint( id ) );
676  }
677  catch( const IO_ERROR& ioe )
678  {
679  wxString msg =
680  wxString::Format( _( "Could not load footprint '%s' from library '%s'."
681  "\n\n%s" ),
683  DisplayError( this, msg );
684  }
685 
686  UpdateTitle();
687 
688  updateView();
689 
690  GetCanvas()->Refresh();
691  Update3DView( true, true );
692  }
693 }
void DisplayError(wxWindow *aParent, const wxString &aText, int aDisplayTime)
Display an error or warning message box with aMessage.
Definition: confirm.cpp:279
void UpdateTitle()
Update the window title with current library information.
Model changes (required full reload)
Definition: tool_base.h:80
void setCurFootprintName(const wxString &aName)
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
void Update3DView(bool aMarkDirty, bool aRefresh, const wxString *aTitle=nullptr) override
Update the 3D view, if the viewer is opened by this frame.
virtual const wxString Problem() const
what was the problem?
Definition: exceptions.cpp:46
void Add(BOARD_ITEM *aItem, ADD_MODE aMode=ADD_MODE::INSERT) override
Adds an item to the container.
Definition: board.cpp:608
FOOTPRINT * loadFootprint(const LIB_ID &aFootprintId)
Attempts to load aFootprintId from the footprint library table.
void ResetTools(TOOL_BASE::RESET_REASON aReason)
Reset all tools (i.e.
#define _(s)
int SetLibNickname(const UTF8 &aNickname)
Override the logical library name portion of the LIB_ID to aNickname.
Definition: lib_id.cpp:97
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
const char * name
Definition: DXF_plotter.cpp:56
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
void DeleteAllFootprints()
Remove all footprints from the deque and free the memory associated with them.
Definition: board.cpp:836
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:54
BOARD * GetBoard() const
Hold an error message and may be used when throwing exceptions containing meaningful error messages.
Definition: ki_exception.h:75

References _, BOARD::Add(), BOARD::DeleteAllFootprints(), DisplayError(), Format(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), getCurFootprintName(), getCurNickname(), TOOLS_HOLDER::GetToolManager(), PCB_BASE_FRAME::loadFootprint(), m_fpList, TOOL_BASE::MODEL_RELOAD, name, IO_ERROR::Problem(), EDA_DRAW_PANEL_GAL::Refresh(), TOOL_MANAGER::ResetTools(), setCurFootprintName(), LIB_ID::SetLibNickname(), Update3DView(), UpdateTitle(), and updateView().

Referenced by ReCreateFootprintList(), selectNext(), and selectPrev().

◆ ClickOnLibList()

void FOOTPRINT_VIEWER_FRAME::ClickOnLibList ( wxCommandEvent &  aEvent)
private

Definition at line 629 of file footprint_viewer_frame.cpp.

630 {
631  int ii = m_libList->GetSelection();
632 
633  if( ii < 0 )
634  return;
635 
636  wxString name = m_libList->GetString( ii );
637 
638  if( getCurNickname() == name )
639  return;
640 
641  setCurNickname( name );
642 
644  UpdateTitle();
645 }
void UpdateTitle()
Update the window title with current library information.
void setCurNickname(const wxString &aNickname)
const char * name
Definition: DXF_plotter.cpp:56

References getCurNickname(), m_libList, name, ReCreateFootprintList(), setCurNickname(), and UpdateTitle().

Referenced by ReCreateLibraryList(), selectNext(), and selectPrev().

◆ CloseFootprintViewer()

void FOOTPRINT_VIEWER_FRAME::CloseFootprintViewer ( wxCommandEvent &  event)
private

Definition at line 1078 of file footprint_viewer_frame.cpp.

1079 {
1080  Close( false );
1081 }

◆ CommonSettingsChanged()

void FOOTPRINT_VIEWER_FRAME::CommonSettingsChanged ( bool  aEnvVarsChanged,
bool  aTextVarsChanged 
)
overrideprivatevirtual

Notification event that some of the common (suite-wide) settings have changed.

Update menus, toolbars, local variables, etc.

Reimplemented from PCB_BASE_FRAME.

Definition at line 830 of file footprint_viewer_frame.cpp.

831 {
832  PCB_BASE_FRAME::CommonSettingsChanged( aEnvVarsChanged, aTextVarsChanged );
833 
834  if( aEnvVarsChanged )
836 }
void CommonSettingsChanged(bool aEnvVarsChanged, bool aTextVarsChanged) override
Notification event that some of the common (suite-wide) settings have changed.
void ReCreateLibraryList()
Create or recreate the list of current loaded libraries.

References PCB_BASE_FRAME::CommonSettingsChanged(), and ReCreateLibraryList().

◆ Compile_Ratsnest()

void PCB_BASE_FRAME::Compile_Ratsnest ( bool  aDisplayStatus)
inherited

Create the entire board ratsnest.

Function Compile_Ratsnest Create the entire board ratsnest.

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

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

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

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

Definition at line 40 of file ratsnest.cpp.

41 {
42  GetBoard()->GetConnectivity()->RecalculateRatsnest();
43 
44  if( aDisplayStatus )
45  SetMsgPanel( m_pcb );
46 }
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
std::shared_ptr< CONNECTIVITY_DATA > GetConnectivity() const
Return a list of missing connections between components/tracks.
Definition: board.h:345
BOARD * GetBoard() const

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

Referenced by DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), PCB_EDIT_FRAME::ExportToGenCAD(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), 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 816 of file eda_base_frame.cpp.

817 {
818  // KICAD_MANAGER_FRAME overrides this
819  return Kiface().KifaceSettings();
820 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
APP_SETTINGS_BASE * KifaceSettings() const
Definition: kiface_base.h:92

References Kiface(), and KIFACE_BASE::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(), GERBVIEW_FRAME::GERBVIEW_FRAME(), GRID_MENU::GRID_MENU(), COMMON_TOOLS::GridFast1(), COMMON_TOOLS::GridFast2(), EDA_DRAW_FRAME::IsGridVisible(), SCH_BASE_FRAME::libeditconfig(), EDA_DRAW_FRAME::OnUpdateSelectGrid(), PCB_CALCULATOR_FRAME::PCB_CALCULATOR_FRAME(), GERBVIEW_FRAME::Read_EXCELLON_File(), DIALOG_GRID_SETTINGS::RebuildGridSizes(), EDA_DRAW_FRAME::resolveCanvasType(), 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(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataFromWindow(), DIALOG_GRID_SETTINGS::TransferDataToWindow(), PANEL_GERBVIEW_EXCELLON_SETTINGS::TransferDataToWindow(), ZOOM_MENU::update(), GRID_MENU::update(), EDA_DRAW_FRAME::UpdateGridSelectBox(), EDA_DRAW_FRAME::UpdateZoomSelectBox(), EDA_BASE_FRAME::windowClosing(), 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 358 of file eda_base_frame.h.

359  {
360  wxString baseCfgName = m_configName.IsEmpty() ? GetName() : m_configName;
361  return baseCfgName;
362  }
wxString m_configName

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

604 {
605  EDA_3D_VIEWER_FRAME* draw3DFrame = Get3DViewerFrame();
606 
607  if( !draw3DFrame )
608  draw3DFrame = new EDA_3D_VIEWER_FRAME( &Kiway(), this, _( "3D Viewer" ) );
609 
610  // Raising the window does not show the window on Windows if iconized. This should work
611  // on any platform.
612  if( draw3DFrame->IsIconized() )
613  draw3DFrame->Iconize( false );
614 
615  draw3DFrame->Raise();
616  draw3DFrame->Show( true );
617 
618  // Raising the window does not set the focus on Linux. This should work on any platform.
619  if( wxWindow::FindFocus() != draw3DFrame )
620  draw3DFrame->SetFocus();
621 
622  // Allocate a slice of time to display the 3D frame
623  // a call to wxSafeYield() should be enough (and better), but on Linux we need
624  // to call wxYield()
625  // otherwise the activity messages are not displayed during the first board loading
626  wxYield();
627 
628  // Note, the caller is responsible to load/update the board 3D view.
629  // after frame creation the board is not automatically created.
630 
631  return draw3DFrame;
632 }
KIWAY & Kiway() const
Return a reference to the KIWAY that this object has an opportunity to participate in.
Definition: kiway_holder.h:53
EDA_3D_VIEWER_FRAME * Get3DViewerFrame()
Create and handle a window for the 3d viewer connected to a Kiway and a pcbboard.
#define _(s)

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

842 {
843 #if defined( __WXOSX_MAC__ )
845 #else
846  m_infoBar = new WX_INFOBAR( this, &m_auimgr );
847 
848  m_auimgr.AddPane( m_infoBar, EDA_PANE().InfoBar().Name( wxT( "InfoBar" ) ).Top().Layer(1) );
849 #endif
850 }
wxAuiManager m_auimgr
virtual wxWindow * GetToolCanvas() const =0
Canvas access.
Specialization of the wxAuiPaneInfo class for KiCad panels.
A modified version of the wxInfoBar class that allows us to:
Definition: infobar.h:73
WX_INFOBAR * m_infoBar

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

◆ CreateNewFootprint()

FOOTPRINT * PCB_BASE_FRAME::CreateNewFootprint ( const wxString &  aFootprintName,
bool  aQuiet = false 
)
inherited

Creates a new footprint, at position 0,0.

The new footprint contains only 2 texts: a reference and a value: Reference = REF** Value = "VAL**" or Footprint name in lib

Note
They are dummy texts, which will be replaced by the actual texts when the footprint is placed on a board and a netlist is read.
Parameters
aFootprintNameis the name of the new footprint in library.
aQuietprevents user dialogs from being shown

Definition at line 1136 of file footprint_libraries_utils.cpp.

1137 {
1138  wxString footprintName = aFootprintName;
1139 
1140  // Static to store user preference for a session
1141  static int footprintType = 1;
1142  int footprintTranslated = FP_SMD;
1143 
1144  // Ask for the new footprint name
1145  if( footprintName.IsEmpty() && !aQuiet )
1146  {
1147  WX_TEXT_ENTRY_DIALOG dlg( this, _( "Enter footprint name:" ), _( "New Footprint" ),
1148  footprintName, _( "Footprint type:" ),
1149  { _( "Through hole" ), _( "SMD" ), _( "Other" ) },
1150  footprintType );
1151  dlg.SetTextValidator( FOOTPRINT_NAME_VALIDATOR( &footprintName ) );
1152 
1153  if( dlg.ShowModal() != wxID_OK )
1154  return nullptr; //Aborted by user
1155 
1156  footprintType = dlg.GetChoice();
1157 
1158  switch( footprintType )
1159  {
1160  case 0:
1161  footprintTranslated = FP_THROUGH_HOLE;
1162  break;
1163  case 1:
1164  footprintTranslated = FP_SMD;
1165  break;
1166  default:
1167  footprintTranslated = 0;
1168  }
1169  }
1170 
1171  footprintName.Trim( true );
1172  footprintName.Trim( false );
1173 
1174  if( footprintName.IsEmpty() )
1175  {
1176  if( !aQuiet )
1177  DisplayInfoMessage( this, _( "No footprint name defined." ) );
1178 
1179  return nullptr;
1180  }
1181 
1182  // Creates the new footprint and add it to the head of the linked list of footprints
1183  FOOTPRINT* footprint = new FOOTPRINT( GetBoard() );
1184 
1185  // Update its name in lib
1186  footprint->SetFPID( LIB_ID( wxEmptyString, footprintName ) );
1187 
1188  footprint->SetAttributes( footprintTranslated );
1189 
1190  PCB_LAYER_ID txt_layer;
1191  wxPoint default_pos;
1193 
1194  footprint->Reference().SetText( settings.m_DefaultFPTextItems[0].m_Text );
1195  footprint->Reference().SetVisible( settings.m_DefaultFPTextItems[0].m_Visible );
1196  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[0].m_Layer;
1197  footprint->Reference().SetLayer( txt_layer );
1198  default_pos.y -= settings.GetTextSize( txt_layer ).y / 2;
1199  footprint->Reference().SetPosition( default_pos );
1200  default_pos.y += settings.GetTextSize( txt_layer ).y;
1201 
1202  footprint->Value().SetText( settings.m_DefaultFPTextItems[1].m_Text );
1203  footprint->Value().SetVisible( settings.m_DefaultFPTextItems[1].m_Visible );
1204  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[1].m_Layer;
1205  footprint->Value().SetLayer( txt_layer );
1206  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1207  footprint->Value().SetPosition( default_pos );
1208  default_pos.y += settings.GetTextSize( txt_layer ).y;
1209 
1210  for( size_t i = 2; i < settings.m_DefaultFPTextItems.size(); ++i )
1211  {
1212  FP_TEXT* textItem = new FP_TEXT( footprint );
1213  textItem->SetText( settings.m_DefaultFPTextItems[i].m_Text );
1214  textItem->SetVisible( settings.m_DefaultFPTextItems[i].m_Visible );
1215  txt_layer = (PCB_LAYER_ID) settings.m_DefaultFPTextItems[i].m_Layer;
1216  textItem->SetLayer( txt_layer );
1217  default_pos.y += settings.GetTextSize( txt_layer ).y / 2;
1218  textItem->SetPosition( default_pos );
1219  default_pos.y += settings.GetTextSize( txt_layer ).y;
1220  footprint->GraphicalItems().push_back( textItem );
1221  }
1222 
1223  if( footprint->GetReference().IsEmpty() )
1224  footprint->SetReference( footprintName );
1225 
1226  if( footprint->GetValue().IsEmpty() )
1227  footprint->SetValue( footprintName );
1228 
1229  footprint->RunOnChildren(
1230  [&] ( BOARD_ITEM* aChild )
1231  {
1232  if( aChild->Type() == PCB_FP_TEXT_T )
1233  {
1234  FP_TEXT* textItem = static_cast<FP_TEXT*>( aChild );
1235  PCB_LAYER_ID layer = textItem->GetLayer();
1236 
1237  textItem->SetTextThickness( settings.GetTextThickness( layer ) );
1238  textItem->SetTextSize( settings.GetTextSize( layer ) );
1239  textItem->SetItalic( settings.GetTextItalic( layer ) );
1240  textItem->SetKeepUpright( settings.GetTextUpright( layer ) );
1241  }
1242  } );
1243 
1244  SetMsgPanel( footprint );
1245  return footprint;
1246 }
void SetReference(const wxString &aReference)
Definition: footprint.h:475
virtual BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Returns the BOARD_DESIGN_SETTINGS for the open project.
std::vector< TEXT_ITEM_INFO > m_DefaultFPTextItems
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
virtual void SetPosition(const wxPoint &aPos) override
Definition: fp_text.h:93
const wxString & GetValue() const
Definition: footprint.h:488
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:164
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:49
void SetItalic(bool isItalic)
Definition: eda_text.h:200
A KICAD version of wxTextEntryDialog which supports the various improvements/work-arounds from DIALOG...
void SetTextValidator(wxTextValidatorStyle style)
void SetTextSize(const wxSize &aNewSize)
Definition: eda_text.h:258
A logical library item identifier and consists of various portions much like a URI.
Definition: lib_id.h:51
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
void SetAttributes(int aAttributes)
Definition: footprint.h:240
FP_TEXT & Value()
read/write accessors:
Definition: footprint.h:502
bool GetTextUpright(PCB_LAYER_ID aLayer) const
This class provides a custom wxValidator object for limiting the allowable characters when defining f...
Definition: validators.h:63
FP_TEXT & Reference()
Definition: footprint.h:503
bool GetTextItalic(PCB_LAYER_ID aLayer) const
virtual void SetVisible(bool aVisible)
Definition: eda_text.h:206
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:124
void SetMsgPanel(const std::vector< MSG_PANEL_ITEM > &aList)
Clear the message panel and populates it with the contents of aList.
const wxString & GetReference() const
Definition: footprint.h:466
#define _(s)
DRAWINGS & GraphicalItems()
Definition: footprint.h:172
void SetValue(const wxString &aValue)
Definition: footprint.h:496
void SetFPID(const LIB_ID &aFPID)
Definition: footprint.h:196
void SetKeepUpright(bool aKeepUpright)
Definition: fp_text.h:115
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:65
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invoke a function on all BOARD_ITEMs that belong to the footprint (pads, drawings,...
Definition: footprint.cpp:1299
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:180
BOARD * GetBoard() const
void DisplayInfoMessage(wxWindow *aParent, const wxString &aMessage, const wxString &aExtraInfo)
Display an informational message box with aMessage.
Definition: confirm.cpp:307
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:143
wxSize GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112
Container for design settings for a BOARD object.

References _, DisplayInfoMessage(), FP_SMD, FP_THROUGH_HOLE, 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::SetAttributes(), FOOTPRINT::SetFPID(), EDA_TEXT::SetItalic(), FP_TEXT::SetKeepUpright(), 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().

◆ CreateServer()

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

Definition at line 43 of file eda_dde.cpp.

44 {
45  wxIPV4address addr;
46 
47  // Set the port number
48  addr.Service( service );
49 
50  // Listen on localhost only if requested
51  if( local )
52  addr.Hostname( HOSTNAME );
53 
54  delete m_socketServer;
55  m_socketServer = new wxSocketServer( addr );
56 
57  m_socketServer->SetNotify( wxSOCKET_CONNECTION_FLAG );
58  m_socketServer->SetEventHandler( *this, ID_EDA_SOCKET_EVENT_SERV );
59  m_socketServer->Notify( true );
60 }
static const wxString HOSTNAME(wxT("localhost"))
wxSocketServer * m_socketServer
Definition: kiway_player.h:218

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.

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

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

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

◆ DClickOnFootprintList()

void FOOTPRINT_VIEWER_FRAME::DClickOnFootprintList ( wxMouseEvent &  aEvent)
private

Definition at line 696 of file footprint_viewer_frame.cpp.

697 {
698  wxCommandEvent evt;
699  AddFootprintToPCB( evt );
700 }
void AddFootprintToPCB(wxCommandEvent &aEvent)
Export the current footprint name and close the library browser.

References AddFootprintToPCB().

Referenced by FOOTPRINT_VIEWER_FRAME(), and ~FOOTPRINT_VIEWER_FRAME().

◆ Destroy()

◆ DismissModal()

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

Definition at line 166 of file kiway_player.cpp.

167 {
168  m_modal_ret_val = aRetVal;
169  m_modal_string = aResult;
170 
171  if( m_modal_loop )
172  {
173  m_modal_loop->Exit();
174  m_modal_loop = nullptr; // this marks it as dismissed.
175  }
176 
177  Show( false );
178 }
bool m_modal_ret_val
Definition: kiway_player.h:216
wxString m_modal_string
Definition: kiway_player.h:215
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:213

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

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

◆ DisplayConstraintsMsg()

void EDA_DRAW_FRAME::DisplayConstraintsMsg ( const wxString &  msg)
inherited

Definition at line 518 of file eda_draw_frame.cpp.

519 {
520  SetStatusText( msg, 7 );
521 }

Referenced by DRAWING_TOOL::updateStatusBar().

◆ DisplayGridMsg()

void PCB_BASE_FRAME::DisplayGridMsg ( )
overridevirtualinherited

Display the current grid pane on the status bar.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 702 of file pcb_base_frame.cpp.

703 {
704  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
705  wxString line;
706 
707  line.Printf( wxT( "grid X %s Y %s" ),
708  MessageTextFromValue( m_userUnits, gridSize.x, false ),
709  MessageTextFromValue( m_userUnits, gridSize.y, false ) );
710 
711  SetStatusText( line, 4 );
712 }
wxString MessageTextFromValue(EDA_UNITS aUnits, int aValue, bool aAddUnitLabel, EDA_DATA_TYPE aType)
Convert a value to a string using double notation.
Definition: base_units.cpp:104
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
const VECTOR2D & GetGridSize() const
Return the grid size.
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References PCB_BASE_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetGridSize(), EDA_BASE_FRAME::m_userUnits, MessageTextFromValue(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by PCB_BASE_FRAME::UpdateStatusBar().

◆ DisplayToolMsg()

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

Reimplemented from TOOLS_HOLDER.

Definition at line 512 of file eda_draw_frame.cpp.

513 {
514  SetStatusText( msg, 6 );
515 }

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

537 {
538  wxString msg;
539 
540  switch( m_userUnits )
541  {
542  case EDA_UNITS::INCHES: msg = _( "inches" ); break;
543  case EDA_UNITS::MILS: msg = _( "mils" ); break;
544  case EDA_UNITS::MILLIMETRES: msg = _( "mm" ); break;
545  default: msg = _( "Units" ); break;
546  }
547 
548  SetStatusText( msg, 5 );
549 }
#define _(s)
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

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

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

◆ doAutoSave()

bool EDA_BASE_FRAME::doAutoSave ( )
protectedvirtualinherited

This should be overridden by the derived class to handle the auto save feature.

Returns
true if the auto save was successful otherwise false.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 327 of file eda_base_frame.cpp.

328 {
329  wxCHECK_MSG( false, true, wxT( "Auto save timer function not overridden. Bad programmer!" ) );
330 }

Referenced by EDA_BASE_FRAME::onAutoSaveTimer().

◆ doCloseWindow()

void FOOTPRINT_VIEWER_FRAME::doCloseWindow ( )
overrideprivatevirtual

Reimplemented from EDA_BASE_FRAME.

Definition at line 356 of file footprint_viewer_frame.cpp.

357 {
358  // A workaround to avoid flicker, in modal mode when modview frame is destroyed,
359  // when the aui toolbar is not docked (i.e. shown in a miniframe)
360  // (useful on windows only)
361  m_mainToolBar->SetFocus();
362 
363  GetCanvas()->StopDrawing();
364 
365  if( IsModal() )
366  {
367  // Only dismiss a modal frame once, so that the return values set by
368  // the prior DismissModal() are not bashed for ShowModal().
369  if( !IsDismissed() )
370  DismissModal( false );
371 
372  // window to be destroyed by the caller of KIWAY_PLAYER::ShowModal()
373  }
374  else
375  {
376  Destroy();
377  }
378 }
bool IsDismissed()
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
ACTION_TOOLBAR * m_mainToolBar
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...
Definition: kiway_player.h:173
void DismissModal(bool aRetVal, const wxString &aResult=wxEmptyString)
bool Destroy() override
Our version of Destroy() which is virtual from wxWidgets.
void StopDrawing()
Prevent the GAL canvas from further drawing until it is recreated or StartDrawing() is called.

References KIWAY_PLAYER::Destroy(), KIWAY_PLAYER::DismissModal(), PCB_BASE_FRAME::GetCanvas(), KIWAY_PLAYER::IsDismissed(), KIWAY_PLAYER::IsModal(), EDA_DRAW_FRAME::m_mainToolBar, and EDA_DRAW_PANEL_GAL::StopDrawing().

◆ ensureWindowIsOnScreen()

void EDA_BASE_FRAME::ensureWindowIsOnScreen ( )
protectedinherited

Definition at line 657 of file eda_base_frame.cpp.

658 {
659  wxDisplay display( wxDisplay::GetFromWindow( this ) );
660  wxRect clientSize = display.GetClientArea();
661  wxPoint pos = GetPosition();
662  wxSize size = GetWindowSize();
663 
664  wxLogTrace( traceDisplayLocation,
665  wxT( "ensureWindowIsOnScreen: clientArea (%d, %d) w %d h %d" ), clientSize.x, clientSize.y,
666  clientSize.width, clientSize.height );
667 
668  if( pos.y < clientSize.y )
669  {
670  wxLogTrace( traceDisplayLocation,
671  wxT( "ensureWindowIsOnScreen: y pos %d below minimum, setting to %d" ), pos.y,
672  clientSize.y );
673  pos.y = clientSize.y;
674  }
675 
676  if( pos.x < clientSize.x )
677  {
678  wxLogTrace( traceDisplayLocation,
679  wxT( "ensureWindowIsOnScreen: x pos %d is off the client rect, setting to %d" ), pos.x,
680  clientSize.x );
681  pos.x = clientSize.x;
682  }
683 
684  if( pos.x + size.x - clientSize.x > clientSize.width )
685  {
686  int newWidth = clientSize.width - ( pos.x - clientSize.x );
687  wxLogTrace( traceDisplayLocation,
688  wxT( "ensureWindowIsOnScreen: effective width %d above available %d, setting to %d" ),
689  pos.x + size.x, clientSize.width, newWidth );
690  size.x = newWidth;
691  }
692 
693  if( pos.y + size.y - clientSize.y > clientSize.height )
694  {
695  int newHeight = clientSize.height - ( pos.y - clientSize.y );
696  wxLogTrace( traceDisplayLocation,
697  wxT( "ensureWindowIsOnScreen: effective height %d above available %d, setting to %d" ),
698  pos.y + size.y, clientSize.height, newHeight );
699  size.y = newHeight;
700  }
701 
702  wxLogTrace( traceDisplayLocation, wxT( "Updating window position (%d, %d) with size (%d, %d)" ),
703  pos.x, pos.y, size.x, size.y );
704 
705  SetSize( pos.x, pos.y, size.x, size.y );
706 }
const wxChar *const traceDisplayLocation
Flag to enable debug output of display positioning logic.
wxSize GetWindowSize()
Get the undecorated window size that can be used for restoring the window size.

References EDA_BASE_FRAME::GetWindowSize(), and traceDisplayLocation.

Referenced by EDA_BASE_FRAME::OnSize().

◆ EraseMsgBox()

void EDA_DRAW_FRAME::EraseMsgBox ( )
inherited

Definition at line 305 of file eda_draw_frame.cpp.

306 {
307  if( m_messagePanel )
309 }
EDA_MSG_PANEL * m_messagePanel
void EraseMsgBox()
Definition: msgpanel.cpp:198

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

Referenced by GERBVIEW_CONTROL::UpdateMessagePanel().

◆ ExecuteRemoteCommand()

virtual void KIWAY_PLAYER::ExecuteRemoteCommand ( const char *  cmdline)
inlinevirtualinherited

Execute a remote command sent via socket (to port KICAD_PCB_PORT_SERVICE_NUMBER, currently 4242).

Subclasses should override to implement actual command handlers.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 196 of file kiway_player.h.

196 {}

Referenced by KIWAY_PLAYER::OnSockRequest().

◆ findDialogs()

std::vector< wxWindow * > EDA_DRAW_FRAME::findDialogs ( )
protectedinherited

Definition at line 842 of file eda_draw_frame.cpp.

843 {
844  std::vector<wxWindow*> dialogs;
845 
846  for( wxWindow* window : GetChildren() )
847  {
848  if( dynamic_cast<DIALOG_SHIM*>( window ) )
849  dialogs.push_back( window );
850  }
851 
852  return dialogs;
853 }

Referenced by PCB_BASE_FRAME::FocusOnItems(), and EDA_DRAW_FRAME::FocusOnLocation().

◆ FinishAUIInitialization()

void EDA_BASE_FRAME::FinishAUIInitialization ( )
inherited

Definition at line 853 of file eda_base_frame.cpp.

854 {
855 #if defined( __WXOSX_MAC__ )
856  m_auimgr.Update();
857 #else
858  // Call Update() to fix all pane default sizes, especially the "InfoBar" pane before
859  // hiding it.
860  m_auimgr.Update();
861 
862  // We don't want the infobar displayed right away
863  m_auimgr.GetPane( wxT( "InfoBar" ) ).Hide();
864  m_auimgr.Update();
865 #endif
866 }
wxAuiManager m_auimgr

References EDA_BASE_FRAME::m_auimgr.

◆ FocusOnItem()

void PCB_BASE_FRAME::FocusOnItem ( BOARD_ITEM aItem,
PCB_LAYER_ID  aLayer = UNDEFINED_LAYER 
)
inherited

◆ FocusOnItems()

void PCB_BASE_FRAME::FocusOnItems ( std::vector< BOARD_ITEM * >  aItems,
PCB_LAYER_ID  aLayer = UNDEFINED_LAYER 
)
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 215 of file pcb_base_frame.cpp.

216 {
217  static std::vector<KIID> lastBrightenedItemIDs;
218 
219  BOARD_ITEM* lastItem = nullptr;
220 
221  for( KIID lastBrightenedItemID : lastBrightenedItemIDs )
222  {
225  #if BOOST_VERSION >= 106700
226  try
227  {
228  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
229  }
230  catch( const boost::uuids::entropy_error& )
231  {
232  wxLogError( wxT( "A Boost UUID entropy exception was thrown in %s:%s." ),
233  __FILE__, __FUNCTION__ );
234  }
235  #else
236  lastItem = GetBoard()->GetItem( lastBrightenedItemID );
237  #endif
238 
239  if( lastItem && lastItem != DELETED_BOARD_ITEM::GetInstance() )
240  {
241  lastItem->ClearBrightened();
242 
243  if( lastItem->Type() == PCB_FOOTPRINT_T )
244  {
245  static_cast<FOOTPRINT*>( lastItem )->RunOnChildren(
246  [&]( BOARD_ITEM* child )
247  {
248  child->ClearBrightened();
249  } );
250  }
251  else if( lastItem->Type() == PCB_GROUP_T )
252  {
253  static_cast<PCB_GROUP*>( lastItem )->RunOnChildren(
254  [&]( BOARD_ITEM* child )
255  {
256  child->ClearBrightened();
257  } );
258  }
259 
260  GetCanvas()->GetView()->Update( lastItem );
261  lastBrightenedItemID = niluuid;
262  GetCanvas()->Refresh();
263  }
264  }
265 
266  lastBrightenedItemIDs.clear();
267 
268  if( aItems.empty() )
269  return;
270 
271  wxPoint focusPt;
272  KIGFX::VIEW* view = GetCanvas()->GetView();
273  SHAPE_POLY_SET viewportPoly( view->GetViewport() );
274 
275  for( wxWindow* dialog : findDialogs() )
276  {
277  wxPoint dialogPos = GetCanvas()->ScreenToClient( dialog->GetScreenPosition() );
278  SHAPE_POLY_SET dialogPoly( BOX2D( view->ToWorld( dialogPos, true ),
279  view->ToWorld( dialog->GetSize(), false ) ) );
280 
281  try
282  {
283  viewportPoly.BooleanSubtract( dialogPoly, SHAPE_POLY_SET::PM_FAST );
284  }
285  catch( const ClipperLib::clipperException& exc )
286  {
287  // This may be overkill and could be an assertion but we are more likely to
288  // find any clipper errors this way.
289  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
290  }
291  }
292 
293  SHAPE_POLY_SET itemPoly, clippedPoly;
294 
295  for( BOARD_ITEM* item : aItems )
296  {
297  if( item && item != DELETED_BOARD_ITEM::GetInstance() )
298  {
299  item->SetBrightened();
300 
301  if( item->Type() == PCB_FOOTPRINT_T )
302  {
303  static_cast<FOOTPRINT*>( item )->RunOnChildren(
304  [&]( BOARD_ITEM* child )
305  {
306  child->SetBrightened();
307  });
308  }
309  else if( item->Type() == PCB_GROUP_T )
310  {
311  static_cast<PCB_GROUP*>( item )->RunOnChildren(
312  [&]( BOARD_ITEM* child )
313  {
314  child->SetBrightened();
315  });
316  }
317 
318  GetCanvas()->GetView()->Update( item );
319  lastBrightenedItemIDs.push_back( item->m_Uuid );
320 
321  // Focus on the object's location. Prefer a visible part of the object to its anchor
322  // in order to keep from scrolling around.
323 
324  focusPt = item->GetPosition();
325 
326  if( aLayer == UNDEFINED_LAYER )
327  aLayer = item->GetLayerSet().Seq()[0];
328 
329  switch( item->Type() )
330  {
331  case PCB_FOOTPRINT_T:
332  try
333  {
334  itemPoly = static_cast<FOOTPRINT*>( item )->GetBoundingHull();
335  }
336  catch( const ClipperLib::clipperException& exc )
337  {
338  // This may be overkill and could be an assertion but we are more likely to
339  // find any clipper errors this way.
340  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
341  }
342 
343  break;
344 
345  case PCB_PAD_T:
346  case PCB_MARKER_T:
347  case PCB_VIA_T:
348  FocusOnLocation( item->GetFocusPosition() );
349  GetCanvas()->Refresh();
350  return;
351 
352  case PCB_SHAPE_T:
353  case PCB_TEXT_T:
354  case PCB_FP_TEXT_T:
355  case PCB_FP_SHAPE_T:
356  case PCB_FP_ZONE_T:
357  case PCB_TRACE_T:
358  case PCB_ARC_T:
359  case PCB_DIMENSION_T:
360  case PCB_DIM_ALIGNED_T:
361  case PCB_DIM_LEADER_T:
362  case PCB_DIM_CENTER_T:
364  item->TransformShapeWithClearanceToPolygon( itemPoly, aLayer, 0, Millimeter2iu( 0.1 ),
365  ERROR_INSIDE );
366  break;
367 
368  case PCB_ZONE_T:
369  {
370  ZONE* zone = static_cast<ZONE*>( item );
371  #if 0
372  // Using the filled area shapes to find a Focus point can give good results, but
373  // unfortunately the calculations are highly time consuming, even for not very
374  // large areas (can be easily a few minutes for large areas).
375  // so we used only the zone outline that usually do not have too many vertices.
376  zone->TransformShapeWithClearanceToPolygon( itemPoly, aLayer, 0, Millimeter2iu( 0.1 ),
377  ERROR_INSIDE );
378 
379  if( itemPoly.IsEmpty() )
380  itemPoly = *zone->Outline();
381  #else
382  // much faster calculation time when using only the zone outlines
383  itemPoly = *zone->Outline();
384  #endif
385 
386  break;
387  }
388 
389  default:
390  {
391  BOX2I item_bbox = item->GetBoundingBox();
392  itemPoly.NewOutline();
393  itemPoly.Append( item_bbox.GetOrigin() );
394  itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( item_bbox.GetWidth(), 0 ) );
395  itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( 0, item_bbox.GetHeight() ) );
396  itemPoly.Append( item_bbox.GetOrigin() + VECTOR2I( item_bbox.GetWidth(),
397  item_bbox.GetHeight() ) );
398  break;
399  }
400  }
401 
402  try
403  {
404  clippedPoly.BooleanIntersection( itemPoly, viewportPoly, SHAPE_POLY_SET::PM_FAST );
405  }
406  catch( const ClipperLib::clipperException& exc )
407  {
408  // This may be overkill and could be an assertion but we are more likely to
409  // find any clipper errors this way.
410  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
411  }
412 
413  if( !clippedPoly.IsEmpty() )
414  itemPoly = clippedPoly;
415  }
416  }
417 
418  /*
419  * Perform a step-wise deflate to find the visual-center-of-mass
420  */
421 
422  BOX2I bbox = itemPoly.BBox();
423  int step = std::min( bbox.GetWidth(), bbox.GetHeight() ) / 10;
424 
425  while( !itemPoly.IsEmpty() )
426  {
427  focusPt = (wxPoint) itemPoly.BBox().Centre();
428 
429  try
430  {
431  itemPoly.Deflate( step, 4, SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS );
432  }
433  catch( const ClipperLib::clipperException& exc )
434  {
435  // This may be overkill and could be an assertion but we are more likely to
436  // find any clipper errors this way.
437  wxLogError( wxT( "Clipper library exception '%s' occurred." ), exc.what() );
438  }
439  }
440 
441  FocusOnLocation( focusPt );
442 
443  GetCanvas()->Refresh();
444 }
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:845
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:512
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition: typeinfo.h:100
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:101
KIID niluuid(0)
class FP_TEXT, text in a footprint
Definition: typeinfo.h:92
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:49
VECTOR2D ToWorld(const VECTOR2D &aCoord, bool aAbsolute=true) const
Converts a screen space point/vector to a point/vector in world space coordinates.
Definition: view.cpp:449
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:108
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition: typeinfo.h:102
SHAPE_POLY_SET * Outline()
Definition: zone.h:320
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
bool IsEmpty() const
BOX2< VECTOR2D > BOX2D
Definition: box2.h:507
void SetBrightened()
Definition: eda_item.h:129
class PCB_TEXT, text on a layer
Definition: typeinfo.h:91
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:97
class FP_SHAPE, a footprint edge
Definition: typeinfo.h:93
class PAD, a pad in a footprint
Definition: typeinfo.h:89
VECTOR2< int > VECTOR2I
Definition: vector2d.h:622
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:95
void ClearBrightened()
Definition: eda_item.h:132
Definition: kiid.h:44
virtual void Update(const VIEW_ITEM *aItem, int aUpdateFlags) const override
For dynamic VIEWs, inform the associated VIEW that the graphical representation of this item has chan...
Definition: pcb_view.cpp:92
Represent a set of closed polygons.
static DELETED_BOARD_ITEM * GetInstance()
Definition: board_item.h:348
coord_type GetWidth() const
Definition: box2.h:180
void Deflate(int aAmount, int aCircleSegmentsCount, CORNER_STRATEGY aCornerStrategy=ROUND_ALL_CORNERS)
Handle a list of polygons defining a copper zone.
Definition: zone.h:56
class ZONE, a copper pour area
Definition: typeinfo.h:105
void BooleanIntersection(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset union between a and b, store the result in it self For aFastMode meaning,...
class PCB_DIMENSION_BASE: abstract dimension meta-type
Definition: typeinfo.h:99
int NewOutline()
Creates a new hole in a given outline.
Acute angles are chamfered.
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
class FOOTPRINT, a footprint
Definition: typeinfo.h:88
class PCB_MARKER, a marker used to show something
Definition: typeinfo.h:98
Vec Centre() const
Definition: box2.h:63
std::vector< wxWindow * > findDialogs()
class ZONE, managed by a footprint
Definition: typeinfo.h:94
virtual void Refresh(bool aEraseBackground=true, const wxRect *aRect=nullptr) override
Update the board display after modifying it by a python script (note: it is automatically called by a...
coord_type GetHeight() const
Definition: box2.h:181
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition: typeinfo.h:103
class PCB_VIA, a via (like a track segment on a copper layer)
Definition: typeinfo.h:96
void BooleanSubtract(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset intersection For aFastMode meaning, see function booleanOp.
BOARD * GetBoard() const
const Vec & GetOrigin() const
Definition: box2.h:176
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the zone shape to a closed polygon Used in filling zones calculations Circles and arcs are ap...
Definition: zone.cpp:1353
void FocusOnLocation(const wxPoint &aPos)
Useful to focus on a particular location, in find functions.
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:90
static constexpr int Millimeter2iu(double mm)
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Add a new vertex to the contour indexed by aOutline and aHole (defaults to the outline of the last po...

References SHAPE_POLY_SET::Append(), SHAPE_POLY_SET::BBox(), SHAPE_POLY_SET::BooleanIntersection(), SHAPE_POLY_SET::BooleanSubtract(), BOX2< Vec >::Centre(), SHAPE_POLY_SET::CHAMFER_ACUTE_CORNERS, EDA_ITEM::ClearBrightened(), SHAPE_POLY_SET::Deflate(), ERROR_INSIDE, EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::FocusOnLocation(), PCB_BASE_FRAME::GetBoard(), PCB_BASE_FRAME::GetCanvas(), BOX2< Vec >::GetHeight(), DELETED_BOARD_ITEM::GetInstance(), BOARD::GetItem(), BOX2< Vec >::GetOrigin(), PCB_DRAW_PANEL_GAL::GetView(), KIGFX::VIEW::GetViewport(), BOX2< Vec >::GetWidth(), SHAPE_POLY_SET::IsEmpty(), Millimeter2iu(), SHAPE_POLY_SET::NewOutline(), niluuid, ZONE::Outline(), PCB_ARC_T, PCB_DIM_ALIGNED_T, PCB_DIM_CENTER_T, PCB_DIM_LEADER_T, PCB_DIM_ORTHOGONAL_T, PCB_DIMENSION_T, PCB_FOOTPRINT_T, PCB_FP_SHAPE_T, PCB_FP_TEXT_T, PCB_FP_ZONE_T, PCB_GROUP_T, PCB_MARKER_T, PCB_PAD_T, PCB_SHAPE_T, PCB_TEXT_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, SHAPE_POLY_SET::PM_FAST, EDA_DRAW_PANEL_GAL::Refresh(), EDA_ITEM::SetBrightened(), KIGFX::VIEW::ToWorld(), ZONE::TransformShapeWithClearanceToPolygon(), EDA_ITEM::Type(), UNDEFINED_LAYER, and KIGFX::PCB_VIEW::Update().

Referenced by PCB_BASE_FRAME::FocusOnItem(), and DIALOG_DRC::OnDRCItemSelected().

◆ FocusOnLocation()

void EDA_DRAW_FRAME::FocusOnLocation ( const wxPoint &  aPos)
inherited

Useful to focus on a particular location, in find functions.

Move the graphic cursor (crosshair cursor) at a given coordinate and reframes the drawing if the requested point is out of view or if center on location is requested.

Parameters
aPosis the point to go to.

Definition at line 856 of file eda_draw_frame.cpp.

857 {
858  bool centerView = false;
859  BOX2D r = GetCanvas()->GetView()->GetViewport();
860 
861  // Center if we're off the current view, or within 10% of its edge
862  r.Inflate( - (int) r.GetWidth() / 10 );
863 
864  if( !r.Contains( aPos ) )
865  centerView = true;
866 
867  std::vector<BOX2D> dialogScreenRects;
868 
869  for( wxWindow* dialog : findDialogs() )
870  {
871  dialogScreenRects.emplace_back( GetCanvas()->ScreenToClient( dialog->GetScreenPosition() ),
872  dialog->GetSize() );
873  }
874 
875  // Center if we're behind an obscuring dialog, or within 10% of its edge
876  for( BOX2D rect : dialogScreenRects )
877  {
878  rect.Inflate( rect.GetWidth() / 10 );
879 
880  if( rect.Contains( GetCanvas()->GetView()->ToScreen( aPos ) ) )
881  centerView = true;
882  }
883 
884  if( centerView )
885  {
886  try
887  {
888  GetCanvas()->GetView()->SetCenter( aPos, dialogScreenRects );
889  }
890  catch( const ClipperLib::clipperException& exc )
891  {
892  wxLogError( wxT( "Clipper library error '%s' occurred centering object." ),
893  exc.what() );
894  }
895  }
896 
898 }
BOX2D GetViewport() const
Return the current viewport visible area rectangle.
Definition: view.cpp:512
KIGFX::VIEW_CONTROLS * GetViewControls() const
Return a pointer to the #VIEW_CONTROLS instance used in the panel.
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
void SetCenter(const VECTOR2D &aCenter)
Set the center point of the VIEW (i.e.
Definition: view.cpp:578
virtual KIGFX::VIEW * GetView() const
Return a pointer to the #VIEW instance used in the panel.
virtual void SetCrossHairCursorPosition(const VECTOR2D &aPosition, bool aWarpView=true)=0
Move the graphic crosshair cursor to the requested position expressed in world coordinates.
E_SERIE r
Definition: eserie.cpp:41
std::vector< wxWindow * > findDialogs()

References EDA_DRAW_FRAME::findDialogs(), EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetView(), EDA_DRAW_PANEL_GAL::GetViewControls(), KIGFX::VIEW::GetViewport(), r, KIGFX::VIEW::SetCenter(), and KIGFX::VIEW_CONTROLS::SetCrossHairCursorPosition().

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_SELECTION_TOOL::FindItem(), SCH_EDITOR_CONTROL::FindNext(), SCH_EDIT_FRAME::FocusOnItem(), PCB_BASE_FRAME::FocusOnItems(), and DIALOG_FIND::search().

◆ Get3DViewerFrame()

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

Definition at line 99 of file pcb_base_frame.cpp.

100 {
101  wxWindow* frame = FindWindowByName( QUALIFIED_VIEWER3D_FRAMENAME( this ) );
102  return dynamic_cast<EDA_3D_VIEWER_FRAME*>( frame );
103 }
#define QUALIFIED_VIEWER3D_FRAMENAME(parent)

References QUALIFIED_VIEWER3D_FRAMENAME.

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

◆ GetAboutTitle()

const wxString& EDA_BASE_FRAME::GetAboutTitle ( ) const
inlineinherited

◆ GetActiveLayer()

virtual PCB_LAYER_ID PCB_BASE_FRAME::GetActiveLayer ( ) const
inlinevirtualinherited

Definition at line 363 of file pcb_base_frame.h.

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

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

Referenced by DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::buildFilterLists(), CONVERT_TOOL::CreateLines(), CONVERT_TOOL::CreatePolys(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_BASE_FRAME::GetCollectorsGuide(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectDRCError(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_CONTROL::LayerNext(), PCB_CONTROL::LayerPrev(), PCB_CONTROL::LayerToggle(), ROUTER_TOOL::MainLoop(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::OnAddField(), DIALOG_FOOTPRINT_PROPERTIES::OnAddField(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::OnLayerChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_DRAW_PANEL_GAL::OnShow(), FOOTPRINT_EDIT_FRAME::OnUpdateLayerSelectBox(), PCB_EDIT_FRAME::OnUpdateLayerSelectBox(), DRAWING_TOOL::PlaceCharacteristics(), DRAWING_TOOL::PlaceStackup(), DRAWING_TOOL::PlaceText(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), and ROUTER_TOOL::switchLayerOnViaPlacement().

◆ GetAutoSaveFilePrefix()

static wxString EDA_BASE_FRAME::GetAutoSaveFilePrefix ( )
inlinestaticprotectedinherited

◆ GetAutoSaveInterval()

int EDA_BASE_FRAME::GetAutoSaveInterval ( ) const
inlineinherited

Definition at line 204 of file eda_base_frame.h.

204 { return m_autoSaveInterval; }

References EDA_BASE_FRAME::m_autoSaveInterval.

◆ GetAuxOrigin()

const wxPoint & PCB_BASE_FRAME::GetAuxOrigin ( ) const
inherited

Definition at line 483 of file pcb_base_frame.cpp.

484 {
486 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:590
const wxPoint & GetAuxOrigin()

References BOARD_DESIGN_SETTINGS::GetAuxOrigin(), BOARD::GetDesignSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::GetUserOrigin().

◆ GetBoard()

BOARD* PCB_BASE_FRAME::GetBoard ( ) const
inlineinherited

Definition at line 207 of file pcb_base_frame.h.

208  {
209  wxASSERT( m_pcb );
210  return m_pcb;
211  }

References PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::AddFootprintToBoard(), AddFootprintToPCB(), DIALOG_PLOT::applyPlotSettings(), GRID_CELL_LAYER_SELECTOR::BeginEdit(), DIALOG_BOARD_REANNOTATE::BuildFootprintList(), FOOTPRINT_EDIT_FRAME::CanCloseFPFromBoard(), FOOTPRINT_EDIT_FRAME::canCloseWindow(), FOOTPRINT_EDITOR_CONTROL::CheckFootprint(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::ClearModify(), ClickOnFootprintList(), PCB_BASE_FRAME::Compile_Ratsnest(), DIALOG_GEN_FOOTPRINT_POSITION::CreateAsciiFiles(), DIALOG_GEN_FOOTPRINT_POSITION::CreateGerberFiles(), CreateHeaderInfoData(), CONVERT_TOOL::CreateLines(), PCB_BASE_FRAME::CreateNewFootprint(), ZONE_CREATE_HELPER::createNewZone(), DIALOG_PRINT_PCBNEW::createPrintout(), PANEL_FP_EDITOR_COLOR_SETTINGS::createSwatches(), PANEL_PCBNEW_COLOR_SETTINGS::createSwatches(), FOOTPRINT_EDITOR_CONTROL::CutCopyFootprint(), PCB_CONTROL::DeleteItemCursor(), DIALOG_BOARD_SETUP::DIALOG_BOARD_SETUP(), DIALOG_BOARD_STATISTICS::DIALOG_BOARD_STATISTICS(), DIALOG_DIMENSION_PROPERTIES::DIALOG_DIMENSION_PROPERTIES(), DIALOG_DRC::DIALOG_DRC(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_NET_INSPECTOR::DIALOG_NET_INSPECTOR(), DIALOG_PAD_PROPERTIES::DIALOG_PAD_PROPERTIES(), DIALOG_RULE_AREA_PROPERTIES::DIALOG_RULE_AREA_PROPERTIES(), DIALOG_SWAP_LAYERS::DIALOG_SWAP_LAYERS(), DIALOG_TEXT_PROPERTIES::DIALOG_TEXT_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), APPEARANCE_CONTROLS::doApplyLayerPreset(), PCB_EDIT_FRAME::doAutoSave(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), PCB_EDIT_FRAME::DoGenFootprintsPositionFile(), PCB_EDIT_FRAME::DoGenFootprintsReport(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), ROUTER_TOOL::DpDimensionsDialog(), GRID_CELL_LAYER_RENDERER::Draw(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawSpecificationStackup(), DRAWING_TOOL::DrawVia(), EDIT_TOOL::Duplicate(), PCB_EDIT_FRAME::Edit_Zone_Params(), DIALOG_COPPER_ZONE::ensureSelectedNetIsVisible(), VIA_SIZE_MENU::eventHandler(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExchangeFootprint(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_EDITOR_CONTROL::ExportFootprint(), PCB_EDIT_FRAME::ExportFootprintsToLibrary(), DIALOG_COPPER_ZONE::ExportSetupToOtherCopperZones(), BOARD_EDITOR_CONTROL::ExportSpecctraDSN(), PCB_EDIT_FRAME::ExportToGenCAD(), PCB_EDIT_FRAME::ExportVRML_File(), PCB_EDIT_FRAME::Files_io_from_id(), PCB_BASE_FRAME::FocusOnItems(), FOOTPRINT_VIEWER_FRAME(), PCB_EDIT_FRAME::GenD356File(), PCB_EDIT_FRAME::GenFootprintsReport(), GetBoard(), EDA_3D_VIEWER_FRAME::GetBoard(), VECTOR_DRC_ITEMS_PROVIDER::GetCount(), DIALOG_BOARD_STATISTICS::getDataFromPCB(), PCB_BASE_EDIT_FRAME::GetDesignRulesPath(), FOOTPRINT_EDIT_FRAME::GetDesignSettings(), FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), PCB_LAYER_BOX_SELECTOR::getEnabledLayers(), DISPLAY_FOOTPRINTS_FRAME::GetFootprint(), PCB_BASE_FRAME::GetItem(), PCB_LAYER_SELECTOR::getLayerName(), PCB_LAYER_BOX_SELECTOR::getLayerName(), FOOTPRINT_EDIT_FRAME::GetLoadedFPID(), FOOTPRINT_EDIT_FRAME::GetModel(), GetModel(), FOOTPRINT_WIZARD_FRAME::GetModel(), DISPLAY_FOOTPRINTS_FRAME::GetModel(), PCB_BASE_FRAME::GetSeverity(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), GRID_CELL_LAYER_SELECTOR::GetValue(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), PCB_EDITOR_CONDITIONS::hasItemsFunc(), FOOTPRINT_EDITOR_CONTROL::ImportFootprint(), FOOTPRINT_EDIT_FRAME::ImportFootprint(), BOARD_EDITOR_CONTROL::ImportSpecctraSession(), EDIT_TOOL::Init(), DIALOG_PLOT::init_Dialog(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), BOARD_INSPECTION_TOOL::InspectClearance(), BOARD_INSPECTION_TOOL::InspectConstraints(), BOARD_INSPECTION_TOOL::InspectDRCError(), ARRAY_CREATOR::Invoke(), FOOTPRINT_EDIT_FRAME::IsContentModified(), FOOTPRINT_EDIT_FRAME::IsCurrentFPFromBoard(), PCB_LAYER_SELECTOR::isLayerEnabled(), PCB_LAYER_BOX_SELECTOR::isLayerEnabled(), PCB_EDIT_FRAME::KiwayMailIn(), LoadBoard(), FOOTPRINT_EDIT_FRAME::LoadFootprintFromBoard(), DIALOG_NETLIST_IMPORT::loadNetlist(), PCB_EDIT_FRAME::LoadProjectSettings(), DIALOG_DRC::OnActivateDlg(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), DIALOG_NET_INSPECTOR::onBoardChanged(), APPEARANCE_CONTROLS::OnBoardChanged(), DIALOG_IMPORT_SETTINGS::OnBrowseClicked(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_DRC::OnDRCItemSelected(), DIALOG_EXPORT_STEP::onExportButton(), PCB_EDIT_FRAME::OnExportIDF3(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_EDIT_FRAME::OnExportVRML(), APPEARANCE_CONTROLS::OnLayerContextMenu(), PCB_BASE_FRAME::OnModify(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_PLOT::OnOutputDirectoryBrowseClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnOutputDirectoryBrowseClicked(), PANEL_SETUP_RULES::onScintillaCharAdded(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), OnUpdateFootprintButton(), FOOTPRINT_EDIT_FRAME::OnUpdateLoadFootprintFromBoard(), FOOTPRINT_EDIT_FRAME::OnUpdateSaveFootprintToBoard(), PCB_EDIT_FRAME::OpenProjectFiles(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), PANEL_SETUP_CONSTRAINTS::PANEL_SETUP_CONSTRAINTS(), PANEL_SETUP_LAYERS::PANEL_SETUP_LAYERS(), PANEL_SETUP_MASK_AND_PASTE::PANEL_SETUP_MASK_AND_PASTE(), PANEL_SETUP_TEXT_AND_GRAPHICS::PANEL_SETUP_TEXT_AND_GRAPHICS(), PANEL_SETUP_TRACKS_AND_VIAS::PANEL_SETUP_TRACKS_AND_VIAS(), PCB_CONTROL::Paste(), DIALOG_UPDATE_PCB::PerformUpdate(), DRAWING_TOOL::PlaceImportedGraphics(), DIALOG_PLOT::Plot(), ROUTER_TOOL::prepareInteractive(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::processItem(), DIALOG_EXCHANGE_FOOTPRINTS::processMatchingFootprints(), FOOTPRINT_EDITOR_CONTROL::Properties(), EDIT_TOOL::Properties(), DIALOG_COPPER_ZONE::readNetInformation(), BOARD_REANNOTATE_TOOL::ReannotateDuplicates(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildLayerContextMenu(), APPEARANCE_CONTROLS::rebuildLayers(), APPEARANCE_CONTROLS::rebuildNets(), PCB_EDIT_FRAME::RecreateCmpFileFromBoard(), Refresh(), DIALOG_PLOT::reInitDialog(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), BOARD_INSPECTION_TOOL::reportClearance(), DRC_TOOL::Reset(), PCB_EDIT_FRAME::RunActionPlugin(), DIALOG_FOOTPRINT_CHECKER::runChecks(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), PCB_EDIT_FRAME::SaveProjectSettings(), DIALOG_BOARD_STATISTICS::saveReportClicked(), DIALOG_FIND::search(), SelectAndViewFootprint(), PCB_BASE_FRAME::SelectOneLayer(), DIALOG_GLOBAL_DELETION::SetCurrentLayer(), APPEARANCE_CONTROLS::SetObjectVisible(), DIALOG_PLOT::SetPlotFormat(), VECTOR_DRC_ITEMS_PROVIDER::SetSeverities(), ZONE_SETTINGS::SetupLayersList(), FOOTPRINT_EDIT_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), APPEARANCE_CONTROLS::showNetclass(), DIALOG_COPPER_ZONE::sortNetsByPadCount(), GLOBAL_EDIT_TOOL::SwapLayers(), PCB_EDIT_FRAME::SwitchLayer(), DIALOG_SWAP_LAYERS::TransferDataFromWindow(), DIALOG_UNUSED_PAD_LAYERS::TransferDataFromWindow(), DIALOG_TRACK_VIA_PROPERTIES::TransferDataFromWindow(), PANEL_SETUP_RULES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_SWAP_LAYERS::TransferDataToWindow(), DIALOG_DIMENSION_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), DIALOG_BOARD_STATISTICS::updateDrillGrid(), PCB_CONTROL::UpdateMessagePanel(), DISPLAY_FOOTPRINTS_FRAME::UpdateMsgPanel(), FOOTPRINT_WIZARD_FRAME::UpdateMsgPanel(), DRC_TOOL::updatePointers(), FOOTPRINT_EDIT_FRAME::UpdateTitle(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), DIALOG_DRC::writeReport(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetBoardBoundingBox()

EDA_RECT PCB_BASE_FRAME::GetBoardBoundingBox ( bool  aBoardEdgesOnly = false) const
inherited

Calculate the bounding box containing all board items (or board edge segments).

Parameters
aBoardEdgesOnlyis true if we are interested in board edge segments only.
Returns
the board's bounding box.

Definition at line 560 of file pcb_base_frame.cpp.

561 {
562  EDA_RECT area = aBoardEdgesOnly ? m_pcb->GetBoardEdgesBoundingBox() : m_pcb->GetBoundingBox();
563 
564  if( area.GetWidth() == 0 && area.GetHeight() == 0 )
565  {
566  wxSize pageSize = GetPageSizeIU();
567 
569  {
570  area.SetOrigin( 0, 0 );
571  area.SetEnd( pageSize.x, pageSize.y );
572  }
573  else
574  {
575  area.SetOrigin( -pageSize.x / 2, -pageSize.y / 2 );
576  area.SetEnd( pageSize.x / 2, pageSize.y / 2 );
577  }
578  }
579 
580  return area;
581 }
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: board.h:724
const EDA_RECT GetBoardEdgesBoundingBox() const
Return the board bounding box calculated using exclusively the board edges (graphics on Edge....
Definition: board.h:738
int GetWidth() const
Definition: eda_rect.h:118
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:130
bool m_showBorderAndTitleBlock
void SetEnd(int x, int y)
Definition: eda_rect.h:191
int GetHeight() const
Definition: eda_rect.h:119
Handle the component boundary box.
Definition: eda_rect.h:42
const wxSize GetPageSizeIU() const override
Works off of GetPageSettings() to return the size of the paper page in the internal units of this par...

References BOARD::GetBoardEdgesBoundingBox(), BOARD::GetBoundingBox(), EDA_RECT::GetHeight(), PCB_BASE_FRAME::GetPageSizeIU(), EDA_RECT::GetWidth(), PCB_BASE_FRAME::m_pcb, EDA_DRAW_FRAME::m_showBorderAndTitleBlock, EDA_RECT::SetEnd(), and EDA_RECT::SetOrigin().

Referenced by FOOTPRINT_EDIT_FRAME::GetDocumentExtents(), and PCB_BASE_FRAME::GetDocumentExtents().

◆ GetCanvas()

PCB_DRAW_PANEL_GAL * PCB_BASE_FRAME::GetCanvas ( ) const
overridevirtualinherited

Return a pointer to GAL-based canvas of given EDA draw frame.

Returns
Pointer to GAL-based canvas.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 911 of file pcb_base_frame.cpp.

912 {
913  return static_cast<PCB_DRAW_PANEL_GAL*>( EDA_DRAW_FRAME::GetCanvas() );
914 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

Referenced by PCB_BASE_EDIT_FRAME::ActivateGalCanvas(), FOOTPRINT_EDIT_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::ActivateGalCanvas(), AddFootprintToPCB(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), DIALOG_NET_INSPECTOR::buildNetsList(), ClickOnFootprintList(), FOOTPRINT_WIZARD_FRAME::ClickOnPageList(), FOOTPRINT_EDIT_FRAME::CommonSettingsChanged(), PCB_BASE_FRAME::CommonSettingsChanged(), DIALOG_PRINT_PCBNEW::createPrintout(), PCB_CONTROL::DeleteItemCursor(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), PCB_BASE_FRAME::DisplayGridMsg(), APPEARANCE_CONTROLS::doApplyLayerPreset(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), BOARD_INSPECTION_TOOL::doHideNet(), PCB_TOOL_BASE::doInteractiveItemPlacement(), EDIT_TOOL::doMoveSelection(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), MICROWAVE_TOOL::drawMicrowaveInductor(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), DRAWING_TOOL::DrawZone(), PCB_EDIT_FRAME::Edit_Zone_Params(), PAD_TOOL::EnumeratePads(), DIALOG_DRC::ExcludeMarker(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), PCB_SELECTION_TOOL::FindItem(), ROUTER_TOOL::finishInteractive(), PCB_CONTROL::FlipPcbView(), PCB_BASE_FRAME::FocusOnItems(), FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetCollectorsGuide(), APPEARANCE_CONTROLS::getVisibleLayers(), APPEARANCE_CONTROLS::getVisibleObjects(), ROUTER_TOOL::handleLayerSwitch(), FOOTPRINT_EDIT_FRAME::HardRedraw(), EDIT_TOOL::Init(), DISPLAY_FOOTPRINTS_FRAME::InitDisplay(), ROUTER_TOOL::InlineDrag(), DRAWING_TOOL::InteractivePlaceWithPreview(), PCB_CONTROL::LayerAlphaDec(), PCB_CONTROL::LayerAlphaInc(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_BASE_FRAME::LoadSettings(), PCB_PICKER_TOOL::Main(), CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL::Main(), ROUTER_TOOL::MainLoop(), LENGTH_TUNER_TOOL::MainLoop(), PCB_VIEWER_TOOLS::MeasureTool(), DIALOG_BOARD_REANNOTATE::OnApplyClick(), APPEARANCE_CONTROLS::OnColorSwatchChanged(), DIALOG_NET_INSPECTOR::onDeleteNet(), DIALOG_DRC::OnDRCItemRClick(), PCB_SELECTION_TOOL::OnIdle(), APPEARANCE_CONTROLS::OnLayerAlphaChanged(), APPEARANCE_CONTROLS::OnLayerContextMenu(), APPEARANCE_CONTROLS::onLayerVisibilityToggled(), DIALOG_GROUP_PROPERTIES::OnMemberSelected(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetColorMode(), APPEARANCE_CONTROLS::onNetContextMenu(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), DIALOG_EXCHANGE_FOOTPRINTS::OnOKClicked(), APPEARANCE_CONTROLS::onRatsnestMode(), DIALOG_GROUP_PROPERTIES::OnRemoveMember(), DIALOG_NET_INSPECTOR::onRenameNet(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_CLEANUP_TRACKS_AND_VIAS::OnSelectItem(), DIALOG_CLEANUP_GRAPHICS::OnSelectItem(), DIALOG_FOOTPRINT_CHECKER::OnSelectItem(), DIALOG_NET_INSPECTOR::onSortingChanged(), FOOTPRINT_TREE_PANE::onUpdateUI(), PCB_EDIT_FRAME::OpenProjectFiles(), BOARD_EDITOR_CONTROL::PageSettings(), ROUTER_TOOL::performRouting(), LENGTH_TUNER_TOOL::performTuning(), BOARD_EDITOR_CONTROL::PlaceFootprint(), DRAWING_TOOL::PlaceImportedGraphics(), BOARD_EDITOR_CONTROL::PlaceTarget(), DRAWING_TOOL::PlaceText(), DIALOG_PAD_PROPERTIES::prepareCanvas(), ROUTER_TOOL::prepareInteractive(), PCB_EDIT_FRAME::Process_Special_Functions(), FOOTPRINT_EDITOR_CONTROL::Properties(), EDIT_TOOL::Properties(), BOARD_COMMIT::Push(), DIALOG_BOARD_REANNOTATE::ReannotateBoard(), NET_GRID_TABLE::Rebuild(), APPEARANCE_CONTROLS::rebuildNets(), ReCreateLibraryList(), FOOTPRINT_WIZARD_FRAME::ReCreatePageList(), Refresh(), refreshCallback(), DIALOG_FOOTPRINT_CHECKER::refreshEditor(), DIALOG_DRC::refreshEditor(), FOOTPRINT_WIZARD_FRAME::ReloadFootprint(), PCB_SELECTION_TOOL::RequestSelection(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), DIALOG_FOOTPRINT_CHECKER::runChecks(), DRC_TOOL::RunTests(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), SaveSettings(), DIALOG_FIND::search(), PCB_SELECTION_TOOL::SelectAll(), SelectAndViewFootprint(), PCB_SELECTION_TOOL::selectMultiple(), DRAWING_TOOL::SetAnchor(), PCB_BASE_EDIT_FRAME::SetBoard(), PCB_BASE_FRAME::SetDisplayOptions(), PCB_POINT_EDITOR::setEditedPoint(), APPEARANCE_CONTROLS::SetLayerVisible(), APPEARANCE_CONTROLS::SetObjectVisible(), FOOTPRINT_EDIT_FRAME::setupTools(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleLayers(), APPEARANCE_CONTROLS::setVisibleObjects(), GLOBAL_EDIT_TOOL::swapBoardItem(), GLOBAL_EDIT_TOOL::SwapLayers(), FOOTPRINT_EDIT_FRAME::SwitchCanvas(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), PCB_EDIT_FRAME::Tracks_and_Vias_Size_Event(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES::TransferDataFromWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), NET_GRID_TABLE::updateNetColor(), PCB_BASE_FRAME::UpdateStatusBar(), DISPLAY_FOOTPRINTS_FRAME::updateView(), FOOTPRINT_WIZARD_FRAME::updateView(), updateView(), FOOTPRINT_EDIT_FRAME::UpdateView(), PCB_SELECTION_TOOL::zoomFitSelection(), DIALOG_GROUP_PROPERTIES::~DIALOG_GROUP_PROPERTIES(), DIALOG_NET_INSPECTOR::~DIALOG_NET_INSPECTOR(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB(), DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME(), ~FOOTPRINT_VIEWER_FRAME(), FOOTPRINT_WIZARD_FRAME::~FOOTPRINT_WIZARD_FRAME(), PCB_BASE_EDIT_FRAME::~PCB_BASE_EDIT_FRAME(), and PCB_BASE_FRAME::~PCB_BASE_FRAME().

◆ GetCollectorsGuide()

GENERAL_COLLECTORS_GUIDE PCB_BASE_FRAME::GetCollectorsGuide ( )
inherited
Returns
global configuration options.

Definition at line 677 of file pcb_base_frame.cpp.

678 {
680  GetCanvas()->GetView() );
681 
682  // account for the globals
684  guide.SetIgnoreMTextsOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT ) );
685  guide.SetIgnoreMTextsOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_TEXT ) );
686  guide.SetIgnoreModulesOnBack( ! m_pcb->IsElementVisible( LAYER_MOD_BK ) );
687  guide.SetIgnoreModulesOnFront( ! m_pcb->IsElementVisible( LAYER_MOD_FR ) );
688  guide.SetIgnorePadsOnBack( ! m_pcb->IsElementVisible( LAYER_PAD_BK ) );
689  guide.SetIgnorePadsOnFront( ! m_pcb->IsElementVisible( LAYER_PAD_FR ) );
690  guide.SetIgnoreThroughHolePads( ! m_pcb->IsElementVisible( LAYER_PADS_TH ) );
691  guide.SetIgnoreModulesVals( ! m_pcb->IsElementVisible( LAYER_MOD_VALUES ) );
692  guide.SetIgnoreModulesRefs( ! m_pcb->IsElementVisible( LAYER_MOD_REFERENCES ) );
693  guide.SetIgnoreThroughVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
694  guide.SetIgnoreBlindBuriedVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
695  guide.SetIgnoreMicroVias( ! m_pcb->IsElementVisible( LAYER_VIAS ) );
696  guide.SetIgnoreTracks( ! m_pcb->IsElementVisible( LAYER_TRACKS ) );
697 
698  return guide;
699 }
smd pads, front layer
Definition: layer_ids.h:209
show footprints values (when texts are visible)
Definition: layer_ids.h:217
PCB_DRAW_PANEL_GAL * GetCanvas() const override
Return a pointer to GAL-based canvas of given EDA draw frame.
smd pads, back layer
Definition: layer_ids.h:210
LSET GetVisibleLayers() const
A proxy function that calls the correspondent function in m_BoardSettings.
Definition: board.cpp:481
show footprints on back
Definition: layer_ids.h:216
virtual PCB_LAYER_ID GetActiveLayer() const
Meta control for all vias opacity/visibility.
Definition: layer_ids.h:200
text marked as invisible
Definition: layer_ids.h:207
show footprints on front
Definition: layer_ids.h:215
void SetIgnoreMTextsMarkedNoShow(bool ignore)
Definition: collectors.h:499
virtual KIGFX::PCB_VIEW * GetView() const override
Return a pointer to the #VIEW instance used in the panel.
bool IsElementVisible(GAL_LAYER_ID aLayer) const
Test whether a given element category is visible.
Definition: board.cpp:533
show footprints references (when texts are visible)
Definition: layer_ids.h:218
multilayer pads, usually with holes
Definition: layer_ids.h:220
A general implementation of a COLLECTORS_GUIDE.
Definition: collectors.h:377

References PCB_BASE_FRAME::GetActiveLayer(), PCB_BASE_FRAME::GetCanvas(), PCB_DRAW_PANEL_GAL::GetView(), BOARD::GetVisibleLayers(), BOARD::IsElementVisible(), LAYER_MOD_BK, LAYER_MOD_FR, LAYER_MOD_REFERENCES, LAYER_MOD_TEXT, LAYER_MOD_TEXT_INVISIBLE, LAYER_MOD_VALUES, LAYER_PAD_BK, LAYER_PAD_FR, LAYER_PADS_TH, LAYER_TRACKS, LAYER_VIAS, PCB_BASE_FRAME::m_pcb, and GENERAL_COLLECTORS_GUIDE::SetIgnoreMTextsMarkedNoShow().

Referenced by PCB_CONTROL::DeleteItemCursor(), PAD_TOOL::EnumeratePads(), and BOARD_INSPECTION_TOOL::highlightNet().

◆ GetColorSettings()

COLOR_SETTINGS * FOOTPRINT_VIEWER_FRAME::GetColorSettings ( ) const
overridevirtual

Helper to retrieve the current color settings.

Returns
a pointer to the active COLOR_SETTINGS.

Reimplemented from PCB_BASE_FRAME.

Definition at line 819 of file footprint_viewer_frame.cpp.

820 {
821  auto* settings = Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
822 
823  if( settings )
824  return Pgm().GetSettingsManager().GetColorSettings( settings->m_ColorTheme );
825  else
826  return Pgm().GetSettingsManager().GetColorSettings();
827 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References Pgm().

Referenced by GetGridColor().

◆ getCurFootprintName()

const wxString FOOTPRINT_VIEWER_FRAME::getCurFootprintName ( )
private

Definition at line 851 of file footprint_viewer_frame.cpp.

852 {
854 }
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
Definition: project.cpp:227

References PROJECT::GetRString(), PROJECT::PCB_FOOTPRINT_VIEWER_FP_NAME, and KIWAY_HOLDER::Prj().

Referenced by ClickOnFootprintList(), FOOTPRINT_VIEWER_FRAME(), ReCreateFootprintList(), SelectAndViewFootprint(), and Update3DView().

◆ getCurNickname()

const wxString FOOTPRINT_VIEWER_FRAME::getCurNickname ( )
private

Definition at line 839 of file footprint_viewer_frame.cpp.

840 {
842 }
PROJECT & Prj() const
Return a reference to the PROJECT associated with this KIWAY.
virtual const wxString & GetRString(RSTRING_T aStringId)
Return a "retained string", which is any session and project specific string identified in enum RSTRI...
Definition: project.cpp:227

References PROJECT::GetRString(), PROJECT::PCB_FOOTPRINT_VIEWER_LIB_NICKNAME, and KIWAY_HOLDER::Prj().

Referenced by AddFootprintToPCB(), ClickOnFootprintList(), ClickOnLibList(), FOOTPRINT_VIEWER_FRAME(), ReCreateFootprintList(), ReCreateLibraryList(), SelectAndViewFootprint(), and UpdateTitle().

◆ GetCurrentFileName()

virtual wxString EDA_BASE_FRAME::GetCurrentFileName ( ) const
inlinevirtualinherited

Get the full filename + path of the currently opened file in the frame.

If no file is open, an empty string is returned.

Returns
the filename and full path to the open file

Reimplemented in PCB_EDIT_FRAME, SCH_EDIT_FRAME, PL_EDITOR_FRAME, and KICAD_MANAGER_FRAME.

Definition at line 439 of file eda_base_frame.h.

439 { return wxEmptyString; }

Referenced by EDA_BASE_FRAME::SaveSettings().

◆ GetCurrentSelection()

SELECTION & FOOTPRINT_VIEWER_FRAME::GetCurrentSelection ( )
overridevirtual

Get the current selection from the canvas area.

Returns
the current selection.

Reimplemented from TOOLS_HOLDER.

Definition at line 313 of file footprint_viewer_frame.cpp.

314 {
315  return m_toolManager->GetTool<PCB_SELECTION_TOOL>()->GetSelection();
316 }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
The selection tool: currently supports:

References TOOL_MANAGER::GetTool(), and TOOLS_HOLDER::m_toolManager.

◆ GetDesignSettings()

◆ GetDisplayOptions()

const PCB_DISPLAY_OPTIONS& PCB_BASE_FRAME::GetDisplayOptions ( ) const
inlineinherited

Display options control the way tracks, vias, outlines and other things are shown (for instance solid or sketch mode).

Definition at line 180 of file pcb_base_frame.h.

180 { return m_displayOptions; }
PCB_DISPLAY_OPTIONS m_displayOptions

References PCB_BASE_FRAME::m_displayOptions.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), PCB_VIEWER_TOOLS::displayOptions(), PCB_TOOL_BASE::displayOptions(), EDIT_TOOL::doMoveSelection(), PAD_TOOL::EditPad(), PCB_BASE_FRAME::GetUserOrigin(), PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc(), BOARD_INSPECTION_TOOL::HighlightItem(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onNetColorMode(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), APPEARANCE_CONTROLS::onRatsnestMode(), PCB_DRAW_PANEL_GAL::OnShow(), PCB_EDITOR_CONDITIONS::padFillDisplayFunc(), PCB_EDITOR_CONDITIONS::padNumberDisplayFunc(), PCB_DRAW_PANEL_GAL::PCB_DRAW_PANEL_GAL(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_EDIT_FRAME::Process_Special_Functions(), BOARD_COMMIT::Push(), PAD_TOOL::Reset(), PCB_EDIT_FRAME::SaveProjectSettings(), DISPLAY_FOOTPRINTS_FRAME::SaveSettings(), PCB_SELECTION_TOOL::selectPoint(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_BASE_FRAME::SwitchLayer(), PCB_EDIT_FRAME::SwitchLayer(), APPEARANCE_CONTROLS::syncObjectSettings(), PCB_EDITOR_CONDITIONS::textFillDisplayFunc(), PCB_EDITOR_CONDITIONS::trackFillDisplayFunc(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataToWindow(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataToWindow(), PANEL_EDIT_OPTIONS::TransferDataToWindow(), APPEARANCE_CONTROLS::UpdateDisplayOptions(), PCB_EDITOR_CONDITIONS::viaFillDisplayFunc(), and PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc().

◆ GetDocumentExtents()

const BOX2I PCB_BASE_FRAME::GetDocumentExtents ( bool  aIncludeAllVisible = true) const
inlineoverridevirtualinherited

Returns bbox of document with option to not include some items.

Used most commonly by "Zoom to Fit" and "Zoom to Objects". In Eeschema for "Zoom to Fit" it's passed "true" to include drawing sheet border, and "false" by "Zoom To Objects" to ignore drawing sheet border. In Pcbnew, false makes it ignore any items outside the PCB edge such as fabrication notes.

Parameters
aIncludeAllVisibleTrue to include everything visible in bbox calculations, false to ignore some visible items (program dependent).
Returns
Bounding box of the document (ignoring some items as requested).

Reimplemented from EDA_DRAW_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 115 of file pcb_base_frame.h.

116  {
117  /* "Zoom to Fit" calls this with "aIncludeAllVisible" as true. Since that feature
118  * always ignored the page and border, this function returns a bbox without them
119  * as well when passed true. This technically is not all things visible, but it
120  * keeps behavior consistent.
121  *
122  * When passed false, this function returns a bbox of just the board edge. This
123  * allows things like fabrication text or anything else outside the board edge to
124  * be ignored, and just zooms up to the board itself.
125  *
126  * Calling "GetBoardBoundingBox(true)" when edge cuts are turned off will return
127  * the entire page and border, so we call "GetBoardBoundingBox(false)" instead.
128  */
129  if( aIncludeAllVisible || !m_pcb->IsLayerVisible( Edge_Cuts ) )
130  return GetBoardBoundingBox( false );
131  else
132  return GetBoardBoundingBox( true );
133  }
EDA_RECT GetBoardBoundingBox(bool aBoardEdgesOnly=false) const
Calculate the bounding box containing all board items (or board edge segments).
bool IsLayerVisible(PCB_LAYER_ID aLayer) const
A proxy function that calls the correspondent function in m_BoardSettings tests whether a given layer...
Definition: board.cpp:473

References Edge_Cuts, PCB_BASE_FRAME::GetBoardBoundingBox(), BOARD::IsLayerVisible(), and PCB_BASE_FRAME::m_pcb.

◆ GetDoImmediateActions()

bool TOOLS_HOLDER::GetDoImmediateActions ( ) const
inlineinherited

Indicate that hotkeys should perform an immediate action even if another tool is currently active.

If false, the first hotkey should select the relevant tool.

Definition at line 129 of file tools_holder.h.

129 { return m_immediateActions; }
bool m_immediateActions
Definition: tools_holder.h:171

References TOOLS_HOLDER::m_immediateActions.

◆ GetDragAction()

MOUSE_DRAG_ACTION TOOLS_HOLDER::GetDragAction ( ) const
inlineinherited

Indicates whether a drag should draw a selection rectangle or drag selected (or unselected) objects.

Definition at line 135 of file tools_holder.h.

135 { return m_dragAction; }
MOUSE_DRAG_ACTION m_dragAction
Definition: tools_holder.h:175

References TOOLS_HOLDER::m_dragAction.

Referenced by PL_SELECTION_TOOL::Main(), EE_SELECTION_TOOL::Main(), and PCB_SELECTION_TOOL::Main().

◆ GetDrawBgColor()

virtual COLOR4D EDA_DRAW_FRAME::GetDrawBgColor ( ) const
inlinevirtualinherited

◆ GetFileFromHistory()

wxString EDA_BASE_FRAME::GetFileFromHistory ( int  cmdId,
const wxString &  type,
FILE_HISTORY aFileHistory = nullptr 
)
inherited

Fetches the file name from the file history list.

This removes the selected file, if this file does not exist. The menu is also updated, if #FILE_HISTORY::UseMenu was called at initialization time.

Parameters
cmdIdThe command ID associated with the aFileHistory object.
typePlease document me!
aFileHistoryThe FILE_HISTORY in use. If null, the main application file history is used
Returns
a wxString containing the selected filename

Definition at line 936 of file eda_base_frame.cpp.

938 {
939  if( !aFileHistory )
940  aFileHistory = m_fileHistory;
941 
942  wxASSERT( aFileHistory );
943 
944  int baseId = aFileHistory->GetBaseId();
945 
946  wxASSERT( cmdId >= baseId && cmdId < baseId + (int) aFileHistory->GetCount() );
947 
948  unsigned i = cmdId - baseId;
949 
950  if( i < aFileHistory->GetCount() )
951  {
952  wxString fn = aFileHistory->GetHistoryFile( i );
953 
954  if( wxFileName::FileExists( fn ) )
955  {
956  return fn;
957  }
958  else
959  {
960  DisplayErrorMessage( this, wxString::Format( _( "File '%s' was not found." ), fn ) );
961  aFileHistory->RemoveFileFromHistory( i );
962  }
963  }
964 
965  // Update the menubar to update the file history menu
966  if( GetMenuBar() )
967  {
968  ReCreateMenuBar();
969  GetMenuBar()->Refresh();
970  }
971 
972  return wxEmptyString;
973 }
void DisplayErrorMessage(wxWindow *aParent, const wxString &aText, const wxString &aExtraInfo)
Display an error message with aMessage.
Definition: confirm.cpp:292
#define _(s)
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200
FILE_HISTORY * m_fileHistory
virtual void ReCreateMenuBar()
Recreates the menu bar.

References _, DisplayErrorMessage(), Format(), EDA_BASE_FRAME::m_fileHistory, and EDA_BASE_FRAME::ReCreateMenuBar().

Referenced by GERBVIEW_FRAME::OnDrlFileHistory(), KICAD_MANAGER_FRAME::OnFileHistory(), PL_EDITOR_FRAME::OnFileHistory(), PCB_EDIT_FRAME::OnFileHistory(), GERBVIEW_FRAME::OnGbrFileHistory(), GERBVIEW_FRAME::OnJobFileHistory(), SCH_EDIT_FRAME::OnLoadFile(), and GERBVIEW_FRAME::OnZipFileHistory().

◆ GetFileHistory()

FILE_HISTORY& EDA_BASE_FRAME::GetFileHistory ( )
inlineinherited

Get the frame's main file history.

Returns
the main file history

Definition at line 423 of file eda_base_frame.h.

424  {
425  return *m_fileHistory;
426  }
FILE_HISTORY * m_fileHistory

References EDA_BASE_FRAME::m_fileHistory.

Referenced by KICAD_MANAGER_FRAME::ReCreateMenuBar(), GERBVIEW_FRAME::ReCreateMenuBar(), PL_EDITOR_FRAME::ReCreateMenuBar(), SCH_EDIT_FRAME::ReCreateMenuBar(), and PCB_EDIT_FRAME::ReCreateMenuBar().

◆ GetFindHistoryList()

wxArrayString& EDA_DRAW_FRAME::GetFindHistoryList ( )
inlineinherited

◆ GetFindReplaceData()

wxFindReplaceData& EDA_DRAW_FRAME::GetFindReplaceData ( )
inlineinherited

◆ GetFootprintEditorSettings()

FOOTPRINT_EDITOR_SETTINGS * PCB_BASE_FRAME::GetFootprintEditorSettings ( ) const
inherited

Definition at line 850 of file pcb_base_frame.cpp.

851 {
852  return Pgm().GetSettingsManager().GetAppSettings<FOOTPRINT_EDITOR_SETTINGS>();
853 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References Pgm().

Referenced by FOOTPRINT_WIZARD_FRAME::GetColorSettings(), and FOOTPRINT_EDIT_FRAME::GetColorSettings().

◆ GetFootprintFromBoardByReference()

FOOTPRINT * PCB_BASE_FRAME::GetFootprintFromBoardByReference ( )
inherited
Returns
a reference to the footprint found by its reference on the current board. The reference is entered by the user from a dialog (by awxTextCtlr, or a list of available references)

Definition at line 459 of file load_select_footprint.cpp.

460 {
461  wxString footprintName;
462  wxArrayString fplist;
463 
464  // Build list of available fp references, to display them in dialog
465  for( FOOTPRINT* fp : GetBoard()->Footprints() )
466  fplist.Add( fp->GetReference() + wxT( " ( " ) + fp->GetValue() + wxT( " )" ) );
467 
468  fplist.Sort();
469 
470  DIALOG_GET_FOOTPRINT_BY_NAME dlg( this, fplist );
471 
472  if( dlg.ShowModal() != wxID_OK ) //Aborted by user
473  return nullptr;
474 
475  footprintName = dlg.GetValue();
476  footprintName.Trim( true );
477  footprintName.Trim( false );
478 
479  if( !footprintName.IsEmpty() )
480  {
481  for( FOOTPRINT* fp : GetBoard()->Footprints() )
482  {
483  if( fp->GetReference().CmpNoCase( footprintName ) == 0 )
484  return fp;
485  }
486  }
487 
488  return nullptr;
489 }
DIALOG_GET_FOOTPRINT_BY_NAME is a helper dialog to select a footprint by its reference One can enter ...
FOOTPRINTS & Footprints()
Definition: board.h:234
BOARD * GetBoard() const

References FOOTPRINT::Add(), BOARD::Footprints(), GetBoard(), and DIALOG_GET_FOOTPRINT_BY_NAME::GetValue().

◆ GetFrameType()

FRAME_T EDA_BASE_FRAME::GetFrameType ( ) const
inlineinherited

Definition at line 207 of file eda_base_frame.h.

207 { return m_ident; }

References EDA_BASE_FRAME::m_ident.

◆ GetGalDisplayOptions()

◆ GetGridColor()

COLOR4D FOOTPRINT_VIEWER_FRAME::GetGridColor ( )
overridevirtual

Reimplemented from EDA_DRAW_FRAME.

Definition at line 959 of file footprint_viewer_frame.cpp.

960 {
961  return GetColorSettings()->GetColor( LAYER_GRID );
962 }
COLOR_SETTINGS * GetColorSettings() const override
Helper to retrieve the current color settings.
COLOR4D GetColor(int aLayer) const

References COLOR_SETTINGS::GetColor(), GetColorSettings(), and LAYER_GRID.

◆ GetGridOrigin()

const wxPoint & PCB_BASE_FRAME::GetGridOrigin ( ) const
overridevirtualinherited

Return the absolute coordinates of the origin of the snap grid.

This is treated as a relative offset and snapping will occur at multiples of the grid size relative to this point.

Implements EDA_DRAW_FRAME.

Definition at line 471 of file pcb_base_frame.cpp.

472 {
474 }
const wxPoint & GetGridOrigin()
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:590

References BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::GetGridOrigin(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_BASE_FRAME::GetUserOrigin().

◆ GetInfoBar()

◆ GetItem()

EDA_ITEM * PCB_BASE_FRAME::GetItem ( const KIID aId) const
overridevirtualinherited

Fetch an item by KIID.

Frame-type-specific implementation.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 198 of file pcb_base_frame.cpp.

199 {
200  return GetBoard()->GetItem( aId );
201 }
BOARD_ITEM * GetItem(const KIID &aID) const
Definition: board.cpp:845
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), and BOARD::GetItem().

◆ GetMagneticItemsSettings()

MAGNETIC_SETTINGS* FOOTPRINT_VIEWER_FRAME::GetMagneticItemsSettings ( )
inlineoverridevirtual

Reimplemented from PCB_BASE_FRAME.

Definition at line 57 of file footprint_viewer_frame.h.

58  {
59  return &m_magneticItems;
60  }
MAGNETIC_SETTINGS m_magneticItems

References m_magneticItems.

◆ GetMaxUndoItems()

int EDA_BASE_FRAME::GetMaxUndoItems ( ) const
inlineinherited

Definition at line 582 of file eda_base_frame.h.

582 { return m_undoRedoCountMax; }

References EDA_BASE_FRAME::m_undoRedoCountMax.

Referenced by EDA_DRAW_FRAME::SaveSettings().

◆ GetModel()

BOARD_ITEM_CONTAINER * FOOTPRINT_VIEWER_FRAME::GetModel ( ) const
overridevirtual
Returns
the primary data model.

Implements PCB_BASE_FRAME.

Definition at line 1084 of file footprint_viewer_frame.cpp.

1085 {
1086  return GetBoard()->GetFirstFootprint();
1087 }
FOOTPRINT * GetFirstFootprint() const
Get the first footprint on the board or nullptr.
Definition: board.h:318
BOARD * GetBoard() const

References PCB_BASE_FRAME::GetBoard(), and BOARD::GetFirstFootprint().

◆ GetMoveWarpsCursor()

bool TOOLS_HOLDER::GetMoveWarpsCursor ( ) const
inlineinherited

Indicate that a move operation should warp the mouse pointer to the origin of the move object.

This improves snapping, but some users are allergic to mouse warping.

Definition at line 141 of file tools_holder.h.

141 { return m_moveWarpsCursor; }
bool m_moveWarpsCursor
Definition: tools_holder.h:177

References TOOLS_HOLDER::m_moveWarpsCursor.

Referenced by EDIT_TOOL::doMoveSelection(), ROUTER_TOOL::InlineDrag(), SYMBOL_EDITOR_MOVE_TOOL::Main(), and SCH_MOVE_TOOL::Main().

◆ GetMruPath()

◆ GetNearestGridPosition()

wxPoint EDA_DRAW_FRAME::GetNearestGridPosition ( const wxPoint &  aPosition) const
inherited

Return the nearest aGridSize location to aPosition.

Parameters
aPositionThe position to check.
Returns
The nearest grid position.

Definition at line 795 of file eda_draw_frame.cpp.

796 {
797  const wxPoint& gridOrigin = GetGridOrigin();
798  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize();
799 
800  double xOffset = fmod( gridOrigin.x, gridSize.x );
801  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
802  double yOffset = fmod( gridOrigin.y, gridSize.y );
803  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
804 
805  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
806 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
const VECTOR2D & GetGridSize() const
Return the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SCH_DRAWING_TOOLS::sizeSheet().

◆ GetNearestHalfGridPosition()

wxPoint EDA_DRAW_FRAME::GetNearestHalfGridPosition ( const wxPoint &  aPosition) const
inherited

Return the nearest aGridSize / 2 location to aPosition.

This is useful when attempting for keep outer points on grid but not the middle point.

Parameters
aPositionThe position to check.
Returns
The nearest half-grid position.

Definition at line 809 of file eda_draw_frame.cpp.

810 {
811  const wxPoint& gridOrigin = GetGridOrigin();
812  VECTOR2D gridSize = GetCanvas()->GetGAL()->GetGridSize() / 2.0;
813 
814  double xOffset = fmod( gridOrigin.x, gridSize.x );
815  int x = KiROUND( (aPosition.x - xOffset) / gridSize.x );
816  double yOffset = fmod( gridOrigin.y, gridSize.y );
817  int y = KiROUND( (aPosition.y - yOffset) / gridSize.y );
818 
819  return wxPoint( KiROUND( x * gridSize.x + xOffset ), KiROUND( y * gridSize.y + yOffset ) );
820 }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
virtual const wxPoint & GetGridOrigin() const =0
Return the absolute coordinates of the origin of the snap grid.
const VECTOR2D & GetGridSize() const
Return the grid size.
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:73

References EDA_DRAW_FRAME::GetCanvas(), EDA_DRAW_PANEL_GAL::GetGAL(), EDA_DRAW_FRAME::GetGridOrigin(), KIGFX::GAL::GetGridSize(), KiROUND(), VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by SYMBOL_EDITOR_EDIT_TOOL::Mirror(), SCH_EDIT_TOOL::Mirror(), SYMBOL_EDITOR_EDIT_TOOL::Rotate(), and SCH_EDIT_TOOL::Rotate().

◆ GetOriginTransforms()

ORIGIN_TRANSFORMS & PCB_BASE_FRAME::GetOriginTransforms ( )
overridevirtualinherited

Return a reference to the default ORIGIN_TRANSFORMS object.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 505 of file pcb_base_frame.cpp.

506 {
507  return m_originTransforms;
508 }
PCB_ORIGIN_TRANSFORMS m_originTransforms

References PCB_BASE_FRAME::m_originTransforms.

◆ GetPageSettings()

const PAGE_INFO & PCB_BASE_FRAME::GetPageSettings ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 456 of file pcb_base_frame.cpp.

457 {
458  return m_pcb->GetPageSettings();
459 }
const PAGE_INFO & GetPageSettings() const
Definition: board.h:536

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_CONTROL::Print().

◆ GetPageSizeIU()

const wxSize PCB_BASE_FRAME::GetPageSizeIU ( ) const
overridevirtualinherited

Works off of GetPageSettings() to return the size of the paper page in the internal units of this particular view.

Implements EDA_DRAW_FRAME.

Definition at line 462 of file pcb_base_frame.cpp.

463 {
464  // this function is only needed because EDA_DRAW_FRAME is not compiled
465  // with either -DPCBNEW or -DEESCHEMA, so the virtual is used to route
466  // into an application specific source file.
467  return m_pcb->GetPageSettings().GetSizeIU();
468 }
const PAGE_INFO & GetPageSettings() const
Definition: board.h:536

References BOARD::GetPageSettings(), and PCB_BASE_FRAME::m_pcb.

Referenced by PCB_CONTROL::AppendBoard(), FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetBoardBoundingBox(), and PCB_EDIT_FRAME::OpenProjectFiles().

◆ GetPcbNewSettings()

PCBNEW_SETTINGS * PCB_BASE_FRAME::GetPcbNewSettings ( ) const
inherited

Definition at line 844 of file pcb_base_frame.cpp.

845 {
846  return Pgm().GetSettingsManager().GetAppSettings<PCBNEW_SETTINGS>();
847 }
KIWAY Kiway & Pgm(), KFCTL_STANDALONE
The global Program "get" accessor.
Definition: single_top.cpp:106

References Pgm().

Referenced by DIALOG_COPPER_ZONE::AcceptOptions(), DIALOG_PLOT::applyPlotSettings(), DIALOG_CLEANUP_TRACKS_AND_VIAS::DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_EXPORT_3DFILE::DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::DIALOG_EXPORT_STEP(), DIALOG_FOOTPRINT_PROPERTIES::DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_IMPORT_GFX::DIALOG_IMPORT_GFX(), DIALOG_NETLIST_IMPORT::DIALOG_NETLIST_IMPORT(), DIALOG_UPDATE_PCB::DIALOG_UPDATE_PCB(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), FOOTPRINT_VIEWER_FRAME(), PCB_BASE_EDIT_FRAME::GetColorSettings(), DIALOG_PLOT::init_Dialog(), DIALOG_GENDRILL::initDialog(), DIALOG_EXPORT_SVG::initDialog(), DIALOG_GEN_FOOTPRINT_POSITION::initDialog(), DIALOG_DRC::initValues(), DIALOG_BOARD_REANNOTATE::InitValues(), DIALOG_COPPER_ZONE::loadPersistentNetSortConfigurations(), DIALOG_PRINT_PCBNEW::onColorModeClicked(), DIALOG_GEN_FOOTPRINT_POSITION::OnGenerate(), DIALOG_EXPORT_SVG::onPagePerLayerClicked(), PNS::TOOL_BASE::Reset(), DIALOG_PRINT_PCBNEW::saveSettings(), DIALOG_COPPER_ZONE::storePersistentNetSortConfigurations(), PCB_EDIT_FRAME::ToggleLayersManager(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_NON_COPPER_ZONES_EDITOR::TransferDataFromWindow(), DIALOG_RULE_AREA_PROPERTIES::TransferDataFromWindow(), PANEL_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), DIALOG_GENDRILL::UpdateConfig(), DIALOG_BOARD_REANNOTATE::~DIALOG_BOARD_REANNOTATE(), DIALOG_CLEANUP_TRACKS_AND_VIAS::~DIALOG_CLEANUP_TRACKS_AND_VIAS(), DIALOG_DRC::~DIALOG_DRC(), DIALOG_EXPORT_3DFILE::~DIALOG_EXPORT_3DFILE(), DIALOG_EXPORT_IDF3::~DIALOG_EXPORT_IDF3(), DIALOG_EXPORT_STEP::~DIALOG_EXPORT_STEP(), DIALOG_EXPORT_SVG::~DIALOG_EXPORT_SVG(), DIALOG_FOOTPRINT_PROPERTIES::~DIALOG_FOOTPRINT_PROPERTIES(), DIALOG_IMPORT_GFX::~DIALOG_IMPORT_GFX(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetPlotSettings()

const PCB_PLOT_PARAMS & PCB_BASE_FRAME::GetPlotSettings ( ) const
virtualinherited

Return the PCB_PLOT_PARAMS for the BOARD owned by this frame.

Overloaded in FOOTPRINT_EDIT_FRAME.

Reimplemented in FOOTPRINT_EDIT_FRAME.

Definition at line 548 of file pcb_base_frame.cpp.

549 {
550  return m_pcb->GetPlotOptions();
551 }
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: board.h:539

References BOARD::GetPlotOptions(), and PCB_BASE_FRAME::m_pcb.

Referenced by DIALOG_PLOT::CreateDrillFile(), DIALOG_GENDRILL::DIALOG_GENDRILL(), DIALOG_PLOT::DIALOG_PLOT(), and FOOTPRINT_EDIT_FRAME::GetPlotSettings().

◆ GetRedoCommandCount()

virtual int EDA_BASE_FRAME::GetRedoCommandCount ( ) const
inlinevirtualinherited

◆ GetScreen()

PCB_SCREEN* PCB_BASE_FRAME::GetScreen ( ) const
inlineoverridevirtualinherited

Return a pointer to a BASE_SCREEN or one of its derivatives.

It is overloaded by derived classes to return SCH_SCREEN or PCB_SCREEN.

Reimplemented from EDA_DRAW_FRAME.

Definition at line 229 of file pcb_base_frame.h.

229 { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
virtual BASE_SCREEN * GetScreen() const
Return a pointer to a BASE_SCREEN or one of its derivatives.

References EDA_DRAW_FRAME::GetScreen().

Referenced by FOOTPRINT_EDIT_FRAME::Clear_Pcb(), PCB_EDIT_FRAME::Clear_Pcb(), FOOTPRINT_EDIT_FRAME::ClearModify(), FOOTPRINT_EDITOR_CONTROL::CreateFootprint(), PCB_EDIT_FRAME::doAutoSave(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawVia(), PCB_EDIT_FRAME::Files_io_from_id(), FOOTPRINT_VIEWER_FRAME(), PCB_BASE_FRAME::GetActiveLayer(), FP_TREE_SYNCHRONIZING_ADAPTER::GetAttr(), FP_TREE_SYNCHRONIZING_ADAPTER::GetValue(), ROUTER_TOOL::handleLayerSwitch(), FOOTPRINT_EDIT_FRAME::IsContentModified(), PCB_CONTROL::LayerToggle(), FOOTPRINT_EDITOR_CONTROL::NewFootprint(), PCB_EDIT_FRAME::OnExportSTEP(), PCB_BASE_FRAME::OnModify(), DIALOG_POSITION_RELATIVE::OnUseUserOriginClick(), PCB_EDIT_FRAME::OpenProjectFiles(), PCB_EDIT_FRAME::PrepareLayerIndicator(), FOOTPRINT_EDIT_FRAME::RevertFootprint(), PCB_EDIT_FRAME::SavePcbFile(), DIALOG_FIND::search(), ROUTER_TOOL::SelectCopperLayerPair(), PCB_BASE_FRAME::SetActiveLayer(), PCB_BASE_FRAME::SetPageSettings(), PCB_BASE_FRAME::UpdateStatusBar(), and DISPLAY_FOOTPRINTS_FRAME::~DISPLAY_FOOTPRINTS_FRAME().

◆ GetScreenDesc()

wxString EDA_DRAW_FRAME::GetScreenDesc ( ) const
virtualinherited

Reimplemented in SCH_EDIT_FRAME.

Definition at line 957 of file eda_draw_frame.cpp.

958 {
959  // Virtual function. Base class implementation returns an empty string.
960  return wxEmptyString;
961 }

Referenced by KIGFX::SCH_VIEW::DisplaySheet(), and EDA_DRAW_FRAME::PrintDrawingSheet().

◆ GetSettingsManager()

SETTINGS_MANAGER* EDA_BASE_FRAME::GetSettingsManager ( ) const
inlineinherited

Definition at line 140 of file eda_base_frame.h.

140 { return m_settingsManager; }
SETTINGS_MANAGER * m_settingsManager

References EDA_BASE_FRAME::m_settingsManager.

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), KICAD_MANAGER_FRAME::canCloseWindow(), KICAD_MANAGER_FRAME::CreateNewProject(), PCB_EDIT_FRAME::doAutoSave(), SCH_EDIT_FRAME::doAutoSave(), PCB_BASE_EDIT_FRAME::doCloseWindow(), FOOTPRINT_EDIT_FRAME::doCloseWindow(), PCB_EDIT_FRAME::Files_io_from_id(), DIALOG_PLOT_SCHEMATIC::getColorSettings(), GetSettingsManager(), DIALOG_PLOT_SCHEMATIC::initDlg(), DIALOG_SCHEMATIC_SETUP::OnAuxiliaryAction(), DIALOG_BOARD_SETUP::OnAuxiliaryAction(), SCH_EDIT_FRAME::OnImportProject(), GERBER_LAYER_WIDGET::OnLayerColorChange(), GERBER_LAYER_WIDGET::OnRenderColorChange(), KICAD_MANAGER_FRAME::OnUnarchiveFiles(), PCB_EDIT_FRAME::OpenProjectFiles(), SCH_EDIT_FRAME::OpenProjectFiles(), PANEL_FP_EDITOR_COLOR_SETTINGS::PANEL_FP_EDITOR_COLOR_SETTINGS(), PANEL_PCBNEW_COLOR_SETTINGS::PANEL_PCBNEW_COLOR_SETTINGS(), PCB_EDIT_FRAME::SavePcbCopy(), PCB_EDIT_FRAME::SavePcbFile(), SCH_EDIT_FRAME::SaveProject(), SCH_EDIT_FRAME::SaveProjectSettings(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), PANEL_FP_EDITOR_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_PCBNEW_COLOR_SETTINGS::TransferDataFromWindow(), PANEL_SYM_COLOR_SETTINGS::TransferDataToWindow(), DIALOG_PRINT_PCBNEW::TransferDataToWindow(), and SCH_EDIT_FRAME::~SCH_EDIT_FRAME().

◆ GetSeverity()

SEVERITY PCB_BASE_FRAME::GetSeverity ( int  aErrorCode) const
overridevirtualinherited

Reimplemented from EDA_BASE_FRAME.

Definition at line 818 of file pcb_base_frame.cpp.

819 {
820  if( aErrorCode >= CLEANUP_FIRST )
821  return RPT_SEVERITY_ACTION;
822 
824 
825  return bds.m_DRCSeverities[ aErrorCode ];
826 }
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:590
std::map< int, SEVERITY > m_DRCSeverities
BOARD * GetBoard() const
Container for design settings for a BOARD object.

References CLEANUP_FIRST, PCB_BASE_FRAME::GetBoard(), BOARD::GetDesignSettings(), BOARD_DESIGN_SETTINGS::m_DRCSeverities, and RPT_SEVERITY_ACTION.

◆ GetShowPolarCoords()

bool EDA_DRAW_FRAME::GetShowPolarCoords ( ) const
inlineinherited

For those frames that support polar coordinates.

Definition at line 120 of file eda_draw_frame.h.

120 { return m_polarCoords; }

References EDA_DRAW_FRAME::m_polarCoords.

Referenced by EDITOR_CONDITIONS::polarCoordFunc(), COMMON_TOOLS::TogglePolarCoords(), GERBVIEW_FRAME::UpdateStatusBar(), and PCB_BASE_FRAME::UpdateStatusBar().

◆ GetTitleBlock()

const TITLE_BLOCK & PCB_BASE_FRAME::GetTitleBlock ( ) const
overridevirtualinherited

Implements EDA_DRAW_FRAME.

Definition at line 511 of file pcb_base_frame.cpp.

512 {
513  return m_pcb->GetTitleBlock();
514 }
TITLE_BLOCK & GetTitleBlock()
Definition: board.h:542

References BOARD::GetTitleBlock(), and PCB_BASE_FRAME::m_pcb.

◆ GetToolCanvas()

wxWindow* EDA_DRAW_FRAME::GetToolCanvas ( ) const
inlineoverridevirtualinherited

Canvas access.

Implements TOOLS_HOLDER.

Definition at line 422 of file eda_draw_frame.h.

422 { return GetCanvas(); }
virtual EDA_DRAW_PANEL_GAL * GetCanvas() const
Return a pointer to GAL-based canvas of given EDA draw frame.

References EDA_DRAW_FRAME::GetCanvas().

◆ GetToolManager()

TOOL_MANAGER* TOOLS_HOLDER::GetToolManager ( ) const
inlineinherited

Return the MVC controller.

Definition at line 54 of file tools_holder.h.

54 { return m_toolManager; }
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158

References TOOLS_HOLDER::m_toolManager.

Referenced by PROJECT_TREE_ITEM::Activate(), AddFootprintToPCB(), SYMBOL_EDITOR_CONTROL::AddSymbolToSchematic(), APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), BOARD_COMMIT::BOARD_COMMIT(), ClickOnFootprintList(), TOOLS_HOLDER::CommonSettingsChanged(), DIALOG_FOOTPRINT_CHECKER::deleteAllMarkers(), DIALOG_ERC::deleteAllMarkers(), DIALOG_DRC::deleteAllMarkers(), DIALOG_BOARD_REANNOTATE::DIALOG_BOARD_REANNOTATE(), DIALOG_MIGRATE_BUSES::DIALOG_MIGRATE_BUSES(), PL_DRAW_PANEL_GAL::DisplayDrawingSheet(), DIALOG_CLEANUP_GRAPHICS::doCleanup(), DIALOG_CLEANUP_TRACKS_AND_VIAS::doCleanup(), SIM_PLOT_FRAME::doCloseWindow(), DIALOG_GLOBAL_DELETION::DoGlobalDeletions(), SCH_FIELD::DoHypertextMenu(), DRAWING_TOOL::DrawVia(), TRACK_WIDTH_MENU::eventHandler(), DIFF_PAIR_MENU::eventHandler(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), SCH_EDIT_FRAME::ExecuteRemoteCommand(), GERBVIEW_FRAME::GERBVIEW_FRAME(), FP_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), SYMBOL_TREE_SYNCHRONIZING_ADAPTER::GetContextMenuTool(), PL_EDITOR_FRAME::GetLayoutFromRedoList(), PL_EDITOR_FRAME::GetLayoutFromUndoList(), SCH_NAVIGATE_TOOL::HypertextCommand(), DIALOG_PAD_PROPERTIES::initValues(), ROUTER_TOOL::InlineBreakTrack(), EDA_3D_VIEWER_FRAME::InstallPreferences(), KICAD_MANAGER_FRAME::InstallPreferences(), PL_EDITOR_FRAME::InstallPreferences(), FOOTPRINT_EDIT_FRAME::InstallPreferences(), SYMBOL_EDIT_FRAME::InstallPreferences(), GERBVIEW_FRAME::InstallPreferences(), PCB_EDIT_FRAME::InstallPreferences(), SCH_EDIT_FRAME::InstallPreferences(), PCB_EDIT_FRAME::LoadProjectSettings(), FOOTPRINT_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSymbol(), PROPERTIES_FRAME::OnAcceptPrms(), DIALOG_DRC::OnActivateDlg(), DIALOG_FOOTPRINT_CHECKER::OnCancelClick(), DIALOG_DRC::OnCancelClick(), DIALOG_INSPECTOR::onCellClicked(), DIALOG_ERC::OnCloseErcDialog(), DIALOG_FOOTPRINT_CHECKER::OnDeleteOneClick(), DIALOG_DRC::OnDeleteOneClick(), DIALOG_ABOUT::onDonateClick(), DIALOG_DRC::OnDRCItemRClick(), DIALOG_ERC::OnERCItemSelected(), DIALOG_CONSTRAINTS_REPORTER::OnErrorLinkClicked(), KICAD_MANAGER_FRAME::OnIdle(), FOOTPRINTS_LISTBOX::OnLeftDClick(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::onNetContextMenu(), PANEL_PCBNEW_ACTION_PLUGINS::OnOpenDirectoryButtonClick(), SIM_PLOT_FRAME::onProbe(), PANEL_PCBNEW_ACTION_PLUGINS::OnReloadButtonClick(), DIALOG_ABOUT::onReportBug(), DIALOG_PLOT::onRunDRC(), DIALOG_DRC::OnRunDRCClick(), HIERARCHY_NAVIG_DLG::onSelectSheetPath(), SCH_EDIT_FRAME::onSize(), SYMBOL_TREE_PANE::onSymbolSelected(), DIALOG_SYMBOL_FIELDS_TABLE::OnTableCellClick(), SIM_PLOT_FRAME::onTune(), PANEL_KICAD_LAUNCHER::PANEL_KICAD_LAUNCHER(), PANEL_SELECTION_FILTER::PANEL_SELECTION_FILTER(), DIALOG_UPDATE_PCB::PerformUpdate(), DIALOG_PLOT::Plot(), TOOLS_HOLDER::PopTool(), SCH_EDIT_FRAME::PutDataInPreviousState(), FOOTPRINT_WIZARD_FRAME::PythonPluginsReload(), Refresh(), PL_EDITOR_FRAME::RollbackFromUndo(), FOOTPRINT_EDIT_FRAME::SaveFootprintToBoard(), PCB_EDIT_FRAME::SaveProjectSettings(), FOOTPRINT_EDIT_FRAME::SaveSettings(), EDA_3D_VIEWER_FRAME::SaveSettings(), DIALOG_FIND::search(), CVPCB_MAINFRAME::setupEventHandlers(), APPEARANCE_CONTROLS::showNetclass(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), DIALOG_GRID_SETTINGS::TransferDataFromWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_FOOTPRINT_PROPERTIES_FP_EDITOR::TransferDataFromWindow(), DIALOG_SYMBOL_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXT_PROPERTIES::TransferDataToWindow(), PANEL_3D_DISPLAY_OPTIONS::TransferDataToWindow(), DIALOG_SYMBOL_FIELDS_TABLE::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::TransferDataToWindow(), DIALOG_GLOBAL_EDIT_TRACKS_AND_VIAS::TransferDataToWindow(), EDA_DRAW_FRAME::UpdateMsgPanel(), NET_GRID_TABLE::updateNetVisibility(), DIALOG_NETLIST_IMPORT::~DIALOG_NETLIST_IMPORT(), and DIALOG_UPDATE_PCB::~DIALOG_UPDATE_PCB().

◆ GetType()

HOLDER_TYPE KIWAY_HOLDER::GetType ( ) const
inlineinherited

Definition at line 46 of file kiway_holder.h.

46 { return m_type; }
HOLDER_TYPE m_type
Definition: kiway_holder.h:76

References KIWAY_HOLDER::m_type.

Referenced by DIALOG_SHIM::DIALOG_SHIM().

◆ GetUndoCommandCount()

virtual int EDA_BASE_FRAME::GetUndoCommandCount ( ) const
inlinevirtualinherited

◆ GetUnitPair()

void EDA_DRAW_FRAME::GetUnitPair ( EDA_UNITS aPrimaryUnit,
EDA_UNITS aSecondaryUnits 
)
inherited

Get the pair or units in current use.

The primary unit is the main unit of the frame, and the secondary unit is the unit of the other system that was used most recently.

Definition at line 1075 of file eda_draw_frame.cpp.

1076 {
1078 
1079  aPrimaryUnit = GetUserUnits();
1080  aSecondaryUnits = EDA_UNITS::MILS;
1081 
1082  if( EDA_UNIT_UTILS::IsImperialUnit( aPrimaryUnit ) )
1083  {
1084  if( cmnTool )
1085  aSecondaryUnits = cmnTool->GetLastMetricUnits();
1086  else
1087  aSecondaryUnits = EDA_UNITS::MILLIMETRES;
1088  }
1089  else
1090  {
1091  if( cmnTool )
1092  aSecondaryUnits = cmnTool->GetLastImperialUnits();
1093  else
1094  aSecondaryUnits = EDA_UNITS::MILS;
1095  }
1096 }
EDA_UNITS GetLastMetricUnits()
Definition: common_tools.h:74
bool IsImperialUnit(EDA_UNITS aUnit)
Definition: eda_units.cpp:26
EDA_UNITS GetLastImperialUnits()
Definition: common_tools.h:75
Handles action that are shared between different applications.
Definition: common_tools.h:37
TOOL_MANAGER * m_toolManager
Definition: tools_holder.h:158
EDA_UNITS GetUserUnits() const
Return the user units currently in use.

References COMMON_TOOLS::GetLastImperialUnits(), COMMON_TOOLS::GetLastMetricUnits(), TOOL_MANAGER::GetTool(), EDA_BASE_FRAME::GetUserUnits(), EDA_UNIT_UTILS::IsImperialUnit(), TOOLS_HOLDER::m_toolManager, MILLIMETRES, and MILS.

Referenced by GRID_MENU::BuildChoiceList(), and PCB_EDIT_FRAME::UpdateTrackWidthSelectBox().

◆ GetUserOrigin()

const wxPoint PCB_BASE_FRAME::GetUserOrigin ( ) const
inherited

Definition at line 489 of file pcb_base_frame.cpp.

490 {
491  auto& displ_opts = GetDisplayOptions();
492  wxPoint origin( 0, 0 );
493 
494  switch( displ_opts.m_DisplayOrigin )
495  {
497  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_AUX: origin = GetAuxOrigin(); break;
498  case PCB_DISPLAY_OPTIONS::PCB_ORIGIN_GRID: origin = GetGridOrigin(); break;
499  default: wxASSERT( false ); break;
500  }
501 
502  return origin;
503 }
const wxPoint & GetGridOrigin() const override
Return the absolute coordinates of the origin of the snap grid.
const PCB_DISPLAY_OPTIONS & GetDisplayOptions() const
Display options control the way tracks, vias, outlines and other things are shown (for instance solid...
const wxPoint & GetAuxOrigin() const

References PCB_BASE_FRAME::GetAuxOrigin(), PCB_BASE_FRAME::GetDisplayOptions(), PCB_BASE_FRAME::GetGridOrigin(), PCB_DISPLAY_OPTIONS::PCB_ORIGIN_AUX, PCB_DISPLAY_OPTIONS::PCB_ORIGIN_GRID, and PCB_DISPLAY_OPTIONS::PCB_ORIGIN_PAGE.

Referenced by PCB_ORIGIN_TRANSFORMS::GetUserXOrigin(), and PCB_ORIGIN_TRANSFORMS::GetUserYOrigin().

◆ GetUserUnits()

EDA_UNITS EDA_BASE_FRAME::GetUserUnits ( ) const
inlineinherited

Return the user units currently in use.

Definition at line 126 of file eda_base_frame.h.

127  {
128  return m_userUnits;
129  }
EDA_UNITS m_userUnits
Map containing the UI update handlers registered with wx for each action.

References EDA_BASE_FRAME::m_userUnits.

Referenced by DIALOG_CONSTRAINTS_REPORTER::AddPage(), PANEL_SETUP_TRACKS_AND_VIAS::AppendDiffPairs(), PANEL_SETUP_TRACKS_AND_VIAS::AppendTrackWidth(), PANEL_SETUP_TRACKS_AND_VIAS::AppendViaSize(), EE_INSPECTION_TOOL::CheckSymbol(), PANEL_SETUP_BOARD_STACKUP::computeBoardThickness(), MICROWAVE_TOOL::createFootprint(), MICROWAVE_TOOL::createMicrowaveInductor(), DIALOG_GROUP_PROPERTIES::DIALOG_GROUP_PROPERTIES(), DIALOG_TRACK_VIA_PROPERTIES::DIALOG_TRACK_VIA_PROPERTIES(), GERBVIEW_SELECTION_TOOL::disambiguationMenu(), EDA_DRAW_FRAME::DisplayGridMsg(), GERBER_FILE_IMAGE::DisplayImageInfo(), DIALOG_GROUP_PROPERTIES::DoAddMember(), PL_SELECTION_TOOL::doSelectionMenu(), EE_SELECTION_TOOL::doSelectionMenu(), PCB_SELECTION_TOOL::doSelectionMenu(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawBoardCharacteristics(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawSegment(), DRAWING_TOOL::DrawSpecificationStackup(), EVT_GRID_CMD_CELL_CHANGED(), PCB_EDIT_FRAME::GenFootprintsReport(), PANEL_FP_EDITOR_DEFAULTS::getGridValue(), PANEL_SETUP_TEXT_AND_GRAPHICS::getGridValue(), BOARD_INSPECTION_TOOL::getItemDescription(), SCH_PIN::GetMsgPanelInfo(), PL_EDITOR_LAYOUT::GetMsgPanelInfo(), PCB_MARKER::GetMsgPanelInfo(), PCB_TEXT::GetMsgPanelInfo(), PCB_TARGET::GetMsgPanelInfo(), DS_DRAW_ITEM_BASE::GetMsgPanelInfo(), LIB_TEXT::GetMsgPanelInfo(), ZONE::GetMsgPanelInfo(), LIB_FIELD::GetMsgPanelInfo(), SCH_BITMAP::GetMsgPanelInfo(), NETINFO_ITEM::GetMsgPanelInfo(), LIB_PIN::GetMsgPanelInfo(), PCB_TRACK::GetMsgPanelInfo(), FP_TEXT::GetMsgPanelInfo(), SCH_FIELD::GetMsgPanelInfo(), PCB_DIMENSION_BASE::GetMsgPanelInfo(), SCH_TEXT::GetMsgPanelInfo(), PCB_VIA::GetMsgPanelInfo(), PCB_DIM_ALIGNED::GetMsgPanelInfo(), PCB_DIM_LEADER::GetMsgPanelInfo(), PAD::GetMsgPanelInfo(), EDA_DRAW_FRAME::GetUnitPair(), GetUserUnits(), FP_TEXT_GRID_TABLE::GetValue(), PIN_TABLE_DATA_MODEL::GetValue(), RC_TREE_MODEL::GetValue(), BOARD_INSPECTION_TOOL::InspectClearance(), GERBVIEW_INSPECTION_TOOL::MeasureTool(), PCB_VIEWER_TOOLS::MeasureTool(), PANEL_SETUP_BOARD_STACKUP::onAdjustDielectricThickness(), PANEL_SETUP_BOARD_STACKUP::onThicknessChange(), DIALOG_TRACK_VIA_PROPERTIES::onUnitsChanged(), DIALOG_NET_INSPECTOR::onUnitsChanged(), UNIT_BINDER::onUnitsChanged(), PANEL_PREVIEW_3D_MODEL::PANEL_PREVIEW_3D_MODEL(), PANEL_SETUP_BOARD_STACKUP::PANEL_SETUP_BOARD_STACKUP(), POSITION_RELATIVE_TOOL::PositionRelative(), DRC_TOOL::RunTests(), FP_TEXT_GRID_TABLE::SetValue(), PIN_TABLE_DATA_MODEL::SetValue(), EDA_SHAPE::ShapeGetMsgPanelInfo(), GERBVIEW_INSPECTION_TOOL::ShowDCodes(), PIN_TABLE_DATA_MODEL::SortRows(), COMMON_TOOLS::ToggleUnits(), PANEL_SETUP_BOARD_STACKUP::transferDataFromUIToStackup(), PANEL_SETUP_NETCLASSES::TransferDataFromWindow(), PANEL_SETUP_TRACKS_AND_VIAS::TransferDataFromWindow(), PANEL_SETUP_NETCLASSES::TransferDataToWindow(), PANEL_SETUP_CONSTRAINTS::TransferDataToWindow(), UNIT_BINDER::UNIT_BINDER(), PCB_BASE_EDIT_FRAME::unitsChangeRefresh(), EDITOR_CONDITIONS::unitsFunc(), VIA_SIZE_MENU::update(), TRACK_WIDTH_MENU::update(), DIFF_PAIR_MENU::update(), BOARD_NETLIST_UPDATER::updateCopperZoneNets(), GERBVIEW_FRAME::updateDCodeSelectBox(), DIALOG_DIMENSION_PROPERTIES::updateDimensionFromDialog(), ROUTER_TOOL::UpdateMessagePanel(), PNS_TUNE_STATUS_POPUP::UpdateStatus(), GERBVIEW_FRAME::UpdateStatusBar(), PL_EDITOR_FRAME::UpdateStatusBar(), SCH_BASE_FRAME::UpdateStatusBar(), PCB_BASE_FRAME::UpdateStatusBar(), PCB_EDIT_FRAME::UpdateViaSizeSelectBox(), and DRC_TOOL::userUnits().

◆ GetWindowSettings()

WINDOW_SETTINGS * FOOTPRINT_VIEWER_FRAME::GetWindowSettings ( APP_SETTINGS_BASE aCfg)
overrideprivatevirtual

Return a pointer to the window settings for this frame.

By default, points to aCfg->m_Window for top-level frames.

Parameters
aCfgis this frame's config object

Reimplemented from EDA_BASE_FRAME.

Definition at line 810 of file footprint_viewer_frame.cpp.

811 {
812  PCBNEW_SETTINGS* cfg = dynamic_cast<PCBNEW_SETTINGS*>( aCfg );
813  wxCHECK_MSG( cfg, nullptr, wxT( "config not existing" ) );
814 
815  return &cfg->m_FootprintViewer;
816 }
WINDOW_SETTINGS m_FootprintViewer

References PCBNEW_SETTINGS::m_FootprintViewer.

Referenced by LoadSettings().

◆ GetWindowSize()

wxSize EDA_BASE_FRAME::GetWindowSize ( )
inherited

Get the undecorated window size that can be used for restoring the window size.

This is needed for GTK, since the normal wxWidgets GetSize() call will return a window size that includes the window decorations added by the window manager.

Returns
the undecorated window size

Definition at line 1237 of file eda_base_frame.cpp.

1238 {
1239 #ifdef __WXGTK__
1240  wxSize winSize = GetSize();
1241 
1242  // GTK includes the window decorations in the normal GetSize call,
1243  // so we have to use a GTK-specific sizing call that returns the
1244  // non-decorated window size.
1245  if( m_ident == KICAD_MAIN_FRAME_T )
1246  {
1247  int width = 0;
1248  int height = 0;
1249  GTKDoGetSize( &width, &height );
1250 
1251  winSize.Set( width, height );
1252  }
1253 #else
1254  wxSize winSize = GetSize();
1255 #endif
1256 
1257  return winSize;
1258 }

References KICAD_MAIN_FRAME_T, and EDA_BASE_FRAME::m_ident.

Referenced by EDA_BASE_FRAME::ensureWindowIsOnScreen(), EDA_BASE_FRAME::OnMaximize(), and EDA_BASE_FRAME::SaveWindowSettings().

◆ GetZoneSettings()

const ZONE_SETTINGS & PCB_BASE_FRAME::GetZoneSettings ( ) const
inherited

◆ GetZoomLevelIndicator()

const wxString EDA_DRAW_FRAME::GetZoomLevelIndicator ( ) const
inherited

Return a human readable value for display in dialogs.

Definition at line 574 of file eda_draw_frame.cpp.

575 {
576  // returns a human readable value which can be displayed as zoom
577  // level indicator in dialogs.
578  double zoom = m_canvas->GetGAL()->GetZoomFactor();
579  return wxString::Format( wxT( "Z %.2f" ), zoom );
580 }
EDA_DRAW_PANEL_GAL * m_canvas
This the frame's interface to setting GAL display options.
KIGFX::GAL * GetGAL() const
Return a pointer to the GAL instance used in the panel.
double GetZoomFactor() const
Get the zoom factor.
void Format(OUTPUTFORMATTER *out, int aNestLevel, int aCtl, const CPTREE &aTree)
Output a PTREE into s-expression format via an OUTPUTFORMATTER derivative.
Definition: ptree.cpp:200

References Format(), EDA_DRAW_PANEL_GAL::GetGAL(), KIGFX::GAL::GetZoomFactor(), EDA_DRAW_FRAME::m_canvas, and zoom.

Referenced by PL_EDITOR_FRAME::UpdateStatusBar(), and EDA_DRAW_FRAME::UpdateStatusBar().

◆ handleActivateEvent()

void EDA_DRAW_FRAME::handleActivateEvent ( wxActivateEvent &  aEvent)
protectedvirtualinherited

Handle a window activation event.

Reimplemented in PCB_BASE_EDIT_FRAME.

Definition at line 1127 of file eda_draw_frame.cpp.

1128 {
1129  // Force a refresh of the message panel to ensure that the text is the right color
1130  // when the window activates
1131  if( !IsIconized() )
1132  m_messagePanel->Refresh();
1133 }
EDA_MSG_PANEL * m_messagePanel

References EDA_DRAW_FRAME::m_messagePanel.

Referenced by PCB_BASE_EDIT_FRAME::handleActivateEvent(), and EDA_DRAW_FRAME::onActivate().

◆ HandleSystemColorChange()

void EDA_BASE_FRAME::HandleSystemColorChange ( )
virtualinherited

Update the UI in response to a change in the system colors.

Definition at line 1261 of file eda_base_frame.cpp.

1262 {
1263  // Update the icon theme when the system theme changes and update the toolbars
1265  ThemeChanged();
1266 
1267  // This isn't handled by ThemeChanged()
1268  if( GetMenuBar() )
1269  {
1270  // For icons in menus, icon scaling & hotkeys
1271  ReCreateMenuBar();
1272  GetMenuBar()->Refresh();
1273  }
1274 }
void ThemeChanged()
Notifies the store that the icon theme has been changed by the user, so caches must be invalidated.
virtual void ThemeChanged()
Process light/dark theme change.
virtual void ReCreateMenuBar()
Recreates the menu bar.
BITMAP_STORE * GetBitmapStore()
Definition: bitmap.cpp:93

References GetBitmapStore(), EDA_BASE_FRAME::ReCreateMenuBar(), BITMAP_STORE::ThemeChanged(), and EDA_BASE_FRAME::ThemeChanged().

Referenced by EDA_BASE_FRAME::onSystemColorChange().

◆ HandleUpdateUIEvent()

void EDA_BASE_FRAME::HandleUpdateUIEvent ( wxUpdateUIEvent &  aEvent,
EDA_BASE_FRAME aFrame,
ACTION_CONDITIONS  aCond 
)
staticinherited

Handle events generated when the UI is trying to figure out the current state of the UI controls related to TOOL_ACTIONS (e.g.

enabled, checked, etc.).

Parameters
aEventis the wxUpdateUIEvent to be processed.
aFrameis the frame to get the selection from
aCondare the #UI SELECTION_CONDITIONS used

Definition at line 376 of file eda_base_frame.cpp.

378 {
379  bool checkRes = false;
380  bool enableRes = true;
381  bool showRes = true;
382  bool isCut = aEvent.GetId() == ACTIONS::cut.GetUIId();
383  bool isCopy = aEvent.GetId() == ACTIONS::copy.GetUIId();
384  bool isPaste = aEvent.GetId() == ACTIONS::paste.GetUIId();
385  SELECTION& selection = aFrame->GetCurrentSelection();
386 
387  try
388  {
389  checkRes = aCond.checkCondition( selection );
390  enableRes = aCond.enableCondition( selection );
391  showRes = aCond.showCondition( selection );
392  }
393  catch( std::exception& )
394  {
395  // Something broke with the conditions, just skip the event.
396  aEvent.Skip();
397  return;
398  }
399 
400  if( isCut || isCopy || isPaste )
401  {
402  wxWindow* focus = wxWindow::FindFocus();
403  wxTextEntry* textEntry = dynamic_cast<wxTextEntry*>( focus );
404 
405  if( textEntry && isCut && textEntry->CanCut() )
406  enableRes = true;
407  else if( textEntry && isCopy && textEntry->CanCopy() )
408  enableRes = true;
409  else if( textEntry && isPaste && textEntry->CanPaste() )
410  enableRes = true;
411  }
412 
413  aEvent.Enable( enableRes );
414  aEvent.Show( showRes );
415 
416  // wxWidgets 3.1.5+ includes a field in the event that says if the event supports being
417  // checked, since wxMenuItems don't want to be checked unless they actually are checkable
418 #if wxCHECK_VERSION( 3, 1, 5 )
419  if( aEvent.IsCheckable() )
420  aEvent.Check( checkRes );
421 #else
422  bool canCheck = true;
423 
424  // wxMenuItems don't want to be checked unless they actually are checkable, so we have to
425  // check to see if they can be and can't just universally apply a check in this event.
426  if( auto menu = dynamic_cast<wxMenu*>( aEvent.GetEventObject() ) )
427  canCheck = menu->FindItem( aEvent.GetId() )->IsCheckable();
428 
429  if( canCheck )
430  aEvent.Check( checkRes );
431 #endif
432 }
SELECTION_CONDITION showCondition
Returns true if the UI control should be shown.
int GetUIId() const
Definition: tool_action.h:130
SELECTION_CONDITION enableCondition
Returns true if the UI control should be enabled.
SELECTION_CONDITION checkCondition
Returns true if the UI control should be checked.
static TOOL_ACTION copy
Definition: actions.h:67
static TOOL_ACTION cut
Definition: actions.h:66
virtual SELECTION & GetCurrentSelection()
Get the current selection from the canvas area.
Definition: tools_holder.h:101
static TOOL_ACTION paste
Definition: actions.h:68

References ACTION_CONDITIONS::checkCondition, ACTIONS::copy, ACTIONS::cut, ACTION_CONDITIONS::enableCondition, TOOLS_HOLDER::GetCurrentSelection(), TOOL_ACTION::GetUIId(), ACTIONS::paste, and ACTION_CONDITIONS::showCondition.

Referenced by EDA_BASE_FRAME::RegisterUIUpdateHandler().

◆ HardRedraw()

void EDA_DRAW_FRAME::HardRedraw ( )
virtualinherited

Rebuild the GAL and redraws the screen.

Call when something went wrong.

Reimplemented in SCH_EDIT_FRAME, SYMBOL_EDIT_FRAME, PL_EDITOR_FRAME, SCH_BASE_FRAME, PCB_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 829 of file eda_draw_frame.cpp.

830 {
831  // To be implemented by subclasses.
832 }

Referenced by EDA_DRAW_FRAME::resolveCanvasType(), and COMMON_TOOLS::ZoomRedraw().

◆ help_name()

wxString EDA_BASE_FRAME::help_name ( )
virtualinherited

Reimplemented in KICAD_MANAGER_FRAME.

Definition at line 829 of file eda_base_frame.cpp.

830 {
831  return Kiface().GetHelpFileName();
832 }
KIFACE_BASE & Kiface()
Global KIFACE_BASE "get" accessor.
const wxString & GetHelpFileName() const
Return just the basename portion of the current help file.
Definition: kiface_base.h:109

References KIFACE_BASE::GetHelpFileName(), and Kiface().

Referenced by COMMON_CONTROL::ShowHelp().

◆ ImportHotkeyConfigFromFile()

void EDA_BASE_FRAME::ImportHotkeyConfigFromFile ( std::map< std::string, TOOL_ACTION * >  aActionMap,
const wxString &  aDefaultShortname 
)
inherited

Prompt the user for a hotkey file to read, and read it.

Parameters
aActionMapcurrent hotkey map (over which the imported hotkeys will be applied).
aDefaultShortnamea default short name (extension not needed) like Eeschema, KiCad...

◆ initExitKey()

void EDA_BASE_FRAME::initExitKey ( )
protectedinherited

Sets the common key-pair for exiting the application (Ctrl-Q) and ties it to the wxID_EXIT event id.

This is useful in sub-applications to pass the event up to a non-owning window.

Definition at line 1145 of file eda_base_frame.cpp.

1146 {
1147  wxAcceleratorEntry entries[1];
1148  entries[0].Set( wxACCEL_CTRL, int( 'Q' ), wxID_EXIT );
1149  wxAcceleratorTable accel( 1, entries );
1150  SetAcceleratorTable( accel );
1151 }

◆ InstallPreferences()

virtual void EDA_BASE_FRAME::InstallPreferences ( PAGED_DIALOG ,
PANEL_HOTKEYS_EDITOR  
)
inlinevirtualinherited

Allow a frame to load its preference panels (if any) into the preferences dialog.

Parameters
aParenta paged dialog into which the preference panels should be installed.

Reimplemented in SCH_EDIT_FRAME, PCB_EDIT_FRAME, GERBVIEW_FRAME, SYMBOL_EDIT_FRAME, FOOTPRINT_EDIT_FRAME, PL_EDITOR_FRAME, KICAD_MANAGER_FRAME, and EDA_3D_VIEWER_FRAME.

Definition at line 298 of file eda_base_frame.h.

298 { }

Referenced by EDA_BASE_FRAME::OnPreferences().

◆ isAutoSaveRequired()

virtual bool EDA_BASE_FRAME::isAutoSaveRequired ( ) const
inlineprotectedvirtualinherited

Return the auto save status of the application.

Override this function if your derived frame supports automatic file saving.

Reimplemented in SCH_EDIT_FRAME, and PCB_EDIT_FRAME.

Definition at line 617 of file eda_base_frame.h.

617 { return false; }

Referenced by EDA_BASE_FRAME::ProcessEvent().

◆ IsContentModified()

bool EDA_BASE_FRAME::IsContentModified ( ) const
virtualinherited

Get if the contents of the frame have been modified since the last save.

Returns
true if the contents of the frame have not been saved

Reimplemented in SCH_EDIT_FRAME, CVPCB_MAINFRAME, PCB_EDIT_FRAME, PL_EDITOR_FRAME, SYMBOL_EDIT_FRAME, and FOOTPRINT_EDIT_FRAME.

Definition at line 1138 of file eda_base_frame.cpp.

1139 {
1140  // This function should be overridden in child classes
1141  return false;
1142 }

Referenced by GERBVIEW_FRAME::Clear_DrawLayers(), and EDITOR_CONDITIONS::contentModifiedFunc().

◆ IsCurrentTool()

bool TOOLS_HOLDER::IsCurrentTool ( const TOOL_ACTION aAction) const
inherited

Definition at line 109 of file tools_holder.cpp.

110 {
111  if( m_toolStack.empty() )
112  return &aAction == &ACTIONS::selectionTool;
113  else
114  return m_toolStack.back() == aAction.GetName();
115 }
std::vector< std::string > m_toolStack
Definition: tools_holder.h:164
static TOOL_ACTION selectionTool
Definition: actions.h:153
const std::string & GetName() const
Return name of the action.
Definition: tool_action.h:101

References TOOL_ACTION::GetName(), TOOLS_HOLDER::m_toolStack, and ACTIONS::selectionTool.

Referenced by SCH_EDIT_TOOL::Init(), BOARD_EDITOR_CONTROL::Init(), EDIT_TOOL::Init(), SCH_LINE_WIRE_BUS_TOOL::Init(), and EDITOR_CONDITIONS::toolFunc().

◆ IsDismissed()

bool KIWAY_PLAYER::IsDismissed ( )
inherited
Returns
false only if both the frame is acting in modal mode and it has not been dismissed yet with DismissModal(). True if the dialog is not modal or if it is modal and has been dismissed.

Definition at line 160 of file kiway_player.cpp.

161 {
162  return !m_modal_loop;
163 }
WX_EVENT_LOOP * m_modal_loop
< Points to nested event_loop. NULL means not modal and dismissed.
Definition: kiway_player.h:213

References KIWAY_PLAYER::m_modal_loop.

Referenced by SYMBOL_VIEWER_FRAME::doCloseWindow(), doCloseWindow(), and FOOTPRINT_WIZARD_FRAME::doCloseWindow().

◆ IsGridVisible()