KiCad PCB EDA Suite
pl_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 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 PL_POINT_EDITOR_H
26 #define PL_POINT_EDITOR_H
27 
28 #include <tool/tool_interactive.h>
29 #include <tool/edit_points.h>
30 #include <tool/selection.h>
31 #include <tool/tool_menu.h>
32 
33 class PL_SELECTION_TOOL;
34 class PL_EDITOR_FRAME;
35 
42 {
43 public:
45 
47  void Reset( RESET_REASON aReason ) override;
48 
50  bool Init() override;
51 
52  int Main( const TOOL_EVENT& aEvent );
53 
58  bool HasPoint() { return m_editedPoint != nullptr; }
59 
61  void setTransitions() override;
62 
63 private:
65  void updateItem() const;
66 
68  void updatePoints();
69 
71  void updateEditedPoint( const TOOL_EVENT& aEvent );
72 
74  void setEditedPoint( EDIT_POINT* aPoint );
75 
77  inline bool isModified( const EDIT_POINT& aPoint ) const
78  {
79  return m_editedPoint == &aPoint;
80  }
81 
82  inline int getEditedPointIndex() const
83  {
84  for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
85  {
86  if( m_editedPoint == &m_editPoints->Point( i ) )
87  return i;
88  }
89 
90  return wxNOT_FOUND;
91  }
92 
93  int modifiedSelection( const TOOL_EVENT& aEvent );
94 
95 private:
98 
101 
103  std::shared_ptr<EDIT_POINTS> m_editPoints;
104 };
105 
106 #endif // PL_POINT_EDITOR_H
PL_EDITOR_FRAME * m_frame
Class PL_EDITOR_FRAME is the main window used in the page layout editor.
void updatePoints()
Updates edit points with item's points.
bool Init() override
Function Init() Init() is called once upon a registration of the tool.
PL_SELECTION_TOOL * m_selectionTool
std::shared_ptr< EDIT_POINTS > m_editPoints
Currently available edit points.
void setEditedPoint(EDIT_POINT *aPoint)
Sets the current point being edited. NULL means none.
bool isModified(const EDIT_POINT &aPoint) const
Returns true if aPoint is the currently modified point.
int getEditedPointIndex() const
bool HasPoint()
Indicates the cursor is over an edit point.
int Main(const TOOL_EVENT &aEvent)
void updateEditedPoint(const TOOL_EVENT &aEvent)
Updates which point is being edited.
void Reset(RESET_REASON aReason) override
Function Reset() Brings the tool to a known, initial state.
Class TOOL_EVENT.
Definition: tool_event.h:168
void updateItem() const
Updates item's points with edit points.
EDIT_POINT * m_editedPoint
Currently edited point, NULL if there is none.
int modifiedSelection(const TOOL_EVENT &aEvent)
size_t i
Definition: json11.cpp:597
RESET_REASON
Determines the reason of reset for a tool
Definition: tool_base.h:79
Class EDIT_POINT.
Definition: edit_points.h:46
void setTransitions() override
Sets up handlers for various events.
Class PL_POINT_EDITOR.