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
52
int
PlacePad
(
const
TOOL_EVENT
& aEvent );
53
57
int
EditPad
(
const
TOOL_EVENT
& aEvent );
58
59
int
OnUndoRedo
(
const
TOOL_EVENT
& aEvent );
60
61
bool
InPadEditMode
() {
return
m_editPad
!=
niluuid
; }
62
void
ExitPadEditMode
();
63
64
wxString
GetLastPadNumber
()
const
{
return
m_lastPadNumber
; }
65
void
SetLastPadNumber
(
const
wxString& aPadNumber ) {
m_lastPadNumber
= aPadNumber; }
66
73
std::vector<PCB_SHAPE*>
RecombinePad
(
PAD
* aPad,
bool
aIsDryRun );
74
75
private
:
77
void
setTransitions
()
override
;
78
80
int
pastePadProperties
(
const
TOOL_EVENT
& aEvent );
81
83
int
copyPadSettings
(
const
TOOL_EVENT
& aEvent );
84
86
int
pushPadSettings
(
const
TOOL_EVENT
& aEvent );
87
88
void
explodePad
(
PAD
* aPad,
PCB_LAYER_ID
* aLayer,
BOARD_COMMIT
& aCommit );
89
90
void
enterPadEditMode
();
91
92
private
:
93
wxString
m_lastPadNumber
;
94
95
HIGH_CONTRAST_MODE
m_previousHighContrastMode
;
96
KIID
m_editPad
;
97
};
HIGH_CONTRAST_MODE
HIGH_CONTRAST_MODE
Determine how inactive layers should be displayed.
Definition:
board_project_settings.h:95
ACTION_MENU
Define the structure of a menu based on ACTIONs.
Definition:
action_menu.h:49
BOARD_COMMIT
Definition:
board_commit.h:49
KIID
Definition:
kiid.h:49
PAD_TOOL
Definition:
pad_tool.h:33
PAD_TOOL::OnUndoRedo
int OnUndoRedo(const TOOL_EVENT &aEvent)
Definition:
pad_tool.cpp:760
PAD_TOOL::m_previousHighContrastMode
HIGH_CONTRAST_MODE m_previousHighContrastMode
Definition:
pad_tool.h:95
PAD_TOOL::explodePad
void explodePad(PAD *aPad, PCB_LAYER_ID *aLayer, BOARD_COMMIT &aCommit)
Definition:
pad_tool.cpp:862
PAD_TOOL::setTransitions
void setTransitions() override
< Bind handlers to corresponding TOOL_ACTIONs.
Definition:
pad_tool.cpp:915
PAD_TOOL::EditPad
int EditPad(const TOOL_EVENT &aEvent)
Enter/exit WYSIWYG pad shape editing.
Definition:
pad_tool.cpp:708
PAD_TOOL::ExitPadEditMode
void ExitPadEditMode()
Definition:
pad_tool.cpp:832
PAD_TOOL::m_editPad
KIID m_editPad
Definition:
pad_tool.h:96
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:169
PAD_TOOL::enterPadEditMode
void enterPadEditMode()
Definition:
pad_tool.cpp:796
PAD_TOOL::pastePadProperties
int pastePadProperties(const TOOL_EVENT &aEvent)
Copy pad settings from a pad to the board design settings.
Definition:
pad_tool.cpp:142
PAD_TOOL::PlacePad
int PlacePad(const TOOL_EVENT &aEvent)
Place a pad in footprint editor.
Definition:
pad_tool.cpp:562
PAD_TOOL::EnumeratePads
int EnumeratePads(const TOOL_EVENT &aEvent)
Tool for quick pad enumeration.
Definition:
pad_tool.cpp:296
PAD_TOOL::PAD_TOOL
PAD_TOOL()
Definition:
pad_tool.cpp:52
PAD_TOOL::Init
bool Init() override
Init() is called once upon a registration of the tool.
Definition:
pad_tool.cpp:81
PAD_TOOL::SetLastPadNumber
void SetLastPadNumber(const wxString &aPadNumber)
Definition:
pad_tool.h:65
PAD_TOOL::GetLastPadNumber
wxString GetLastPadNumber() const
Definition:
pad_tool.h:64
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:904
PAD_TOOL::~PAD_TOOL
~PAD_TOOL()=default
React to model/view changes.
PAD_TOOL::InPadEditMode
bool InPadEditMode()
Definition:
pad_tool.h:61
PAD_TOOL::m_lastPadNumber
wxString m_lastPadNumber
Definition:
pad_tool.h:93
PAD_TOOL::pushPadSettings
int pushPadSettings(const TOOL_EVENT &aEvent)
Definition:
pad_tool.cpp:239
PAD
Definition:
pad.h:54
PCB_SHAPE
Definition:
pcb_shape.h:38
PCB_TOOL_BASE
Definition:
pcb_tool_base.h:71
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:168
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 Tue Aug 12 2025 00:06:57 for KiCad PCB EDA Suite by
1.9.6