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-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 
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::SetOffset( 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::Move( const wxPoint& aPosition )
105 {
106  if ( !m_PolyPoints.size() )
107  return;
108  SetOffset( aPosition - m_PolyPoints[0] );
109 }
110 
111 
112 void LIB_BEZIER::MirrorHorizontal( const wxPoint& aCenter )
113 {
114  size_t i, imax = m_PolyPoints.size();
115 
116  for( i = 0; i < imax; i++ )
117  {
118  m_PolyPoints[i].x -= aCenter.x;
119  m_PolyPoints[i].x *= -1;
120  m_PolyPoints[i].x += aCenter.x;
121  }
122 
123  imax = m_BezierPoints.size();
124 
125  for( i = 0; i < imax; i++ )
126  {
127  m_BezierPoints[i].x -= aCenter.x;
128  m_BezierPoints[i].x *= -1;
129  m_BezierPoints[i].x += aCenter.x;
130  }
131 }
132 
133 void LIB_BEZIER::MirrorVertical( const wxPoint& aCenter )
134 {
135  size_t i, imax = m_PolyPoints.size();
136 
137  for( i = 0; i < imax; i++ )
138  {
139  m_PolyPoints[i].y -= aCenter.y;
140  m_PolyPoints[i].y *= -1;
141  m_PolyPoints[i].y += aCenter.y;
142  }
143 
144  imax = m_BezierPoints.size();
145 
146  for( i = 0; i < imax; i++ )
147  {
148  m_BezierPoints[i].y -= aCenter.y;
149  m_BezierPoints[i].y *= -1;
150  m_BezierPoints[i].y += aCenter.y;
151  }
152 }
153 
154 void LIB_BEZIER::Rotate( const wxPoint& aCenter, bool aRotateCCW )
155 {
156  int rot_angle = aRotateCCW ? -900 : 900;
157 
158  size_t i, imax = m_PolyPoints.size();
159 
160  for( i = 0; i < imax; i++ )
161  {
162  RotatePoint( &m_PolyPoints[i], aCenter, rot_angle );
163  }
164 
165  imax = m_BezierPoints.size();
166 
167  for( i = 0; i < imax; i++ )
168  {
169  RotatePoint( &m_BezierPoints[i], aCenter, rot_angle );
170  }
171 }
172 
173 
174 void LIB_BEZIER::Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
175  const TRANSFORM& aTransform )
176 {
177  wxASSERT( aPlotter != NULL );
178 
179  static std::vector< wxPoint > cornerList;
180  cornerList.clear();
181 
182  for( unsigned ii = 0; ii < m_PolyPoints.size(); ii++ )
183  {
184  wxPoint pos = m_PolyPoints[ii];
185  pos = aTransform.TransformCoordinate( pos ) + aOffset;
186  cornerList.push_back( pos );
187  }
188 
189  if( aFill && m_Fill == FILLED_WITH_BG_BODYCOLOR )
190  {
192  aPlotter->PlotPoly( cornerList, FILLED_WITH_BG_BODYCOLOR, 0 );
193  }
194 
195  bool already_filled = m_Fill == FILLED_WITH_BG_BODYCOLOR;
196  aPlotter->SetColor( GetLayerColor( LAYER_DEVICE ) );
197  aPlotter->PlotPoly( cornerList, already_filled ? NO_FILL : m_Fill, GetPenSize() );
198 }
199 
200 
202 {
203  if( m_Width > 0 )
204  return m_Width;
205 
206  if( m_Width == 0 )
207  return GetDefaultLineThickness();
208 
209  return -1; // a value to use a minimal pen size
210 }
211 
212 
213 void LIB_BEZIER::drawGraphic( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
214  COLOR4D aColor, GR_DRAWMODE aDrawMode, void* aData,
215  const TRANSFORM& aTransform )
216 {
217  std::vector<wxPoint> PolyPointsTraslated;
218 
220  BEZIER_POLY converter( m_BezierPoints );
221  converter.GetPoly( m_PolyPoints );
222 
223  PolyPointsTraslated.clear();
224 
225  for( unsigned int i = 0; i < m_PolyPoints.size() ; i++ )
226  PolyPointsTraslated.push_back( aTransform.TransformCoordinate( m_PolyPoints[i] ) +
227  aOffset );
228 
229  if( aColor == COLOR4D::UNSPECIFIED ) // Used normal color or selected color
230  {
231  if( IsSelected() )
232  color = GetItemSelectedColor();
233  }
234  else
235  {
236  color = aColor;
237  }
238 
239  FILL_T fill = aData ? NO_FILL : m_Fill;
240 
241  if( aColor != COLOR4D::UNSPECIFIED )
242  fill = NO_FILL;
243 
244  GRSetDrawMode( aDC, aDrawMode );
245  EDA_RECT* const clipbox = aPanel? aPanel->GetClipBox() : NULL;
246 
247  if( fill == FILLED_WITH_BG_BODYCOLOR )
248  GRPoly( clipbox, aDC, m_PolyPoints.size(),
249  &PolyPointsTraslated[0], 1, GetPenSize(),
252  else if( fill == FILLED_SHAPE )
253  GRPoly( clipbox, aDC, m_PolyPoints.size(),
254  &PolyPointsTraslated[0], 1, GetPenSize(), color, color );
255  else
256  GRPoly( clipbox, aDC, m_PolyPoints.size(),
257  &PolyPointsTraslated[0], 0, GetPenSize(), color, color );
258 
259  /* Set to one (1) to draw bounding box around bezier curve to validate
260  * bounding box calculation. */
261 #if 0
262  EDA_RECT bBox = GetBoundingBox();
263  GRRect( aPanel->GetClipBox(), aDC, bBox.GetOrigin().x, bBox.GetOrigin().y,
264  bBox.GetEnd().x, bBox.GetEnd().y, 0, LIGHTMAGENTA );
265 #endif
266 }
267 
268 
269 bool LIB_BEZIER::HitTest( const wxPoint& aRefPos ) const
270 {
271  int mindist = GetPenSize() / 2;
272 
273  // Have a minimal tolerance for hit test
274  if ( mindist < MINIMUM_SELECTION_DISTANCE )
275  mindist = MINIMUM_SELECTION_DISTANCE;
276 
277  return HitTest( aRefPos, mindist, DefaultTransform );
278 }
279 
280 
281 bool LIB_BEZIER::HitTest( const wxPoint &aPosRef, int aThreshold, const TRANSFORM& aTransform ) const
282 {
283  wxPoint start, end;
284 
285  if( aThreshold < 0 )
286  aThreshold = GetPenSize() / 2;
287 
288  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
289  {
290  start = aTransform.TransformCoordinate( m_PolyPoints[ii - 1] );
291  end = aTransform.TransformCoordinate( m_PolyPoints[ii] );
292 
293  if ( TestSegmentHit( aPosRef, start, end, aThreshold ) )
294  return true;
295  }
296 
297  return false;
298 }
299 
300 
302 {
303  EDA_RECT rect;
304  int xmin, xmax, ymin, ymax;
305 
306  if( !GetCornerCount() )
307  return rect;
308 
309  xmin = xmax = m_PolyPoints[0].x;
310  ymin = ymax = m_PolyPoints[0].y;
311 
312  for( unsigned ii = 1; ii < GetCornerCount(); ii++ )
313  {
314  xmin = std::min( xmin, m_PolyPoints[ii].x );
315  xmax = std::max( xmax, m_PolyPoints[ii].x );
316  ymin = std::min( ymin, m_PolyPoints[ii].y );
317  ymax = std::max( ymax, m_PolyPoints[ii].y );
318  }
319 
320  rect.SetOrigin( xmin, ymin );
321  rect.SetEnd( xmax, ymax );
322  rect.Inflate( ( GetPenSize()+1 ) / 2 );
323 
324  rect.RevertYAxis();
325 
326  return rect;
327 }
328 
329 
330 void LIB_BEZIER::GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList )
331 {
332  wxString msg;
333  EDA_RECT bBox = GetBoundingBox();
334 
335  LIB_ITEM::GetMsgPanelInfo( aUnits, aList );
336 
337  msg = MessageTextFromValue( aUnits, m_Width, true );
338 
339  aList.push_back( MSG_PANEL_ITEM( _( "Line Width" ), msg, BLUE ) );
340 
341  msg.Printf( wxT( "(%d, %d, %d, %d)" ), bBox.GetOrigin().x,
342  bBox.GetOrigin().y, bBox.GetEnd().x, bBox.GetEnd().y );
343 
344  aList.push_back( MSG_PANEL_ITEM( _( "Bounding Box" ), msg, BROWN ) );
345 }
346 
348 {
349  if( !m_PolyPoints.size() )
350  return wxPoint(0, 0);
351 
352  return m_PolyPoints[0];
353 }
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
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
virtual 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 SetOffset(const wxPoint &aOffset) override
Set the drawing object by aOffset from the current position.
Definition: lib_bezier.cpp:80
void GRPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:701
const wxPoint GetOrigin() const
Definition: eda_rect.h:112
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:223
Implementation of conversion functions that require both schematic and board internal units...
virtual void SetColor(COLOR4D color)=0
void Move(const wxPoint &aPosition) override
Move a draw object to aPosition.
Definition: lib_bezier.cpp:104
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
bool Contains(const wxPoint &aPoint) const
Function Contains.
void GetPoly(std::vector< wxPoint > &aOutput, int aMinSegLen=0)
Converts Bezier curve to a polygon.
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
Definition: lib_bezier.cpp:301
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:174
bool IsSelected() const
Definition: base_struct.h:224
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:347
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.
wxString MessageTextFromValue(EDA_UNITS_T aUnits, int aValue, bool aUseMils)
Definition: base_units.cpp:125
wxPoint TransformCoordinate(const wxPoint &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:41
void GRRect(EDA_RECT *aClipBox, wxDC *aDC, int x1, int y1, int x2, int y2, COLOR4D aColor)
Definition: gr_basic.cpp:1003
void MirrorHorizontal(const wxPoint &aCenter) override
Mirror the draw object along the horizontal (X) axis about aCenter point.
Definition: lib_bezier.cpp:112
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
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
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.
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.
Definition: lib_bezier.cpp:330
unsigned GetCornerCount() const
Definition: lib_bezier.h:74
virtual void Rotate()
Rotate the draw item.
const wxPoint GetEnd() const
Definition: eda_rect.h:114
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:201
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.
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:269
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:178
size_t i
Definition: json11.cpp:597
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
void drawGraphic(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, COLOR4D aColor, GR_DRAWMODE aDrawMode, void *aData, const TRANSFORM &aTransform) override
Draw the item on aPanel.
Definition: lib_bezier.cpp:213
void MirrorVertical(const wxPoint &aCenter) override
Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.
Definition: lib_bezier.cpp:133
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
FILL_T
Enum FILL_T is the set of fill types used in plotting or drawing enclosed areas.
Definition: base_struct.h:54
COLOR4D GetItemSelectedColor()
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:159
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:113
Definition: colors.h:62