KiCad PCB EDA Suite
ee_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) 2019 CERN
5  * Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, you may find one here:
19  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20  * or you may search the http://www.gnu.org website for the version 2 license,
21  * or you may write to the Free Software Foundation, Inc.,
22  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23  */
24 
25 #ifndef EE_POINT_EDITOR_H
26 #define EE_POINT_EDITOR_H
27 
28 #include <tools/ee_tool_base.h>
29 #include <tool/edit_points.h>
30 #include <tool/selection.h>
31 
32 class EE_SELECTION_TOOL;
33 class SCH_BASE_FRAME;
34 
38 class EE_POINT_EDITOR : public EE_TOOL_BASE<SCH_BASE_FRAME>
39 {
40 public:
42 
44  void Reset( RESET_REASON aReason ) override;
45 
47  bool Init() override;
48 
49  int Main( const TOOL_EVENT& aEvent );
50 
55  bool HasPoint() { return m_editedPoint != nullptr; }
56 
58  void setTransitions() override;
59 
60 private:
62  void updateParentItem() const;
63 
65  void updatePoints();
66 
68  void updateEditedPoint( const TOOL_EVENT& aEvent );
69 
71  void setEditedPoint( EDIT_POINT* aPoint );
72 
74  inline bool isModified( const EDIT_POINT& aPoint ) const
75  {
76  return m_editedPoint == &aPoint;
77  }
78 
79  inline int getEditedPointIndex() const
80  {
81  for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
82  {
83  if( m_editedPoint == &m_editPoints->Point( i ) )
84  return i;
85  }
86 
87  return wxNOT_FOUND;
88  }
89 
90  bool addCornerCondition( const SELECTION& aSelection );
91  bool removeCornerCondition( const SELECTION& aSelection );
92 
94  int addCorner( const TOOL_EVENT& aEvent );
95  int removeCorner( const TOOL_EVENT& aEvent );
96  int modifiedSelection( const TOOL_EVENT& aEvent );
97 
98  void saveItemsToUndo();
99  void rollbackFromUndo();
100 
101 private:
104 
106  std::shared_ptr<EDIT_POINTS> m_editPoints;
107 };
108 
109 #endif // EE_POINT_EDITOR_H
int Main(const TOOL_EVENT &aEvent)
bool HasPoint()
Indicate the cursor is over an edit point.
void updateEditedPoint(const TOOL_EVENT &aEvent)
Set the current point being edited. NULL means none.
EDIT_POINT * m_editedPoint
< Currently edited point, NULL if there is none.
void updatePoints()
Update which point is being edited.
int modifiedSelection(const TOOL_EVENT &aEvent)
bool addCornerCondition(const SELECTION &aSelection)
bool Init() override
Init() is called once upon a registration of the tool.
Generic, UI-independent tool event.
Definition: tool_event.h:152
int removeCorner(const TOOL_EVENT &aEvent)
void updateParentItem() const
< Update item's points with edit points.
int addCorner(const TOOL_EVENT &aEvent)
TOOL_ACTION handlers.
bool removeCornerCondition(const SELECTION &aSelection)
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
std::shared_ptr< EDIT_POINTS > m_editPoints
int getEditedPointIndex() const
Tool that displays edit points allowing to modify items by dragging the points.
void setEditedPoint(EDIT_POINT *aPoint)
Return true if aPoint is the currently modified point.
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:77
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:49
Represent a single point that can be used for modifying items.
Definition: edit_points.h:47
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
bool isModified(const EDIT_POINT &aPoint) const