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 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 
37 {
38 public:
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  enum class LEADER_MODE
71  {
72  DIRECT,
73  DEG45,
74  };
75 
79  POLYGON_GEOM_MANAGER( CLIENT& aClient );
80 
84  bool AddPoint( const VECTOR2I& aPt );
85 
89  void SetFinished();
90 
94  void Reset();
95 
100  void SetLeaderMode( LEADER_MODE aMode );
101 
103  {
104  return m_leaderMode;
105  }
106 
111  void AllowIntersections( bool aEnabled )
112  {
113  m_intersectionsAllowed = true;
114  }
115 
120  bool IntersectionsAllowed() const
121  {
122  return m_intersectionsAllowed;
123  }
124 
130  bool IsSelfIntersecting( bool aIncludeLeaderPts ) const;
131 
135  void SetCursorPosition( const VECTOR2I& aPos );
136 
141  bool IsPolygonInProgress() const;
142 
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 
177 private:
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_
virtual void OnGeometryChange(const POLYGON_GEOM_MANAGER &aMgr)=0
Sent when the polygon geometry changes
SHAPE_LINE_CHAIN m_lockedPoints
Point that have been "locked in"
LEADER_MODE
The kind of the leader line.
POLYGON_GEOM_MANAGER(CLIENT &aClient)
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...
VECTOR2 defines a general 2D-vector/point.
Definition: vector2d.h:61
LEADER_MODE m_leaderMode
The current mode of the leader line
CLIENT & m_client
The "user" of the polygon data that is informed when the geometry changes
bool NewPointClosesOutline(const VECTOR2I &aPt) const
void SetLeaderMode(LEADER_MODE aMode)
Set the leader mode to use when calculating the leader/returner lines.
LEADER_MODE GetLeaderMode() const
bool IntersectionsAllowed() const
Checks whether self-intersecting polygons are enabled.
Unconstrained point-to-point
"Listener" interface for a class that wants to be updated about polygon geometry changes
virtual bool OnFirstPoint(POLYGON_GEOM_MANAGER &aMgr)=0
Called before the first point is added - clients can do initialisation here, and can veto the start o...
bool IsSelfIntersecting(bool aIncludeLeaderPts) const
Checks whether the locked points constitute a self-intersecting outline.
void AllowIntersections(bool aEnabled)
Enables/disables self-intersecting polygons.
void DeleteLastCorner()
Remove the last-added point from the polygon.
bool m_intersectionsAllowed
Flag enabling self-intersecting polygons
SHAPE_LINE_CHAIN.
void Reset()
Clear the manager state and start again.
const SHAPE_LINE_CHAIN & GetLockedInPoints() const
Get the "locked-in" points that describe the polygon itself.
virtual void OnComplete(const POLYGON_GEOM_MANAGER &aMgr)=0
Called when the polygon is complete
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)
bool AddPoint(const VECTOR2I &aPt)
Lock in a polygon point.
void SetCursorPosition(const VECTOR2I &aPos)
Set the current cursor position.
void SetFinished()
Mark the polygon finished and update the client.
Class that handles the drawing of a polygon, including management of last corner deletion and drawing...
SHAPE_LINE_CHAIN m_leaderPts
Points in the temporary "leader" line(s)