KiCad PCB EDA Suite
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 (C) 2017-2021 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#ifndef __POSITION_RELATIVE_TOOL_H
25#define __POSITION_RELATIVE_TOOL_H
26
27#include <math/vector2d.h>
28#include <tools/pcb_tool_base.h>
29#include "pcb_selection_tool.h"
32
33class BOARD_COMMIT;
34class BOARD_ITEM;
37
46{
47public:
49
50 void Reset( RESET_REASON aReason ) override;
51
53 bool Init() override;
54
58 int PositionRelative( const TOOL_EVENT& aEvent );
59
64 int SelectPositionRelativeItem( const TOOL_EVENT& aEvent );
65
70
75 int RelativeItemSelectionMove( const VECTOR2I& anchor, const VECTOR2I& translation );
76
78 void setTransitions() override;
79
80private:
82
86
87 std::unique_ptr<BOARD_COMMIT> m_commit;
88
91
93};
94
95#endif
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:53
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
The selection tool: currently supports:
The interactive edit tool.
int RelativeItemSelectionMove(const VECTOR2I &anchor, const VECTOR2I &translation)
Position the m_position_relative_selection selection relative to anchor position using the given tran...
int PositionRelative(const TOOL_EVENT &aEvent)
Invoke a dialog box to allow positioning of the item relative to another by an exact amount.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
int SelectPositionRelativeItem(const TOOL_EVENT &aEvent)
Invoke the picker tool to select the item to which the previous selection will be placed relative to.
bool Init() override
Init() is called once upon a registration of the tool.
DIALOG_POSITION_RELATIVE * m_dialog
std::unique_ptr< BOARD_COMMIT > m_commit
VECTOR2I GetSelectionAnchorPosition() const
Return the position of the selected item(s)
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
PCB_SELECTION_TOOL * m_selectionTool
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:155