KiCad PCB EDA Suite
Loading...
Searching...
No Matches
group_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) 2020-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 GROUP_TOOL_H
25#define GROUP_TOOL_H
26
27#include <math/vector2d.h>
28#include <tools/pcb_tool_base.h>
29#include "pcb_selection_tool.h"
31
32class BOARD_COMMIT;
33class BOARD_ITEM;
36
38{
39public:
40 GROUP_TOOL();
41
42 void Reset( RESET_REASON aReason ) override;
43
45 bool Init() override;
46
47 int GroupProperties( const TOOL_EVENT& aEvent );
48
52 int PickNewMember( const TOOL_EVENT& aEvent );
53
55 int Group( const TOOL_EVENT& aEvent );
56
58 int Ungroup( const TOOL_EVENT& aEvent );
59
61 int RemoveFromGroup( const TOOL_EVENT& aEvent );
62
64 int EnterGroup( const TOOL_EVENT& aEvent );
65
67 int LeaveGroup( const TOOL_EVENT& aEvent );
68
69private:
71 void setTransitions() override;
72
76 std::unique_ptr<BOARD_COMMIT> m_commit;
77};
78
79#endif
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
int GroupProperties(const TOOL_EVENT &aEvent)
Definition: group_tool.cpp:117
int LeaveGroup(const TOOL_EVENT &aEvent)
Definition: group_tool.cpp:369
bool Init() override
Init() is called once upon a registration of the tool.
Definition: group_tool.cpp:94
int RemoveFromGroup(const TOOL_EVENT &aEvent)
Restrict selection to only member of the group.
Definition: group_tool.cpp:330
DIALOG_GROUP_PROPERTIES * m_propertiesDialog
Definition: group_tool.h:74
int Group(const TOOL_EVENT &aEvent)
Ungroup selected items.
Definition: group_tool.cpp:221
std::unique_ptr< BOARD_COMMIT > m_commit
Definition: group_tool.h:76
PCB_SELECTION_TOOL * m_selectionTool
Definition: group_tool.h:75
int Ungroup(const TOOL_EVENT &aEvent)
Remove selection from group.
Definition: group_tool.cpp:290
PCB_BASE_EDIT_FRAME * m_frame
Definition: group_tool.h:73
void setTransitions() override
< Set up handlers for various events.
Definition: group_tool.cpp:376
int PickNewMember(const TOOL_EVENT &aEvent)
Invoke the picker tool to select a new member of the group.
Definition: group_tool.cpp:133
int EnterGroup(const TOOL_EVENT &aEvent)
Leave the current group (deselect its members and select the group as a whole).
Definition: group_tool.cpp:357
Common, abstract interface for edit frames.
The selection tool: currently supports:
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:167
void Reset() override