pcb_control.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-2020 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_CONTROL_H
#define PCB_CONTROL_H
 
#include <pcb_io/pcb_io_mgr.h>
#include <functional>
#include <memory>
#include <tools/pcb_tool_base.h>
#include <status_popup.h>
#include <wx/dialog.h>
#include <wx/weakref.h>
 
namespace KIGFX {
    class ORIGIN_VIEWITEM;
}
 
class PCB_BASE_FRAME;
class BOARD_ITEM;
class PCB_GENERATED_TABLE;

 
class PCB_CONTROL : public PCB_TOOL_BASE
{
public:
    PCB_CONTROL();
    ~PCB_CONTROL();

    void Reset( RESET_REASON aReason ) override;
 
    int AddLibrary( const TOOL_EVENT& aEvent );
    int Print( const TOOL_EVENT& aEvent );
    int Quit( const TOOL_EVENT& aEvent );
 
    // Footprint library control actions
    int LoadFpFromBoard( const TOOL_EVENT& aEvent );
    int SaveFpToBoard( const TOOL_EVENT& aEvent );
    int IterateFootprint( const TOOL_EVENT& aEvent );
 
    // Display modes
    int ToggleRatsnest( const TOOL_EVENT& aEvent );
    int ZoneDisplayMode( const TOOL_EVENT& aEvent );
    int TrackDisplayMode( const TOOL_EVENT& aEvent );
    int ViaDisplayMode( const TOOL_EVENT& aEvent );
 
    // Update the view with the new high-contrast mode from the display settings
    int HighContrastMode( const TOOL_EVENT& aEvent );
 
    int ContrastModeFeedback( const TOOL_EVENT& aEvent );
 
    // Rotate through the available high-contrast, net color and ratsnest color modes
    int HighContrastModeCycle( const TOOL_EVENT& aEvent );
    int NetColorModeCycle( const TOOL_EVENT& aEvent );
    int RatsnestModeCycle( const TOOL_EVENT& aEvent );
 
    // Layer control
    int LayerSwitch( const TOOL_EVENT& aEvent );
    int LayerNext( const TOOL_EVENT& aEvent );
    int LayerPrev( const TOOL_EVENT& aEvent );
    int LayerToggle( const TOOL_EVENT& aEvent );
    int LayerAlphaInc( const TOOL_EVENT& aEvent );
    int LayerAlphaDec( const TOOL_EVENT& aEvent );
    int CycleLayerPresets( const TOOL_EVENT& aEvent );
    int LayerPresetFeedback( const TOOL_EVENT& aEvent );
 
    // Grid control
    int GridPlaceOrigin( const TOOL_EVENT& aEvent );
    int GridResetOrigin( const TOOL_EVENT& aEvent );
 
    // Low-level access (below undo) to setting the grid origin
    static void DoSetGridOrigin( KIGFX::VIEW* aView, PCB_BASE_FRAME* aFrame,
                                 EDA_ITEM* originViewItem, const VECTOR2D& aPoint );
 
    int Undo( const TOOL_EVENT& aEvent );
    int Redo( const TOOL_EVENT& aEvent );
 
    // Snapping control
    int SnapMode( const TOOL_EVENT& aEvent );
    int SnapModeFeedback( const TOOL_EVENT& aEvent );
 
    // Miscellaneous
    int InteractiveDelete( const TOOL_EVENT& aEvent );
    int Paste( const TOOL_EVENT& aEvent );
    int AppendBoardFromFile( const TOOL_EVENT& aEvent );
    int AppendDesignBlock( const TOOL_EVENT& aEvent );
    int ApplyDesignBlockLayout( const TOOL_EVENT& aEvent );
    int PlaceLinkedDesignBlock( const TOOL_EVENT& aEvent );
    int SaveToLinkedDesignBlock( const TOOL_EVENT& aEvent );
    int AppendBoard( PCB_IO& pi, const wxString& fileName, DESIGN_BLOCK* aDesignBlock = nullptr,
                     BOARD_COMMIT* aCommit = nullptr, bool aSkipMove = false );
    int UpdateMessagePanel( const TOOL_EVENT& aEvent );
    int PlaceCharacteristics( const TOOL_EVENT& aEvent );
    int PlaceStackup( const TOOL_EVENT& aEvent );
    int PlaceDrillChart( const TOOL_EVENT& aEvent );
    int PlaceDrillMap( const TOOL_EVENT& aEvent );
    int ShowDrillGroups( const TOOL_EVENT& aEvent );
 
    int CollectAndEmbed3DModels( const TOOL_EVENT& aEvent );
 
    int FlipPcbView( const TOOL_EVENT& aEvent );
 
    int RehatchShapes( const TOOL_EVENT& aEvent );

    static void rehatchBoardItem( KIGFX::VIEW* aView, BOARD_ITEM* aItem );
 
    // Drag and drop
    int DdAppendBoard( const TOOL_EVENT& aEvent );
    int DdAddLibrary( const TOOL_EVENT& aEvent );
    int DdImportFootprint( const TOOL_EVENT& aEvent );
 
private:
    void setTransitions() override;

    void unfilledZoneCheck();

    void pruneItemLayers( std::vector<BOARD_ITEM*>& aItems );

    bool placeBoardItems( BOARD_COMMIT* aCommit, std::vector<BOARD_ITEM*>& aItems, bool aIsNew, bool aAnchorAtOrigin,
                          bool aReannotateDuplicates, bool aSkipMove );
 
    bool placeBoardItems( BOARD_COMMIT* aCommit, BOARD* aBoard, bool aAnchorAtOrigin, bool aReannotateDuplicates,
                          bool aSkipMove );

    PCB_LAYER_ID pickDocumentationLayer( const std::function<bool( PCB_LAYER_ID )>& aAvailable,
                                         const wxString&                            aNoLayerMessage );

    int placeGeneratedTable( std::unique_ptr<PCB_GENERATED_TABLE> aTable, const wxString& aNoLayerMessage,
                             const wxString& aUndoMessage );
 
private:
    PCB_BASE_FRAME*                         m_frame;
 
    std::unique_ptr<KIGFX::ORIGIN_VIEWITEM> m_gridOrigin;
 
    BOARD_ITEM*                             m_pickerItem;
 
    std::unique_ptr<STATUS_TEXT_POPUP>      m_statusPopup;

    wxWeakRef<wxDialog>                     m_drillGroupsDialog;
};
 
#endif