eda_draw_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) 2009 Jean-Pierre Charras, [email protected]
 * Copyright (C) 2011 Wayne Stambaugh <[email protected]>
 * Copyright (C) 1992-2024 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 DRAW_FRAME_H_
#define DRAW_FRAME_H_
 
#include <api/api_plugin.h>
#include <eda_base_frame.h>
#include <eda_search_data.h>
#include <kiway_player.h>
#include <gal/gal_display_options.h>
#include <gal_display_options_common.h>
#include <gal/color4d.h>
#include <class_draw_panel_gal.h>
#include <kiid.h>
#include <hotkeys_basic.h>
#include <widgets/lib_tree.h>
 
class EDA_ITEM;
class wxSingleInstanceChecker;
class ACTION_TOOLBAR;
class COLOR_SETTINGS;
class LOCKFILE;
class TOOL_MENU;
class APP_SETTINGS_BASE;
class wxFindReplaceData;
class SEARCH_PANE;
class HOTKEY_CYCLE_POPUP;
class PROPERTIES_PANEL;
class NET_INSPECTOR_PANEL;
enum class BITMAP_TYPE;
 
namespace KIGFX
{
 class GAL_DISPLAY_OPTIONS;
 class RENDER_SETTINGS;
}
 
using KIGFX::COLOR4D;
using KIGFX::RENDER_SETTINGS;
 
#define LIB_EDIT_FRAME_NAME wxT( "LibeditFrame" )
#define LIB_VIEW_FRAME_NAME wxT( "ViewlibFrame" )
#define SCH_EDIT_FRAME_NAME wxT( "SchematicFrame" )
#define SYMBOL_CHOOSER_FRAME_NAME wxT( "SymbolChooserFrame" )
#define PL_EDITOR_FRAME_NAME wxT( "PlEditorFrame" )
#define FOOTPRINT_WIZARD_FRAME_NAME wxT( "FootprintWizard" )
#define FOOTPRINT_CHOOSER_FRAME_NAME wxT( "FootprintChooserFrame" )
#define FOOTPRINT_EDIT_FRAME_NAME wxT( "ModEditFrame" )
#define FOOTPRINT_VIEWER_FRAME_NAME wxT( "ModViewFrame" )
#define PCB_EDIT_FRAME_NAME wxT( "PcbFrame" )
 
 
class EDA_DRAW_FRAME : public KIWAY_PLAYER
{
public:
 EDA_DRAW_FRAME( KIWAY* aKiway, wxWindow* aParent, FRAME_T aFrameType, const wxString& aTitle,
 const wxPoint& aPos, const wxSize& aSize, long aStyle,
 const wxString& aFrameName, const EDA_IU_SCALE& aIuScale );
 
 ~EDA_DRAW_FRAME();
 
 bool LockFile( const wxString& aFileName );
 
 void ReleaseFile();
 
 void ScriptingConsoleEnableDisable();
 
 bool IsScriptingConsoleVisible();
 
 EDA_SEARCH_DATA& GetFindReplaceData() { return *m_findReplaceData; }
 wxArrayString& GetFindHistoryList() { return m_findStringHistoryList; }
 
 virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) = 0;
 virtual const PAGE_INFO& GetPageSettings() const = 0;
 
 virtual const VECTOR2I GetPageSizeIU() const = 0;
 
 bool GetShowPolarCoords() const { return m_polarCoords; }
 void SetShowPolarCoords( bool aShow ) { m_polarCoords = aShow; }
 
 void ToggleUserUnits() override;
 
 void GetUnitPair( EDA_UNITS& aPrimaryUnit, EDA_UNITS& aSecondaryUnits ) override;
 
 virtual const VECTOR2I& GetGridOrigin() const = 0;
 virtual void SetGridOrigin( const VECTOR2I& aPosition ) = 0;
 
 VECTOR2I GetNearestGridPosition( const VECTOR2I& aPosition ) const;
 
 VECTOR2I GetNearestHalfGridPosition( const VECTOR2I& aPosition ) const;
 
 virtual const TITLE_BLOCK& GetTitleBlock() const = 0;
 virtual void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) = 0;
 
 // the background color of the draw canvas:
 // Virtual because some frames can have a specific way to get/set the bg color
 virtual COLOR4D GetDrawBgColor() const { return m_drawBgColor; }
 virtual void SetDrawBgColor( const COLOR4D& aColor) { m_drawBgColor= aColor ; }
 
 virtual COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const;
 
 bool LibraryFileBrowser( bool doOpen, wxFileName& aFilename, const wxString& wildcard,
 const wxString& ext, bool isDirectory = false, bool aIsGlobal = false,
 const wxString& aGlobalPath = wxEmptyString );
 
 void CommonSettingsChanged( bool aEnvVarsChanged, bool aTextVarsChanged ) override;
 
 virtual wxString GetScreenDesc() const;
 virtual wxString GetFullScreenDesc() const;
 
 virtual BASE_SCREEN* GetScreen() const { return m_currentScreen; }
 
 void EraseMsgBox();
 
 virtual void ReCreateHToolbar() { };
 virtual void ReCreateVToolbar() { };
 virtual void ReCreateOptToolbar() { };
 virtual void ReCreateAuxiliaryToolbar() { }
 
 virtual void UpdateToolbarControlSizes() { }
 
 /*
 * These 4 functions provide a basic way to show/hide grid and /get/set grid color.
 *
 * These parameters are saved in KiCad config for each main frame.
 */
 bool IsGridVisible() const;
 virtual void SetGridVisibility( bool aVisible );
 
 bool IsGridOverridden() const;
 virtual void SetGridOverrides( bool aOverride );
 
 virtual COLOR4D GetGridColor() { return m_gridColor; }
 virtual void SetGridColor( const COLOR4D& aColor ) { m_gridColor = aColor; }
 
 void OnSelectGrid( wxCommandEvent& event );
 
 void UpdateGridSelectBox();
 
 void OnUpdateSelectGrid( wxUpdateUIEvent& aEvent );
 
 void OnUpdateSelectZoom( wxUpdateUIEvent& aEvent );
 
 void UpdateZoomSelectBox();
 
 const wxString GetZoomLevelIndicator() const;
 
 virtual void OnSelectZoom( wxCommandEvent& event );
 
 virtual void OnSize( wxSizeEvent& event ) override;
 
 void OnMove( wxMoveEvent& aEvent ) override;
 
 virtual void HardRedraw();
 
 virtual void Zoom_Automatique( bool aWarpPointer );
 
 void FocusOnLocation( const VECTOR2I& aPos );
 
 void AddStandardSubMenus( TOOL_MENU& aMenu );
 
 void PrintDrawingSheet( const RENDER_SETTINGS* aSettings, BASE_SCREEN* aScreen,
 const std::map<wxString, wxString>* aProperties, double aMils2Iu,
 const wxString& aFilename, const wxString& aSheetLayer = wxEmptyString );
 
 void DisplayToolMsg( const wxString& msg ) override;
 
 void DisplayConstraintsMsg( const wxString& msg );
 
 virtual void OnPageSettingsChange() {}
 
 void UpdateStatusBar() override;
 
 void DisplayUnitsMsg();
 
 virtual void DisplayGridMsg();
 
 void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
 void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
 void AppendMsgPanel( const wxString& aTextUpper, const wxString& aTextLower, int aPadding = 6 );
 
 virtual void ClearMsgPanel();
 
 void SetMsgPanel( const std::vector< MSG_PANEL_ITEM >& aList );
 void SetMsgPanel( EDA_ITEM* aItem );
 
 void SetMsgPanel( const wxString& aTextUpper, const wxString& aTextLower, int aPadding = 6 );
 
 virtual void UpdateMsgPanel();
 
 virtual LIB_TREE* GetLibTree() const { return nullptr; }
 virtual LIB_ID GetTargetLibId() const { return LIB_ID(); }
 
 virtual bool IsLibraryTreeShown() const { return false; }
 virtual void ToggleLibraryTree() {};
 virtual void FocusLibraryTreeInput() {};
 
 PROPERTIES_PANEL* GetPropertiesPanel() { return m_propertiesPanel; }
 
 void UpdateProperties();
 
 virtual void ToggleProperties() {}
 
 static const wxString PropertiesPaneName() { return wxS( "PropertiesManager" ); }
 
 static const wxString NetInspectorPanelName() { return wxS( "NetInspector" ); }
 
 virtual EDA_ITEM* GetItem( const KIID& aId ) const { return nullptr; }
 
 virtual void PrintPage( const RENDER_SETTINGS* aSettings );
 
 virtual void ActivateGalCanvas();
 
 virtual void SwitchCanvas( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType );
 
 virtual EDA_DRAW_PANEL_GAL* GetCanvas() const { return m_canvas; }
 void SetCanvas( EDA_DRAW_PANEL_GAL* aPanel ) { m_canvas = aPanel; }
 
 wxWindow* GetToolCanvas() const override { return GetCanvas(); }
 
 GAL_DISPLAY_OPTIONS_IMPL& GetGalDisplayOptions() { return m_galDisplayOptions; }
 
 void RefreshCanvas() override
 {
 GetCanvas()->Refresh();
 }
 
 virtual const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const;
 
 void RecreateToolbars();
 
 void OnToolbarSizeChanged();
 
 void ShowChangedLanguage() override;
 
 HOTKEY_CYCLE_POPUP* GetHotkeyPopup() { return m_hotkeyPopup; }
 
 virtual void CreateHotkeyPopup();
 
 
 bool SaveCanvasImageToFile( const wxString& aFileName, BITMAP_TYPE aBitmapType );
 
 virtual void OnApiPluginInvoke( wxCommandEvent& aEvent );
 
 virtual PLUGIN_ACTION_SCOPE PluginActionScope() const { return PLUGIN_ACTION_SCOPE::INVALID; }
 
 
 DECLARE_EVENT_TABLE()
 
protected:
 virtual void SetScreen( BASE_SCREEN* aScreen ) { m_currentScreen = aScreen; }
 
 void unitsChangeRefresh() override;
 
 void setupUnits( APP_SETTINGS_BASE* aCfg );
 
 void updateStatusBarWidths();
 
 std::vector<wxWindow*> findDialogs();
 
 virtual void resolveCanvasType();
 
 EDA_DRAW_PANEL_GAL::GAL_TYPE loadCanvasTypeSetting( APP_SETTINGS_BASE* aCfg = nullptr );
 
 bool saveCanvasTypeSetting( EDA_DRAW_PANEL_GAL::GAL_TYPE aCanvasType );
 
 virtual void handleActivateEvent( wxActivateEvent& aEvent );
 void onActivate( wxActivateEvent& aEvent );
 
 virtual void addApiPluginTools();
 
 
 wxSocketServer* m_socketServer;
 
 std::unique_ptr<LOCKFILE> m_file_checker;
 
 COLOR4D m_gridColor; // Grid color
 COLOR4D m_drawBgColor; // The background color of the draw canvas; BLACK for
 // Pcbnew, BLACK or WHITE for Eeschema
 int m_undoRedoCountMax; // Default Undo/Redo command Max depth, to be handed
 // to screens
 bool m_polarCoords; // For those frames that support polar coordinates
 
 bool m_showBorderAndTitleBlock; // Show the drawing sheet (border & title block).
 
 wxChoice* m_gridSelectBox;
 wxChoice* m_zoomSelectBox;
 
 ACTION_TOOLBAR* m_mainToolBar;
 ACTION_TOOLBAR* m_auxiliaryToolBar; // Additional tools under main toolbar
 ACTION_TOOLBAR* m_drawToolBar; // Drawing tools (typically on right edge of window)
 ACTION_TOOLBAR* m_optionsToolBar; // Options (typically on left edge of window)
 
 std::unique_ptr<EDA_SEARCH_DATA> m_findReplaceData;
 wxArrayString m_findStringHistoryList;
 wxArrayString m_replaceStringHistoryList;
 
 EDA_MSG_PANEL* m_messagePanel;
 int m_msgFrameHeight;
 
 COLOR_SETTINGS* m_colorSettings;
 SEARCH_PANE* m_searchPane;
 PROPERTIES_PANEL* m_propertiesPanel;
 NET_INSPECTOR_PANEL* m_netInspectorPanel;
 
 HOTKEY_CYCLE_POPUP* m_hotkeyPopup;
 
 EDA_DRAW_PANEL_GAL::GAL_TYPE m_canvasType;
 
 static bool m_openGLFailureOccured; 
 
private:
 BASE_SCREEN* m_currentScreen; 
 EDA_DRAW_PANEL_GAL* m_canvas;
 
 GAL_DISPLAY_OPTIONS_IMPL m_galDisplayOptions;
 
 int m_lastToolbarIconSize;
};
 
#endif // DRAW_FRAME_H_