KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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, see <https://www.gnu.org/licenses/>.
19 */
20
21#ifndef PL_POINT_EDITOR_H
22#define PL_POINT_EDITOR_H
23
25#include <tool/edit_points.h>
26#include <tool/selection.h>
27#include <tool/tool_menu.h>
28
29namespace KIGFX { namespace PREVIEW { class ANGLE_ITEM; } }
30
32class PL_EDITOR_FRAME;
33
38{
39public:
41
43 void Reset( RESET_REASON aReason ) override;
44
46 bool Init() override;
47
48 int Main( const TOOL_EVENT& aEvent );
49
54 bool HasPoint() { return m_editedPoint != nullptr; }
55
57 void setTransitions() override;
58
59private:
61 void updateItem() const;
62
64 void updatePoints();
65
67 void updateEditedPoint( const TOOL_EVENT& aEvent );
68
70 void setEditedPoint( EDIT_POINT* aPoint );
71
73 inline bool isModified( const EDIT_POINT& aPoint ) const
74 {
75 return m_editedPoint == &aPoint;
76 }
77
78 inline int getEditedPointIndex() const
79 {
80 for( unsigned i = 0; i < m_editPoints->PointsSize(); ++i )
81 {
82 if( m_editedPoint == &m_editPoints->Point( i ) )
83 return i;
84 }
85
86 return wxNOT_FOUND;
87 }
88
89 int modifiedSelection( const TOOL_EVENT& aEvent );
90
91private:
94
97
99 std::shared_ptr<EDIT_POINTS> m_editPoints;
100 std::unique_ptr<KIGFX::PREVIEW::ANGLE_ITEM> m_angleItem;
101};
102
103#endif // PL_POINT_EDITOR_H
Represent a single point that can be used for modifying items.
Definition edit_points.h:44
The main window used in the drawing sheet editor.
void setTransitions() override
This method is meant to be overridden in order to specify handlers for events.
PL_EDITOR_FRAME * m_frame
PL_SELECTION_TOOL * m_selectionTool
Currently edited point, NULL if there is none.
int modifiedSelection(const TOOL_EVENT &aEvent)
int getEditedPointIndex() const
void updateItem() const
< Update item's points with edit points.
bool HasPoint()
Indicate the cursor is over an edit point.
bool isModified(const EDIT_POINT &aPoint) const
void updateEditedPoint(const TOOL_EVENT &aEvent)
Set the current point being edited. NULL means none.
EDIT_POINT * m_editedPoint
Currently available edit points.
bool Init() override
Init() is called once upon a registration of the tool.
int Main(const TOOL_EVENT &aEvent)
void updatePoints()
Update which point is being edited.
std::unique_ptr< KIGFX::PREVIEW::ANGLE_ITEM > m_angleItem
void setEditedPoint(EDIT_POINT *aPoint)
Return true if aPoint is the currently modified point.
std::shared_ptr< EDIT_POINTS > m_editPoints
RESET_REASON
Determine the reason of reset for a tool.
Definition tool_base.h:74
Generic, UI-independent tool event.
Definition tool_event.h:167
TOOL_INTERACTIVE(TOOL_ID aId, const std::string &aName)
Create a tool with given id & name.
void Reset() override
The Cairo implementation of the graphics abstraction layer.
Definition eda_group.h:29