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, you may find one here:
18
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19
* or you may search the http://www.gnu.org website for the version 2 license,
20
* or you may write to the Free Software Foundation, Inc.,
21
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22
*/
23
24
#pragma once
25
26
#include <
tools/pcb_tool_base.h
>
27
28
class
ACTION_MENU
;
29
class
PCB_SHAPE
;
30
31
32
class
PAD_TOOL
:
public
PCB_TOOL_BASE
33
{
34
public
:
35
PAD_TOOL
();
36
~PAD_TOOL
() =
default
;
37
39
void
Reset
(
RESET_REASON
aReason )
override
;
40
42
bool
Init
()
override
;
43
47
int
EnumeratePads
(
const
TOOL_EVENT
& aEvent );
48
49
int
PadTable
(
const
TOOL_EVENT
& aEvent );
50
54
int
PlacePad
(
const
TOOL_EVENT
& aEvent );
55
59
int
EditPad
(
const
TOOL_EVENT
& aEvent );
60
61
int
OnUndoRedo
(
const
TOOL_EVENT
& aEvent );
62
63
bool
InPadEditMode
() {
return
m_editPad
!=
niluuid
; }
64
void
ExitPadEditMode
();
65
66
wxString
GetLastPadNumber
()
const
{
return
m_lastPadNumber
; }
67
void
SetLastPadNumber
(
const
wxString& aPadNumber ) {
m_lastPadNumber
= aPadNumber; }
68
75
std::vector<PCB_SHAPE*>
RecombinePad
(
PAD
* aPad,
bool
aIsDryRun );
76
77
private
:
79
void
setTransitions
()
override
;
80
82
int
pastePadProperties
(
const
TOOL_EVENT
& aEvent );
83
85
int
copyPadSettings
(
const
TOOL_EVENT
& aEvent );
86
88
int
pushPadSettings
(
const
TOOL_EVENT
& aEvent );
89
90
void
explodePad
(
PAD
* aPad,
PCB_LAYER_ID
* aLayer,
BOARD_COMMIT
& aCommit );
91
92
void
enterPadEditMode
();
93
94
private
:
95
wxString
m_lastPadNumber
;
96
97
HIGH_CONTRAST_MODE
m_previousHighContrastMode
;
98
KIID
m_editPad
;
99
};
HIGH_CONTRAST_MODE
HIGH_CONTRAST_MODE
Determine how inactive layers should be displayed.
Definition
board_project_settings.h:113
ACTION_MENU
Define the structure of a menu based on ACTIONs.
Definition
action_menu.h:47
BOARD_COMMIT
Definition
board_commit.h:48
KIID
Definition
kiid.h:49
PAD_TOOL::OnUndoRedo
int OnUndoRedo(const TOOL_EVENT &aEvent)
Definition
pad_tool.cpp:762
PAD_TOOL::m_previousHighContrastMode
HIGH_CONTRAST_MODE m_previousHighContrastMode
Definition
pad_tool.h:97
PAD_TOOL::explodePad
void explodePad(PAD *aPad, PCB_LAYER_ID *aLayer, BOARD_COMMIT &aCommit)
Definition
pad_tool.cpp:864
PAD_TOOL::setTransitions
void setTransitions() override
< Bind handlers to corresponding TOOL_ACTIONs.
Definition
pad_tool.cpp:933
PAD_TOOL::EditPad
int EditPad(const TOOL_EVENT &aEvent)
Enter/exit WYSIWYG pad shape editing.
Definition
pad_tool.cpp:710
PAD_TOOL::ExitPadEditMode
void ExitPadEditMode()
Definition
pad_tool.cpp:834
PAD_TOOL::m_editPad
KIID m_editPad
Definition
pad_tool.h:98
PAD_TOOL::copyPadSettings
int copyPadSettings(const TOOL_EVENT &aEvent)
Push pad settings from a pad to other pads on board or footprint.
Definition
pad_tool.cpp:171
PAD_TOOL::enterPadEditMode
void enterPadEditMode()
Definition
pad_tool.cpp:798
PAD_TOOL::pastePadProperties
int pastePadProperties(const TOOL_EVENT &aEvent)
Copy pad settings from a pad to the board design settings.
Definition
pad_tool.cpp:144
PAD_TOOL::PlacePad
int PlacePad(const TOOL_EVENT &aEvent)
Place a pad in footprint editor.
Definition
pad_tool.cpp:564
PAD_TOOL::EnumeratePads
int EnumeratePads(const TOOL_EVENT &aEvent)
Tool for quick pad enumeration.
Definition
pad_tool.cpp:298
PAD_TOOL::PAD_TOOL
PAD_TOOL()
Definition
pad_tool.cpp:53
PAD_TOOL::PadTable
int PadTable(const TOOL_EVENT &aEvent)
Definition
pad_tool.cpp:916
PAD_TOOL::Init
bool Init() override
Init() is called once upon a registration of the tool.
Definition
pad_tool.cpp:82
PAD_TOOL::SetLastPadNumber
void SetLastPadNumber(const wxString &aPadNumber)
Definition
pad_tool.h:67
PAD_TOOL::GetLastPadNumber
wxString GetLastPadNumber() const
Definition
pad_tool.h:66
PAD_TOOL::RecombinePad
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:906
PAD_TOOL::~PAD_TOOL
~PAD_TOOL()=default
React to model/view changes.
PAD_TOOL::InPadEditMode
bool InPadEditMode()
Definition
pad_tool.h:63
PAD_TOOL::m_lastPadNumber
wxString m_lastPadNumber
Definition
pad_tool.h:95
PAD_TOOL::pushPadSettings
int pushPadSettings(const TOOL_EVENT &aEvent)
Definition
pad_tool.cpp:241
PAD
Definition
pad.h:54
PCB_SHAPE
Definition
pcb_shape.h:38
PCB_TOOL_BASE::PCB_TOOL_BASE
PCB_TOOL_BASE(TOOL_ID aId, const std::string &aName)
Constructor.
Definition
pcb_tool_base.h:78
TOOL_BASE::RESET_REASON
RESET_REASON
Determine the reason of reset for a tool.
Definition
tool_base.h:78
TOOL_EVENT
Generic, UI-independent tool event.
Definition
tool_event.h:171
Reset
void Reset() override
niluuid
KIID niluuid(0)
PCB_LAYER_ID
PCB_LAYER_ID
A quick note on layer IDs:
Definition
layer_ids.h:60
pcb_tool_base.h
src
pcbnew
tools
pad_tool.h
Generated on Sun Sep 21 2025 01:05:31 for KiCad PCB EDA Suite by
1.13.2