KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_point_editor.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) 2013-2017 CERN
5 * Copyright (C) 2021-2023 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * @author Maciej Suminski <[email protected]>
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef PCB_POINT_EDITOR_H
28#define PCB_POINT_EDITOR_H
29
31#include "tool/edit_points.h"
32#include <pcbnew_settings.h>
33#include <status_popup.h>
34
35#include <memory>
36
37
40class SHAPE_POLY_SET;
41
46{
47public:
49
51 void Reset( RESET_REASON aReason ) override;
52
54 bool Init() override;
55
59 int OnSelectionChange( const TOOL_EVENT& aEvent );
60
66 bool HasPoint() { return m_editedPoint != nullptr; }
67 bool HasMidpoint() { return HasPoint() && dynamic_cast<EDIT_LINE*>( m_editedPoint ); }
68 bool HasCorner() { return HasPoint() && !HasMidpoint(); }
69
70private:
72 void setTransitions() override;
73
74 std::shared_ptr<EDIT_POINTS> makePoints( EDA_ITEM* aItem );
75
77 void updateItem( BOARD_COMMIT& aCommit );
78
80 void updatePoints();
81
83 void updateEditedPoint( const TOOL_EVENT& aEvent );
84
86 void setEditedPoint( EDIT_POINT* aPoint );
87
88 inline int getEditedPointIndex() const
89 {
90 for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
91 {
92 if( m_editedPoint == &m_editPoints->Point( i ) )
93 return i;
94 }
95
96 return wxNOT_FOUND;
97 }
98
100 inline bool isModified( const EDIT_POINT& aPoint ) const
101 {
102 return m_editedPoint == &aPoint;
103 }
104
106 void setAltConstraint( bool aEnabled );
107
110
112 bool removeCornerCondition( const SELECTION& aSelection );
113
115 int movePoint( const TOOL_EVENT& aEvent );
116 int addCorner( const TOOL_EVENT& aEvent );
117 int removeCorner( const TOOL_EVENT& aEvent );
118 int chamferCorner( const TOOL_EVENT& aEvent );
119 int modifiedSelection( const TOOL_EVENT& aEvent );
120
122 int changeArcEditMode( const TOOL_EVENT& aEvent );
123
124private:
127 std::shared_ptr<EDIT_POINTS> m_editPoints;
128
131
133
135
137
138 // Alternative constraint, enabled while a modifier key is held
139 std::shared_ptr<EDIT_CONSTRAINT<EDIT_POINT>> m_altConstraint;
141
142 bool m_inPointEditorTool; // Re-entrancy guard
143
144 // This handles the edit process for a specific tpye of item (not
145 // just C++ type, because PCB_SHAPE is one type that has many subtypes)
146 std::unique_ptr<POINT_EDIT_BEHAVIOR> m_editorBehavior;
147
148 static const unsigned int COORDS_PADDING; // Padding from coordinates limits for this tool
149};
150
151#endif
ARC_EDIT_MODE
Settings for arc editing.
Definition: app_settings.h:52
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
Represent a line connecting two EDIT_POINTs.
Definition: edit_points.h:223
Represent a single point that can be used for modifying items.
Definition: edit_points.h:48
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
Tool that displays edit points allowing to modify items by dragging the points.
int changeArcEditMode(const TOOL_EVENT &aEvent)
void updateItem(BOARD_COMMIT &aCommit)
Update edit points with item's points.
int OnSelectionChange(const TOOL_EVENT &aEvent)
Change selection event handler.
void setAltConstraint(bool aEnabled)
Return a point that should be used as a constrainer for 45 degrees mode.
static const unsigned int COORDS_PADDING
bool removeCornerCondition(const SELECTION &aSelection)
EDIT_POINT * m_hoveredPoint
int addCorner(const TOOL_EVENT &aEvent)
bool HasPoint()
Indicate the cursor is over an edit point.
EDIT_POINT m_original
Original pos for the current drag point.
EDIT_POINT get45DegConstrainer() const
Condition to display "Remove corner" context menu entry.
int modifiedSelection(const TOOL_EVENT &aEvent)
Change the edit method for arcs.
std::unique_ptr< POINT_EDIT_BEHAVIOR > m_editorBehavior
int removeCorner(const TOOL_EVENT &aEvent)
bool Init() override
Init() is called once upon a registration of the tool.
PCB_SELECTION m_preview
int movePoint(const TOOL_EVENT &aEvent)
TOOL_ACTION handlers.
void setEditedPoint(EDIT_POINT *aPoint)
EDIT_POINT m_altConstrainer
bool isModified(const EDIT_POINT &aPoint) const
Set up an alternative constraint (typically enabled upon a modifier key being pressed).
ARC_EDIT_MODE m_arcEditMode
EDIT_POINT * m_editedPoint
void updateEditedPoint(const TOOL_EVENT &aEvent)
Set the current point being edited. NULL means none.
std::shared_ptr< EDIT_CONSTRAINT< EDIT_POINT > > m_altConstraint
int getEditedPointIndex() const
Return true if aPoint is the currently modified point.
void updatePoints()
Update which point is being edited.
int chamferCorner(const TOOL_EVENT &aEvent)
void setTransitions() override
< Set up handlers for various events.
std::shared_ptr< EDIT_POINTS > m_editPoints
PCB_BASE_FRAME * m_frame
std::shared_ptr< EDIT_POINTS > makePoints(EDA_ITEM *aItem)
Update item's points with edit points.
PCB_SELECTION_TOOL * m_selectionTool
The selection tool: currently supports:
A helper class interface to manage the edit points for a single item.
Represent a set of closed polygons.
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