pad_tool.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * 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 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/>.
 */
 
#pragma once
 
#include <memory>
 
#include <tools/pcb_tool_base.h>
 
class ACTION_MENU;
class PAD;
class PAD_MASTER_PROVIDER;
class PCB_SHAPE;
 
 
class PAD_TOOL : public PCB_TOOL_BASE
{
public:
    PAD_TOOL();
    ~PAD_TOOL();

    void Reset( RESET_REASON aReason ) override;

    bool Init() override;

    int EnumeratePads( const TOOL_EVENT& aEvent );
 
    int PadTable( const TOOL_EVENT& aEvent );

    int PlacePad( const TOOL_EVENT& aEvent );

    int EditPad( const TOOL_EVENT& aEvent );
 
    int OnUndoRedo( const TOOL_EVENT& aEvent );
 
    bool InPadEditMode() { return m_editPad != niluuid; }
    void ExitPadEditMode();
 
    wxString GetLastPadNumber() const { return m_lastPadNumber; }
    void SetLastPadNumber( const wxString& aPadNumber ) { m_lastPadNumber = aPadNumber; }

    void RecordMasterPad( const PAD& aPad );

    std::vector<PCB_SHAPE*> RecombinePad( PAD* aPad, bool aIsDryRun );
 
protected:
    void setTransitions() override;
 
private:
    int pastePadProperties( const TOOL_EVENT& aEvent );

    int copyPadSettings( const TOOL_EVENT& aEvent );

    int pushPadSettings( const TOOL_EVENT& aEvent );
 
    void explodePad( PAD* aPad, BOARD_COMMIT& aCommit );
 
    void enterPadEditMode();
 
private:
    wxString           m_lastPadNumber;
 
    HIGH_CONTRAST_MODE m_previousHighContrastMode;
    KIID               m_editPad;

    std::unique_ptr<PAD_MASTER_PROVIDER> m_masterPadProvider;

    std::unique_ptr<PAD> m_bufferPad;
};