KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pad_tool.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <https://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
22#include <tools/pcb_tool_base.h>
23
24class ACTION_MENU;
25class PCB_SHAPE;
26
27
28class PAD_TOOL : public PCB_TOOL_BASE
29{
30public:
31 PAD_TOOL();
32 ~PAD_TOOL() = default;
33
35 void Reset( RESET_REASON aReason ) override;
36
38 bool Init() override;
39
43 int EnumeratePads( const TOOL_EVENT& aEvent );
44
45 int PadTable( const TOOL_EVENT& aEvent );
46
50 int PlacePad( const TOOL_EVENT& aEvent );
51
55 int EditPad( const TOOL_EVENT& aEvent );
56
57 int OnUndoRedo( const TOOL_EVENT& aEvent );
58
59 bool InPadEditMode() { return m_editPad != niluuid; }
60 void ExitPadEditMode();
61
62 wxString GetLastPadNumber() const { return m_lastPadNumber; }
63 void SetLastPadNumber( const wxString& aPadNumber ) { m_lastPadNumber = aPadNumber; }
64
71 std::vector<PCB_SHAPE*> RecombinePad( PAD* aPad, bool aIsDryRun );
72
73private:
75 void setTransitions() override;
76
78 int pastePadProperties( const TOOL_EVENT& aEvent );
79
81 int copyPadSettings( const TOOL_EVENT& aEvent );
82
84 int pushPadSettings( const TOOL_EVENT& aEvent );
85
86 void explodePad( PAD* aPad, PCB_LAYER_ID* aLayer, BOARD_COMMIT& aCommit );
87
88 void enterPadEditMode();
89
90private:
92
95};
HIGH_CONTRAST_MODE
Determine how inactive layers should be displayed.
Define the structure of a menu based on ACTIONs.
Definition action_menu.h:43
Definition kiid.h:44
int OnUndoRedo(const TOOL_EVENT &aEvent)
Definition pad_tool.cpp:728
HIGH_CONTRAST_MODE m_previousHighContrastMode
Definition pad_tool.h:93
void explodePad(PAD *aPad, PCB_LAYER_ID *aLayer, BOARD_COMMIT &aCommit)
Definition pad_tool.cpp:830
void setTransitions() override
< Bind handlers to corresponding TOOL_ACTIONs.
Definition pad_tool.cpp:899
int EditPad(const TOOL_EVENT &aEvent)
Enter/exit WYSIWYG pad shape editing.
Definition pad_tool.cpp:676
void ExitPadEditMode()
Definition pad_tool.cpp:800
KIID m_editPad
Definition pad_tool.h:94
int copyPadSettings(const TOOL_EVENT &aEvent)
Push pad settings from a pad to other pads on board or footprint.
Definition pad_tool.cpp:168
void enterPadEditMode()
Definition pad_tool.cpp:764
int pastePadProperties(const TOOL_EVENT &aEvent)
Copy pad settings from a pad to the board design settings.
Definition pad_tool.cpp:141
int PlacePad(const TOOL_EVENT &aEvent)
Place a pad in footprint editor.
Definition pad_tool.cpp:561
int EnumeratePads(const TOOL_EVENT &aEvent)
Tool for quick pad enumeration.
Definition pad_tool.cpp:295
int PadTable(const TOOL_EVENT &aEvent)
Definition pad_tool.cpp:882
bool Init() override
Init() is called once upon a registration of the tool.
Definition pad_tool.cpp:79
void SetLastPadNumber(const wxString &aPadNumber)
Definition pad_tool.h:63
wxString GetLastPadNumber() const
Definition pad_tool.h:62
std::vector< PCB_SHAPE * > RecombinePad(PAD *aPad, bool aIsDryRun)
Recombine an exploded pad (or one produced with overlapping polygons in an older version).
Definition pad_tool.cpp:872
~PAD_TOOL()=default
React to model/view changes.
bool InPadEditMode()
Definition pad_tool.h:59
wxString m_lastPadNumber
Definition pad_tool.h:91
int pushPadSettings(const TOOL_EVENT &aEvent)
Definition pad_tool.cpp:238
Definition pad.h:61
PCB_TOOL_BASE(TOOL_ID aId, const std::string &aName)
Constructor.
RESET_REASON
Determine the reason of reset for a tool.
Definition tool_base.h:74
Generic, UI-independent tool event.
Definition tool_event.h:167
void Reset() override
KIID niluuid(0)
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:56