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  aFormatter.Print( 0, "B %lu %d %d %d", (long unsigned)m_BezierPoints.size(),
59 
60  for( const auto& pt : m_BezierPoints )
61  aFormatter.Print( 0, " %d %d", pt.x, pt.y );
62 
63  aFormatter.Print( 0, " %c\n", fill_tab[m_Fill] );
64 
65  return true;
66 }
67 
68 
69 bool LIB_BEZIER::Load( LINE_READER& aLineReader, wxString& aErrorMsg )
70 {
71  char* p;
72  int i, ccount = 0;
73  wxPoint pt;
74  char* line = (char*) aLineReader;
75 
76  i = sscanf( line + 2, "%d %d %d %d", &ccount, &m_Unit, &m_Convert, &m_Width );
77 
78  if( i !=4 )
79  {
80  aErrorMsg.Printf( _( "Bezier only had %d parameters of the required 4" ), i );
81  return false;
82  }
83 
84  if( ccount <= 0 )
85  {
86  aErrorMsg.Printf( _( "Bezier count parameter %d is invalid" ), ccount );
87  return false;
88  }
89 
90  strtok( line + 2, " \t\n" ); // Skip field
91  strtok( NULL, " \t\n" ); // Skip field
92  strtok( NULL, " \t\n" ); // Skip field
93  strtok( NULL, " \t\n" );
94 
95  for( i = 0; i < ccount; i++ )
96  {
97  p = strtok( NULL, " \t\n" );
98 
99  if( sscanf( p, "%d", &pt.x ) != 1 )
100  {
101  aErrorMsg.Printf( _( "Bezier point %d X position not defined" ), i );
102  return false;
103  }
104 
105  p = strtok( NULL, " \t\n" );
106 
107  if( sscanf( p, "%d", &pt.y ) != 1 )
108  {
109  aErrorMsg.Printf( _( "Bezier point %d Y position not defined" ), i );
110  return false;
111  }
112 
113  m_BezierPoints.push_back( pt );
114  }
115 
116  m_Fill = NO_FILL;
117 
118  if( ( p = strtok( NULL, " \t\n" ) ) != NULL )
119  {
120  if( p[0] == 'F' )
122 
123  if( p[0] == 'f' )
125  }
126 
127  return true;
128 }
129 
130 
132 {
133  return new LIB_BEZIER( *this );
134 }
135 
136 
137 int LIB_BEZIER::compare( const LIB_ITEM& aOther ) const
138 {
139  wxASSERT( aOther.Type() == LIB_BEZIER_T );
140 
141  const LIB_BEZIER* tmp = ( LIB_BEZIER* ) &aOther;
142 
143  if( m_BezierPoints.size() != tmp->m_BezierPoints.size() )
144  return m_BezierPoints.size() - tmp->m_BezierPoints.size();
145 
146  for( size_t i = 0; i < m_BezierPoints.size(); i++ )
147  {
148  if( m_BezierPoints[i].x != tmp->m_BezierPoints[i].x )
149  return m_BezierPoints[i].x - tmp->m_BezierPoints[i].x;
150 
151  if( m_BezierPoints[i].y != tmp->m_BezierPoints[i].y )
152  return m_BezierPoints[i].y - tmp->m_BezierPoints[i].y;
153  }
154 
155  return 0;
156 }
157 
158 
159 void LIB_BEZIER::SetOffset( const wxPoint& aOffset )
160 {
161  size_t i;
162 
163  for( i = 0; i < m_BezierPoints.size(); i++ )
164  m_BezierPoints[i] += aOffset;
165 
166  for( i = 0; i < m_PolyPoints.size(); i++ )
167  m_PolyPoints[i] += aOffset;
168 }
169 
170 
171 bool LIB_BEZIER::Inside( EDA_RECT& aRect ) const
172 {
173  for( size_t i = 0; i < m_PolyPoints.size(); i++ )
174  {
175  if( aRect.Contains( m_PolyPoints[i].x, -m_PolyPoints[i].y ) )
176  return true;
177  }
178 
179  return false;
180 }
181 
182 
183 void LIB_BEZIER::Move( const wxPoint& aPosition )
184 {
185  SetOffset( aPosition - m_PolyPoints[0] );
186 }
187 
188 
189 void LIB_BEZIER::MirrorHorizontal( const wxPoint& aCenter )
190 {
191  size_t i, imax = m_PolyPoints.size();
192 
193  for( i = 0; i < imax; i++ )
194  {
195  m_PolyPoints[i].x -= aCenter.x;
196  m_PolyPoints[i].x *= -1;
197  m_PolyPoints[i].x += aCenter.x;
198  }
199 
200  imax = m_BezierPoints.size();
201 
202  for( i = 0; i < imax; i++ )
203  {
204  m_BezierPoints[i].x -= aCenter.x;
205  m_BezierPoints[i].x *= -1;
206  m_BezierPoints[i].x += aCenter.x;
207  }
208 }
209 
210 void LIB_BEZIER::MirrorVertical( const wxPoint& aCenter )
211 {
212  size_t i, imax = m_PolyPoints.size();
213 
214  for( i = 0; i < imax; i++ )
215  {
216  m_PolyPoints[i].y -= aCenter.y;
217  m_PolyPoints[i].y *= -1;
218  m_PolyPoints[i].y += aCenter.y;
219  }
220 
221  imax = m_BezierPoints.size();
222 
223  for( i = 0; i < imax; i++ )
224  {
225  m_BezierPoints[i].y -= aCenter.y;
226  m_BezierPoints[i].y *= -1;
227  m_BezierPoints[i].y += aCenter.y;
228  }
229 }
230 
231 void LIB_BEZIER::Rotate( const wxPoint& aCenter, bool aRotateCCW )
232 {
233  int rot_angle = aRotateCCW ? -900 : 900;
234 
235  size_t i, imax = m_PolyPoints.size();
236 
237  for( i = 0; i < imax; i++ )
238  {
239  RotatePoint( &m_PolyPoints[i], aCenter, rot_angle );
240  }
241 
242  imax = m_BezierPoints.size();
243 
244  for( i = 0; i < imax; i++ )
245  {
246  RotatePoint( &m_BezierPoints[i], aCenter, rot_angle );
247  }
248 }
249 
250 
251 void LIB_BEZIER::Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
252  const TRANSFORM& aTransform )
253 {
254  wxASSERT( aPlotter != NULL );
255 
256  static std::vector< wxPoint > cornerList;
257  cornerList.clear();
258 
259  for( unsigned ii = 0; ii < m_PolyPoints.size(); ii++ )
260  {
261  wxPoint pos = m_PolyPoints[ii];
262  pos = aTransform.TransformCoordinate( pos ) + aOffset;
263  cornerList.push_back( pos );
264  }
265 
266  if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
267  {
269  aPlotter->PlotPoly( cornerList, FILLED_WITH_BG_BODYCOLOR, 0 );
270  }
271 
272  bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
273  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
274  aPlotter->PlotPoly( cornerList, already_filled ? NO_FILL : m_Fill, GetPenSize() );
275 }
276 
277 
279 {
280  return ( m_Width == 0 ) ? GetDefaultLineThickness() : m_Width;
281 }
282 
283 
284 void LIB_BEZIER::drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
285  COLOR4D aColor, GR_DRAWMODE aDrawMode, void* aData,
286  const TRANSFORM& aTransform )
287 {
288  std::vector<wxPoint> PolyPointsTraslated;
289 
291  BEZIER_POLY converter( m_BezierPoints );
292  converter.GetPoly( m_PolyPoints );
293 
294  PolyPointsTraslated.clear();
295 
296  for( unsigned int i = 0; i < m_PolyPoints.size() ; i++ )
297  PolyPointsTraslated.push_back( aTransform.TransformCoordinate( m_PolyPoints[i] ) +
298  aOffset );
299 
300  if( aColor == COLOR4D::UNSPECIFIED ) // Used normal color or selected color
301  {
302  if( IsSelected() )
303  color = GetItemSelectedColor();
304  }
305  else
306  {
307  color = aColor;
308  }
309 
310  FILL_T fill = aData ? NO_FILL : m_Fill;
311 
312  if( aColor != COLOR4D::UNSPECIFIED )
313  fill = NO_FILL;
314 
315  GRSetDrawMode( aDC, aDrawMode );
316  EDA_RECT* const clipbox = aPanel? aPanel->GetClipBox() : NULL;
317 
318  if( fill == FILLED_WITH_BG_BODYCOLOR )
319  GRPoly( clipbox, aDC, m_PolyPoints.size(),
320  &PolyPointsTraslated[0], 1, GetPenSize(),
323  else if( fill == FILLED_SHAPE )
324  GRPoly( clipbox, aDC, m_PolyPoints.size(),
325  &PolyPointsTraslated[0], 1, GetPenSize(), color, color );
326  else
327  GRPoly( clipbox, aDC, m_PolyPoints.size(),
328  &PolyPointsTraslated[0], 0, GetPenSize(), color, color );
329 
330  /* Set to one (1) to draw bounding box around bezier curve to validate
331  * bounding box calculation. */
332 #if 0
333  EDA_RECT bBox = GetBoundingBox();
334  GRRect( aPanel->GetClipBox(), aDC, bBox.GetOrigin().x, bBox.GetOrigin().y,
335  bBox.GetEnd().x, bBox.GetEnd().y, 0, LIGHTMAGENTA );
336 #endif
337 }
338 
339 
340 bool LIB_BEZIER::HitTest( const wxPoint& aRefPos ) const
341 {
342  int mindist = GetPenSize() / 2;
343 
344  // Have a minimal tolerance for hit test
345  if ( mindist < MINIMUM_SELECTION_DISTANCE )
346  mindist = MINIMUM_SELECTION_DISTANCE;
347 
348  return HitTest( aRefPos, mindist, DefaultTransform );
349 }
350 
351 
352 bool LIB_BEZIER::HitTest( const wxPoint &aPosRef, int aThreshold, const TRANSFORM& aTransform ) const
353 {
354  wxPoint start, end;
355 
356  if( aThreshold < 0 )
357  aThreshold = GetPenSize() / 2;
358 
359  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
360  {
361  start = aTransform.TransformCoordinate( m_PolyPoints[ii - 1] );
362  end = aTransform.TransformCoordinate( m_PolyPoints[ii] );
363 
364  if ( TestSegmentHit( aPosRef, start, end, aThreshold ) )
365  return true;
366  }
367 
368  return false;
369 }
370 
371 
373 {
374  EDA_RECT rect;
375  int xmin, xmax, ymin, ymax;
376 
377  if( !GetCornerCount() )
378  return rect;
379 
380  xmin = xmax = m_PolyPoints[0].x;
381  ymin = ymax = m_PolyPoints[0].y;
382 
383  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
384  {
385  xmin = std::min( xmin, m_PolyPoints[ii].x );
386  xmax = std::max( xmax, m_PolyPoints[ii].x );
387  ymin = std::min( ymin, m_PolyPoints[ii].y );
388  ymax = std::max( ymax, m_PolyPoints[ii].y );
389  }
390 
391  rect.SetOrigin( xmin, ymin );
392  rect.SetEnd( xmax, ymax );
393  rect.Inflate( ( GetPenSize()+1 ) / 2 );
394 
395  rect.RevertYAxis();
396 
397  return rect;
398 }
399 
400 
401 void LIB_BEZIER::GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList )
402 {
403  wxString msg;
404  EDA_RECT bBox = GetBoundingBox();
405 
406  LIB_ITEM::GetMsgPanelInfo( aList );
407 
408  msg = StringFromValue( g_UserUnit, m_Width, true );
409 
410  aList.push_back( MSG_PANEL_ITEM( _( "Line Width" ), msg, BLUE ) );
411 
412  msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
413  bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );
414 
415  aList.push_back( MSG_PANEL_ITEM( _( "Bounding Box" ), msg, BROWN ) );
416 }
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:137
KICAD_T Type() const
Function Type()
Definition: base_struct.h:212
void SetOffset(const wxPoint &aOffset) override
Function Offset sets the drawing object by aOffset from the current position.
Definition: lib_bezier.cpp:159
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:183
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:401
void GetPoly(std::vector< wxPoint > &aOutput)
Converts Bezier curve to a polygon.
const EDA_RECT GetBoundingBox() const override
Definition: lib_bezier.cpp:372
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:251
bool IsSelected() const
Definition: base_struct.h:235
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:189
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:171
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:69
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:131
int GetPenSize() const override
Function GetPenSize.
Definition: lib_bezier.cpp:278
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:340
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:189
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:284
void MirrorVertical(const wxPoint &aCenter) override
Function MirrorVertical mirrors the draw object along the MirrorVertical (Y) axis about aCenter point...
Definition: lib_bezier.cpp:210
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:165
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:70
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:126
Definition: colors.h:62