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
33class SCH_BASE_FRAME;
34
38class EE_POINT_EDITOR : public EE_TOOL_BASE<SCH_BASE_FRAME>
39{
40public:
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
60private:
62 void updateParentItem() const;
63
65 void updatePoints();
66
68 void updateEditedPoint( const TOOL_EVENT& aEvent );
69
71 int clearEditedPoints( 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 void pinEditedCorner( int minWidth, int minHeight, VECTOR2I& topLeft, VECTOR2I& topRight,
94 VECTOR2I& botLeft, VECTOR2I& botRight, EE_GRID_HELPER* aGrid ) const;
95
96 bool addCornerCondition( const SELECTION& aSelection );
97 bool removeCornerCondition( const SELECTION& aSelection );
98
100 int addCorner( const TOOL_EVENT& aEvent );
101 int removeCorner( const TOOL_EVENT& aEvent );
102 int modifiedSelection( const TOOL_EVENT& aEvent );
103
104 void saveItemsToUndo();
105 void rollbackFromUndo();
106
107private:
110
112 std::shared_ptr<EDIT_POINTS> m_editPoints;
113};
114
115#endif // EE_POINT_EDITOR_H
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.
void updatePoints()
Update which point is being edited.
int Main(const TOOL_EVENT &aEvent)
void updateEditedPoint(const TOOL_EVENT &aEvent)
Clear references to the points.
void setEditedPoint(EDIT_POINT *aPoint)
Return true if aPoint is the currently modified point.
int modifiedSelection(const TOOL_EVENT &aEvent)
bool Init() override
Init() is called once upon a registration of the tool.
EDIT_POINT * m_editedPoint
< Currently edited point, NULL if there is none.
bool addCornerCondition(const SELECTION &aSelection)
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
void pinEditedCorner(int minWidth, int minHeight, VECTOR2I &topLeft, VECTOR2I &topRight, VECTOR2I &botLeft, VECTOR2I &botRight, EE_GRID_HELPER *aGrid) const
Update the coordinates of 4 corners of a rectangle, according to constraints and the moved corner.
bool isModified(const EDIT_POINT &aPoint) const
void updateParentItem() const
< Update item's points with edit points.
int addCorner(const TOOL_EVENT &aEvent)
TOOL_ACTION handlers.
std::shared_ptr< EDIT_POINTS > m_editPoints
bool removeCornerCondition(const SELECTION &aSelection)
int removeCorner(const TOOL_EVENT &aEvent)
void Reset(RESET_REASON aReason) override
Bring the tool to a known, initial state.
int getEditedPointIndex() const
int clearEditedPoints(const TOOL_EVENT &aEvent)
Set the current point being edited. NULL means none.
bool HasPoint()
Indicate the cursor is over an edit point.
A foundation class for a tool operating on a schematic or symbol.
Definition: ee_tool_base.h:50
A shim class between EDA_DRAW_FRAME and several derived classes: SYMBOL_EDIT_FRAME,...
RESET_REASON
Determine the reason of reset for a tool.
Definition: tool_base.h:78
Generic, UI-independent tool event.
Definition: tool_event.h:155