forked from KiCad/kicad-source-mirror
-
Notifications
You must be signed in to change notification settings - Fork 0
/
placement_tool.h
177 lines (151 loc) · 6.18 KB
/
placement_tool.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2014 CERN
* Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
*
* @author Maciej Suminski <[email protected]>
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef ALIGN_DISTRIBUTE_TOOL_H_
#define ALIGN_DISTRIBUTE_TOOL_H_
#include <tool/tool_interactive.h>
#include <tools/pcb_selection.h>
#include <board_item.h>
#include <pcb_base_frame.h>
using ALIGNMENT_RECT = std::pair<BOARD_ITEM*, EDA_RECT>;
using ALIGNMENT_RECTS = std::vector<ALIGNMENT_RECT>;
class PCB_SELECTION_TOOL;
class ALIGN_DISTRIBUTE_TOOL : public TOOL_INTERACTIVE
{
public:
ALIGN_DISTRIBUTE_TOOL();
virtual ~ALIGN_DISTRIBUTE_TOOL();
/// @copydoc TOOL_INTERACTIVE::Reset()
void Reset( RESET_REASON aReason ) override {}
/// @copydoc TOOL_INTERACTIVE::Init()
bool Init() override;
/**
* Set Y coordinate of the selected items to the value of the top-most selected item Y
* coordinate.
*/
int AlignTop( const TOOL_EVENT& aEvent );
/**
* Sets Y coordinate of the selected items to the value of the bottom-most selected item Y
* coordinate.
*/
int AlignBottom( const TOOL_EVENT& aEvent );
/**
* Sets X coordinate of the selected items to the value of the left-most selected item X
* coordinate.
*/
int AlignLeft( const TOOL_EVENT& aEvent );
/**
* Sets X coordinate of the selected items to the value of the right-most selected item X
* coordinate.
*/
int AlignRight( const TOOL_EVENT& aEvent );
/**
* Set the x coordinate of the midpoint of each of the selected items to the value of the
* x coordinate of the center of the middle selected item.
*/
int AlignCenterX( const TOOL_EVENT& aEvent );
/**
* Set the y coordinate of the midpoint of each of the selected items to the value of the
* y coordinate of the center of the middle selected item.
*/
int AlignCenterY( const TOOL_EVENT& aEvent );
/**
* Distribute the selected items along the X axis.
*/
int DistributeHorizontally( const TOOL_EVENT& aEvent );
/**
* Distribute the selected items along the Y axis.
*/
int DistributeVertically( const TOOL_EVENT& aEvent );
///< Set up handlers for various events.
void setTransitions() override;
private:
/**
* Populate two vectors with the sorted selection and sorted locked items.
*
* Returns the size of aItemsToAlign()
*/
template< typename T >
size_t GetSelections( ALIGNMENT_RECTS& aItemsToAlign, ALIGNMENT_RECTS& aLockedItems,
T aCompare );
template< typename T >
int selectTarget( ALIGNMENT_RECTS& aItems, ALIGNMENT_RECTS& aLocked, T aGetValue );
/**
* Sets X coordinate of the selected items to the value of the left-most selected item
* X coordinate.
*
* @note Uses the bounding box of items, which do not get mirrored even when
* the view is mirrored!
*/
int doAlignLeft();
/**
* Align selected items using the right edge of their bounding boxes to the right-most item.
*
* @note Uses the bounding box of items, which do not get mirrored even when
* the view is mirrored!
*/
int doAlignRight();
/**
* Distribute selected items using an even spacing between the centers of their bounding
* boxes.
*
* @note Using the centers of bounding box of items can give unsatisfactory visual results
* since items of differing widths will be placed with different gaps. Is only used if
* items overlap.
*/
void doDistributeCentersHorizontally( ALIGNMENT_RECTS& itemsToDistribute,
BOARD_COMMIT& aCommit ) const;
/**
* Distribute selected items using an even spacing between the centers of their bounding
* boxes.
*
* @note Using the centers of bounding box of items can give unsatisfactory visual results
* since items of differing widths will be placed with different gaps. Is only used
* if items overlap
*/
void doDistributeCentersVertically( ALIGNMENT_RECTS& itemsToDistribute,
BOARD_COMMIT& aCommit ) const;
/**
* Distributes selected items using an even spacing between their bounding boxes
*
* @note Using the edges of bounding box of items is only possible if there is enough space
* between them. If this is not the case, use the center spacing method
*/
void doDistributeGapsHorizontally( ALIGNMENT_RECTS& itemsToDistribute, BOARD_COMMIT& aCommit,
const BOARD_ITEM* lastItem, int totalGap ) const;
/**
* Distributes selected items using an even spacing between their bounding boxes
*
* @note Using the edges of bounding box of items is only possible if there is enough space
* between them. If this is not the case, use the center spacing method
*/
void doDistributeGapsVertically( ALIGNMENT_RECTS& itemsToDistribute, BOARD_COMMIT& aCommit,
const BOARD_ITEM* lastItem, int totalGap ) const;
private:
PCB_SELECTION_TOOL* m_selectionTool;
ACTION_MENU* m_placementMenu;
PCB_BASE_FRAME* m_frame;
};
#endif /* ALIGN_DISTRIBUTE_TOOL_H_ */