/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2013 Wayne Stambaugh * Copyright (C) 1992-2018 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 3 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, see . */ /** * @file gerbview_frame.h */ #ifndef WX_GERBER_STRUCT_H #define WX_GERBER_STRUCT_H #include #include #include #include #include #include #include #include #include #include extern COLORS_DESIGN_SETTINGS g_ColorsSettings; #define NO_AVAILABLE_LAYERS UNDEFINED_LAYER class DCODE_SELECTION_BOX; class GERBER_LAYER_WIDGET; class GBR_LAYER_BOX_SELECTOR; class GERBER_DRAW_ITEM; class GERBER_FILE_IMAGE; class GERBER_FILE_IMAGE_LIST; class REPORTER; /** * Class GERBVIEW_FRAME * is the main window used in GerbView. */ #define GERBVIEW_FRAME_NAME wxT( "GerberFrame" ) class GERBVIEW_FRAME : public EDA_DRAW_FRAME // PCB_BASE_FRAME { GBR_LAYOUT* m_gerberLayout; wxPoint m_grid_origin; PAGE_INFO m_paper; // used only to show paper limits to screen public: GBR_DISPLAY_OPTIONS m_DisplayOptions; /** * Function SetLayout * sets the m_gerberLayout member in such as way as to ensure deleting any previous * GBR_LAYOUT. * @param aLayout The GBR_LAYOUT to put into the frame. */ void SetLayout( GBR_LAYOUT* aLayout ) { delete m_gerberLayout; m_gerberLayout = aLayout; } GBR_LAYOUT* GetGerberLayout() const { wxASSERT( m_gerberLayout ); return m_gerberLayout; } /** * Accessors to GERBER_FILE_IMAGE_LIST and GERBER_FILE_IMAGE data */ GERBER_FILE_IMAGE_LIST* GetImagesList() const { return m_gerberLayout->GetImagesList(); } GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const; unsigned ImagesMaxCount() const; ///< The max number of file images /** * Function GetGerberLayoutBoundingBox * calculates the bounding box containing all gerber items. * @return EDA_RECT - the items bounding box */ EDA_RECT GetGerberLayoutBoundingBox(); 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 { return m_grid_origin; } void SetGridOrigin( const wxPoint& aPoint ) override { m_grid_origin = aPoint; } const TITLE_BLOCK& GetTitleBlock() const override; void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override; /** * Function SetCurItem * sets the currently selected item and displays it in the MsgPanel. * If the given item is NULL then the MsgPanel is erased and there is no * currently selected item. This function is intended to make the process * of "selecting" an item more formal, and to indivisibly tie the operation * of selecting an item to displaying it using GERBER_DRAW_ITEM::Display_Infos(). * @param aItem The GERBER_DRAW_ITEM to make the selected item or NULL if none. * @param aDisplayInfo = true to display item info, false if not (default = true) */ void SetCurItem( GERBER_DRAW_ITEM* aItem, bool aDisplayInfo = true ); /** Install the dialog box for layer selection * @param aDefaultLayer = Preselection (NB_PCB_LAYERS for "(Deselect)" layer) * @param aCopperLayerCount = number of copper layers * @param aShowDeselectOption = display a "(Deselect)" radiobutton (when set to true) * @return new layer value (NB_PCB_LAYERS when "(Deselect)" radiobutton selected), * or -1 if canceled * * Providing the option to also display a "(Deselect)" radiobutton makes the * GerbView's "Export to Pcbnew" command) more "user friendly", * by permitting any layer to be "deselected" immediately after its * corresponding radiobutton has been clicked on. (It would otherwise be * necessary to first cancel the "Select Layer:" dialog box (invoked after a * different radiobutton is clicked on) prior to then clicking on the "Deselect" * button provided within the "Layer selection:" dialog box). */ int SelectPCBLayer( int aDefaultLayer, int aOpperLayerCount, bool aNullLayer = false ); ///> @copydoc EDA_DRAW_FRAME::SetGridColor() virtual void SetGridColor( COLOR4D aColor ) override; protected: GERBER_LAYER_WIDGET* m_LayersManager; // Auxiliary file history used to store zip files history. wxFileHistory m_zipFileHistory; // Auxiliary file history used to store drill files history. wxFileHistory m_drillFileHistory; // Auxiliary file history used to store job files history. wxFileHistory m_jobFileHistory; /// The last filename chosen to be proposed to the user wxString m_lastFileName; public: wxChoice* m_SelComponentBox; // a choice box to display and highlight component graphic items wxChoice* m_SelNetnameBox; // a choice box to display and highlight netlist graphic items wxChoice* m_SelAperAttributesBox; // a choice box to display aperture attributes and highlight items GBR_LAYER_BOX_SELECTOR* m_SelLayerBox; // The combobox to select the current active graphic layer // (which is drawn on top on the other layers DCODE_SELECTION_BOX* m_DCodeSelector; // a list box to select the dcode Id to highlight. wxTextCtrl* m_TextInfo; // a wxTextCtrl used to display some info about // gerber data (format..) COLORS_DESIGN_SETTINGS* m_colorsSettings; private: // list of PARAM_CFG_xxx to read/write parameters saved in config PARAM_CFG_ARRAY m_configSettings; int m_displayMode; // Gerber images ("layers" in Gerbview) can be drawn: // - in fast mode (write mode) but if there are negative // items only the last image is correctly drawn (no // problem to see only one image or when no negative items) // - in "exact" mode (but slower) in write mode: // last image covers previous images // - in "exact" mode (also slower) in OR mode // (transparency mode) // m_displayMode = 0, 1 or 2 bool m_show_layer_manager_tools; void updateComponentListSelectBox(); void updateNetnameListSelectBox(); void updateAperAttributesSelectBox(); void updateDCodeSelectBox(); virtual void unitsChangeRefresh() override; // See class EDA_DRAW_FRAME // The Tool Framework initalization void setupTools(); // An array string to store warning messages when reading a gerber file. wxArrayString m_Messages; /// Updates the GAL with display settings changes void applyDisplaySettingsToGAL(); /** * Loads a list of Gerber files and updates the view based on them * @param aPath is the base path for the filenames if they are relative * @param aFilenameList is a list of filenames to load * @return true if every file loaded successfully */ bool loadListOfGerberFiles( const wxString& aPath, const wxArrayString& aFilenameList ); public: GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent ); ~GERBVIEW_FRAME(); void OnCloseWindow( wxCloseEvent& Event ); bool OpenProjectFiles( const std::vector& aFileSet, int aCtl ) override; // Virtual basic functions: void RedrawActiveWindow( wxDC* DC, bool EraseBg ) override; void ReCreateHToolbar() override; void ReCreateAuxiliaryToolbar() override; /** * Function ReCreateVToolbar * creates or updates the right vertical toolbar. * * @note This is currently not used. */ void ReCreateVToolbar() override; /** * Create or update the left vertical toolbar (option toolbar */ void ReCreateOptToolbar(); void ReCreateMenuBar() override; void OnLeftClick( wxDC* aDC, const wxPoint& aMousePos ) override; void OnLeftDClick( wxDC* aDC, const wxPoint& aMousePos ) override; bool OnRightClick( const wxPoint& aMousePos, wxMenu* aPopMenu ) override; void OnUpdateSelectTool( wxUpdateUIEvent& aEvent ); double BestZoom() override; void UpdateStatusBar() override; /** * 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; /** * Function ReportMessage * Add a message (a string) in message list * for instance when reading a Gerber file * @param aMessage = the string to add in list */ void ReportMessage( const wxString aMessage ) { m_Messages.Add( aMessage ); } /** * Function ClearMessageList * Clear the message list * Call it before reading a Gerber file */ void ClearMessageList() { m_Messages.Clear(); } /** * Function GetDisplayMode * @return 0 for fast mode (not fully compatible with negative objects) * 1 for exact mode, write mode * 2 for exact mode, OR mode (transparency mode) */ int GetDisplayMode() { return m_displayMode; } /** * Function SetDisplayMode * @param aMode = 0 for fast mode * 1 for exact mode, write mode * 2 for exact mode, OR mode (transparency mode) */ void SetDisplayMode( int aMode ) { m_displayMode = aMode; } /** * Function IsElementVisible * tests whether a given element category is visible. Keep this as an * inline function. * @param aItemIdVisible is an item id from the enum GERBVIEW_LAYER_ID * @return bool - true if the element is visible. */ bool IsElementVisible( GERBVIEW_LAYER_ID aItemIdVisible ) const; /** * Function SetElementVisibility * changes the visibility of an element category * @param aItemIdVisible is an item id from the enum GERBVIEW_LAYER_ID * @param aNewState = The new visibility state of the element category * (see enum PCB) */ void SetElementVisibility( GERBVIEW_LAYER_ID aItemIdVisible, bool aNewState ); /** * Function SetGridVisibility(), virtual from EDA_DRAW_FRAME * It may be overloaded by derived classes * @param aVisible = true if the grid must be shown */ void SetGridVisibility( bool aVisible ) override; /** * Function GetVisibleLayers * is a proxy function that calls the correspondent function in m_BoardSettings * Returns a bit-mask of all the layers that are visible * @return long - the visible layers in bit-mapped form. */ long GetVisibleLayers() const; /** * Function SetVisibleLayers * is a proxy function that calls the correspondent function in m_BoardSettings * changes the bit-mask of visible layers * @param aLayerMask = The new bit-mask of visible layers */ void SetVisibleLayers( long aLayerMask ); /** * Function IsLayerVisible * tests whether a given layer is visible * @param aLayer = The layer to be tested (still 0-31!) * @return bool - true if the layer is visible. */ bool IsLayerVisible( int aLayer ) const; /** * Function GetVisibleElementColor * returns the color of a gerber visible element. */ COLOR4D GetVisibleElementColor( GERBVIEW_LAYER_ID aItemIdVisible ); void SetVisibleElementColor( GERBVIEW_LAYER_ID aItemIdVisible, COLOR4D aColor ); /** * Function GetLayerColor * gets a layer color for any valid layer. */ COLOR4D GetLayerColor( int aLayer ) const; /** * Function SetLayerColor * changes a layer color for any valid layer. */ void SetLayerColor( int aLayer, COLOR4D aColor ); /** * Function GetNegativeItemsColor * @return the color of negative items. * This is usually the background color, but can be another color * in order to see negative objects */ COLOR4D GetNegativeItemsColor(); /** * Function DisplayLinesSolidMode * @return true to draw gerber lines in solid (filled) mode, * false to draw gerber lines in sketch mode */ bool DisplayLinesSolidMode() { return m_DisplayOptions.m_DisplayLinesFill; } /** * Function DisplayPolygonsSolidMode * @return true to draw polygon in solid (filled) mode, * false to draw polygon outlines only */ bool DisplayPolygonsSolidMode() { return m_DisplayOptions.m_DisplayPolygonsFill; } /** * Function DisplayFlashedItemsSolidMode * @return true to draw flashed items in solid (filled) mode, * false to draw draw flashed in sketch mode */ bool DisplayFlashedItemsSolidMode() { return m_DisplayOptions.m_DisplayFlashedItemsFill; } /** * Function ReFillLayerWidget * changes out all the layers in m_Layers and may be called upon * loading new gerber files. */ void ReFillLayerWidget(); /** * Function SetActiveLayer * will change the currently active layer to \a aLayer and also * update the GERBER_LAYER_WIDGET. */ void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true ); /** * Function SetActiveLayer * returns the active layer */ int GetActiveLayer(); /** * Function getNextAvailableLayer * finds the next empty layer starting at \a aLayer and returns it to the caller. If no * empty layers are found, NO_AVAILABLE_LAYERS is return. * @param aLayer The first layer to search. * @return The first empty layer found or NO_AVAILABLE_LAYERS. */ int getNextAvailableLayer( int aLayer = 0 ) const; bool hasAvailableLayers() const { return getNextAvailableLayer() != NO_AVAILABLE_LAYERS; } /** * Function syncLayerWidget * updates the currently "selected" layer within the GERBER_LAYER_WIDGET. * The currently active layer is defined by the return value of GetActiveLayer(). *

* This function cannot be inline without including layer_widget.h in * here and we do not want to do that. */ void syncLayerWidget(); /** * Function syncLayerBox * updates the currently "selected" layer within m_SelLayerBox * The currently active layer, as defined by the return value of * GetActiveLayer(). * @param aRebuildLayerBox = true to rebuild the layer box * false to just updates the selection. */ void syncLayerBox( bool aRebuildLayerBox = false ); /** * Function UpdateTitleAndInfo * displays the short filename (if exists) of the selected layer * on the caption of the main GerbView window * and some other parameters * Name of the layer (found in the gerber file: LN <name> command) in the status bar * Name of the Image (found in the gerber file: IN <name> command) in the status bar * and other data in toolbar */ void UpdateTitleAndInfo(); /** * Function GetConfigurationSettings * Populates the GerbView applications settings list. * (list of parameters that must be saved in GerbView parameters) * Currently, only the settings that are needed at start up by the main window are * defined here. There are other locally used settings scattered throughout the * GerbView source code (mainly in dialogs). If you need to define a configuration * setting that need to be loaded at run time, this is the place to define it. */ PARAM_CFG_ARRAY& GetConfigurationSettings( void ); void LoadSettings( wxConfigBase* aCfg ) override; void SaveSettings( wxConfigBase* aCfg ) override; void OnToggleCoordType( wxCommandEvent& aEvent ); void OnToggleFlashItemDrawMode( wxCommandEvent& aEvent ); void OnToggleLineDrawMode( wxCommandEvent& aEvent ); void OnTogglePolygonDrawMode( wxCommandEvent& aEvent ); void OnToggleShowLayerManager( wxCommandEvent& aEvent ); void ShowChangedLanguage() override; void Process_Special_Functions( wxCommandEvent& event ); void OnSelectOptionToolbar( wxCommandEvent& event ); /// Handles the changing of the highlighted component/net/attribute void OnSelectHighlightChoice( wxCommandEvent& event ); /** * Function OnSelectActiveDCode * Selects the active DCode for the current active layer. * Items using this DCode are highlighted. */ void OnSelectActiveDCode( wxCommandEvent& event ); /** * Function OnSelectActiveLayer * Selects the active layer: * - if a file is loaded, it is loaded in this layer * _ this layer is displayed on top of other layers */ void OnSelectActiveLayer( wxCommandEvent& event ); /** * Function OnShowGerberSourceFile * Call the preferred editor to show (and edit) the gerber source file * loaded in the active layer */ void OnShowGerberSourceFile( wxCommandEvent& event ); /** * Function OnSelectDisplayMode * called on a display mode selection * Mode selection can be fast display, * or exact mode with stacked images or with transparency */ void OnSelectDisplayMode( wxCommandEvent& event ); /** * Function OnQuit * called on request of application quit */ void OnQuit( wxCommandEvent& event ); ///> @copydoc EDA_DRAW_FRAME::GetHotKeyDescription() EDA_HOTKEY* GetHotKeyDescription( int aCommand ) const override; /** * Function OnHotKey. * ** Commands are case insensitive ** * Some commands are relatives to the item under the mouse cursor * @param aDC = current device context * @param aHotkeyCode = hotkey code (ascii or wxWidget code for special keys) * @param aPosition The cursor position in logical (drawing) units. * @param aItem = NULL or pointer on a EDA_ITEM under the mouse cursor */ bool OnHotKey( wxDC* aDC, int aHotkeyCode, const wxPoint& aPosition, EDA_ITEM* aItem = NULL ) override; GERBER_DRAW_ITEM* Locate( const wxPoint& aPosition, int typeloc ); void Process_Config( wxCommandEvent& event ); void InstallGerberOptionsDialog( wxCommandEvent& event ); void OnUpdateDrawMode( wxUpdateUIEvent& aEvent ); void OnUpdateCoordType( wxUpdateUIEvent& aEvent ); void OnUpdateFlashedItemsDrawMode( wxUpdateUIEvent& aEvent ); void OnUpdateLineDrawMode( wxUpdateUIEvent& aEvent ); void OnUpdatePolygonDrawMode( wxUpdateUIEvent& aEvent ); void OnUpdateShowDCodes( wxUpdateUIEvent& aEvent ); void OnUpdateShowNegativeItems( wxUpdateUIEvent& aEvent ); void OnUpdateShowLayerManager( wxUpdateUIEvent& aEvent ); void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent ); void OnUpdateLayerSelectBox( wxUpdateUIEvent& aEvent ); void OnUpdateDiffMode( wxUpdateUIEvent& aEvent ); void OnUpdateHighContrastMode( wxUpdateUIEvent& aEvent ); /** * Function BlockCommand * returns the block command (BLOCK_MOVE, BLOCK_COPY...) corresponding to * the \a aKey (ALT, SHIFT ALT ..) */ virtual int BlockCommand( EDA_KEY key ) override; /** * Function HandleBlockPlace * handles the block place command. */ virtual void HandleBlockPlace( wxDC* DC ) override; /** * Function HandleBlockEnd * handles the end of a block command, * It is called at the end of the definition of the area of a block. * Depending on the current block command, this command is executed * or parameters are initialized to prepare a call to HandleBlockPlace * in GetScreen()->m_BlockLocate * * @return false if no item selected, or command finished, * true if some items found and HandleBlockPlace must be called later. */ virtual bool HandleBlockEnd( wxDC* DC ) override; /** * Function Block_Move * moves all tracks and segments within the selected block. * New location is determined by the current offset from the selected * block's original location. */ void Block_Move(); /** * Function ToPrinter * Open a dialog frame to print layers */ void ToPrinter( wxCommandEvent& event ); void Files_io( wxCommandEvent& event ); /** * Function OnGbrFileHistory * deletes the current data and loads a Gerber file selected from history list on * current layer. */ void OnGbrFileHistory( wxCommandEvent& event ); /** * Function OnDrlFileHistory * deletes the current data and load a drill file in Excellon format selected from * history list on current layer. */ void OnDrlFileHistory( wxCommandEvent& event ); /** * Function OnZipFileHistory * deletes the current data and load a zip archive file selected from the * history list. The archive is expected coantaining a set of gerber and drill file */ void OnZipFileHistory( wxCommandEvent& event ); /** * deletes the current data and load a gerber job file selected from the * history list. */ void OnJobFileHistory( wxCommandEvent& event ); /** * Extracts gerber and drill files from the zip archive, and load them * @param aFullFileName is the full filename of the zip archive * @param aReporter a REPORTER to collect warning and error messages * @return true if OK, false if a file cannot be readable */ bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr ); /** * function LoadGerberFiles * Load a photoplot (Gerber) file or many files. * @param aFileName - void string or file name with full path to open or empty string to * open a new file. In this case one one file is loaded * if void string: user will be prompted for filename(s) * @return true if file was opened successfully. */ bool LoadGerberFiles( const wxString& aFileName ); bool Read_GERBER_File( const wxString& GERBER_FullFileName ); /** * function LoadExcellonFiles * Load a drill (EXCELLON) file or many files. * @param aFileName - void string or file name with full path to open or empty string to * open a new file. In this case one one file is loaded * if empty string: user will be prompted for filename(s) * @return true if file was opened successfully. */ bool LoadExcellonFiles( const wxString& aFileName ); bool Read_EXCELLON_File( const wxString& aFullFileName ); /** * function LoadZipArchiveFileLoadZipArchiveFile * Load a zipped archive file. * @param aFileName - void string or file name with full path to open or empty string to * open a new file. * if empty string: user will be prompted for filename(s) * @return true if file was opened successfully. */ bool LoadZipArchiveFile( const wxString& aFileName ); /** * Load a Gerber job file, and load gerber files found in job files. * @param aFileName - void string or file name with full path to open or empty string to * open a new file. * if empty string: user will be prompted for filename(s) * @return true if file(s) was opened successfully. */ bool LoadGerberJobFile( const wxString& aFileName ); bool GeneralControl( wxDC* aDC, const wxPoint& aPosition, EDA_KEY aHotKey = 0 ) override; /** * Set Size Items (Lines, Flashes) from DCodes List */ void Liste_D_Codes(); // PCB handling bool Clear_DrawLayers( bool query ); void Erase_Current_DrawLayer( bool query ); void SortLayersByX2Attributes(); /** * Updates the display options and refreshes the view as needed * @param aOptions is the new options to apply */ void UpdateDisplayOptions( const GBR_DISPLAY_OPTIONS& aOptions ); // Conversion function void ExportDataInPcbnewFormat( wxCommandEvent& event ); /* SaveCopyInUndoList() virtual * currently: do nothing in GerbView. */ void SaveCopyInUndoList( GERBER_DRAW_ITEM* aItemToCopy, UNDO_REDO_T aTypeCommand = UR_UNSPECIFIED, const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) { } /** * Function SaveCopyInUndoList (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 */ void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList, UNDO_REDO_T aTypeCommand, const wxPoint& aTransformPoint = wxPoint( 0, 0 ) ) { // currently: do nothing in GerbView. } /** Virtual function PrintPage * used to print a page * @param aDC = wxDC given by the calling print function * @param aPrintMasklayer = a 32 bits mask: bit n = 1 -> layer n is printed * @param aPrintMirrorMode = not used here (Set when printing in mirror mode) * @param aData = a pointer on an auxiliary data (not always used, NULL if not used) */ virtual void PrintPage( wxDC* aDC, LSET aPrintMasklayer, bool aPrintMirrorMode, void* aData = NULL ) override; ///> @copydoc EDA_DRAW_FRAME::UseGalCanvas virtual void UseGalCanvas( bool aEnable ) override; /** * switches currently used canvas (default / Cairo / OpenGL). */ void OnSwitchCanvas( wxCommandEvent& aEvent ); /** * Update UI called when switches currently used canvas (default / Cairo / OpenGL). */ void OnUpdateSwitchCanvas( wxUpdateUIEvent& aEvent ); /** * Allows Gerbview to install its preferences panels into the preferences dialog. */ void InstallPreferences( PAGED_DIALOG* aParent ) override; /** * Called after the preferences dialog is run. */ void CommonSettingsChanged() override; DECLARE_EVENT_TABLE() }; #endif /* WX_GERBER_STRUCT_H */