pcb_base_frame.h

Go to the documentation of this file.

/*
 * 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 <[email protected]>
 * Copyright (C) 1992-2021 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
 */

#ifndef PCB_BASE_FRAME_H
#define PCB_BASE_FRAME_H


#include <eda_item.h>
#include <board.h>
#include <eda_draw_frame.h>
#include <outline_mode.h>
#include <lib_id.h>
#include <pcb_display_options.h>
#include <pcb_draw_panel_gal.h>
#include <pcb_origin_transforms.h>
#include <pcb_screen.h>
#include <richio.h>
#include <vector>


/* Forward declarations of classes. */
class APP_SETTINGS_BASE;
class BOARD;
class BOARD_CONNECTED_ITEM;
class COLOR_SETTINGS;
class FOOTPRINT;
class PAD;
class EDA_3D_VIEWER_FRAME;
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;
class FOOTPRINT_EDITOR_SETTINGS;
struct MAGNETIC_SETTINGS;
class PROGRESS_REPORTER;


wxDECLARE_EVENT( BOARD_CHANGED, wxCommandEvent );

class PCB_BASE_FRAME : public EDA_DRAW_FRAME
{
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();

 EDA_3D_VIEWER_FRAME* Get3DViewerFrame();

 virtual void Update3DView( bool aMarkDirty, bool aRefresh,
 const wxString* aTitle = nullptr );

 FOOTPRINT* LoadFootprint( const LIB_ID& aFootprintId );

 EDA_RECT GetBoardBoundingBox( bool aBoardEdgesOnly = false ) const;

 const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
 {
 /* "Zoom to Fit" calls this with "aIncludeAllVisible" as true. Since that feature
 * always ignored the page and border, this function returns a bbox without them
 * as well when passed true. This technically is not all things visible, but it
 * keeps behavior consistent.
 *
 * When passed false, this function returns a bbox of just the board edge. This
 * allows things like fabrication text or anything else outside the board edge to
 * be ignored, and just zooms up to the board itself.
 *
 * Calling "GetBoardBoundingBox(true)" when edge cuts are turned off will return
 * the entire page and border, so we call "GetBoardBoundingBox(false)" instead.
 */
 if( aIncludeAllVisible || !m_pcb->IsLayerVisible( Edge_Cuts ) )
 return GetBoardBoundingBox( false );
 else
 return GetBoardBoundingBox( true );
 }

 virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
 const PAGE_INFO& GetPageSettings() const override;
 const wxSize GetPageSizeIU() const override;

 const wxPoint& GetGridOrigin() const override;
 void SetGridOrigin( const wxPoint& aPoint ) override;

 const wxPoint& GetAuxOrigin() const;

 const wxPoint GetUserOrigin() const;

 ORIGIN_TRANSFORMS& GetOriginTransforms() override;

 const TITLE_BLOCK& GetTitleBlock() const override;
 void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;

 virtual BOARD_DESIGN_SETTINGS& GetDesignSettings() const;

 virtual COLOR_SETTINGS* GetColorSettings() const override
 {
 wxFAIL_MSG( wxT( "Color settings requested for a PCB_BASE_FRAME that does not override!" ) );
 return nullptr;
 }

 PCBNEW_SETTINGS& Settings() { return *m_settings; }

 void SetDrawBgColor( const COLOR4D& aColor ) override;

 const PCB_DISPLAY_OPTIONS& GetDisplayOptions() const { return m_displayOptions; }

 void SetDisplayOptions( const PCB_DISPLAY_OPTIONS& aOptions, bool aRefresh = true );

 const ZONE_SETTINGS& GetZoneSettings() const;
 void SetZoneSettings( const ZONE_SETTINGS& aSettings );

 virtual const PCB_PLOT_PARAMS& GetPlotSettings() const;
 virtual void SetPlotSettings( const PCB_PLOT_PARAMS& aSettings );

 virtual void SetBoard( BOARD* aBoard, PROGRESS_REPORTER* aReporter = nullptr );

 BOARD* GetBoard() const
 {
 wxASSERT( m_pcb );
 return m_pcb;
 }

 virtual BOARD_ITEM_CONTAINER* GetModel() const = 0;

 EDA_ITEM* GetItem( const KIID& aId ) const override;

 void FocusOnItem( BOARD_ITEM* aItem, PCB_LAYER_ID aLayer = UNDEFINED_LAYER );
 void FocusOnItems( std::vector<BOARD_ITEM*> aItems, PCB_LAYER_ID aLayer = UNDEFINED_LAYER );

 // General
 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(); }

 EDA_3D_VIEWER_FRAME* CreateAndShow3D_Frame();

 GENERAL_COLLECTORS_GUIDE GetCollectorsGuide();

 wxString SelectLibrary( const wxString& aNicknameExisting );

 FOOTPRINT* GetFootprintFromBoardByReference();

 virtual void OnModify();

 FOOTPRINT* CreateNewFootprint( const wxString& aFootprintName, bool aQuiet = false );

 void PlaceFootprint( FOOTPRINT* aFootprint, bool aRecreateRatsnest = true );

 void ShowPadPropertiesDialog( PAD* aPad );

 FOOTPRINT* SelectFootprintFromLibTree( LIB_ID aPreselect = LIB_ID() );

 virtual void AddFootprintToBoard( FOOTPRINT* aFootprint );

 wxString SelectFootprintFromLibBrowser();

 void Compile_Ratsnest( bool aDisplayStatus );

 virtual void SaveCopyInUndoList( EDA_ITEM* aItemToCopy, UNDO_REDO aTypeCommand ) = 0;

 virtual void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
 UNDO_REDO aTypeCommand ) = 0;


 PCB_LAYER_ID SelectOneLayer( PCB_LAYER_ID aDefaultLayer, LSET aNotAllowedLayersMask = LSET(),
 wxPoint aDlgPosition = wxDefaultPosition );

 virtual void SwitchLayer( PCB_LAYER_ID aLayer );

 virtual void SetActiveLayer( PCB_LAYER_ID aLayer ) { GetScreen()->m_Active_Layer = aLayer; }
 virtual PCB_LAYER_ID GetActiveLayer() const { return GetScreen()->m_Active_Layer; }

 SEVERITY GetSeverity( int aErrorCode ) const override;

 virtual void OnDisplayOptionsChanged() {}

 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;

 PCBNEW_SETTINGS* GetPcbNewSettings() const;

 FOOTPRINT_EDITOR_SETTINGS* GetFootprintEditorSettings() const;

 virtual MAGNETIC_SETTINGS* GetMagneticItemsSettings();

 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;

 void DisplayGridMsg() override;

 PCB_DRAW_PANEL_GAL* GetCanvas() const override;

 virtual void ActivateGalCanvas() override;

protected:
 bool canCloseWindow( wxCloseEvent& aCloseEvent ) override;

 FOOTPRINT* loadFootprint( const LIB_ID& aFootprintId );

 virtual void unitsChangeRefresh() override;

protected:
 BOARD* m_pcb;
 PCB_DISPLAY_OPTIONS m_displayOptions;
 PCB_ORIGIN_TRANSFORMS m_originTransforms;
 PCBNEW_SETTINGS* m_settings; // No ownership, just a shortcut
};

#endif // PCB_BASE_FRAME_H