mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-15 10:43:15 +02:00
c7ec110fba
This includes outside the window and behind an occluding dialog. This keeps the view from jumping around when focusing on nearby objects.
464 lines
15 KiB
C++
464 lines
15 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
|
* Copyright (C) 2008-2016 Wayne Stambaugh <stambaughw@verizon.net>
|
|
* Copyright (C) 1992-2019 KiCad Developers, see AUTHORS.txt for contributors.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, you may find one here:
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
*/
|
|
|
|
/**
|
|
* @file pcb_base_frame.h
|
|
* @brief Classes used in Pcbnew, CvPcb and GerbView.
|
|
*/
|
|
|
|
#ifndef PCB_BASE_FRAME_H
|
|
#define PCB_BASE_FRAME_H
|
|
|
|
|
|
#include <vector>
|
|
|
|
#include <eda_draw_frame.h>
|
|
#include <base_struct.h>
|
|
#include <eda_text.h> // EDA_DRAW_MODE_T
|
|
#include <richio.h>
|
|
#include <pcb_screen.h>
|
|
#include <pcb_display_options.h>
|
|
#include <pcb_draw_panel_gal.h>
|
|
#include <lib_id.h>
|
|
|
|
/* Forward declarations of classes. */
|
|
class APP_SETTINGS_BASE;
|
|
class BOARD;
|
|
class BOARD_CONNECTED_ITEM;
|
|
class COLOR_SETTINGS;
|
|
class MODULE;
|
|
class TRACK;
|
|
class D_PAD;
|
|
class TEXTE_MODULE;
|
|
class EDA_3D_VIEWER;
|
|
class GENERAL_COLLECTOR;
|
|
class GENERAL_COLLECTORS_GUIDE;
|
|
class BOARD_DESIGN_SETTINGS;
|
|
class ZONE_SETTINGS;
|
|
class PCB_PLOT_PARAMS;
|
|
class FP_LIB_TABLE;
|
|
class PCBNEW_SETTINGS;
|
|
|
|
/**
|
|
* PCB_BASE_FRAME
|
|
* basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
|
|
*/
|
|
class PCB_BASE_FRAME : public EDA_DRAW_FRAME
|
|
{
|
|
public:
|
|
wxPoint m_UserGridSize;
|
|
|
|
int m_FastGrid1; // 1st fast grid setting (index in EDA_DRAW_FRAME::m_gridSelectBox)
|
|
int m_FastGrid2; // 2nd fast grid setting (index in EDA_DRAW_FRAME::m_gridSelectBox)
|
|
|
|
protected:
|
|
BOARD* m_Pcb;
|
|
|
|
PCB_DISPLAY_OPTIONS m_DisplayOptions;
|
|
|
|
PCBNEW_SETTINGS* m_Settings; // No ownership, just a shortcut
|
|
|
|
void updateZoomSelectBox();
|
|
virtual void unitsChangeRefresh() override;
|
|
|
|
/**
|
|
* Function loadFootprint
|
|
* attempts to load \a aFootprintId from the footprint library table.
|
|
*
|
|
* @param aFootprintId is the #LIB_ID of component footprint to load.
|
|
* @return the #MODULE if found or NULL if \a aFootprintId not found in any of the
|
|
* libraries in the table returned from #Prj().PcbFootprintLibs().
|
|
* @throw IO_ERROR if an I/O error occurs or a #PARSE_ERROR if a file parsing error
|
|
* occurs while reading footprint library files.
|
|
*/
|
|
MODULE* loadFootprint( const LIB_ID& aFootprintId );
|
|
|
|
public:
|
|
PCB_BASE_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType,
|
|
const wxString& aTitle, const wxPoint& aPos, const wxSize& aSize,
|
|
long aStyle, const wxString& aFrameName );
|
|
|
|
~PCB_BASE_FRAME();
|
|
|
|
/**
|
|
* @return a reference to the child 3D viewer frame, when exists, or NULL
|
|
*/
|
|
EDA_3D_VIEWER* Get3DViewerFrame();
|
|
|
|
/**
|
|
* Update the 3D view, if the viewer is opened by this frame
|
|
* @param aTitle = the new title of the 3D frame, or nullptr
|
|
* to do not change the frame title
|
|
* @return false if the 3D view cannot be updated (because the
|
|
* owner of the viewer is not this frame)
|
|
*/
|
|
virtual void Update3DView( bool aForceReload, const wxString* aTitle = nullptr );
|
|
|
|
/**
|
|
* Function LoadFootprint
|
|
* attempts to load \a aFootprintId from the footprint library table.
|
|
*
|
|
* @param aFootprintId is the #LIB_ID of component footprint to load.
|
|
* @return the #MODULE if found or NULL if \a aFootprintId not found in any of the
|
|
* libraries in table returned from #Prj().PcbFootprintLibs().
|
|
*/
|
|
MODULE* LoadFootprint( const LIB_ID& aFootprintId );
|
|
|
|
/**
|
|
* Function GetBoardBoundingBox
|
|
* calculates the bounding box containing all board items (or board edge segments).
|
|
* @param aBoardEdgesOnly is true if we are interested in board edge segments only.
|
|
* @return EDA_RECT - the board's bounding box
|
|
*/
|
|
EDA_RECT GetBoardBoundingBox( bool aBoardEdgesOnly = false ) const;
|
|
|
|
const BOX2I GetDocumentExtents() const override
|
|
{
|
|
return GetBoardBoundingBox( false );
|
|
}
|
|
|
|
virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
|
|
const PAGE_INFO& GetPageSettings() const override;
|
|
const wxSize GetPageSizeIU() const override;
|
|
|
|
const wxPoint& GetAuxOrigin() const override;
|
|
void SetAuxOrigin( const wxPoint& aPoint ) override;
|
|
|
|
const wxPoint& GetGridOrigin() const override;
|
|
void SetGridOrigin( const wxPoint& aPoint ) override;
|
|
|
|
const TITLE_BLOCK& GetTitleBlock() const override;
|
|
void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;
|
|
|
|
/**
|
|
* Function GetDesignSettings
|
|
* returns the BOARD_DESIGN_SETTINGS for the BOARD owned by this frame.
|
|
* Overloaded in FOOTPRINT_EDIT_FRAME.
|
|
*/
|
|
virtual BOARD_DESIGN_SETTINGS& GetDesignSettings() const;
|
|
virtual void SetDesignSettings( const BOARD_DESIGN_SETTINGS& aSettings );
|
|
|
|
/**
|
|
* Helper to retrieve the current color settings
|
|
* @return a pointer to the active COLOR_SETTINGS
|
|
*/
|
|
COLOR_SETTINGS* ColorSettings();
|
|
|
|
PCBNEW_SETTINGS& Settings() { return *m_Settings; }
|
|
|
|
void SetDrawBgColor( COLOR4D aColor ) override;
|
|
|
|
/**
|
|
* Function GetDisplayOptions
|
|
* returns the display options current in use
|
|
* Display options are relative to the way tracks, vias, outlines
|
|
* and other things are shown (for instance solid or sketch mode)
|
|
*/
|
|
const PCB_DISPLAY_OPTIONS& GetDisplayOptions() const
|
|
{
|
|
return m_DisplayOptions;
|
|
}
|
|
|
|
void SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions )
|
|
{
|
|
m_DisplayOptions = aOptions;
|
|
}
|
|
|
|
const ZONE_SETTINGS& GetZoneSettings() const;
|
|
void SetZoneSettings( const ZONE_SETTINGS& aSettings );
|
|
|
|
/**
|
|
* Function GetPlotSettings
|
|
* returns the PCB_PLOT_PARAMS for the BOARD owned by this frame.
|
|
* Overloaded in FOOTPRINT_EDIT_FRAME.
|
|
*/
|
|
virtual const PCB_PLOT_PARAMS& GetPlotSettings() const;
|
|
virtual void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings );
|
|
|
|
/**
|
|
* Function SetBoard
|
|
* sets the m_Pcb member in such as way as to ensure deleting any previous
|
|
* BOARD.
|
|
* @param aBoard The BOARD to put into the frame.
|
|
*/
|
|
virtual void SetBoard( BOARD* aBoard );
|
|
|
|
BOARD* GetBoard() const
|
|
{
|
|
wxASSERT( m_Pcb );
|
|
return m_Pcb;
|
|
}
|
|
|
|
void FocusOnItem( BOARD_ITEM* aItem );
|
|
|
|
// General
|
|
virtual void OnCloseWindow( wxCloseEvent& Event ) = 0;
|
|
virtual void ReCreateOptToolbar() override { }
|
|
virtual void ShowChangedLanguage() override;
|
|
virtual void ReCreateMenuBar() override;
|
|
virtual void UpdateStatusBar() override;
|
|
|
|
PCB_SCREEN* GetScreen() const override { return (PCB_SCREEN*) EDA_DRAW_FRAME::GetScreen(); }
|
|
|
|
void UpdateGridSelectBox();
|
|
|
|
/**
|
|
* Function GetZoomLevelIndicator
|
|
* returns a human readable value which can be displayed as zoom
|
|
* level indicator in dialogs.
|
|
* Virtual from the base class
|
|
*/
|
|
const wxString GetZoomLevelIndicator() const override;
|
|
|
|
/**
|
|
* Shows the 3D view frame.
|
|
* If it does not exist, it is created.
|
|
* If it exists, it is bring to the foreground
|
|
*/
|
|
EDA_3D_VIEWER* CreateAndShow3D_Frame();
|
|
|
|
/**
|
|
* Function GetCollectorsGuide
|
|
* @return GENERAL_COLLECTORS_GUIDE - that considers the global
|
|
*configuration options.
|
|
*/
|
|
GENERAL_COLLECTORS_GUIDE GetCollectorsGuide();
|
|
|
|
/**
|
|
* Function SelectLibrary
|
|
* puts up a dialog and allows the user to pick a library, for unspecified use.
|
|
*
|
|
* @param aNicknameExisting is the current choice to highlight
|
|
* @return wxString - the library or wxEmptyString on abort.
|
|
*/
|
|
wxString SelectLibrary( const wxString& aNicknameExisting );
|
|
|
|
/**
|
|
* Function GetFootprintFromBoardByReference
|
|
* @return a reference to the footprint found by its refence
|
|
* on the curent board. the reference is entered by the user from
|
|
* a dialog (by awxTextCtlr, or a list of available references)
|
|
*/
|
|
MODULE* GetFootprintFromBoardByReference();
|
|
|
|
/**
|
|
* Function OnModify
|
|
* Virtual
|
|
* Must be called after a change
|
|
* in order to set the "modify" flag of the current screen
|
|
* and update the date in frame reference
|
|
* do not forget to call this basic OnModify function to update info
|
|
* in derived OnModify functions
|
|
*/
|
|
virtual void OnModify();
|
|
|
|
// Modules (footprints)
|
|
|
|
/**
|
|
* Function CreateNewModule
|
|
* Creates a new module or footprint, at position 0,0
|
|
* The new module contains only 2 texts: a reference and a value:
|
|
* Reference = REF**
|
|
* Value = "VAL**" or Footprint name in lib
|
|
* Note: they are dummy texts, which will be replaced by the actual texts
|
|
* when the fooprint is placed on a board and a netlist is read
|
|
* @param aModuleName = name of the new footprint in library
|
|
* @return a reference to the new module
|
|
*/
|
|
MODULE* CreateNewModule( const wxString& aModuleName );
|
|
|
|
void Edit_Module( MODULE* module, wxDC* DC );
|
|
|
|
/**
|
|
* Function PlaceModule
|
|
* places \a aModule at the current cursor position and updates module coordinates
|
|
* with the new position.
|
|
*
|
|
* @param aModule A MODULE object point of the module to be placed.
|
|
* @param aRecreateRatsnest A bool true redraws the module rats nest.
|
|
*/
|
|
void PlaceModule( MODULE* aModule, bool aRecreateRatsnest = true );
|
|
|
|
void InstallPadOptionsFrame( D_PAD* pad );
|
|
|
|
/**
|
|
* Function SelectFootprintFromLibTree
|
|
* opens a dialog to select a footprint.
|
|
*
|
|
* @param aPreslect = if valid, the LIB_ID to select (otherwise the global history is used)
|
|
*/
|
|
MODULE* SelectFootprintFromLibTree( LIB_ID aPreselect = LIB_ID() );
|
|
|
|
/**
|
|
* Adds the given module to the board.
|
|
* @param module
|
|
* @param aDC (can be NULL ) = the current Device Context, to draw the new footprint
|
|
*/
|
|
virtual void AddModuleToBoard( MODULE* module );
|
|
|
|
/**
|
|
* Function SelectFootprintFromLibBrowser
|
|
* launches the footprint viewer to select the name of a footprint to load.
|
|
*
|
|
* @return the selected footprint name or an empty string if no selection was made.
|
|
*/
|
|
wxString SelectFootprintFromLibBrowser();
|
|
|
|
// ratsnest functions
|
|
/**
|
|
* Function Compile_Ratsnest
|
|
* Create the entire board ratsnest.
|
|
* Must be called after a board change (changes for
|
|
* pads, footprints or a read netlist ).
|
|
* @param aDC = the current device context (can be NULL)
|
|
* @param aDisplayStatus : if true, display the computation results
|
|
*/
|
|
void Compile_Ratsnest( bool aDisplayStatus );
|
|
|
|
/* Functions relative to Undo/redo commands: */
|
|
|
|
/**
|
|
* Function SaveCopyInUndoList (virtual pure)
|
|
* Creates a new entry in undo list of commands.
|
|
* add a picker to handle aItemToCopy
|
|
* @param aItemToCopy = the board item modified by the command to undo
|
|
* @param aTypeCommand = command type (see enum UNDO_REDO_T)
|
|
* @param aTransformPoint = the reference point of the transformation, for
|
|
* commands like move
|
|
*/
|
|
virtual void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy,
|
|
UNDO_REDO_T aTypeCommand,
|
|
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
|
|
|
|
/**
|
|
* Function SaveCopyInUndoList (virtual pure, overloaded).
|
|
* Creates a new entry in undo list of commands.
|
|
* add a list of pickers to handle a list of items
|
|
* @param aItemsList = the list of items modified by the command to undo
|
|
* @param aTypeCommand = command type (see enum UNDO_REDO_T)
|
|
* @param aTransformPoint = the reference point of the transformation,
|
|
* for commands like move
|
|
*/
|
|
virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
|
|
UNDO_REDO_T aTypeCommand,
|
|
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) = 0;
|
|
|
|
|
|
/** Install the dialog box for layer selection
|
|
* @param aDefaultLayer = Preselection (NB_PCB_LAYERS for "(Deselect)" layer)
|
|
* @param aNotAllowedLayersMask = a layer mask for not allowed layers
|
|
* (= 0 to show all layers in use)
|
|
* @param aDlgPosition = position of dialog ( defualt = centered)
|
|
* @return the selected layer id
|
|
*/
|
|
PCB_LAYER_ID SelectLayer( PCB_LAYER_ID aDefaultLayer,
|
|
LSET aNotAllowedLayersMask = LSET(),
|
|
wxPoint aDlgPosition = wxDefaultPosition );
|
|
|
|
virtual void SwitchLayer( wxDC* DC, PCB_LAYER_ID layer );
|
|
|
|
/**
|
|
* Function SetActiveLayer
|
|
* will change the currently active layer to \a aLayer.
|
|
*/
|
|
virtual void SetActiveLayer( PCB_LAYER_ID aLayer )
|
|
{
|
|
GetScreen()->m_Active_Layer = aLayer;
|
|
}
|
|
|
|
/**
|
|
* Function GetActiveLayer
|
|
* returns the active layer
|
|
*/
|
|
virtual PCB_LAYER_ID GetActiveLayer() const
|
|
{
|
|
return GetScreen()->m_Active_Layer;
|
|
}
|
|
|
|
void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
|
|
|
|
PCBNEW_SETTINGS* GetSettings();
|
|
|
|
void CommonSettingsChanged( bool aEnvVarsChanged ) override;
|
|
|
|
void OnTogglePadDrawMode( wxCommandEvent& aEvent );
|
|
void OnToggleGraphicDrawMode( wxCommandEvent& aEvent );
|
|
void OnToggleEdgeDrawMode( wxCommandEvent& aEvent );
|
|
void OnToggleTextDrawMode( wxCommandEvent& aEvent );
|
|
|
|
// User interface update event handlers.
|
|
void OnUpdateSelectZoom( wxUpdateUIEvent& aEvent );
|
|
|
|
virtual void OnUpdateLayerAlpha( wxUpdateUIEvent& aEvent ) {}
|
|
|
|
/**
|
|
* Function SetFastGrid1()
|
|
*
|
|
* Switches grid settings to the 1st "fast" setting predefined by user.
|
|
*/
|
|
void SetFastGrid1();
|
|
|
|
/**
|
|
* Function SetFastGrid2()
|
|
*
|
|
* Switches grid settings to the 1st "fast" setting predefined by user.
|
|
*/
|
|
void SetFastGrid2();
|
|
|
|
/**
|
|
* Function IsGridVisible()
|
|
*
|
|
* @return true if the grid is shown
|
|
*/
|
|
virtual bool IsGridVisible() const override;
|
|
|
|
/**
|
|
* Function SetGridVisibility()
|
|
* Turn the display of the canvas grid on/off
|
|
*
|
|
* Note: After calling, the view must be refreshed to update the grid display
|
|
*
|
|
* @param aVisible = true if the grid is shown
|
|
*/
|
|
virtual void SetGridVisibility( bool aVisible ) override;
|
|
|
|
/**
|
|
* Function DisplayGridMsg()
|
|
*
|
|
* Display the current grid pane on the status bar.
|
|
*/
|
|
void DisplayGridMsg();
|
|
|
|
PCB_DRAW_PANEL_GAL* GetCanvas() const override;
|
|
|
|
///> @copydoc EDA_DRAW_FRAME::UseGalCanvas
|
|
virtual void ActivateGalCanvas() override;
|
|
|
|
DECLARE_EVENT_TABLE()
|
|
};
|
|
|
|
#endif // PCB_BASE_FRAME_H
|