KiCad PCB EDA Suite
polygon_geom_manager.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) 2017-2021 Kicad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, you may find one here:
18 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
19 * or you may search the http://www.gnu.org website for the version 2 license,
20 * or you may write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
22 */
23
24#ifndef PREVIEW_POLYGON_GEOM_MANAGER__H_
25#define PREVIEW_POLYGON_GEOM_MANAGER__H_
26
28
36{
37public:
38
43 class CLIENT
44 {
45 public:
53 virtual bool OnFirstPoint( POLYGON_GEOM_MANAGER& aMgr ) = 0;
54
56 virtual void OnGeometryChange( const POLYGON_GEOM_MANAGER& aMgr ) = 0;
57
59 virtual void OnComplete( const POLYGON_GEOM_MANAGER& aMgr ) = 0;
60
61 virtual ~CLIENT()
62 {
63 }
64 };
65
69 enum class LEADER_MODE
70 {
71 DIRECT,
72 DEG45,
73 };
74
78 POLYGON_GEOM_MANAGER( CLIENT& aClient );
79
83 bool AddPoint( const VECTOR2I& aPt );
84
88 void SetFinished();
89
93 void Reset();
94
98 void SetLeaderMode( LEADER_MODE aMode );
99
101 {
102 return m_leaderMode;
103 }
104
110 void AllowIntersections( bool aEnabled )
111 {
113 }
114
121 {
123 }
124
131 bool IsSelfIntersecting( bool aIncludeLeaderPts ) const;
132
136 void SetCursorPosition( const VECTOR2I& aPos );
137
142 bool IsPolygonInProgress() const;
143
147 bool NewPointClosesOutline( const VECTOR2I& aPt ) const;
148
152 void DeleteLastCorner();
153
154 /* =================================================================
155 * Interfaces for users of the geometry
156 */
157
162 {
163 return m_lockedPoints;
164 }
165
173 {
174 return m_leaderPts;
175 }
176
177private:
178
183 void updateLeaderPoints( const VECTOR2I& aEndPoint,
184 LEADER_MODE aModifier = LEADER_MODE::DIRECT );
185
188
191
194
197
200};
201
202#endif // PREVIEW_POLYGON_GEOM_MANAGER__H_
"Listener" interface for a class that wants to be updated about polygon geometry changes
virtual void OnGeometryChange(const POLYGON_GEOM_MANAGER &aMgr)=0
Called when the polygon is complete.
virtual bool OnFirstPoint(POLYGON_GEOM_MANAGER &aMgr)=0
Called before the first point is added - clients can do initialization here, and can veto the start o...
virtual void OnComplete(const POLYGON_GEOM_MANAGER &aMgr)=0
Class that handles the drawing of a polygon, including management of last corner deletion and drawing...
bool AddPoint(const VECTOR2I &aPt)
Lock in a polygon point.
CLIENT & m_client
The current mode of the leader line.
const SHAPE_LINE_CHAIN & GetLockedInPoints() const
Get the "locked-in" points that describe the polygon itself.
void updateLeaderPoints(const VECTOR2I &aEndPoint, LEADER_MODE aModifier=LEADER_MODE::DIRECT)
Update the leader line points based on a new endpoint (probably a cursor position)
POLYGON_GEOM_MANAGER(CLIENT &aClient)
SHAPE_LINE_CHAIN m_leaderPts
LEADER_MODE
The kind of the leader line.
@ DIRECT
Unconstrained point-to-point.
void SetCursorPosition(const VECTOR2I &aPos)
Set the current cursor position.
bool IntersectionsAllowed() const
Check whether self-intersecting polygons are enabled.
LEADER_MODE GetLeaderMode() const
void AllowIntersections(bool aEnabled)
Enables/disables self-intersecting polygons.
void DeleteLastCorner()
Remove the last-added point from the polygon.
bool IsSelfIntersecting(bool aIncludeLeaderPts) const
Check whether the locked points constitute a self-intersecting outline.
bool NewPointClosesOutline(const VECTOR2I &aPt) const
void SetFinished()
Mark the polygon finished and update the client.
void SetLeaderMode(LEADER_MODE aMode)
Set the leader mode to use when calculating the leader/returner lines.
LEADER_MODE m_leaderMode
Flag enabling self-intersecting polygons.
const SHAPE_LINE_CHAIN & GetLeaderLinePoints() const
Get the points comprising the leader line (the line from the last locked-in point to the current curs...
void Reset()
Clear the manager state and start again.
SHAPE_LINE_CHAIN m_lockedPoints
Points in the temporary "leader" line(s)
bool m_intersectionsAllowed
Point that have been "locked in".
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...