KiCad PCB EDA Suite
class_pad_draw_functions.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) 2016 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
5  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
6  * Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net>
7  * Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, you may find one here:
21  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22  * or you may search the http://www.gnu.org website for the version 2 license,
23  * or you may write to the Free Software Foundation, Inc.,
24  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25  */
26 
31 #include <fctsys.h>
32 #include <gr_basic.h>
33 #include <common.h>
34 #include <trigo.h>
35 #include <class_pcb_screen.h>
36 #include <class_drawpanel.h>
37 #include <drawtxt.h>
39 #include <wxBasePcbFrame.h>
40 #include <wxPcbStruct.h>
41 #include <pcbnew_id.h> // ID_TRACK_BUTT
42 #include <pcbnew.h>
43 #include <class_board.h>
45 
46 
47 
48 /* uncomment this line to show this pad with its specfic size and color
49  * when it is not on copper layers, and only one solder mask layer or solder paste layer
50  * is displayed for this pad
51  * After testing this feature,I am not sure this is a good idea
52  * but the code is left here.
53  */
54 
55 //#define SHOW_PADMASK_REAL_SIZE_AND_COLOR
56 
57 
58 // Helper class to store parameters used to draw a pad
60 {
61  m_DrawPanel = NULL;
63  m_Color = BLACK;
64  m_HoleColor = BLACK; // could be DARKGRAY;
66  m_PadClearance = 0;
67  m_Display_padnum = true;
68  m_Display_netname = true;
69  m_ShowPadFilled = true;
70  m_ShowNCMark = true;
71  m_ShowNotPlatedHole = false;
72  m_IsPrinting = false;
73 }
74 
75 
76 void D_PAD::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, GR_DRAWMODE aDraw_mode,
77  const wxPoint& aOffset )
78 {
79  wxSize mask_margin; // margin (clearance) used for some non copper layers
80 
81 #ifdef SHOW_PADMASK_REAL_SIZE_AND_COLOR
82  int showActualMaskSize = 0; /* Layer number if the actual pad size on mask layer can
83  * be displayed i.e. if only one layer is shown for this pad
84  * and this layer is a mask (solder mask or solder paste
85  */
86 #endif
87 
88  if( m_Flags & DO_NOT_DRAW )
89  return;
90 
91  PAD_DRAWINFO drawInfo;
92 
93  drawInfo.m_Offset = aOffset;
94 
95  /* We can show/hide pads from the layer manager.
96  * options are show/hide pads on front and/or back side of the board
97  * For through pads, we hide them only if both sides are hidden.
98  * smd pads on back are hidden for all layers (copper and technical layers)
99  * on back side of the board
100  * smd pads on front are hidden for all layers (copper and technical layers)
101  * on front side of the board
102  * ECO, edge and Draw layers and not considered
103  */
104 
105  BOARD* brd = GetBoard();
106 
107  auto frame = static_cast<PCB_EDIT_FRAME*> ( aPanel->GetParent() );
108  const auto& cds = frame->Settings().Colors();
109 
110  bool frontVisible = brd->IsElementVisible( LAYER_PAD_FR );
111  bool backVisible = brd->IsElementVisible( LAYER_PAD_BK );
112 
113  if( !frontVisible && !backVisible )
114  return;
115 
116  // If pad is only on front side (no layer on back side)
117  // and if hide front side pads is enabled, do not draw
118  if( !frontVisible && !( m_layerMask & LSET::BackMask() ).any() )
119  return;
120 
121  // If pad is only on back side (no layer on front side)
122  // and if hide back side pads is enabled, do not draw
123  if( !backVisible && !( m_layerMask & LSET::FrontMask() ).any() )
124  return;
125 
126 
127  wxCHECK_RET( frame != NULL, wxT( "Panel has no parent frame window." ) );
128 
129  DISPLAY_OPTIONS* displ_opts = (DISPLAY_OPTIONS*)frame->GetDisplayOptions();
130  PCB_SCREEN* screen = frame->GetScreen();
131 
132  if( displ_opts && displ_opts->m_DisplayPadFill == SKETCH )
133  drawInfo.m_ShowPadFilled = false;
134  else
135  drawInfo.m_ShowPadFilled = true;
136 
138 
139  if( m_layerMask[F_Cu] )
140  {
141  color = cds.GetItemColor( LAYER_PAD_FR );
142  }
143 
144  if( m_layerMask[B_Cu] )
145  {
146  color = color.LegacyMix( cds.GetItemColor( LAYER_PAD_BK ) );
147  }
148 
149  if( color == BLACK ) // Not on a visible copper layer (i.e. still nothing to show)
150  {
151  // If the pad is on only one tech layer, use the layer color else use DARKGRAY
152  LSET mask_non_copper_layers = m_layerMask & ~LSET::AllCuMask();
153 
154 #ifdef SHOW_PADMASK_REAL_SIZE_AND_COLOR
155  mask_non_copper_layers &= brd->GetVisibleLayers();
156 #endif
157  PCB_LAYER_ID pad_layer = mask_non_copper_layers.ExtractLayer();
158 
159  switch( (int) pad_layer )
160  {
161  case UNDEFINED_LAYER: // More than one layer
162  color = DARKGRAY;
163  break;
164 
165  case UNSELECTED_LAYER: // Shouldn't really happen...
166  break;
167 
168  default:
169  color = cds.GetLayerColor( pad_layer );
170 #ifdef SHOW_PADMASK_REAL_SIZE_AND_COLOR
171  showActualMaskSize = pad_layer;
172 #endif
173  }
174  }
175 
176  // if SMD or connector pad and high contrast mode
177  if( ( aDraw_mode & GR_ALLOW_HIGHCONTRAST ) &&
179  displ_opts && displ_opts->m_ContrastModeDisplay )
180  {
181  // when routing tracks
182  if( frame->GetToolId() == ID_TRACK_BUTT )
183  {
184  PCB_LAYER_ID routeTop = screen->m_Route_Layer_TOP;
185  PCB_LAYER_ID routeBot = screen->m_Route_Layer_BOTTOM;
186 
187  // if routing between copper and component layers,
188  // or the current layer is one of said 2 external copper layers,
189  // then highlight only the current layer.
190  if( ( screen->m_Active_Layer == F_Cu || screen->m_Active_Layer == B_Cu ) ||
191  ( routeTop==F_Cu && routeBot==B_Cu ) ||
192  ( routeTop==B_Cu && routeBot==F_Cu )
193  )
194  {
195  if( !IsOnLayer( screen->m_Active_Layer ) )
196  color = COLOR4D( DARKDARKGRAY );
197  }
198  // else routing between an internal signal layer and some other
199  // layer. Grey out all PAD_ATTRIB_SMD pads not on current or the single
200  // selected external layer.
201  else if( !IsOnLayer( screen->m_Active_Layer )
202  && !IsOnLayer( routeTop )
203  && !IsOnLayer( routeBot ) )
204  {
205  color = COLOR4D( DARKDARKGRAY );
206  }
207  }
208  // when not edting tracks, show PAD_ATTRIB_SMD components not on active layer
209  // as greyed out
210  else
211  {
212  if( !IsOnLayer( screen->m_Active_Layer ) )
213  color = COLOR4D( DARKDARKGRAY );
214  }
215  }
216 
217 #ifdef SHOW_PADMASK_REAL_SIZE_AND_COLOR
218  if( showActualMaskSize )
219  {
220  switch( showActualMaskSize )
221  {
222  case B_Mask:
223  case F_Mask:
224  mask_margin.x = mask_margin.y = GetSolderMaskMargin();
225  break;
226 
227  case B_Paste:
228  case F_Paste:
229  mask_margin = GetSolderPasteMargin();
230  break;
231 
232  default:
233  // Another layer which has no margin to handle
234  break;
235  }
236  }
237 #endif
238 
239  // if Contrast mode is ON and a technical layer active, show pads on this
240  // layer so we can see pads on paste or solder layer and the size of the
241  // mask
242  if( ( aDraw_mode & GR_ALLOW_HIGHCONTRAST ) &&
243  displ_opts && displ_opts->m_ContrastModeDisplay && !IsCopperLayer( screen->m_Active_Layer ) )
244  {
245  if( IsOnLayer( screen->m_Active_Layer ) )
246  {
247  color = cds.GetLayerColor( screen->m_Active_Layer );
248 
249  // In high contrast mode, and if the active layer is the mask
250  // layer shows the pad size with the mask clearance
251  switch( screen->m_Active_Layer )
252  {
253  case B_Mask:
254  case F_Mask:
255  mask_margin.x = mask_margin.y = GetSolderMaskMargin();
256  break;
257 
258  case B_Paste:
259  case F_Paste:
260  mask_margin = GetSolderPasteMargin();
261  break;
262 
263  default:
264  break;
265  }
266  }
267  else
268  color = DARKDARKGRAY;
269  }
270 
271  if( ( aDraw_mode & GR_HIGHLIGHT ) && !( aDraw_mode & GR_AND ) )
272  color.SetToLegacyHighlightColor();
273 
274  bool DisplayIsol = displ_opts && displ_opts->m_DisplayPadIsol;
275 
276  if( !( m_layerMask & LSET::AllCuMask() ).any() )
277  DisplayIsol = false;
278 
281  {
282  drawInfo.m_ShowNotPlatedHole = true;
283  drawInfo.m_NPHoleColor = cds.GetItemColor( LAYER_NON_PLATED );
284  }
285 
286  drawInfo.m_DrawMode = aDraw_mode;
287  drawInfo.m_Color = color;
288  drawInfo.m_DrawPanel = aPanel;
289  drawInfo.m_Mask_margin = mask_margin;
291  drawInfo.m_IsPrinting = screen->m_IsPrinting;
292  color.a = 0.666;
293 
294  /* Get the pad clearance. This has a meaning only for Pcbnew.
295  * for CvPcb GetClearance() creates debug errors because
296  * there is no net classes so a call to GetClearance() is made only when
297  * needed (never needed in CvPcb)
298  */
299  drawInfo.m_PadClearance = DisplayIsol ? GetClearance() : 0;
300 
301  // Draw the pad number
302  if( displ_opts && !displ_opts->m_DisplayPadNum )
303  drawInfo.m_Display_padnum = false;
304 
305  if( displ_opts &&
306  (( displ_opts ->m_DisplayNetNamesMode == 0 ) || ( displ_opts->m_DisplayNetNamesMode == 2 )) )
307  drawInfo.m_Display_netname = false;
308 
309  // Display net names is restricted to pads that are on the active layer
310  // in high contrast mode display
311  if( ( aDraw_mode & GR_ALLOW_HIGHCONTRAST ) &&
312  !IsOnLayer( screen->m_Active_Layer ) && displ_opts && displ_opts->m_ContrastModeDisplay )
313  drawInfo.m_Display_netname = false;
314 
315  DrawShape( aPanel->GetClipBox(), aDC, drawInfo );
316 }
317 
318 
319 void D_PAD::DrawShape( EDA_RECT* aClipBox, wxDC* aDC, PAD_DRAWINFO& aDrawInfo )
320 {
321  wxPoint coord[12];
322  double angle = m_Orient;
323  int seg_width;
324 
325  GRSetDrawMode( aDC, aDrawInfo.m_DrawMode );
326 
327  // calculate pad shape position :
328  wxPoint shape_pos = ShapePos() - aDrawInfo.m_Offset;
329 
330  wxSize halfsize = m_Size;
331  halfsize.x >>= 1;
332  halfsize.y >>= 1;
333 
334  switch( GetShape() )
335  {
336  case PAD_SHAPE_CIRCLE:
337  if( aDrawInfo.m_ShowPadFilled )
338  GRFilledCircle( aClipBox, aDC, shape_pos.x, shape_pos.y,
339  halfsize.x + aDrawInfo.m_Mask_margin.x, 0,
340  aDrawInfo.m_Color, aDrawInfo.m_Color );
341  else
342  GRCircle( aClipBox, aDC, shape_pos.x, shape_pos.y,
343  halfsize.x + aDrawInfo.m_Mask_margin.x,
344  m_PadSketchModePenSize, aDrawInfo.m_Color );
345 
346  if( aDrawInfo.m_PadClearance )
347  {
348  GRCircle( aClipBox,
349  aDC, shape_pos.x, shape_pos.y,
350  halfsize.x + aDrawInfo.m_PadClearance,
351  0, aDrawInfo.m_Color );
352  }
353 
354  break;
355 
356  case PAD_SHAPE_OVAL:
357  {
358  wxPoint segStart, segEnd;
359  seg_width = BuildSegmentFromOvalShape(segStart, segEnd, angle,
360  aDrawInfo.m_Mask_margin);
361  segStart += shape_pos;
362  segEnd += shape_pos;
363 
364  if( aDrawInfo.m_ShowPadFilled )
365  {
366  GRFillCSegm( aClipBox, aDC, segStart.x, segStart.y, segEnd.x, segEnd.y,
367  seg_width, aDrawInfo.m_Color );
368  }
369  else
370  {
371  GRCSegm( aClipBox, aDC, segStart.x, segStart.y, segEnd.x, segEnd.y,
372  seg_width, m_PadSketchModePenSize, aDrawInfo.m_Color );
373  }
374 
375  // Draw the clearance line
376  if( aDrawInfo.m_PadClearance )
377  {
378  seg_width += 2 * aDrawInfo.m_PadClearance;
379  GRCSegm( aClipBox, aDC, segStart.x, segStart.y, segEnd.x, segEnd.y,
380  seg_width, aDrawInfo.m_Color );
381  }
382  }
383  break;
384 
385  case PAD_SHAPE_RECT:
386  case PAD_SHAPE_TRAPEZOID:
387  BuildPadPolygon( coord, aDrawInfo.m_Mask_margin, angle );
388 
389  for( int ii = 0; ii < 4; ii++ )
390  coord[ii] += shape_pos;
391 
392  GRClosedPoly( aClipBox, aDC, 4, coord, aDrawInfo.m_ShowPadFilled,
393  aDrawInfo.m_ShowPadFilled ? 0 : m_PadSketchModePenSize,
394  aDrawInfo.m_Color, aDrawInfo.m_Color );
395 
396  if( aDrawInfo.m_PadClearance )
397  {
398  #define SEGCOUNT 32 // number of segments to approximate a circle
399  SHAPE_POLY_SET outline;
401 
402  // Draw the polygon: Inflate creates only one convex polygon
403  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
404 
405  GRClosedPoly( aClipBox, aDC, poly.PointCount(),
406  (wxPoint*)&poly.Point( 0 ), false, 0,
407  aDrawInfo.m_Color, aDrawInfo.m_Color );
408  }
409  break;
410 
411  case PAD_SHAPE_ROUNDRECT:
412  {
413  // Use solder[Paste/Mask]size or pad size to build pad shape to draw
414  wxSize size( GetSize() );
415  size += aDrawInfo.m_Mask_margin * 2;
416  int corner_radius = GetRoundRectCornerRadius( size );
417 
418  // Draw the polygon: Inflate creates only one convex polygon
419  SHAPE_POLY_SET outline;
420  bool filled = aDrawInfo.m_ShowPadFilled;
421 
422  if( filled )
423  {
424  wxPoint centers[4];
425  GetRoundRectCornerCenters( centers, corner_radius, shape_pos,
426  size, GetOrientation() );
427  GRClosedPoly( aClipBox, aDC, 4, centers, true, corner_radius*2,
428  aDrawInfo.m_Color, aDrawInfo.m_Color );
429  }
430  else
431  {
432  TransformRoundRectToPolygon( outline, shape_pos, size, GetOrientation(),
433  corner_radius, 64 );
434 
435  SHAPE_LINE_CHAIN& poly = outline.Outline( 0 );
436 
437  GRClosedPoly( aClipBox, aDC, poly.PointCount(),
438  (wxPoint*)&poly.Point( 0 ), aDrawInfo.m_ShowPadFilled, 0,
439  aDrawInfo.m_Color, aDrawInfo.m_Color );
440  }
441 
442  if( aDrawInfo.m_PadClearance )
443  {
444  outline.RemoveAllContours();
445  size = GetSize();
446  size.x += aDrawInfo.m_PadClearance * 2;
447  size.y += aDrawInfo.m_PadClearance * 2;
448  corner_radius = GetRoundRectCornerRadius() + aDrawInfo.m_PadClearance;
449 
450  TransformRoundRectToPolygon( outline, shape_pos, size, GetOrientation(),
451  corner_radius, 32 );
452 
453  // Draw the polygon: Inflate creates only one convex polygon
454  SHAPE_LINE_CHAIN& clearance_poly = outline.Outline( 0 );
455 
456  GRClosedPoly( aClipBox, aDC, clearance_poly.PointCount(),
457  (wxPoint*)&clearance_poly.Point( 0 ), false, 0,
458  aDrawInfo.m_Color, aDrawInfo.m_Color );
459  }
460  }
461  break;
462 
463  case PAD_SHAPE_CUSTOM:
464  {
465  // The full shape has 2 items
466  // 1- The anchor pad: a round or rect pad located at pad position
467  // 2- The custom complex shape
468  // Note: The anchor pad shape is containing by the custom complex shape polygon
469  // The anchor pad is shown to help user to see where is the anchor, only in sketch mode
470  // (In filled mode, it is merged with the basic shapes)
471  wxPoint pad_pos = GetPosition() - aDrawInfo.m_Offset;
472 
473  // In sketch mode only: Draw the anchor pad: a round or rect pad
474  if( !aDrawInfo.m_ShowPadFilled )
475  {
477  {
478  wxPoint poly[4];
479  poly[0] = wxPoint( - halfsize.x, - halfsize.y );
480  poly[1] = wxPoint( - halfsize.x, + halfsize.y );
481  poly[2] = wxPoint( + halfsize.x, + halfsize.y );
482  poly[3] = wxPoint( + halfsize.x, - halfsize.y );
483 
484  for( int ii = 0; ii < 4; ++ii )
485  {
486  RotatePoint( &poly[ii], m_Orient );
487  poly[ii] += pad_pos;
488  }
489 
490  GRClosedPoly( aClipBox, aDC, 4, poly, false, 0,
491  aDrawInfo.m_Color, aDrawInfo.m_Color );
492  }
493  else
494  {
495  GRCircle( aClipBox, aDC, pad_pos.x, pad_pos.y,
496  halfsize.x,
497  m_PadSketchModePenSize, aDrawInfo.m_Color );
498  }
499  }
500 
501  SHAPE_POLY_SET outline; // Will contain the corners in board coordinates
502  outline.Append( m_customShapeAsPolygon );
503  BasicShapesAsPolygonToBoardPosition( &outline, pad_pos, GetOrientation() );
504  SHAPE_LINE_CHAIN* poly;
505 
506  const int segmentToCircleCount = 32;
507 
508  if( aDrawInfo.m_Mask_margin.x )
509  {
510  SHAPE_POLY_SET clearance_outline;
511  clearance_outline.Append( outline );
512  clearance_outline.Inflate( aDrawInfo.m_Mask_margin.x, segmentToCircleCount );
513 
514  poly = &clearance_outline.Outline( 0 );
515  }
516  else
517  {
518  // Draw the polygon: only one polygon is expected
519  // However we provide a multi polygon shape drawing
520  // ( for the future or to show a non expected shape )
521  for( int jj = 0; jj < outline.OutlineCount(); ++jj )
522  {
523  poly = &outline.Outline( jj );
524 
525  GRClosedPoly( aClipBox, aDC, poly->PointCount(),
526  (wxPoint*)&poly->Point( 0 ), aDrawInfo.m_ShowPadFilled, 0,
527  aDrawInfo.m_Color, aDrawInfo.m_Color );
528  }
529  }
530 
531  if( aDrawInfo.m_PadClearance )
532  {
533  SHAPE_POLY_SET clearance_outline;
534  clearance_outline.Append( outline );
535 
536  clearance_outline.Inflate( aDrawInfo.m_PadClearance, segmentToCircleCount );
537 
538  for( int jj = 0; jj < clearance_outline.OutlineCount(); ++jj )
539  {
540  poly = &clearance_outline.Outline( jj );
541 
542  GRClosedPoly( aClipBox, aDC, poly->PointCount(),
543  (wxPoint*)&poly->Point( 0 ), false, 0,
544  aDrawInfo.m_Color, aDrawInfo.m_Color );
545  }
546  }
547  break;
548  }
549 
550  default:
551  break;
552  }
553 
554  // Draw the pad hole
555  wxPoint holepos = m_Pos - aDrawInfo.m_Offset;
556  int hole = m_Drill.x >> 1;
557 
558  bool drawhole = hole > 0;
559 
560  if( !aDrawInfo.m_ShowPadFilled && !aDrawInfo.m_ShowNotPlatedHole )
561  drawhole = false;
562 
563  if( drawhole )
564  {
565  bool blackpenstate = false;
566 
567  if( aDrawInfo.m_IsPrinting )
568  {
569  blackpenstate = GetGRForceBlackPenState();
570  GRForceBlackPen( false );
571  aDrawInfo.m_HoleColor = WHITE;
572  aDrawInfo.m_NPHoleColor = WHITE;
573  }
574  else
575  {
576  GRSetDrawMode( aDC, ( aDrawInfo.m_DrawMode != GR_XOR ) ? GR_COPY : GR_XOR );
577  }
578 
579  COLOR4D hole_color = aDrawInfo.m_HoleColor;
580 
581  if( aDrawInfo. m_ShowNotPlatedHole ) // Draw a specific hole color
582  hole_color = aDrawInfo.m_NPHoleColor;
583 
584  switch( GetDrillShape() )
585  {
587  if( aDC->LogicalToDeviceXRel( hole ) > 1 ) // hole is drawn if hole > 1pixel
588  GRFilledCircle( aClipBox, aDC, holepos.x, holepos.y, hole, 0,
589  hole_color, hole_color );
590  break;
591 
593  {
594  wxPoint drl_start, drl_end;
595  GetOblongDrillGeometry( drl_start, drl_end, seg_width );
596  GRFilledSegment( aClipBox, aDC, holepos + drl_start,
597  holepos + drl_end, seg_width, hole_color );
598  }
599  break;
600 
601  default:
602  break;
603  }
604 
605  if( aDrawInfo.m_IsPrinting )
606  GRForceBlackPen( blackpenstate );
607  }
608 
609  GRSetDrawMode( aDC, aDrawInfo.m_DrawMode );
610 
611  // Draw "No connect" ( / or \ or cross X ) if necessary
612  if( GetNetCode() == 0 && aDrawInfo.m_ShowNCMark )
613  {
614  int dx0 = std::min( halfsize.x, halfsize.y );
615  COLOR4D nc_color = COLOR4D( BLUE );
616 
617  if( m_layerMask[F_Cu] ) /* Draw \ */
618  GRLine( aClipBox, aDC, holepos.x - dx0, holepos.y - dx0,
619  holepos.x + dx0, holepos.y + dx0, 0, nc_color );
620 
621  if( m_layerMask[B_Cu] ) // Draw /
622  GRLine( aClipBox, aDC, holepos.x + dx0, holepos.y - dx0,
623  holepos.x - dx0, holepos.y + dx0, 0, nc_color );
624  }
625 
626  if( !aDrawInfo.m_IsPrinting )
627  GRSetDrawMode( aDC, ( aDrawInfo.m_DrawMode != GR_XOR ) ? GR_COPY : GR_XOR );
628 
629  // Draw the pad number
630  if( !aDrawInfo.m_Display_padnum && !aDrawInfo.m_Display_netname )
631  return;
632 
633  wxPoint tpos0 = shape_pos; // Position of the centre of text
634  wxPoint tpos = tpos0;
635  wxSize AreaSize; // size of text area, normalized to AreaSize.y < AreaSize.x
636  int shortname_len = 0;
637 
638  if( aDrawInfo.m_Display_netname )
639  shortname_len = GetShortNetname().Len();
640 
641  if( GetShape() == PAD_SHAPE_CIRCLE )
642  angle = 0;
643 
644  AreaSize = m_Size;
645 
646  if( m_Size.y > m_Size.x )
647  {
648  angle += 900;
649  AreaSize.x = m_Size.y;
650  AreaSize.y = m_Size.x;
651  }
652 
653  if( shortname_len > 0 ) // if there is a netname, provides room to display this netname
654  {
655  AreaSize.y /= 2; // Text used only the upper area of the
656  // pad. The lower area displays the net name
657  tpos.y -= AreaSize.y / 2;
658  }
659 
660  // Calculate the position of text, that is the middle point of the upper
661  // area of the pad
662  RotatePoint( &tpos, shape_pos, angle );
663 
664  // Draw text with an angle between -90 deg and + 90 deg
665  double t_angle = angle;
666  NORMALIZE_ANGLE_90( t_angle );
667 
668  /* Note: in next calculations, texte size is calculated for 3 or more
669  * chars. Of course, pads numbers and nets names can have less than 3
670  * chars. but after some tries, i found this is gives the best look
671  */
672  #define MIN_CHAR_COUNT 3
673  wxString buffer;
674 
675  int tsize;
676  EDA_RECT* clipBox = aDrawInfo.m_DrawPanel?
677  aDrawInfo.m_DrawPanel->GetClipBox() : NULL;
678 
679  if( aDrawInfo.m_Display_padnum )
680  {
681  StringPadName( buffer );
682  int numpad_len = buffer.Len();
683  numpad_len = std::max( numpad_len, MIN_CHAR_COUNT );
684 
685  tsize = std::min( AreaSize.y, AreaSize.x / numpad_len );
686 
687  if( aDC->LogicalToDeviceXRel( tsize ) >= MIN_TEXT_SIZE ) // Not drawable when size too small.
688  {
689  // tsize reserve room for marges and segments thickness
690  tsize = ( tsize * 7 ) / 10;
691  DrawGraphicHaloText( clipBox, aDC, tpos,
692  aDrawInfo.m_Color, BLACK, WHITE,
693  buffer, t_angle,
694  wxSize( tsize , tsize ), GR_TEXT_HJUSTIFY_CENTER,
695  GR_TEXT_VJUSTIFY_CENTER, tsize / 7, false, false );
696 
697  }
698  }
699 
700  // display the short netname, if exists
701  if( shortname_len == 0 )
702  return;
703 
704  shortname_len = std::max( shortname_len, MIN_CHAR_COUNT );
705  tsize = std::min( AreaSize.y, AreaSize.x / shortname_len );
706 
707  if( aDC->LogicalToDeviceXRel( tsize ) >= MIN_TEXT_SIZE ) // Not drawable in size too small.
708  {
709  tpos = tpos0;
710 
711  if( aDrawInfo.m_Display_padnum )
712  tpos.y += AreaSize.y / 2;
713 
714  RotatePoint( &tpos, shape_pos, angle );
715 
716  // tsize reserve room for marges and segments thickness
717  tsize = ( tsize * 7 ) / 10;
718  DrawGraphicHaloText( clipBox, aDC, tpos,
719  aDrawInfo.m_Color, BLACK, WHITE,
720  GetShortNetname(), t_angle,
721  wxSize( tsize, tsize ), GR_TEXT_HJUSTIFY_CENTER,
722  GR_TEXT_VJUSTIFY_CENTER, tsize / 7, false, false );
723  }
724 }
725 
726 
735  double aRotation, const wxSize& aMargin) const
736 {
737  int width;
738 
739  if( m_Size.y < m_Size.x ) // Build an horizontal equiv segment
740  {
741  int delta = ( m_Size.x - m_Size.y ) / 2;
742  aSegStart.x = -delta - aMargin.x;
743  aSegStart.y = 0;
744  aSegEnd.x = delta + aMargin.x;
745  aSegEnd.y = 0;
746  width = m_Size.y + ( aMargin.y * 2 );
747  }
748  else // Vertical oval: build a vertical equiv segment
749  {
750  int delta = ( m_Size.y -m_Size.x ) / 2;
751  aSegStart.x = 0;
752  aSegStart.y = -delta - aMargin.y;
753  aSegEnd.x = 0;
754  aSegEnd.y = delta + aMargin.y;
755  width = m_Size.x + ( aMargin.x * 2 );
756  }
757 
758  if( aRotation )
759  {
760  RotatePoint( &aSegStart, aRotation);
761  RotatePoint( &aSegEnd, aRotation);
762  }
763 
764  return width;
765 }
766 
767 
768 void D_PAD::BuildPadPolygon( wxPoint aCoord[4], wxSize aInflateValue,
769  double aRotation ) const
770 {
771  wxSize delta;
772  wxSize halfsize;
773 
774  halfsize.x = m_Size.x >> 1;
775  halfsize.y = m_Size.y >> 1;
776 
777  switch( GetShape() )
778  {
779  case PAD_SHAPE_RECT:
780  // For rectangular shapes, inflate is easy
781  halfsize += aInflateValue;
782 
783  // Verify if do not deflate more than than size
784  // Only possible for inflate negative values.
785  if( halfsize.x < 0 )
786  halfsize.x = 0;
787 
788  if( halfsize.y < 0 )
789  halfsize.y = 0;
790  break;
791 
792  case PAD_SHAPE_TRAPEZOID:
793  // Trapezoidal pad: verify delta values
794  delta.x = ( m_DeltaSize.x >> 1 );
795  delta.y = ( m_DeltaSize.y >> 1 );
796 
797  // be sure delta values are not to large
798  if( (delta.x < 0) && (delta.x <= -halfsize.y) )
799  delta.x = -halfsize.y + 1;
800 
801  if( (delta.x > 0) && (delta.x >= halfsize.y) )
802  delta.x = halfsize.y - 1;
803 
804  if( (delta.y < 0) && (delta.y <= -halfsize.x) )
805  delta.y = -halfsize.x + 1;
806 
807  if( (delta.y > 0) && (delta.y >= halfsize.x) )
808  delta.y = halfsize.x - 1;
809  break;
810 
811  default: // is used only for rect and trap. pads
812  return;
813  }
814 
815  // Build the basic rectangular or trapezoid shape
816  // delta is null for rectangular shapes
817  aCoord[0].x = -halfsize.x - delta.y; // lower left
818  aCoord[0].y = +halfsize.y + delta.x;
819 
820  aCoord[1].x = -halfsize.x + delta.y; // upper left
821  aCoord[1].y = -halfsize.y - delta.x;
822 
823  aCoord[2].x = +halfsize.x - delta.y; // upper right
824  aCoord[2].y = -halfsize.y + delta.x;
825 
826  aCoord[3].x = +halfsize.x + delta.y; // lower right
827  aCoord[3].y = +halfsize.y - delta.x;
828 
829  // Offsetting the trapezoid shape id needed
830  // It is assumed delta.x or/and delta.y == 0
831  if( GetShape() == PAD_SHAPE_TRAPEZOID && (aInflateValue.x != 0 || aInflateValue.y != 0) )
832  {
833  double angle;
834  wxSize corr;
835 
836  if( delta.y ) // lower and upper segment is horizontal
837  {
838  // Calculate angle of left (or right) segment with vertical axis
839  angle = atan2( (double) m_DeltaSize.y, (double) m_Size.y );
840 
841  // left and right sides are moved by aInflateValue.x in their perpendicular direction
842  // We must calculate the corresponding displacement on the horizontal axis
843  // that is delta.x +- corr.x depending on the corner
844  corr.x = KiROUND( tan( angle ) * aInflateValue.x );
845  delta.x = KiROUND( aInflateValue.x / cos( angle ) );
846 
847  // Horizontal sides are moved up and down by aInflateValue.y
848  delta.y = aInflateValue.y;
849 
850  // corr.y = 0 by the constructor
851  }
852  else if( delta.x ) // left and right segment is vertical
853  {
854  // Calculate angle of lower (or upper) segment with horizontal axis
855  angle = atan2( (double) m_DeltaSize.x, (double) m_Size.x );
856 
857  // lower and upper sides are moved by aInflateValue.x in their perpendicular direction
858  // We must calculate the corresponding displacement on the vertical axis
859  // that is delta.y +- corr.y depending on the corner
860  corr.y = KiROUND( tan( angle ) * aInflateValue.y );
861  delta.y = KiROUND( aInflateValue.y / cos( angle ) );
862 
863  // Vertical sides are moved left and right by aInflateValue.x
864  delta.x = aInflateValue.x;
865 
866  // corr.x = 0 by the constructor
867  }
868  else // the trapezoid is a rectangle
869  {
870  delta = aInflateValue; // this pad is rectangular (delta null).
871  }
872 
873  aCoord[0].x += -delta.x - corr.x; // lower left
874  aCoord[0].y += delta.y + corr.y;
875 
876  aCoord[1].x += -delta.x + corr.x; // upper left
877  aCoord[1].y += -delta.y - corr.y;
878 
879  aCoord[2].x += delta.x - corr.x; // upper right
880  aCoord[2].y += -delta.y + corr.y;
881 
882  aCoord[3].x += delta.x + corr.x; // lower right
883  aCoord[3].y += delta.y - corr.y;
884 
885  /* test coordinates and clamp them if the offset correction is too large:
886  * Note: if a coordinate is bad, the other "symmetric" coordinate is bad
887  * So when a bad coordinate is found, the 2 symmetric coordinates
888  * are set to the minimun value (0)
889  */
890 
891  if( aCoord[0].x > 0 ) // lower left x coordinate must be <= 0
892  aCoord[0].x = aCoord[3].x = 0;
893 
894  if( aCoord[1].x > 0 ) // upper left x coordinate must be <= 0
895  aCoord[1].x = aCoord[2].x = 0;
896 
897  if( aCoord[0].y < 0 ) // lower left y coordinate must be >= 0
898  aCoord[0].y = aCoord[1].y = 0;
899 
900  if( aCoord[3].y < 0 ) // lower right y coordinate must be >= 0
901  aCoord[3].y = aCoord[2].y = 0;
902  }
903 
904  if( aRotation )
905  {
906  for( int ii = 0; ii < 4; ii++ )
907  RotatePoint( &aCoord[ii], aRotation );
908  }
909 }
void BasicShapesAsPolygonToBoardPosition(SHAPE_POLY_SET *aMergedPolygon, wxPoint aPosition, double aRotation) const
When created, the corners coordinates are relative to the pad position, orientation 0...
Definition: colors.h:57
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Function AllCuMask returns a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:639
void DrawGraphicHaloText(EDA_RECT *aClipBox, wxDC *aDC, const wxPoint &aPos, const COLOR4D aBgColor, COLOR4D aColor1, COLOR4D aColor2, const wxString &aText, double aOrient, const wxSize &aSize, enum EDA_TEXT_HJUSTIFY_T aH_justify, enum EDA_TEXT_VJUSTIFY_T aV_justify, int aWidth, bool aItalic, bool aBold, void(*aCallback)(int x0, int y0, int xf, int yf), PLOTTER *aPlotter)
Draw graphic text with a border, so that it can be read on different backgrounds. ...
Definition: drawtxt.cpp:176
static int m_PadSketchModePenSize
Pen size used to draw pads in sketch mode (mode used to print pads on silkscreen layer) ...
Definition: class_pad.h:122
#define MIN_CHAR_COUNT
show a marker on pads with no nets
bool IsElementVisible(GAL_LAYER_ID LAYER_aPCB) const
Function IsElementVisible tests whether a given element category is visible.
PAD_SHAPE_T GetAnchorPadShape() const
Function GetAnchorPadShape.
Definition: class_pad.h:215
bool m_Display_padnum
Definition: class_pad.h:73
PAD_ATTR_T GetAttribute() const
Definition: class_pad.h:384
void GRSetDrawMode(wxDC *DC, GR_DRAWMODE draw_mode)
Definition: gr_basic.cpp:290
static int KiROUND(double v)
KiROUND rounds a floating point number to an int using "round halfway cases away from zero"...
Definition: common.h:107
like PAD_STANDARD, but not plated mechanical use only, no connection allowed
Definition: pad_shapes.h:65
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, GR_DRAWMODE aDrawMode, const wxPoint &aOffset=ZeroOffset) override
Function Draw BOARD_ITEMs have their own color information.
void BuildPadPolygon(wxPoint aCoord[4], wxSize aInflateValue, double aRotation) const
Function BuildPadPolygon Has meaning only for polygonal pads (trapezoid and rectangular) Build the Co...
int PointCount() const
Function PointCount()
void GRLine(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color)
Definition: gr_basic.cpp:352
Class BOARD to handle a board.
void TransformRoundRectToPolygon(SHAPE_POLY_SET &aCornerBuffer, const wxPoint &aPosition, const wxSize &aSize, double aRotation, int aCornerRadius, int aCircleToSegmentsCount)
Function TransformRoundRectToPolygon convert a rectangle with rounded corners to a polygon Convert ar...
int GetRoundRectCornerRadius() const
Function GetRoundRectCornerRadius Has meaning only for rounded rect pads.
Definition: class_pad.h:497
wxSize m_Size
X and Y size ( relative to orient 0)
Definition: class_pad.h:782
Smd pad, appears on the solder paste layer (default)
Definition: pad_shapes.h:61
#define SEGCOUNT
void GRCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, int aPenSize, COLOR4D Color)
Definition: gr_basic.cpp:481
PAD_DRILL_SHAPE_T GetDrillShape() const
Definition: class_pad.h:367
bool m_ShowNCMark
Definition: class_pad.h:77
void RotatePoint(int *pX, int *pY, double angle)
Definition: trigo.cpp:317
int OutlineCount() const
Returns the number of outlines in the set
void GRFilledCircle(EDA_RECT *ClipBox, wxDC *DC, int x, int y, int r, int width, COLOR4D Color, COLOR4D BgColor)
Definition: gr_basic.cpp:833
PCB_LAYER_ID m_Active_Layer
PAD_SHAPE_T GetShape() const
Function GetShape.
Definition: class_pad.h:205
smd pads, back layer
static LSET FrontMask()
Function FrontMask returns a mask holding all technical layers and the external CU layer on front sid...
Definition: lset.cpp:738
void NORMALIZE_ANGLE_90(T &Angle)
Definition: trigo.h:277
void GRClosedPoly(EDA_RECT *ClipBox, wxDC *DC, int n, wxPoint Points[], bool Fill, COLOR4D Color, COLOR4D BgColor)
Function GRClosedPoly draws a closed polygon onto the drawing context aDC and optionally fills and/or...
Definition: gr_basic.cpp:777
static const int delta[8][2]
Definition: solve.cpp:112
bool m_IsPrinting
Definition: class_pad.h:80
PCB_LAYER_ID ExtractLayer() const
Find the first set PCB_LAYER_ID.
Definition: lset.cpp:578
PCB_LAYER_ID
A quick note on layer IDs:
double a
Alpha component.
Definition: color4d.h:289
Class LSET is a set of PCB_LAYER_IDs.
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, int aClearanceValue, int aCircleToSegmentsCount, double aCorrectionFactor) const
Function TransformShapeWithClearanceToPolygon Convert the pad shape to a closed polygon Used in filli...
Classes used in Pcbnew, CvPcb and GerbView.
void Inflate(int aFactor, int aCircleSegmentsCount)
Performs outline inflation/deflation, using round corners.
#define MIN_TEXT_SIZE
Definition: drawtxt.h:43
void GRForceBlackPen(bool flagforce)
Function GRForceBlackPen.
Definition: gr_basic.cpp:271
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:41
Class SHAPE_POLY_SET.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Returns the reference to aIndex-th outline in the set
void GRFillCSegm(EDA_RECT *ClipBox, wxDC *DC, int x1, int y1, int x2, int y2, int width, COLOR4D Color)
Definition: gr_basic.cpp:584
PCB_GENERAL_SETTINGS & Settings()
int GetSolderMaskMargin() const
Function GetSolderMaskMargin.
Definition: class_pad.cpp:620
GR_DRAWMODE m_DrawMode
Definition: class_pad.h:66
const wxPoint & GetPosition() const override
Definition: class_pad.h:209
EDA_DRAW_PANEL * m_DrawPanel
Definition: class_pad.h:65
bool m_ContrastModeDisplay
Definition: pcbstruct.h:85
COLOR4D m_HoleColor
Definition: class_pad.h:69
const wxSize & GetSize() const
Definition: class_pad.h:258
PCB_LAYER_ID m_Route_Layer_BOTTOM
EDA_RECT * GetClipBox()
bool m_ShowNotPlatedHole
Definition: class_pad.h:78
EDA_DRAW_FRAME * GetParent() const
Definition: draw_panel.cpp:175
SHAPE_POLY_SET m_customShapeAsPolygon
for free shape pads: the set of basic shapes, merged as one polygon, in local coordinates, orient 0, coordinates relative to m_Pos
Definition: class_pad.h:765
void DrawShape(EDA_RECT *aClipBox, wxDC *aDC, PAD_DRAWINFO &aDrawInfo)
Function DrawShape basic function to draw a pad.
wxSize m_DeltaSize
delta on rectangular shapes
Definition: class_pad.h:812
Like smd, does not appear on the solder paste layer (default) note also has a special attribute in Ge...
Definition: pad_shapes.h:62
int m_PadClearance
Definition: class_pad.h:71
COLORS_DESIGN_SETTINGS & Colors()
Class DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.
Definition: pcbstruct.h:62
int GetNetCode() const
Function GetNetCode.
LSET m_layerMask
Bitwise layer :1= copper layer, 15= cmp, 2..14 = internal layers 16 .
Definition: class_pad.h:808
bool m_DisplayPadFill
Definition: pcbstruct.h:65
int BuildSegmentFromOvalShape(wxPoint &aSegStart, wxPoint &aSegEnd, double aRotation, const wxSize &aMargin) const
Function BuildSegmentFromOvalShape Has meaning only for OVAL (and ROUND) pads Build an equivalent seg...
bool m_DisplayPadIsol
Definition: pcbstruct.h:68
wxPoint m_Offset
Definition: class_pad.h:81
smd pads, front layer
Board layer functions and definitions.
handle color for not plated holes
void GetOblongDrillGeometry(wxPoint &aStartPoint, wxPoint &aEndPoint, int &aWidth) const
Function GetOblongDrillGeometry calculates the start point, end point and width of an equivalent segm...
Definition: class_pad.cpp:794
#define max(a, b)
Definition: auxiliary.h:86
Class BOARD holds information pertinent to a Pcbnew printed circuit board.
Definition: class_board.h:169
Class SHAPE_LINE_CHAIN.
bool m_DisplayPadNum
Definition: pcbstruct.h:67
void GRFilledSegment(EDA_RECT *aClipBox, wxDC *aDC, wxPoint aStart, wxPoint aEnd, int aWidth, COLOR4D aColor)
Definition: gr_basic.cpp:592
static DIRECTION_45::AngleType angle(const VECTOR2I &a, const VECTOR2I &b)
LSET GetVisibleLayers() const
Function GetVisibleLayers is a proxy function that calls the correspondent function in m_BoardSetting...
void GRCircle(EDA_RECT *ClipBox, wxDC *DC, int xc, int yc, int r, int width, COLOR4D Color)
Definition: gr_basic.cpp:791
STATUS_FLAGS m_Flags
Flag bits for editing and other uses.
Definition: base_struct.h:175
void RemoveAllContours()
Removes all outlines & holes (clears) the polygon set.
double GetOrientation() const
Function GetOrientation returns the rotation angle of the pad in tenths of degrees, but soon degrees.
Definition: class_pad.h:361
Class EDA_RECT handles the component boundary box.
wxSize GetSolderPasteMargin() const
Function GetSolderPasteMargin.
Definition: class_pad.cpp:653
void GetRoundRectCornerCenters(wxPoint aCenters[4], int aRadius, const wxPoint &aPosition, const wxSize &aSize, double aRotation)
Helper function GetRoundRectCornerCenters Has meaning only for rounded rect Returns the centers of th...
The common library.
int m_DisplayNetNamesMode
Definition: pcbstruct.h:78
int GetClearance(BOARD_CONNECTED_ITEM *aItem=NULL) const override
Function GetClearance returns the clearance in internal units.
Definition: class_pad.cpp:589
static LSET BackMask()
Function BackMask returns a mask holding all technical layers and the external CU layer on back side...
Definition: lset.cpp:745
Definition: colors.h:49
wxPoint ShapePos() const
Definition: class_pad.cpp:501
bool m_ShowPadFilled
Definition: class_pad.h:75
virtual BOARD * GetBoard() const
Function GetBoard returns the BOARD in which this BOARD_ITEM resides, or NULL if none.
bool IsCopperLayer(LAYER_NUM aLayerId)
Function IsCopperLayer tests whether a layer is a copper layer.
COLOR4D m_NPHoleColor
Definition: class_pad.h:70
This file is part of the common libary.
COLOR4D m_Color
Definition: class_pad.h:67
VECTOR2I & Point(int aIndex)
Function Point()
wxSize m_Drill
Drill diam (drill shape = PAD_CIRCLE) or drill size (shape = OVAL) for drill shape = PAD_CIRCLE...
Definition: class_pad.h:778
Definition: colors.h:45
double m_Orient
in 1/10 degrees
Definition: class_pad.h:819
void StringPadName(wxString &text) const
Definition: class_pad.cpp:525
bool m_Display_netname
Definition: class_pad.h:74
bool GetGRForceBlackPenState(void)
Function GetGRForceBlackPenState.
Definition: gr_basic.cpp:281
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Function IsOnLayer tests to see if this object is on the given layer.
Definition: class_pad.h:625
wxSize m_Mask_margin
Definition: class_pad.h:72
Definition: colors.h:68
PCB_LAYER_ID m_Route_Layer_TOP
#define DO_NOT_DRAW
Used to disable draw function.
Definition: base_struct.h:125
#define min(a, b)
Definition: auxiliary.h:85
wxPoint m_Pos
pad Position on board
Definition: class_pad.h:750
int Append(int x, int y, int aOutline=-1, int aHole=-1, bool aAllowDuplication=false)
Appends a vertex at the end of the given outline/hole (default: the last outline) ...
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39
const wxString & GetShortNetname() const
Function GetShortNetname.