KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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 The 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
29
37{
38public:
39
44 class CLIENT
45 {
46 public:
54 virtual bool OnFirstPoint( POLYGON_GEOM_MANAGER& aMgr ) = 0;
55
57 virtual void OnGeometryChange( const POLYGON_GEOM_MANAGER& aMgr ) = 0;
58
60 virtual void OnComplete( const POLYGON_GEOM_MANAGER& aMgr ) = 0;
61
62 virtual ~CLIENT()
63 {
64 }
65 };
66
70 POLYGON_GEOM_MANAGER( CLIENT& aClient );
71
75 bool AddPoint( const VECTOR2I& aPt );
76
80 void SetFinished();
81
85 void Reset();
86
90 void SetLeaderMode( LEADER_MODE aMode );
91
93 {
94 return m_leaderMode;
95 }
96
102 void AllowIntersections( bool aEnabled )
103 {
105 }
106
113 {
115 }
116
123 bool IsSelfIntersecting( bool aIncludeLeaderPts ) const;
124
128 void SetCursorPosition( const VECTOR2I& aPos );
129
134 bool IsPolygonInProgress() const;
135
136 int PolygonPointCount() const;
137
141 bool NewPointClosesOutline( const VECTOR2I& aPt ) const;
142
146 std::optional<VECTOR2I> DeleteLastCorner();
147
148 /* =================================================================
149 * Interfaces for users of the geometry
150 */
151
156 {
157 return m_lockedPoints;
158 }
159
167 {
168 return m_leaderPts;
169 }
170
176 {
177 return m_loopPts;
178 }
179
180private:
181
186 void updateTemporaryLines( const VECTOR2I& aEndPoint,
187 LEADER_MODE aModifier = LEADER_MODE::DIRECT );
188
191
194
197
200
203
206};
207
208#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
bool AddPoint(const VECTOR2I &aPt)
Lock in a polygon point.
void updateTemporaryLines(const VECTOR2I &aEndPoint, LEADER_MODE aModifier=LEADER_MODE::DIRECT)
Update the leader and loop lines points based on a new endpoint (probably a cursor position)
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.
POLYGON_GEOM_MANAGER(CLIENT &aClient)
SHAPE_LINE_CHAIN m_leaderPts
Points between the cursor and start 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.
bool IsSelfIntersecting(bool aIncludeLeaderPts) const
Check whether the locked points constitute a self-intersecting outline.
bool NewPointClosesOutline(const VECTOR2I &aPt) const
std::optional< VECTOR2I > DeleteLastCorner()
Remove the last-added point from the polygon.
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 & GetLoopLinePoints() const
Get the points from the current cursor position to the polygon start point.
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...
a few functions useful in geometry calculations.
LEADER_MODE
The kind of the leader line.
@ DIRECT
Unconstrained point-to-point.
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695