KiCad PCB EDA Suite
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 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
39class SHAPE_POLY_SET;
40
45{
46public:
48
50 void Reset( RESET_REASON aReason ) override;
51
53 bool Init() override;
54
58 int OnSelectionChange( const TOOL_EVENT& aEvent );
59
65 bool HasPoint() { return m_editedPoint != nullptr; }
66
67private:
69 void setTransitions() override;
70
71 void buildForPolyOutline( std::shared_ptr<EDIT_POINTS> points, const SHAPE_POLY_SET* aOutline );
72
73 std::shared_ptr<EDIT_POINTS> makePoints( EDA_ITEM* aItem );
74
76 void updateItem() const;
77
84 bool validatePolygon( SHAPE_POLY_SET& aModified ) const;
85
87 void updatePoints();
88
90 void updateEditedPoint( const TOOL_EVENT& aEvent );
91
93 void setEditedPoint( EDIT_POINT* aPoint );
94
95 inline int getEditedPointIndex() const
96 {
97 for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
98 {
99 if( m_editedPoint == &m_editPoints->Point( i ) )
100 return i;
101 }
102
103 return wxNOT_FOUND;
104 }
105
107 inline bool isModified( const EDIT_POINT& aPoint ) const
108 {
109 return m_editedPoint == &aPoint;
110 }
111
112 void pinEditedCorner( VECTOR2I& aTopLeft, VECTOR2I& aTopRight, VECTOR2I& aBotLeft,
113 VECTOR2I& aBotRight, const VECTOR2I& aHole = { 0, 0 },
114 const VECTOR2I& aHoleSize = { 0, 0 } ) const;
115
117 void setAltConstraint( bool aEnabled );
118
121
123 static bool addCornerCondition( const SELECTION& aSelection );
124
126 static bool canAddCorner( const EDA_ITEM& aItem );
127
129 bool removeCornerCondition( const SELECTION& aSelection );
130
132 int addCorner( const TOOL_EVENT& aEvent );
133 int removeCorner( const TOOL_EVENT& aEvent );
134 int modifiedSelection( const TOOL_EVENT& aEvent );
135
139 void editArcEndpointKeepTangent( PCB_SHAPE* aArc, const VECTOR2I& aCenter,
140 const VECTOR2I& aStart, const VECTOR2I& aMid,
141 const VECTOR2I& aEnd, const VECTOR2I& aCursor ) const;
142
146 void editArcEndpointKeepCenter( PCB_SHAPE* aArc, const VECTOR2I& aCenter,
147 const VECTOR2I& aStart, const VECTOR2I& aMid,
148 const VECTOR2I& aEnd, const VECTOR2I& aCursor ) const;
149
153 void editArcCenterKeepEndpoints( PCB_SHAPE* aArc, const VECTOR2I& aCenter,
154 const VECTOR2I& aStart, const VECTOR2I& aMid,
155 const VECTOR2I& aEnd ) const;
156
160 void editArcMidKeepEndpoints( PCB_SHAPE* aArc, const VECTOR2I& aStart, const VECTOR2I& aEnd,
161 const VECTOR2I& aCursor ) const;
162
166 void editArcMidKeepCenter( PCB_SHAPE* aArc, const VECTOR2I& aCenter, const VECTOR2I& aStart,
167 const VECTOR2I& aMid, const VECTOR2I& aEnd,
168 const VECTOR2I& aCursor ) const;
169
171 int changeArcEditMode( const TOOL_EVENT& aEvent );
172
174 mutable std::unique_ptr<STATUS_TEXT_POPUP> m_statusPopup;
175 std::shared_ptr<EDIT_POINTS> m_editPoints;
176
179
181
183
185
186 // Alternative constraint, enabled while a modifier key is held
187 std::shared_ptr<EDIT_CONSTRAINT<EDIT_POINT>> m_altConstraint;
189
190 static const unsigned int COORDS_PADDING; // Padding from coordinates limits for this tool
191};
192
193#endif
ARC_EDIT_MODE
Settings for arc editing.
Definition: app_settings.h:70
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
Represent a single point that can be used for modifying items.
Definition: edit_points.h:48
Tool that displays edit points allowing to modify items by dragging the points.
int changeArcEditMode(const TOOL_EVENT &aEvent)
void pinEditedCorner(VECTOR2I &aTopLeft, VECTOR2I &aTopRight, VECTOR2I &aBotLeft, VECTOR2I &aBotRight, const VECTOR2I &aHole={ 0, 0 }, const VECTOR2I &aHoleSize={ 0, 0 }) const
Set up an alternative constraint (typically enabled upon a modifier key being pressed).
void editArcMidKeepEndpoints(PCB_SHAPE *aArc, const VECTOR2I &aStart, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
Move the mid point of the arc, while keeping the two endpoints.
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
void editArcMidKeepCenter(PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
Move the mid point of the arc, while keeping the angle.
int addCorner(const TOOL_EVENT &aEvent)
TOOL_ACTION handlers.
bool HasPoint()
Indicate the cursor is over an edit point.
EDIT_POINT m_original
Original position for the current drag point.
EDIT_POINT get45DegConstrainer() const
Condition to display "Create corner" context menu entry.
int modifiedSelection(const TOOL_EVENT &aEvent)
void editArcEndpointKeepTangent(PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
Move an end point of the arc, while keeping the tangent at the other endpoint.
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
int removeCorner(const TOOL_EVENT &aEvent)
static bool canAddCorner(const EDA_ITEM &aItem)
Condition to display "Remove corner" context menu entry.
bool Init() override
Init() is called once upon a registration of the tool.
void setEditedPoint(EDIT_POINT *aPoint)
void buildForPolyOutline(std::shared_ptr< EDIT_POINTS > points, const SHAPE_POLY_SET *aOutline)
EDIT_POINT m_altConstrainer
bool isModified(const EDIT_POINT &aPoint) const
std::unique_ptr< STATUS_TEXT_POPUP > m_statusPopup
ARC_EDIT_MODE m_arcEditMode
EDIT_POINT * m_editedPoint
bool validatePolygon(SHAPE_POLY_SET &aModified) const
Validate a polygon and displays a popup warning if invalid.
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.
void editArcCenterKeepEndpoints(PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd) const
Move the arc center but keep endpoint locations.
static bool addCornerCondition(const SELECTION &aSelection)
Determine if the tool can currently add a corner to the given item.
void setTransitions() override
< Set up handlers for various events.
std::shared_ptr< EDIT_POINTS > m_editPoints
std::shared_ptr< EDIT_POINTS > makePoints(EDA_ITEM *aItem)
Update item's points with edit points.
void editArcEndpointKeepCenter(PCB_SHAPE *aArc, const VECTOR2I &aCenter, const VECTOR2I &aStart, const VECTOR2I &aMid, const VECTOR2I &aEnd, const VECTOR2I &aCursor) const
Move an end point of the arc around the circumference.
PCB_SELECTION_TOOL * m_selectionTool
The selection tool: currently supports:
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:156