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-2012 KiCad Developers, see change_log.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 <class_drawpanel.h>
32 #include <plot_common.h>
33 #include <trigo.h>
34 #include <wxstruct.h>
35 #include <bezier_curves.h>
36 #include <richio.h>
37 #include <base_units.h>
38 #include <msgpanel.h>
39 
40 #include <general.h>
41 #include <lib_bezier.h>
42 #include <transform.h>
43 
44 
46  LIB_ITEM( LIB_BEZIER_T, aParent )
47 {
48  m_Fill = NO_FILL;
49  m_Width = 0;
50  m_isFillable = true;
51  m_typeName = _( "Bezier" );
52 }
53 
54 
55 bool LIB_BEZIER::Save( OUTPUTFORMATTER& aFormatter )
56 {
57  int ccount = GetCornerCount();
58 
59  aFormatter.Print( 0, "B %d %d %d %d", ccount, m_Unit, m_Convert, m_Width );
60 
61  for( const auto& pt : m_BezierPoints )
62  aFormatter.Print( 0, " %d %d", pt.x, pt.y );
63 
64  aFormatter.Print( 0, " %c\n", fill_tab[m_Fill] );
65 
66  return true;
67 }
68 
69 
70 bool LIB_BEZIER::Load( LINE_READER& aLineReader, wxString& aErrorMsg )
71 {
72  char* p;
73  int i, ccount = 0;
74  wxPoint pt;
75  char* line = (char*) aLineReader;
76 
77  i = sscanf( line + 2, "%d %d %d %d", &ccount, &m_Unit, &m_Convert, &m_Width );
78 
79  if( i !=4 )
80  {
81  aErrorMsg.Printf( _( "Bezier only had %d parameters of the required 4" ), i );
82  return false;
83  }
84 
85  if( ccount <= 0 )
86  {
87  aErrorMsg.Printf( _( "Bezier count parameter %d is invalid" ), ccount );
88  return false;
89  }
90 
91  strtok( line + 2, " \t\n" ); // Skip field
92  strtok( NULL, " \t\n" ); // Skip field
93  strtok( NULL, " \t\n" ); // Skip field
94  strtok( NULL, " \t\n" );
95 
96  for( i = 0; i < ccount; i++ )
97  {
98  p = strtok( NULL, " \t\n" );
99 
100  if( sscanf( p, "%d", &pt.x ) != 1 )
101  {
102  aErrorMsg.Printf( _( "Bezier point %d X position not defined" ), i );
103  return false;
104  }
105 
106  p = strtok( NULL, " \t\n" );
107 
108  if( sscanf( p, "%d", &pt.y ) != 1 )
109  {
110  aErrorMsg.Printf( _( "Bezier point %d Y position not defined" ), i );
111  return false;
112  }
113 
114  m_BezierPoints.push_back( pt );
115  }
116 
117  m_Fill = NO_FILL;
118 
119  if( ( p = strtok( NULL, " \t\n" ) ) != NULL )
120  {
121  if( p[0] == 'F' )
123 
124  if( p[0] == 'f' )
126  }
127 
128  return true;
129 }
130 
131 
133 {
134  return new LIB_BEZIER( *this );
135 }
136 
137 
138 int LIB_BEZIER::compare( const LIB_ITEM& aOther ) const
139 {
140  wxASSERT( aOther.Type() == LIB_BEZIER_T );
141 
142  const LIB_BEZIER* tmp = ( LIB_BEZIER* ) &aOther;
143 
144  if( m_BezierPoints.size() != tmp->m_BezierPoints.size() )
145  return m_BezierPoints.size() - tmp->m_BezierPoints.size();
146 
147  for( size_t i = 0; i < m_BezierPoints.size(); i++ )
148  {
149  if( m_BezierPoints[i].x != tmp->m_BezierPoints[i].x )
150  return m_BezierPoints[i].x - tmp->m_BezierPoints[i].x;
151 
152  if( m_BezierPoints[i].y != tmp->m_BezierPoints[i].y )
153  return m_BezierPoints[i].y - tmp->m_BezierPoints[i].y;
154  }
155 
156  return 0;
157 }
158 
159 
160 void LIB_BEZIER::SetOffset( const wxPoint& aOffset )
161 {
162  size_t i;
163 
164  for( i = 0; i < m_BezierPoints.size(); i++ )
165  m_BezierPoints[i] += aOffset;
166 
167  for( i = 0; i < m_PolyPoints.size(); i++ )
168  m_PolyPoints[i] += aOffset;
169 }
170 
171 
172 bool LIB_BEZIER::Inside( EDA_RECT& aRect ) const
173 {
174  for( size_t i = 0; i < m_PolyPoints.size(); i++ )
175  {
176  if( aRect.Contains( m_PolyPoints[i].x, -m_PolyPoints[i].y ) )
177  return true;
178  }
179 
180  return false;
181 }
182 
183 
184 void LIB_BEZIER::Move( const wxPoint& aPosition )
185 {
186  SetOffset( aPosition - m_PolyPoints[0] );
187 }
188 
189 
190 void LIB_BEZIER::MirrorHorizontal( const wxPoint& aCenter )
191 {
192  size_t i, imax = m_PolyPoints.size();
193 
194  for( i = 0; i < imax; i++ )
195  {
196  m_PolyPoints[i].x -= aCenter.x;
197  m_PolyPoints[i].x *= -1;
198  m_PolyPoints[i].x += aCenter.x;
199  }
200 
201  imax = m_BezierPoints.size();
202 
203  for( i = 0; i < imax; i++ )
204  {
205  m_BezierPoints[i].x -= aCenter.x;
206  m_BezierPoints[i].x *= -1;
207  m_BezierPoints[i].x += aCenter.x;
208  }
209 }
210 
211 void LIB_BEZIER::MirrorVertical( const wxPoint& aCenter )
212 {
213  size_t i, imax = m_PolyPoints.size();
214 
215  for( i = 0; i < imax; i++ )
216  {
217  m_PolyPoints[i].y -= aCenter.y;
218  m_PolyPoints[i].y *= -1;
219  m_PolyPoints[i].y += aCenter.y;
220  }
221 
222  imax = m_BezierPoints.size();
223 
224  for( i = 0; i < imax; i++ )
225  {
226  m_BezierPoints[i].y -= aCenter.y;
227  m_BezierPoints[i].y *= -1;
228  m_BezierPoints[i].y += aCenter.y;
229  }
230 }
231 
232 void LIB_BEZIER::Rotate( const wxPoint& aCenter, bool aRotateCCW )
233 {
234  int rot_angle = aRotateCCW ? -900 : 900;
235 
236  size_t i, imax = m_PolyPoints.size();
237 
238  for( i = 0; i < imax; i++ )
239  {
240  RotatePoint( &m_PolyPoints[i], aCenter, rot_angle );
241  }
242 
243  imax = m_BezierPoints.size();
244 
245  for( i = 0; i < imax; i++ )
246  {
247  RotatePoint( &m_BezierPoints[i], aCenter, rot_angle );
248  }
249 }
250 
251 
252 void LIB_BEZIER::Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
253  const TRANSFORM& aTransform )
254 {
255  wxASSERT( aPlotter != NULL );
256 
257  static std::vector< wxPoint > cornerList;
258  cornerList.clear();
259 
260  for( unsigned ii = 0; ii < m_PolyPoints.size(); ii++ )
261  {
262  wxPoint pos = m_PolyPoints[ii];
263  pos = aTransform.TransformCoordinate( pos ) + aOffset;
264  cornerList.push_back( pos );
265  }
266 
267  if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
268  {
270  aPlotter->PlotPoly( cornerList, FILLED_WITH_BG_BODYCOLOR, 0 );
271  }
272 
273  bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
274  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
275  aPlotter->PlotPoly( cornerList, already_filled ? NO_FILL : m_Fill, GetPenSize() );
276 }
277 
278 
280 {
281  return ( m_Width == 0 ) ? GetDefaultLineThickness() : m_Width;
282 }
283 
284 
285 void LIB_BEZIER::drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
286  COLOR4D aColor, GR_DRAWMODE aDrawMode, void* aData,
287  const TRANSFORM& aTransform )
288 {
289  std::vector<wxPoint> PolyPointsTraslated;
290 
292  BEZIER_POLY converter( m_BezierPoints );
293  converter.GetPoly( m_PolyPoints );
294 
295  PolyPointsTraslated.clear();
296 
297  for( unsigned int i = 0; i < m_PolyPoints.size() ; i++ )
298  PolyPointsTraslated.push_back( aTransform.TransformCoordinate( m_PolyPoints[i] ) +
299  aOffset );
300 
301  if( aColor == COLOR4D::UNSPECIFIED ) // Used normal color or selected color
302  {
303  if( IsSelected() )
304  color = GetItemSelectedColor();
305  }
306  else
307  {
308  color = aColor;
309  }
310 
311  FILL_T fill = aData ? NO_FILL : m_Fill;
312 
313  if( aColor != COLOR4D::UNSPECIFIED )
314  fill = NO_FILL;
315 
316  GRSetDrawMode( aDC, aDrawMode );
317  EDA_RECT* const clipbox = aPanel? aPanel->GetClipBox() : NULL;
318 
319  if( fill == FILLED_WITH_BG_BODYCOLOR )
320  GRPoly( clipbox, aDC, m_PolyPoints.size(),
321  &PolyPointsTraslated[0], 1, GetPenSize(),
324  else if( fill == FILLED_SHAPE )
325  GRPoly( clipbox, aDC, m_PolyPoints.size(),
326  &PolyPointsTraslated[0], 1, GetPenSize(), color, color );
327  else
328  GRPoly( clipbox, aDC, m_PolyPoints.size(),
329  &PolyPointsTraslated[0], 0, GetPenSize(), color, color );
330 
331  /* Set to one (1) to draw bounding box around bezier curve to validate
332  * bounding box calculation. */
333 #if 0
334  EDA_RECT bBox = GetBoundingBox();
335  GRRect( aPanel->GetClipBox(), aDC, bBox.GetOrigin().x, bBox.GetOrigin().y,
336  bBox.GetEnd().x, bBox.GetEnd().y, 0, LIGHTMAGENTA );
337 #endif
338 }
339 
340 
341 bool LIB_BEZIER::HitTest( const wxPoint& aRefPos ) const
342 {
343  int mindist = GetPenSize() / 2;
344 
345  // Have a minimal tolerance for hit test
346  if ( mindist < MINIMUM_SELECTION_DISTANCE )
347  mindist = MINIMUM_SELECTION_DISTANCE;
348 
349  return HitTest( aRefPos, mindist, DefaultTransform );
350 }
351 
352 
353 bool LIB_BEZIER::HitTest( const wxPoint &aPosRef, int aThreshold, const TRANSFORM& aTransform ) const
354 {
355  wxPoint start, end;
356 
357  if( aThreshold < 0 )
358  aThreshold = GetPenSize() / 2;
359 
360  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
361  {
362  start = aTransform.TransformCoordinate( m_PolyPoints[ii - 1] );
363  end = aTransform.TransformCoordinate( m_PolyPoints[ii] );
364 
365  if ( TestSegmentHit( aPosRef, start, end, aThreshold ) )
366  return true;
367  }
368 
369  return false;
370 }
371 
372 
374 {
375  EDA_RECT rect;
376  int xmin, xmax, ymin, ymax;
377 
378  if( !GetCornerCount() )
379  return rect;
380 
381  xmin = xmax = m_PolyPoints[0].x;
382  ymin = ymax = m_PolyPoints[0].y;
383 
384  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
385  {
386  xmin = std::min( xmin, m_PolyPoints[ii].x );
387  xmax = std::max( xmax, m_PolyPoints[ii].x );
388  ymin = std::min( ymin, m_PolyPoints[ii].y );
389  ymax = std::max( ymax, m_PolyPoints[ii].y );
390  }
391 
392  rect.SetOrigin( xmin, ymin );
393  rect.SetEnd( xmax, ymax );
394  rect.Inflate( ( GetPenSize()+1 ) / 2 );
395 
396  rect.RevertYAxis();
397 
398  return rect;
399 }
400 
401 
402 void LIB_BEZIER::GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList )
403 {
404  wxString msg;
405  EDA_RECT bBox = GetBoundingBox();
406 
407  LIB_ITEM::GetMsgPanelInfo( aList );
408 
409  msg = StringFromValue( g_UserUnit, m_Width, true );
410 
411  aList.push_back( MSG_PANEL_ITEM( _( "Line Width" ), msg, BLUE ) );
412 
413  msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
414  bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );
415 
416  aList.push_back( MSG_PANEL_ITEM( _( "Bounding Box" ), msg, BROWN ) );
417 }
Definition: colors.h:57
int compare(const LIB_ITEM &aOther) const override
Function compare provides the draw object specific comparison called by the == and < operators...
Definition: lib_bezier.cpp:138
KICAD_T Type() const
Function Type()
Definition: base_struct.h:198
void SetOffset(const wxPoint &aOffset) override
Function Offset sets the drawing object by aOffset from the current position.
Definition: lib_bezier.cpp:160
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:767
Class LINE_READER is an abstract class from which implementation specific LINE_READERs may be derived...
Definition: richio.h:81
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:290
wxString m_typeName
Name of object displayed in the message panel.
Implementation of conversion functions that require both schematic and board internal units...
virtual void SetColor(COLOR4D color)=0
void Move(const wxPoint &aPosition) override
Function Move moves a draw object to aPosition.
Definition: lib_bezier.cpp:184
LIB_BEZIER(LIB_PART *aParent)
Definition: lib_bezier.cpp:45
#define MINIMUM_SELECTION_DISTANCE
Definition: lib_draw_item.h:52
std::vector< wxPoint > m_BezierPoints
Definition: lib_bezier.h:42
bool Contains(const wxPoint &aPoint) const
Function Contains.
wxString StringFromValue(EDA_UNITS_T aUnit, int aValue, bool aAddUnitSymbol)
Function StringFromValue returns the string from aValue according to units (inch, mm ...
Definition: base_units.cpp:203
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i...
void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo displays basic info (type, part and convert) about the current item in messa...
Definition: lib_bezier.cpp:402
void GetPoly(std::vector< wxPoint > &aOutput)
Converts Bezier curve to a polygon.
const EDA_RECT GetBoundingBox() const override
Definition: lib_bezier.cpp:373
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:252
bool IsSelected() const
Definition: base_struct.h:221
void SetOrigin(const wxPoint &pos)
int m_Unit
Unit identification for multiple parts per package.
Class OUTPUTFORMATTER is an important interface (abstract class) used to output 8 bit text in a conve...
Definition: richio.h:327
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
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:167
void RevertYAxis()
Function RevertYAxis Mirror the rectangle from the X axis (negate Y pos and size) ...
Class LIB_ITEM is 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.
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
const wxPoint & GetOrigin() const
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1077
void MirrorHorizontal(const wxPoint &aCenter) override
Function MirrorHorizontal mirrors the draw object along the horizontal (X) axis about aCenter point...
Definition: lib_bezier.cpp:190
Class for tranforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
bool Inside(EDA_RECT &aRect) const override
Function Inside tests if any part of the draw object is inside rectangle bounds of aRect...
Definition: lib_bezier.cpp:172
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:41
Base window classes and related definitions.
void SetEnd(int x, int y)
bool Load(LINE_READER &aLineReader, wxString &aErrorMsg) override
Definition: lib_bezier.cpp:70
std::vector< wxPoint > m_PolyPoints
Definition: lib_bezier.h:43
bool m_isFillable
Flag to indicate if draw item is fillable.
Class LIB_PART defines a library part object.
EDA_RECT * GetClipBox()
Common plot library Plot settings, and plotting engines (Postscript, Gerber, HPGL and DXF) ...
unsigned GetCornerCount() const
Definition: lib_bezier.h:73
virtual void Rotate()
Rotate the draw item.
const wxPoint GetEnd() const
EDA_UNITS_T g_UserUnit
Global variables definitions.
Definition: common.cpp:56
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Definition: lib_bezier.cpp:132
int GetPenSize() const override
Function GetPenSize.
Definition: lib_bezier.cpp:279
Base plotter engine class.
Definition: plot_common.h:86
Bezier curves to polygon converter.
Definition: bezier_curves.h:34
virtual void GetMsgPanelInfo(std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo displays basic info (type, part and convert) about the current item in messa...
TRANSFORM DefaultTransform
Definition: eeschema.cpp:58
const int fill_tab[3]
bool Save(OUTPUTFORMATTER &aFormatter) override
Function Save writes draw item object to aFormatter in component library "*.lib" format.
Definition: lib_bezier.cpp:55
#define max(a, b)
Definition: auxiliary.h:86
FILL_T m_Fill
The body fill type.
bool HitTest(const wxPoint &aPosition) const override
Function HitTest tests if aPosition is contained within or on the bounding area of an item...
Definition: lib_bezier.cpp:341
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
Class EDA_RECT handles the component boundary box.
void drawGraphic(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform) override
Function drawGraphic.
Definition: lib_bezier.cpp:285
void MirrorVertical(const wxPoint &aCenter) override
Function MirrorVertical mirrors the draw object along the MirrorVertical (Y) axis about aCenter point...
Definition: lib_bezier.cpp:211
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:151
int m_Convert
Shape identification for alternate body styles.
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:56
COLOR4D GetItemSelectedColor()
Class EDA_MSG_ITEM is used EDA_MSG_PANEL as the item type for displaying messages.
Definition: msgpanel.h:53
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Function Print formats and writes text to the output stream.
Definition: richio.cpp:408
bool TestSegmentHit(const wxPoint &aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist)
Function TestSegmentHit test for hit on line segment i.e.
Definition: trigo.cpp:142
int m_Width
Definition: lib_bezier.h:41
Message panel definition file.
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Function Inflate inflates the rectangle horizontally by dx and vertically by dy.
#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
#define IS_MOVED
Item being moved.
Definition: base_struct.h:112
Definition: colors.h:62