pcb_draw_panel_gal.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2014 CERN
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <[email protected]>
 *
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#ifndef PCB_DRAW_PANEL_GAL_H_
#define PCB_DRAW_PANEL_GAL_H_
 
#include <class_draw_panel_gal.h>
#include <layer_ids.h>
#include <pcb_view.h>
 
class DS_PROXY_VIEW_ITEM;
class RATSNEST_VIEW_ITEM;
class CONNECTIVITY_DATA;
class PROGRESS_REPORTER;

void ApplyPcbGalLayerOrder( KIGFX::VIEW* aView );
 
class PCB_DRAW_PANEL_GAL : public EDA_DRAW_PANEL_GAL
{
public:
    PCB_DRAW_PANEL_GAL( wxWindow* aParentWindow, wxWindowID aWindowId, const wxPoint& aPosition,
                        const wxSize& aSize, KIGFX::GAL_DISPLAY_OPTIONS& aOptions,
                        GAL_TYPE aGalType = GAL_TYPE_MODERN );
 
    virtual ~PCB_DRAW_PANEL_GAL();

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

    void SetDrawingSheet( DS_PROXY_VIEW_ITEM* aDrawingSheet );
 
    DS_PROXY_VIEW_ITEM* GetDrawingSheet() const { return m_drawingSheet.get(); }
 
    // TODO(JE) Look at optimizing this out
    void UpdateColors();

    void prepareGridSources() override;

    virtual void SetHighContrastLayer( int aLayer ) override
    {
        SetHighContrastLayer( static_cast< PCB_LAYER_ID >( aLayer ) );
    }

    void SetHighContrastLayer( PCB_LAYER_ID aLayer );

    void ChangeHighContrastLayer( PCB_LAYER_ID aLayer );

    virtual void SetTopLayer( int aLayer ) override
    {
        SetTopLayer( static_cast< PCB_LAYER_ID >( aLayer ) );
    }

    void SetTopLayer( PCB_LAYER_ID aLayer );

    void SyncLayersVisibility( const BOARD* aBoard );

    static void SyncLayersVisibility( KIGFX::VIEW& aView, const BOARD* aBoard, PCB_LAYER_ID aActiveLayer );

    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

    void OnShow() override;
 
    bool SwitchBackend( GAL_TYPE aGalType ) override;

    void RedrawRatsnest();

    BOX2I GetDefaultViewBBox() const override;
 
    virtual KIGFX::PCB_VIEW* GetView() const override;
 
protected:
    void setDefaultLayerOrder();

    void setDefaultLayerDeps();

    void updateCanvasFadedLayers();

    void applyHighContrastLayer( PCB_LAYER_ID aLayer, bool aOnlyLayerChanged );

    void addRatsnest( std::shared_ptr<CONNECTIVITY_DATA> aConnectivity );
 
    void beforeRedraw() override;
 
protected:
    std::unique_ptr<DS_PROXY_VIEW_ITEM> m_drawingSheet;  

    bool m_highContrastShown = false;

    bool m_highContrastHidden = false;
    std::unique_ptr<RATSNEST_VIEW_ITEM> m_ratsnest;      
    std::unique_ptr<RATSNEST_VIEW_ITEM> m_localRatsnest; 
};
 
#endif /* PCB_DRAW_PANEL_GAL_H_ */