KiCad PCB EDA Suite
Loading...
Searching...
No Matches
position_relative_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
#ifndef __POSITION_RELATIVE_TOOL_H
21
#define __POSITION_RELATIVE_TOOL_H
22
23
#include <
math/vector2d.h
>
24
#include <
tools/pcb_tool_base.h
>
25
#include <
tools/pcb_selection_tool.h
>
26
#include <wx/weakref.h>
27
28
class
BOARD_COMMIT
;
29
class
BOARD_ITEM
;
30
class
PCB_SELECTION_TOOL
;
31
class
DIALOG_POSITION_RELATIVE
;
32
33
40
41
class
POSITION_RELATIVE_TOOL
:
public
PCB_TOOL_BASE
42
{
43
public
:
44
POSITION_RELATIVE_TOOL
();
45
46
void
Reset
(
RESET_REASON
aReason )
override
;
47
49
bool
Init
()
override
;
50
54
int
PositionRelative
(
const
TOOL_EVENT
& aEvent );
55
60
int
InteractiveOffset
(
const
TOOL_EVENT
& aEvent );
61
65
VECTOR2I
GetSelectionAnchorPosition
()
const
{
return
m_selectionAnchor
; }
66
71
int
RelativeItemSelectionMove
(
const
VECTOR2I
&
anchor
,
const
VECTOR2I
& translation );
72
74
void
setTransitions
()
override
;
75
76
private
:
77
wxWeakRef<DIALOG_POSITION_RELATIVE>
m_dialog
;
78
79
PCB_SELECTION_TOOL
*
m_selectionTool
;
80
PCB_SELECTION
m_selection
;
81
VECTOR2I
m_selectionAnchor
;
82
bool
m_inInteractivePosition
;
// Re-entrancy guard
83
84
std::unique_ptr<BOARD_COMMIT>
m_commit
;
85
};
86
87
#endif
BITMAPS::anchor
@ anchor
Definition
bitmaps_list.h:103
BOARD_COMMIT
Definition
board_commit.h:45
BOARD_ITEM
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition
board_item.h:99
DIALOG_POSITION_RELATIVE
Definition
dialog_position_relative.h:32
PCB_SELECTION_TOOL
The selection tool: currently supports:
Definition
pcb_selection_tool.h:64
PCB_SELECTION
Definition
pcb_selection.h:28
PCB_TOOL_BASE::PCB_TOOL_BASE
PCB_TOOL_BASE(TOOL_ID aId, const std::string &aName)
Constructor.
Definition
pcb_tool_base.h:75
POSITION_RELATIVE_TOOL::m_selectionAnchor
VECTOR2I m_selectionAnchor
Definition
position_relative_tool.h:81
POSITION_RELATIVE_TOOL::RelativeItemSelectionMove
int RelativeItemSelectionMove(const VECTOR2I &anchor, const VECTOR2I &translation)
Position the m_position_relative_selection selection relative to anchor position using the given tran...
Definition
position_relative_tool.cpp:460
POSITION_RELATIVE_TOOL::POSITION_RELATIVE_TOOL
POSITION_RELATIVE_TOOL()
Definition
position_relative_tool.cpp:85
POSITION_RELATIVE_TOOL::PositionRelative
int PositionRelative(const TOOL_EVENT &aEvent)
Invoke a dialog box to allow positioning of the item relative to another by an exact amount.
Definition
position_relative_tool.cpp:121
POSITION_RELATIVE_TOOL::setTransitions
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
Definition
position_relative_tool.cpp:482
POSITION_RELATIVE_TOOL::Init
bool Init() override
Init() is called once upon a registration of the tool.
Definition
position_relative_tool.cpp:112
POSITION_RELATIVE_TOOL::m_dialog
wxWeakRef< DIALOG_POSITION_RELATIVE > m_dialog
Definition
position_relative_tool.h:77
POSITION_RELATIVE_TOOL::m_commit
std::unique_ptr< BOARD_COMMIT > m_commit
Definition
position_relative_tool.h:84
POSITION_RELATIVE_TOOL::m_inInteractivePosition
bool m_inInteractivePosition
Definition
position_relative_tool.h:82
POSITION_RELATIVE_TOOL::GetSelectionAnchorPosition
VECTOR2I GetSelectionAnchorPosition() const
Return the position of the selected item(s)
Definition
position_relative_tool.h:65
POSITION_RELATIVE_TOOL::InteractiveOffset
int InteractiveOffset(const TOOL_EVENT &aEvent)
Draw a line connecting two points and allow the user to enter what it should be.
Definition
position_relative_tool.cpp:180
POSITION_RELATIVE_TOOL::m_selectionTool
PCB_SELECTION_TOOL * m_selectionTool
Definition
position_relative_tool.h:79
POSITION_RELATIVE_TOOL::m_selection
PCB_SELECTION m_selection
Definition
position_relative_tool.h:80
TOOL_BASE::RESET_REASON
RESET_REASON
Determine the reason of reset for a tool.
Definition
tool_base.h:74
TOOL_EVENT
Generic, UI-independent tool event.
Definition
tool_event.h:167
Reset
void Reset() override
pcb_selection_tool.h
pcb_tool_base.h
vector2d.h
VECTOR2I
VECTOR2< int32_t > VECTOR2I
Definition
vector2d.h:708
src
pcbnew
tools
position_relative_tool.h
Generated on Tue Nov 17 2026 00:06:26 for KiCad PCB EDA Suite by
1.13.2