KiCad PCB EDA Suite
lib_bezier.cpp
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) 2004-2019 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 
28 #include <fctsys.h>
29 #include <gr_basic.h>
30 #include <macros.h>
31 #include <sch_draw_panel.h>
32 #include <plotter.h>
33 #include <trigo.h>
34 #include <bezier_curves.h>
35 #include <base_units.h>
36 #include <msgpanel.h>
37 
38 #include <general.h>
39 #include <lib_bezier.h>
40 #include <transform.h>
41 
42 
44  LIB_ITEM( LIB_BEZIER_T, aParent )
45 {
46  m_Fill = NO_FILL;
47  m_Width = 0;
48  m_isFillable = true;
49 }
50 
51 
53 {
54  return new LIB_BEZIER( *this );
55 }
56 
57 
58 int LIB_BEZIER::compare( const LIB_ITEM& aOther ) const
59 {
60  wxASSERT( aOther.Type() == LIB_BEZIER_T );
61 
62  const LIB_BEZIER* tmp = ( LIB_BEZIER* ) &aOther;
63 
64  if( m_BezierPoints.size() != tmp->m_BezierPoints.size() )
65  return m_BezierPoints.size() - tmp->m_BezierPoints.size();
66 
67  for( size_t i = 0; i < m_BezierPoints.size(); i++ )
68  {
69  if( m_BezierPoints[i].x != tmp->m_BezierPoints[i].x )
70  return m_BezierPoints[i].x - tmp->m_BezierPoints[i].x;
71 
72  if( m_BezierPoints[i].y != tmp->m_BezierPoints[i].y )
73  return m_BezierPoints[i].y - tmp->m_BezierPoints[i].y;
74  }
75 
76  return 0;
77 }
78 
79 
80 void LIB_BEZIER::Offset( const wxPoint& aOffset )
81 {
82  size_t i;
83 
84  for( i = 0; i < m_BezierPoints.size(); i++ )
85  m_BezierPoints[i] += aOffset;
86 
87  for( i = 0; i < m_PolyPoints.size(); i++ )
88  m_PolyPoints[i] += aOffset;
89 }
90 
91 
92 bool LIB_BEZIER::Inside( EDA_RECT& aRect ) const
93 {
94  for( size_t i = 0; i < m_PolyPoints.size(); i++ )
95  {
96  if( aRect.Contains( m_PolyPoints[i].x, -m_PolyPoints[i].y ) )
97  return true;
98  }
99 
100  return false;
101 }
102 
103 
104 void LIB_BEZIER::MoveTo( const wxPoint& aPosition )
105 {
106  if ( !m_PolyPoints.size() )
107  {
108  m_PolyPoints.push_back( wxPoint(0, 0) );
109  }
110 
111  Offset( aPosition - m_PolyPoints[ 0 ] );
112 }
113 
114 const wxPoint LIB_BEZIER::GetOffset() const
115 {
116  if ( !m_PolyPoints.size() )
117  {
118  return wxPoint(0, 0);
119  }
120 
121  return m_PolyPoints[0];
122 }
123 
124 void LIB_BEZIER::MirrorHorizontal( const wxPoint& aCenter )
125 {
126  size_t i, imax = m_PolyPoints.size();
127 
128  for( i = 0; i < imax; i++ )
129  {
130  m_PolyPoints[i].x -= aCenter.x;
131  m_PolyPoints[i].x *= -1;
132  m_PolyPoints[i].x += aCenter.x;
133  }
134 
135  imax = m_BezierPoints.size();
136 
137  for( i = 0; i < imax; i++ )
138  {
139  m_BezierPoints[i].x -= aCenter.x;
140  m_BezierPoints[i].x *= -1;
141  m_BezierPoints[i].x += aCenter.x;
142  }
143 }
144 
145 void LIB_BEZIER::MirrorVertical( const wxPoint& aCenter )
146 {
147  size_t i, imax = m_PolyPoints.size();
148 
149  for( i = 0; i < imax; i++ )
150  {
151  m_PolyPoints[i].y -= aCenter.y;
152  m_PolyPoints[i].y *= -1;
153  m_PolyPoints[i].y += aCenter.y;
154  }
155 
156  imax = m_BezierPoints.size();
157 
158  for( i = 0; i < imax; i++ )
159  {
160  m_BezierPoints[i].y -= aCenter.y;
161  m_BezierPoints[i].y *= -1;
162  m_BezierPoints[i].y += aCenter.y;
163  }
164 }
165 
166 void LIB_BEZIER::Rotate( const wxPoint& aCenter, bool aRotateCCW )
167 {
168  int rot_angle = aRotateCCW ? -900 : 900;
169 
170  size_t i, imax = m_PolyPoints.size();
171 
172  for( i = 0; i < imax; i++ )
173  {
174  RotatePoint( &m_PolyPoints[i], aCenter, rot_angle );
175  }
176 
177  imax = m_BezierPoints.size();
178 
179  for( i = 0; i < imax; i++ )
180  {
181  RotatePoint( &m_BezierPoints[i], aCenter, rot_angle );
182  }
183 }
184 
185 
186 void LIB_BEZIER::Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
187  const TRANSFORM& aTransform )
188 {
189  wxASSERT( aPlotter != NULL );
190 
191  static std::vector< wxPoint > cornerList;
192  cornerList.clear();
193 
194  for( unsigned ii = 0; ii < m_PolyPoints.size(); ii++ )
195  {
196  wxPoint pos = m_PolyPoints[ii];
197  pos = aTransform.TransformCoordinate( pos ) + aOffset;
198  cornerList.push_back( pos );
199  }
200 
201  if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
202  {
204  aPlotter->PlotPoly( cornerList, FILLED_WITH_BG_BODYCOLOR, 0 );
205  }
206 
207  bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
208  auto pen_size = GetPenSize();
209 
210  if( !already_filled || pen_size > 0 )
211  {
212  pen_size = std::max( 0, pen_size );
213  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
214  aPlotter->PlotPoly( cornerList, already_filled ? NO_FILL : m_Fill, GetPenSize() );
215  }
216 }
217 
218 
220 {
221  if( m_Width > 0 )
222  return m_Width;
223 
224  if( m_Width == 0 )
225  return GetDefaultLineThickness();
226 
227  return -1; // a value to use a minimal pen size
228 }
229 
230 
231 void LIB_BEZIER::drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
232  void* aData, const TRANSFORM& aTransform )
233 {
234  std::vector<wxPoint> PolyPointsTraslated;
235 
238  BEZIER_POLY converter( m_BezierPoints );
239  converter.GetPoly( m_PolyPoints );
240 
241  PolyPointsTraslated.clear();
242 
243  for( unsigned int i = 0; i < m_PolyPoints.size() ; i++ )
244  PolyPointsTraslated.push_back( aTransform.TransformCoordinate( m_PolyPoints[i] ) +
245  aOffset );
246 
247  FILL_T fill = aData ? NO_FILL : m_Fill;
248 
249  EDA_RECT* const clipbox = aPanel? aPanel->GetClipBox() : NULL;
250 
251  if( fill == FILLED_WITH_BG_BODYCOLOR )
252  {
253  GRPoly( clipbox, aDC, m_PolyPoints.size(), &PolyPointsTraslated[0], 1, GetPenSize(),
254  bgColor, bgColor );
255  }
256  else if( fill == FILLED_SHAPE )
257  {
258  GRPoly( clipbox, aDC, m_PolyPoints.size(), &PolyPointsTraslated[0], 1, GetPenSize(),
259  color, color );
260  }
261  else
262  {
263  GRPoly( clipbox, aDC, m_PolyPoints.size(), &PolyPointsTraslated[0], 0, GetPenSize(),
264  color, color );
265  }
266 }
267 
268 
269 bool LIB_BEZIER::HitTest( const wxPoint& aRefPos, int aAccuracy ) const
270 {
271  int mindist = std::max( aAccuracy + GetPenSize() / 2, MINIMUM_SELECTION_DISTANCE );
272  wxPoint start, end;
273 
274  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
275  {
278 
279  if ( TestSegmentHit( aRefPos, start, end, mindist ) )
280  return true;
281  }
282 
283  return false;
284 }
285 
286 
287 bool LIB_BEZIER::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
288 {
289  if( m_Flags & ( STRUCT_DELETED | SKIP_STRUCT ) )
290  return false;
291 
292  EDA_RECT sel = aRect;
293 
294  if ( aAccuracy )
295  sel.Inflate( aAccuracy );
296 
297  if( aContained )
298  return sel.Contains( GetBoundingBox() );
299 
300  // Fast test: if aRect is outside the polygon bounding box, rectangles cannot intersect
301  if( !sel.Intersects( GetBoundingBox() ) )
302  return false;
303 
304  // Account for the width of the line
305  sel.Inflate( GetWidth() / 2 );
306  unsigned count = m_BezierPoints.size();
307 
308  for( unsigned ii = 1; ii < count; ii++ )
309  {
310  wxPoint vertex = DefaultTransform.TransformCoordinate( m_BezierPoints[ii-1] );
311  wxPoint vertexNext = DefaultTransform.TransformCoordinate( m_BezierPoints[ii] );
312 
313  // Test if the point is within aRect
314  if( sel.Contains( vertex ) )
315  return true;
316 
317  // Test if this edge intersects aRect
318  if( sel.Intersects( vertex, vertexNext ) )
319  return true;
320  }
321 
322  return false;
323 }
324 
325 
327 {
328  EDA_RECT rect;
329  int xmin, xmax, ymin, ymax;
330 
331  if( !GetCornerCount() )
332  return rect;
333 
334  xmin = xmax = m_PolyPoints[0].x;
335  ymin = ymax = m_PolyPoints[0].y;
336 
337  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
338  {
339  xmin = std::min( xmin, m_PolyPoints[ii].x );
340  xmax = std::max( xmax, m_PolyPoints[ii].x );
341  ymin = std::min( ymin, m_PolyPoints[ii].y );
342  ymax = std::max( ymax, m_PolyPoints[ii].y );
343  }
344 
345  rect.SetOrigin( xmin, ymin );
346  rect.SetEnd( xmax, ymax );
347  rect.Inflate( ( GetPenSize()+1 ) / 2 );
348 
349  rect.RevertYAxis();
350 
351  return rect;
352 }
353 
354 
355 void LIB_BEZIER::GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList )
356 {
357  wxString msg;
358  EDA_RECT bBox = GetBoundingBox();
359 
360  LIB_ITEM::GetMsgPanelInfo( aUnits, aList );
361 
362  msg = MessageTextFromValue( aUnits, m_Width, true );
363 
364  aList.push_back( MSG_PANEL_ITEM( _( "Line Width" ), msg, BLUE ) );
365 
366  msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
367  bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );
368 
369  aList.push_back( MSG_PANEL_ITEM( _( "Bounding Box" ), msg, BROWN ) );
370 }
371 
372 wxPoint LIB_BEZIER::GetPosition() const
373 {
374  if( !m_PolyPoints.size() )
375  return wxPoint(0, 0);
376 
377  return m_PolyPoints[0];
378 }
Definition: colors.h:57
int compare(const LIB_ITEM &aOther) const override
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_bezier.cpp:58
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Display basic info (type, part and convert) about the current item in message panel.
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:701
void MoveTo(const wxPoint &aPosition) override
Move a draw object to aPosition.
Definition: lib_bezier.cpp:104
const wxPoint GetOffset() const
Definition: lib_bezier.cpp:114
Implementation of conversion functions that require both schematic and board internal units.
virtual void SetColor(COLOR4D color)=0
LIB_BEZIER(LIB_PART *aParent)
Definition: lib_bezier.cpp:43
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_draw_item.h:53
std::vector< wxPoint > m_BezierPoints
Definition: lib_bezier.h:42
void GetPoly(std::vector< wxPoint > &aOutput, int aMinSegLen=0)
Converts Bezier curve to a polygon.
void drawGraphic(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
Draw the item on aPanel.
Definition: lib_bezier.cpp:231
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: base_struct.h:125
int color
Definition: DXF_plotter.cpp:62
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i....
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
Definition: lib_bezier.cpp:326
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
Definition: lib_bezier.cpp:269
void Plot(PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform) override
Plot the draw item using the plot object.
Definition: lib_bezier.cpp:186
void SetOrigin(const wxPoint &pos)
Definition: eda_rect.h:124
virtual EDA_RECT * GetClipBox()
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:216
virtual void PlotPoly(const std::vector< wxPoint > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=NULL)=0
Function PlotPoly.
COLOR4D GetLayerColor(SCH_LAYER_ID aLayer)
Definition: eeschema.cpp:174
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size)
Definition: eda_rect.h:144
wxPoint GetPosition() const override
Return the current draw object position.
Definition: lib_bezier.cpp:372
bool Contains(const wxPoint &aPoint) const
Function Contains.
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
The base class for drawable items used by schematic library components.
Definition: lib_draw_item.h:67
This file contains miscellaneous commonly used macros and functions.
int GetWidth() const override
Return the width of the draw item.
Definition: lib_bezier.h:100
wxString MessageTextFromValue(EDA_UNITS_T aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:125
unsigned GetCornerCount() const
Definition: lib_bezier.h:74
const wxPoint GetEnd() const
Definition: eda_rect.h:114
void Offset(const wxPoint &aOffset) override
Set the drawing object by aOffset from the current position.
Definition: lib_bezier.cpp:80
void MirrorHorizontal(const wxPoint &aCenter) override
Mirror the draw object along the horizontal (X) axis about aCenter point.
Definition: lib_bezier.cpp:124
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
bool Inside(EDA_RECT &aRect) const override
Test if any part of the draw object is inside rectangle bounds of aRect.
Definition: lib_bezier.cpp:92
const wxPoint GetOrigin() const
Definition: eda_rect.h:112
void SetEnd(int x, int y)
Definition: eda_rect.h:134
std::vector< wxPoint > m_PolyPoints
Definition: lib_bezier.h:43
bool m_isFillable
Flag to indicate if draw item is fillable.
Define a library symbol object.
#define STRUCT_DELETED
flag indication structures to be erased
Definition: base_struct.h:123
void GetMsgPanelInfo(EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
Definition: lib_bezier.cpp:355
virtual void Rotate()
Rotate the draw item.
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: lib_bezier.cpp:52
int GetPenSize() const override
Definition: lib_bezier.cpp:219
Base plotter engine class.
Definition: plotter.h:97
Bezier curves to polygon converter.
Definition: bezier_curves.h:35
TRANSFORM DefaultTransform
Definition: eeschema.cpp:59
#define max(a, b)
Definition: auxiliary.h:86
FILL_T m_Fill
The body fill type.
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:181
size_t i
Definition: json11.cpp:597
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void MirrorVertical(const wxPoint &aCenter) override
Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.
Definition: lib_bezier.cpp:145
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:157
bool Intersects(const EDA_RECT &aRect) const
Function Intersects tests for a common area between rectangles.
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:54
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
bool TestSegmentHit(const wxPoint &aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist)
Function TestSegmentHit test for hit on line segment i.e.
Definition: trigo.cpp:122
int m_Width
Definition: lib_bezier.h:41
Message panel definition file.
EDA_UNITS_T
Definition: common.h:157
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:204
#define min(a, b)
Definition: auxiliary.h:85
Class LIB_BEZIER defines bezier curve graphic body item.
Definition: lib_bezier.h:39
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
Definition: colors.h:62