gerbview_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) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2013 Wayne Stambaugh <[email protected]>
 * Copyright The 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 <https://www.gnu.org/licenses/>.
 */
 
#ifndef  WX_GERBER_STRUCT_H
#define  WX_GERBER_STRUCT_H
 
#include <file_history.h>
#include <eda_draw_frame.h>
#include <layer_ids.h>
#include <gerbview.h>
#include <gbr_layout.h>
#include <page_info.h>
#include <gbr_display_options.h>
 
#include <memory>
 
#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 GERBVIEW_SETTINGS;
class LSET;
class REPORTER;
class SELECTION;
class wxStaticText;
 
#if defined(__linux__) || defined(__FreeBSD__)
class SPNAV_2D_PLUGIN;
#else
class NL_GERBVIEW_PLUGIN;
#endif
 

 
#define GERBVIEW_FRAME_NAME wxT( "GerberFrame" )
 
class GERBVIEW_FRAME : public EDA_DRAW_FRAME
{
public:
    GERBVIEW_FRAME( KIWAY* aKiway, wxWindow* aParent );
    ~GERBVIEW_FRAME();
 
    void doCloseWindow() override;
 
    bool OpenProjectFiles( const std::vector<wxString>& aFileSet, int aCtl ) override;

    bool LoadListOfGerberAndDrillFiles( const wxString& aPath, const wxArrayString& aFilenameList,
                                        std::vector<int>* aFileType );
 
    void UpdateStatusBar() override;
 
    GERBVIEW_SETTINGS* gvconfig() const;

    void ApplyDisplaySettingsToGAL();

    bool IsElementVisible( int aLayerID ) const;

    void SetElementVisibility( int aLayerID, bool aNewState );

    void SetGridVisibility( bool aVisible ) override;

    LSET GetVisibleLayers() const;

    void SetVisibleLayers( const LSET& aLayerMask );

    bool IsLayerVisible( int aLayer ) const;

    COLOR4D GetVisibleElementColor( int aLayerID );
 
    void SetVisibleElementColor( int aLayerID, const COLOR4D& aColor );
 
    COLOR4D GetLayerColor( int aLayer ) const;
    void SetLayerColor( int aLayer, const COLOR4D& aColor );

    void ReFillLayerWidget();

    void SetActiveLayer( int aLayer, bool doLayerWidgetUpdate = true );

    int GetActiveLayer() const { return m_activeLayer; }

    int getNextAvailableLayer() const;

    void syncLayerWidget();

    void syncLayerBox( bool aRebuildLayerBox = false );

    void UpdateTitleAndInfo();

    void DisplayGridMsg() override;
 
    void LoadSettings( APP_SETTINGS_BASE* aCfg ) override;
    void SaveSettings( APP_SETTINGS_BASE* aCfg ) override;
 
    COLOR_SETTINGS* GetColorSettings( bool aForceRefresh = false ) const override;
 
    void ToggleLayerManager();
 
    void ShowChangedLanguage() override;

    void OnSelectHighlightChoice( wxCommandEvent& event );

    void OnSelectActiveDCode( wxCommandEvent& event );

    void OnSelectActiveLayer( wxCommandEvent& event );

    void OnQuit( wxCommandEvent& event );
 
    void OnUpdateSelectDCode( wxUpdateUIEvent& aEvent );

    void OnGbrFileHistory( wxCommandEvent& event );

    void OnDrlFileHistory( wxCommandEvent& event );

    void OnZipFileHistory( wxCommandEvent& event );

    void OnJobFileHistory( wxCommandEvent& event );

    bool unarchiveFiles( const wxString& aFullFileName, REPORTER* aReporter = nullptr,
                         const wxArrayString* aMembers = nullptr );

    bool LoadAutodetectedFiles( const wxString& aFileName );

    bool LoadGerberFiles( const wxString& aFileName );
    bool Read_GERBER_File( const wxString& GERBER_FullFileName );

    bool LoadExcellonFiles( const wxString& aFileName );
    bool Read_EXCELLON_File( const wxString& aFullFileName );

    bool LoadZipArchiveFile( const wxString& aFileName, const wxArrayString* aMembers = nullptr );

    void ClearFileHistory() override;

    bool LoadGerberJobFile( const wxString& aFileName );
 
    // PCB handling
    bool Clear_DrawLayers( bool query );
    void Erase_Current_DrawLayer( bool query );
 
    void SortLayersByFileExtension();
    void SortLayersByX2Attributes();
 
    // Adjust draw params: draw offset and draw rotation for a gerber file image
    void SetLayerDrawPrms();

    void RemapLayers( const std::unordered_map<int, int>& remapping );

    void UpdateXORLayers();
 
    /*
     * Do nothing in GerbView.
     */
    void SaveCopyInUndoList( GERBER_DRAW_ITEM* aItemToCopy,
                             UNDO_REDO aTypeCommand = UNDO_REDO::UNSPECIFIED ) { }

    void SaveCopyInUndoList( const PICKED_ITEMS_LIST& aItemsList,
                             UNDO_REDO aTypeCommand )
    {
        // currently: do nothing in GerbView.
    }

    void ActivateGalCanvas() override;

    void CommonSettingsChanged( int aFlags ) override;
 
    SELECTION& GetCurrentSelection() override;

    void SetLayout( GBR_LAYOUT* aLayout )
    {
        delete m_gerberLayout;
        m_gerberLayout = aLayout;
    }
 
    GBR_LAYOUT* GetGerberLayout() const
    {
        wxASSERT( m_gerberLayout );
        return m_gerberLayout;
    }

    GERBER_FILE_IMAGE_LIST* GetImagesList() const
    {
        return m_gerberLayout->GetImagesList();
    }
 
    GERBER_FILE_IMAGE* GetGbrImage( int aIdx ) const;
 
    unsigned ImagesMaxCount() const;    
 
 
    void SetPageSettings( const PAGE_INFO& aPageSettings ) override;
    const PAGE_INFO& GetPageSettings() const override;
    const VECTOR2I   GetPageSizeIU() const override;
 
    const VECTOR2I& GetGridOrigin() const override { return m_grid_origin; }
    void            SetGridOrigin( const VECTOR2I& aPoint ) override { m_grid_origin = aPoint; }
 
    const TITLE_BLOCK&  GetTitleBlock() const override;
    void SetTitleBlock( const TITLE_BLOCK& aTitleBlock ) override;

    int SelectPCBLayer( int aDefaultLayer, int aCopperLayerCount, const wxString& aGerberName );

    COLOR4D GetGridColor() override;

    virtual void SetGridColor( const COLOR4D& aColor ) override;
 
    const BOX2I GetDocumentExtents( bool aIncludeAllVisible = true ) const override
    {
        wxASSERT( m_gerberLayout );
        return m_gerberLayout->ViewBBox();
    }
 
    void ClearToolbarControl( int aId ) override;
 
    DECLARE_EVENT_TABLE()
 
protected:
    void configureToolbars() override;
    void setupUIConditions() override;
    void doReCreateMenuBar() override;
 
    void handleActivateEvent( wxActivateEvent& aEvent ) override;
    void handleIconizeEvent( wxIconizeEvent& aEvent ) override;
 
private:
    void updateComponentListSelectBox();
    void updateNetnameListSelectBox();
    void updateAperAttributesSelectBox();
    void updateDCodeSelectBox();
    void unitsChangeRefresh() override;      // See class EDA_DRAW_FRAME
 
    void OnClearJobFileHistory( wxCommandEvent& aEvent );
    void OnClearZipFileHistory( wxCommandEvent& aEvent );
    void OnClearDrlFileHistory( wxCommandEvent& aEvent );
    void OnClearGbrFileHistory( wxCommandEvent& aEvent );
 
    void DoWithAcceptedFiles() override;

    bool LoadFileOrShowDialog( const wxString& aFileName, const wxString& dialogFiletypes,
                               const wxString& dialogTitle, const int filetype );
 
    // The Tool Framework initialization
    void setupTools();
 
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..)
 
    GERBER_LAYER_WIDGET*    m_LayersManager;
 
protected:
    FILE_HISTORY            m_zipFileHistory;
    FILE_HISTORY            m_drillFileHistory;
    FILE_HISTORY            m_jobFileHistory;
 
    wxString                m_lastFileName;     // The last filename chosen to be proposed to the
                                                // user.
 
private:
    bool                m_show_layer_manager_tools;
 
    GBR_LAYOUT*         m_gerberLayout;
    int                 m_activeLayer;
    VECTOR2I            m_grid_origin;
    PAGE_INFO           m_paper;            // used only to show paper limits to screen
    wxStaticText*       m_cmpText;          // a message on the auxiliary toolbar,
                                            // relative to the m_SelComponentBox
    wxStaticText*       m_netText;          // a message on the auxiliary toolbar,
                                            // relative to the m_SelNetnameBox
    wxStaticText*       m_apertText;        // a message on the auxiliary toolbar,
                                            // relative to the m_SelAperAttributesBox
    wxStaticText*       m_dcodeText;        // a message on the auxiliary toolbar,
                                            // relative to the m_DCodeSelector
 
#if defined(__linux__) || defined(__FreeBSD__)
    std::unique_ptr<SPNAV_2D_PLUGIN> m_spaceMouse;
#else
    std::unique_ptr<NL_GERBVIEW_PLUGIN> m_spaceMouse;
#endif
};
 
#endif /* WX_GERBER_STRUCT_H */