KiCad PCB EDA Suite
Loading...
Searching...
No Matches
plot_brditems_plotter.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 The 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
24#include <algorithm> // for min
25#include <bitset> // for bitset, operator&, __bi...
26#include <math.h> // for abs
27
28#include <geometry/seg.h> // for SEG
30#include <geometry/shape_line_chain.h> // for SHAPE_LINE_CHAIN
31#include <geometry/shape_poly_set.h> // for SHAPE_POLY_SET, SHAPE_P...
32#include <geometry/shape_rect.h>
34#include <string_utils.h>
35#include <macros.h>
36#include <math/util.h> // for KiROUND
37#include <math/vector2d.h> // for VECTOR2I
39#include <trigo.h>
40#include <font/stroke_font.h>
42#include <callback_gal.h>
43#include <core/typeinfo.h> // for dyn_cast, PCB_DIMENSION_T
44#include <gbr_metadata.h>
45#include <gbr_netlist_metadata.h> // for GBR_NETLIST_METADATA
46#include <layer_ids.h> // for LSET, IsCopperLayer
47#include <lset.h>
48#include <pcbplot.h>
49#include <pcb_plot_params.h> // for PCB_PLOT_PARAMS, PCB_PL...
50#include <advanced_config.h>
51
52#include <pcb_dimension.h>
53#include <pcb_shape.h>
54#include <footprint.h>
55#include <pcb_track.h>
56#include <pad.h>
57#include <pcb_target.h>
58#include <pcb_text.h>
59#include <pcb_textbox.h>
60#include <pcb_tablecell.h>
61#include <pcb_table.h>
62#include <zone.h>
63#include <pcb_barcode.h>
64
65#include <wx/debug.h> // for wxASSERT_MSG
66
67
69{
70 COLOR4D color = ColorSettings()->GetColor( aLayer );
71
72 // A hack to avoid plotting a white item in white color on white paper
73 if( color == COLOR4D::WHITE )
74 color = COLOR4D( LIGHTGRAY );
75
76 return color;
77}
78
79
80void BRDITEMS_PLOTTER::PlotPadNumber( const PAD* aPad, const COLOR4D& aColor )
81{
82 wxString padNumber = UnescapeString( aPad->GetNumber() );
83
84 if( padNumber.IsEmpty() )
85 return;
86
87 BOX2I padBBox = aPad->GetBoundingBox();
88 VECTOR2I position = padBBox.Centre();
89 VECTOR2I padsize = padBBox.GetSize();
90
91 // TODO(JE) padstacks
93 {
94 // See if we have a number box
95 for( const std::shared_ptr<PCB_SHAPE>& primitive : aPad->GetPrimitives( PADSTACK::ALL_LAYERS ) )
96 {
97 if( primitive->IsProxyItem() && primitive->GetShape() == SHAPE_T::RECTANGLE )
98 {
99 position = primitive->GetCenter();
100 RotatePoint( position, aPad->GetOrientation() );
101 position += aPad->ShapePos( PADSTACK::ALL_LAYERS );
102
103 padsize.x = abs( primitive->GetBotRight().x - primitive->GetTopLeft().x );
104 padsize.y = abs( primitive->GetBotRight().y - primitive->GetTopLeft().y );
105
106 break;
107 }
108 }
109 }
110
112 {
113 // Don't allow a 45° rotation to bloat a pad's bounding box unnecessarily
114 int limit = KiROUND( std::min( aPad->GetSize( PADSTACK::ALL_LAYERS ).x,
115 aPad->GetSize( PADSTACK::ALL_LAYERS ).y ) * 1.1 );
116
117 if( padsize.x > limit && padsize.y > limit )
118 {
119 padsize.x = limit;
120 padsize.y = limit;
121 }
122 }
123
124 TEXT_ATTRIBUTES textAttrs;
125
126 textAttrs.m_Mirrored = m_plotter->GetPlotMirrored();
127
128 if( padsize.x < ( padsize.y * 0.95 ) )
129 {
130 textAttrs.m_Angle = ANGLE_90;
131 std::swap( padsize.x, padsize.y );
132 }
133
134 // approximate the size of the pad number text:
135 // We use a size for at least 3 chars, to give a good look even for short numbers
136 int tsize = KiROUND( padsize.x / std::max( PrintableCharCount( padNumber ), 3 ) );
137 tsize = std::min( tsize, padsize.y );
138
139 // enforce a max size
140 tsize = std::min( tsize, pcbIUScale.mmToIU( 5.0 ) );
141
142 textAttrs.m_Size = VECTOR2I( tsize, tsize );
143
144 // use a somewhat spindly font to go with the outlined pads
145 textAttrs.m_StrokeWidth = KiROUND( tsize / 12.0 );
146
147 m_plotter->PlotText( position, aColor, padNumber, textAttrs );
148}
149
150
151void BRDITEMS_PLOTTER::PlotPad( const PAD* aPad, PCB_LAYER_ID aLayer, const COLOR4D& aColor,
152 bool aSketchMode )
153{
154 VECTOR2I shape_pos = aPad->ShapePos( aLayer );
155 GBR_METADATA metadata;
156
157 bool plotOnCopperLayer = ( m_layerMask & LSET::AllCuMask() ).any();
158 bool plotOnExternalCopperLayer = ( m_layerMask & LSET::ExternalCuMask() ).any();
159
160 // Pad not on the solder mask layer cannot be soldered.
161 // therefore it can have a specific aperture attribute.
162 // Not yet in use.
163 // bool isPadOnBoardTechLayers = ( aPad->GetLayerSet() & LSET::AllBoardTechMask() ).any();
164
165 metadata.SetCmpReference( aPad->GetParentFootprint()->GetReference() );
166
167 if( plotOnCopperLayer )
168 {
170 metadata.SetCopper( true );
171
172 // Gives a default attribute, for instance for pads used as tracks in net ties:
173 // Connector pads and SMD pads are on external layers
174 // if on internal layers, they are certainly used as net tie
175 // and are similar to tracks: just conductor items
177
178 const bool useUTF8 = false;
179 const bool useQuoting = false;
180 metadata.SetPadName( aPad->GetNumber(), useUTF8, useQuoting );
181
182 if( !aPad->GetNumber().IsEmpty() )
183 metadata.SetPadPinFunction( aPad->GetPinFunction(), useUTF8, useQuoting );
184
185 metadata.SetNetName( aPad->GetNetname() );
186
187 // Some pads are mechanical pads ( through hole or smd )
188 // when this is the case, they have no pad name and/or are not plated.
189 // In this case gerber files have slightly different attributes.
190 if( aPad->GetAttribute() == PAD_ATTRIB::NPTH || aPad->GetNumber().IsEmpty() )
191 metadata.m_NetlistMetadata.m_NotInNet = true;
192
193 if( !plotOnExternalCopperLayer )
194 {
195 // the .P object attribute (GBR_NETLIST_METADATA::GBR_NETINFO_PAD)
196 // is used on outer layers, unless the component is embedded
197 // or a "etched" component (fp only drawn, not a physical component)
198 // Currently, Pcbnew does not handle embedded component, so we disable the .P
199 // attribute on internal layers
200 // Note the Gerber doc is not really clear about through holes pads about the .P
203
204 }
205
206 // Some attributes are reserved to the external copper layers:
207 // GBR_APERTURE_ATTRIB_CONNECTORPAD and GBR_APERTURE_ATTRIB_SMDPAD_CUDEF
208 // for instance.
209 // Pad with type PAD_ATTRIB::CONN or PAD_ATTRIB::SMD that is not on outer layer
210 // has its aperture attribute set to GBR_APERTURE_ATTRIB_CONDUCTOR
211 switch( aPad->GetAttribute() )
212 {
213 case PAD_ATTRIB::NPTH: // Mechanical pad through hole
215 break;
216
217 case PAD_ATTRIB::PTH : // Pad through hole, a hole is also expected
219 break;
220
221 case PAD_ATTRIB::CONN: // Connector pads, no solder paste but with solder mask.
222 if( plotOnExternalCopperLayer )
224 break;
225
226 case PAD_ATTRIB::SMD: // SMD pads (on external copper layer only)
227 // with solder paste and mask
228 if( plotOnExternalCopperLayer )
230 break;
231 }
232
233 // Fabrication properties can have specific GBR_APERTURE_METADATA options
234 // that replace previous aperture attribute:
235 switch( aPad->GetProperty() )
236 {
237 case PAD_PROP::BGA: // Only applicable to outer layers
238 if( plotOnExternalCopperLayer )
240 break;
241
244 break;
245
248 break;
249
250 case PAD_PROP::TESTPOINT: // Only applicable to outer layers
251 if( plotOnExternalCopperLayer )
253 break;
254
257 break;
258
261 break;
262
263 case PAD_PROP::PRESSFIT: // used only in drill files
264 case PAD_PROP::NONE:
266 break;
267 }
268
269 // Ensure NPTH pads have *always* the GBR_APERTURE_ATTRIB_WASHERPAD attribute
270 if( aPad->GetAttribute() == PAD_ATTRIB::NPTH )
272 }
273 else
274 {
276 }
277
278 // Set plot color (change WHITE to LIGHTGRAY because
279 // the white items are not seen on a white paper or screen
280 m_plotter->SetColor( aColor != WHITE ? aColor : LIGHTGRAY );
281
282 if( aSketchMode )
283 {
284 switch( aPad->GetShape( aLayer ) )
285 {
287 m_plotter->ThickCircle( shape_pos, aPad->GetSize( aLayer ).x, GetSketchPadLineWidth(),
288 nullptr );
289 break;
290
291 case PAD_SHAPE::OVAL:
292 {
293 m_plotter->ThickOval( shape_pos, aPad->GetSize( aLayer ), aPad->GetOrientation(),
294 GetSketchPadLineWidth(), nullptr );
295 break;
296 }
297
303 {
304 SHAPE_POLY_SET outline;
305 aPad->TransformShapeToPolygon( outline, aLayer, 0, m_plotter->GetPlotterArcHighDef(),
306 ERROR_INSIDE, false );
307
308 m_plotter->ThickPoly( outline, GetSketchPadLineWidth(), nullptr );
309 break;
310 }
311
312 default:
314 }
315
316 return;
317 }
318
319 switch( aPad->GetShape( aLayer ) )
320 {
322 m_plotter->FlashPadCircle( shape_pos, aPad->GetSize( aLayer ).x, &metadata );
323 break;
324
325 case PAD_SHAPE::OVAL:
326 m_plotter->FlashPadOval( shape_pos, aPad->GetSize( aLayer ), aPad->GetOrientation(), &metadata );
327 break;
328
330 m_plotter->FlashPadRect( shape_pos, aPad->GetSize( aLayer ), aPad->GetOrientation(), &metadata );
331 break;
332
334 m_plotter->FlashPadRoundRect( shape_pos, aPad->GetSize( aLayer ),
335 aPad->GetRoundRectCornerRadius( aLayer ),
336 aPad->GetOrientation(), &metadata );
337 break;
338
340 {
341 // Build the pad polygon in coordinates relative to the pad
342 // (i.e. for a pad at pos 0,0, rot 0.0). Needed to use aperture macros,
343 // to be able to create a pattern common to all trapezoid pads having the same shape
344 VECTOR2I coord[4];
345
346 // Order is lower left, lower right, upper right, upper left.
347 VECTOR2I half_size = aPad->GetSize( aLayer ) / 2;
348 VECTOR2I trap_delta = aPad->GetDelta( aLayer ) / 2;
349
350 coord[0] = VECTOR2I( -half_size.x - trap_delta.y, half_size.y + trap_delta.x );
351 coord[1] = VECTOR2I( half_size.x + trap_delta.y, half_size.y - trap_delta.x );
352 coord[2] = VECTOR2I( half_size.x - trap_delta.y, -half_size.y + trap_delta.x );
353 coord[3] = VECTOR2I( -half_size.x + trap_delta.y, -half_size.y - trap_delta.x );
354
355 m_plotter->FlashPadTrapez( shape_pos, coord, aPad->GetOrientation(), &metadata );
356 break;
357 }
358
360 if( m_plotter->GetPlotterType() == PLOT_FORMAT::GERBER )
361 {
362 GERBER_PLOTTER* gerberPlotter = static_cast<GERBER_PLOTTER*>( m_plotter );
363
364 gerberPlotter->FlashPadChamferRoundRect( shape_pos, aPad->GetSize( aLayer ),
365 aPad->GetRoundRectCornerRadius( aLayer ),
366 aPad->GetChamferRectRatio( aLayer ),
367 aPad->GetChamferPositions( aLayer ),
368 aPad->GetOrientation(), &metadata );
369 break;
370 }
371
373
374 default:
376 {
377 const std::shared_ptr<SHAPE_POLY_SET>& polygons = aPad->GetEffectivePolygon( aLayer, ERROR_INSIDE );
378
379 if( polygons->OutlineCount() )
380 {
381 m_plotter->FlashPadCustom( shape_pos, aPad->GetSize( aLayer ), aPad->GetOrientation(),
382 polygons.get(), &metadata );
383 }
384 }
385 break;
386 }
387}
388
389
391{
392 if( !GetPlotFPText() )
393 return;
394
395 const wxString variantName = m_board ? m_board->GetCurrentVariant() : wxString();
396 const bool dnp = aFootprint->GetDNPForVariant( variantName );
397
398 const PCB_TEXT* reference = &aFootprint->Reference();
399 PCB_LAYER_ID refLayer = reference->GetLayer();
400
401 // Reference and value have special controls for forcing their plotting
402 if( GetPlotReference()
403 && m_layerMask[refLayer]
404 && reference->IsVisible()
405 && !( dnp && hideDNPItems( refLayer ) ) )
406 {
407 PlotText( reference, refLayer, reference->IsKnockout(), reference->GetFontMetrics(),
408 dnp && crossoutDNPItems( refLayer ) );
409 }
410
411 const PCB_TEXT* value = &aFootprint->Value();
412 PCB_LAYER_ID valueLayer = value->GetLayer();
413
414 if( GetPlotValue()
415 && m_layerMask[valueLayer]
416 && value->IsVisible()
417 && !( dnp && hideDNPItems( valueLayer ) ) )
418 {
419 PlotText( value, valueLayer, value->IsKnockout(), value->GetFontMetrics(), false );
420 }
421
422 std::vector<PCB_TEXT*> texts;
423
424 // Skip the reference and value texts that are handled specially
425 for( PCB_FIELD* field : aFootprint->GetFields() )
426 {
427 wxCHECK2( field, continue );
428
429 if( field->IsReference() || field->IsValue() )
430 continue;
431
432 if( field->IsVisible() )
433 texts.push_back( field );
434 }
435
436 for( BOARD_ITEM* item : aFootprint->GraphicalItems() )
437 {
438 if( PCB_TEXT* textItem = dynamic_cast<PCB_TEXT*>( item ) )
439 texts.push_back( textItem );
440 }
441
442 for( const PCB_TEXT* text : texts )
443 {
444 PCB_LAYER_ID textLayer = text->GetLayer();
445 bool strikeout = false;
446
447 if( textLayer == Edge_Cuts || textLayer >= PCB_LAYER_ID_COUNT )
448 continue;
449
450 if( dnp && hideDNPItems( textLayer ) )
451 continue;
452
453 if( !m_layerMask[textLayer] || aFootprint->GetPrivateLayers().test( textLayer ) )
454 continue;
455
456 if( text->GetText() == wxT( "${REFERENCE}" ) )
457 {
458 if( !GetPlotReference() )
459 continue;
460
461 strikeout = dnp && crossoutDNPItems( textLayer );
462 }
463
464 if( text->GetText() == wxT( "${VALUE}" ) )
465 {
466 if( !GetPlotValue() )
467 continue;
468 }
469
470 PlotText( text, textLayer, text->IsKnockout(), text->GetFontMetrics(), strikeout );
471 }
472}
473
474
476{
477 switch( item->Type() )
478 {
479 case PCB_SHAPE_T:
480 PlotShape( static_cast<const PCB_SHAPE*>( item ) );
481 break;
482
483 case PCB_TEXT_T:
484 {
485 const PCB_TEXT* text = static_cast<const PCB_TEXT*>( item );
486 PlotText( text, text->GetLayer(), text->IsKnockout(), text->GetFontMetrics() );
487 break;
488 }
489
490 case PCB_TEXTBOX_T:
491 {
492 m_plotter->SetTextMode( PLOT_TEXT_MODE::STROKE );
493
494 const PCB_TEXTBOX* textbox = static_cast<const PCB_TEXTBOX*>( item );
495 PlotText( textbox, textbox->GetLayer(), textbox->IsKnockout(), textbox->GetFontMetrics() );
496
497 if( textbox->IsBorderEnabled() )
498 PlotShape( textbox );
499
500 m_plotter->SetTextMode( GetTextMode() );
501 break;
502 }
503
504 case PCB_BARCODE_T:
505 PlotBarCode( static_cast<const PCB_BARCODE*>( item ) );
506 break;
507
508 case PCB_TABLE_T:
509 {
510 const PCB_TABLE* table = static_cast<const PCB_TABLE*>( item );
511
512 m_plotter->SetTextMode( PLOT_TEXT_MODE::STROKE );
513
514 for( const PCB_TABLECELL* cell : table->GetCells() )
515 PlotText( cell, cell->GetLayer(), cell->IsKnockout(), cell->GetFontMetrics() );
516
518
519 m_plotter->SetTextMode( GetTextMode() );
520 break;
521 }
522
524 case PCB_DIM_CENTER_T:
525 case PCB_DIM_RADIAL_T:
527 case PCB_DIM_LEADER_T:
528 m_plotter->SetTextMode( PLOT_TEXT_MODE::STROKE );
529
530 PlotDimension( static_cast<const PCB_DIMENSION_BASE*>( item ) );
531
532 m_plotter->SetTextMode( GetTextMode() );
533 break;
534
535 case PCB_TARGET_T:
536 PlotPcbTarget( static_cast<const PCB_TARGET*>( item ) );
537 break;
538
539 default:
540 break;
541 }
542}
543
544
546{
547 if( !m_layerMask[aDim->GetLayer()] )
548 return;
549
550 COLOR4D color = ColorSettings()->GetColor( aDim->GetLayer() );
551
552 // Set plot color (change WHITE to LIGHTGRAY because
553 // the white items are not seen on a white paper or screen
554 m_plotter->SetColor( color != WHITE ? color : LIGHTGRAY);
555
556 PlotText( aDim, aDim->GetLayer(), false, aDim->GetFontMetrics() );
557
558 PCB_SHAPE temp_item;
559
561 temp_item.SetLayer( aDim->GetLayer() );
562
563 for( const std::shared_ptr<SHAPE>& shape : aDim->GetShapes() )
564 {
565 switch( shape->Type() )
566 {
567 case SH_SEGMENT:
568 {
569 const SEG& seg = static_cast<const SHAPE_SEGMENT*>( shape.get() )->GetSeg();
570
571 temp_item.SetShape( SHAPE_T::SEGMENT );
572 temp_item.SetStart( seg.A );
573 temp_item.SetEnd( seg.B );
574
575 PlotShape( &temp_item );
576 break;
577 }
578
579 case SH_CIRCLE:
580 {
581 VECTOR2I start( shape->Centre() );
582 int radius = static_cast<const SHAPE_CIRCLE*>( shape.get() )->GetRadius();
583
584 temp_item.SetShape( SHAPE_T::CIRCLE );
585 temp_item.SetFilled( false );
586 temp_item.SetStart( start );
587 temp_item.SetEnd( VECTOR2I( start.x + radius, start.y ) );
588
589 PlotShape( &temp_item );
590 break;
591 }
592
593 default:
594 break;
595 }
596 }
597}
598
599
601{
602 int dx1, dx2, dy1, dy2, radius;
603
604 if( !m_layerMask[aMire->GetLayer()] )
605 return;
606
607 m_plotter->SetColor( getColor( aMire->GetLayer() ) );
608
609 PCB_SHAPE temp_item;
610
611 temp_item.SetShape( SHAPE_T::CIRCLE );
612 temp_item.SetFilled( false );
613 temp_item.SetStroke( STROKE_PARAMS( aMire->GetWidth(), LINE_STYLE::SOLID ) );
614 temp_item.SetLayer( aMire->GetLayer() );
615 temp_item.SetStart( aMire->GetPosition() );
616 radius = aMire->GetSize() / 3;
617
618 if( aMire->GetShape() ) // temp_item X
619 radius = aMire->GetSize() / 2;
620
621 // Draw the circle
622 temp_item.SetEnd( VECTOR2I( temp_item.GetStart().x + radius, temp_item.GetStart().y ) );
623
624 PlotShape( &temp_item );
625
626 temp_item.SetShape( SHAPE_T::SEGMENT );
627
628 radius = aMire->GetSize() / 2;
629 dx1 = radius;
630 dy1 = 0;
631 dx2 = 0;
632 dy2 = radius;
633
634 if( aMire->GetShape() ) // Shape X
635 {
636 dx1 = dy1 = radius;
637 dx2 = dx1;
638 dy2 = -dy1;
639 }
640
641 VECTOR2I mirePos( aMire->GetPosition() );
642
643 // Draw the X or + temp_item:
644 temp_item.SetStart( VECTOR2I( mirePos.x - dx1, mirePos.y - dy1 ) );
645 temp_item.SetEnd( VECTOR2I( mirePos.x + dx1, mirePos.y + dy1 ) );
646 PlotShape( &temp_item );
647
648 temp_item.SetStart( VECTOR2I( mirePos.x - dx2, mirePos.y - dy2 ) );
649 temp_item.SetEnd( VECTOR2I( mirePos.x + dx2, mirePos.y + dy2 ) );
650 PlotShape( &temp_item );
651}
652
653
655{
656 const wxString variantName = m_board ? m_board->GetCurrentVariant() : wxString();
657 const bool dnp = aFootprint->GetDNPForVariant( variantName );
658
659 for( const BOARD_ITEM* item : aFootprint->GraphicalItems() )
660 {
661 PCB_LAYER_ID itemLayer = item->GetLayer();
662
663 if( aFootprint->GetPrivateLayers().test( itemLayer ) )
664 continue;
665
666 if( dnp && hideDNPItems( itemLayer ) )
667 continue;
668
669 if( !( m_layerMask & item->GetLayerSet() ).any() )
670 continue;
671
672 switch( item->Type() )
673 {
674 case PCB_SHAPE_T:
675 PlotShape( static_cast<const PCB_SHAPE*>( item ) );
676 break;
677
678 case PCB_TEXTBOX_T:
679 {
680 const PCB_TEXTBOX* textbox = static_cast<const PCB_TEXTBOX*>( item );
681
682 m_plotter->SetTextMode( PLOT_TEXT_MODE::STROKE );
683
684 PlotText( textbox, textbox->GetLayer(), textbox->IsKnockout(),
685 textbox->GetFontMetrics() );
686
687 if( textbox->IsBorderEnabled() )
688 PlotShape( textbox );
689
690 m_plotter->SetTextMode( GetTextMode() );
691 break;
692 }
693
694 case PCB_BARCODE_T:
695 PlotBarCode( static_cast<const PCB_BARCODE*>( item ) );
696 break;
697
698 case PCB_TABLE_T:
699 {
700 const PCB_TABLE* table = static_cast<const PCB_TABLE*>( item );
701
702 m_plotter->SetTextMode( PLOT_TEXT_MODE::STROKE );
703
704 for( const PCB_TABLECELL* cell : table->GetCells() )
705 PlotText( cell, cell->GetLayer(), cell->IsKnockout(), cell->GetFontMetrics() );
706
708
709 m_plotter->SetTextMode( GetTextMode() );
710 break;
711 }
712
714 case PCB_DIM_CENTER_T:
715 case PCB_DIM_RADIAL_T:
717 case PCB_DIM_LEADER_T:
718 PlotDimension( static_cast<const PCB_DIMENSION_BASE*>( item ) );
719 break;
720
721 case PCB_TEXT_T:
722 // Plotted in PlotFootprintTextItems()
723 break;
724
726 // Not plotted at all
727 break;
728
729 default:
730 UNIMPLEMENTED_FOR( item->GetClass() );
731 }
732 }
733}
734
735
736#define getMetadata() ( m_plotter->GetPlotterType() == PLOT_FORMAT::GERBER ? (void*) &gbr_metadata \
737 : m_plotter->GetPlotterType() == PLOT_FORMAT::DXF ? (void*) this \
738 : (void*) nullptr )
739
740
741void BRDITEMS_PLOTTER::PlotText( const EDA_TEXT* aText, PCB_LAYER_ID aLayer, bool aIsKnockout,
742 const KIFONT::METRICS& aFontMetrics, bool aStrikeout )
743{
744 int maxError = m_board->GetDesignSettings().m_MaxError;
745 KIFONT::FONT* font = aText->GetDrawFont( m_plotter->RenderSettings() );
746 wxString shownText( aText->GetShownText( true ) );
747
748 if( shownText.IsEmpty() )
749 return;
750
751 if( !m_layerMask[aLayer] )
752 return;
753
754 GBR_METADATA gbr_metadata;
755
756 if( IsCopperLayer( aLayer ) )
758
759 COLOR4D color = getColor( aLayer );
760 m_plotter->SetColor( color );
761
762 const VECTOR2I& pos = aText->GetTextPos();
763
764 TEXT_ATTRIBUTES attrs = aText->GetAttributes();
766 attrs.m_Angle = aText->GetDrawRotation();
767 attrs.m_Multiline = false;
768
769 m_plotter->SetCurrentLineWidth( attrs.m_StrokeWidth );
770
771 auto strikeoutText =
772 [&]( const PCB_TEXT* text )
773 {
774 SHAPE_POLY_SET textPoly;
775
776 text->TransformTextToPolySet( textPoly, 0, ARC_LOW_DEF, ERROR_INSIDE );
777 textPoly.Rotate( -text->GetDrawRotation(), text->GetDrawPos() );
778
779 BOX2I rect = textPoly.BBox();
780 VECTOR2I start( rect.GetLeft() - attrs.m_StrokeWidth,
781 ( rect.GetTop() + rect.GetBottom() ) / 2 );
782 VECTOR2I end( rect.GetRight() + attrs.m_StrokeWidth,
783 ( rect.GetTop() + rect.GetBottom() ) / 2 );
784
785 RotatePoint( start, text->GetDrawPos(), text->GetDrawRotation() );
786 RotatePoint( end, text->GetDrawPos(), text->GetDrawRotation() );
787
788 m_plotter->ThickSegment( start, end, attrs.m_StrokeWidth, getMetadata() );
789 };
790
791 if( aIsKnockout )
792 {
793 SHAPE_POLY_SET finalPoly;
794
795 if( const PCB_TEXT* text = dynamic_cast<const PCB_TEXT*>( aText) )
796 text->TransformTextToPolySet( finalPoly, 0, maxError, ERROR_INSIDE );
797 else if( const PCB_TEXTBOX* textbox = dynamic_cast<const PCB_TEXTBOX*>( aText ) )
798 textbox->TransformTextToPolySet( finalPoly, 0, maxError, ERROR_INSIDE );
799
800 finalPoly.Fracture();
801
802 for( int ii = 0; ii < finalPoly.OutlineCount(); ++ii )
803 m_plotter->PlotPoly( finalPoly.Outline( ii ), FILL_T::FILLED_SHAPE, 0, getMetadata() );
804 }
805 else
806 {
807 if( font->IsOutline() && !m_board->GetEmbeddedFiles()->GetAreFontsEmbedded() )
808 {
810
811 CALLBACK_GAL callback_gal( empty_opts,
812 // Stroke callback
813 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
814 {
815 m_plotter->ThickSegment( aPt1, aPt2, attrs.m_StrokeWidth, getMetadata() );
816 },
817 // Polygon callback
818 [&]( const SHAPE_LINE_CHAIN& aPoly )
819 {
820 m_plotter->PlotPoly( aPoly, FILL_T::FILLED_SHAPE, 0, getMetadata() );
821 } );
822
823 callback_gal.DrawGlyphs( *aText->GetRenderCache( font, shownText ) );
824 }
825 else if( aText->IsMultilineAllowed() )
826 {
827 std::vector<VECTOR2I> positions;
828 wxArrayString strings_list;
829 wxStringSplit( shownText, strings_list, '\n' );
830 positions.reserve( strings_list.Count() );
831
832 aText->GetLinePositions( m_plotter->RenderSettings(), positions, (int) strings_list.Count() );
833
834 for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
835 {
836 wxString& txt = strings_list.Item( ii );
837 m_plotter->PlotText( positions[ii], color, txt, attrs, font, aFontMetrics, getMetadata() );
838 }
839
840 if( aStrikeout && strings_list.Count() == 1 )
841 strikeoutText( static_cast<const PCB_TEXT*>( aText ) );
842 }
843 else
844 {
845 m_plotter->PlotText( pos, color, shownText, attrs, font, aFontMetrics, getMetadata() );
846
847 if( aStrikeout )
848 strikeoutText( static_cast<const PCB_TEXT*>( aText ) );
849 }
850 }
851}
852
853
854void BRDITEMS_PLOTTER::PlotZone( const ZONE* aZone, PCB_LAYER_ID aLayer, const SHAPE_POLY_SET& aPolysList )
855{
856 if( aPolysList.IsEmpty() )
857 return;
858
859 GBR_METADATA gbr_metadata;
860
861 if( aZone->IsOnCopperLayer() )
862 {
863 gbr_metadata.SetNetName( aZone->GetNetname() );
864 gbr_metadata.SetCopper( true );
865
866 // Zones with no net name can exist.
867 // they are not used to connect items, so the aperture attribute cannot
868 // be set as conductor
869 if( aZone->GetNetname().IsEmpty() )
870 {
872 }
873 else
874 {
877 }
878 }
879
880 m_plotter->SetColor( getColor( aLayer ) );
881
882 m_plotter->StartBlock( nullptr ); // Clean current object attributes
883
884 /*
885 * In non filled mode the outline is plotted, but not the filling items
886 */
887
888 for( int idx = 0; idx < aPolysList.OutlineCount(); ++idx )
889 {
890 const SHAPE_LINE_CHAIN& outline = aPolysList.Outline( idx );
891
892 // Plot the current filled area (as region for Gerber plotter to manage attributes)
893 if( m_plotter->GetPlotterType() == PLOT_FORMAT::GERBER )
894 {
895 static_cast<GERBER_PLOTTER*>( m_plotter )->PlotGerberRegion( outline, &gbr_metadata );
896 }
897 else if( m_plotter->GetPlotterType() == PLOT_FORMAT::DXF )
898 {
899 if( GetDXFPlotMode() == FILLED )
900 m_plotter->PlotPoly( outline, FILL_T::FILLED_SHAPE, 0, getMetadata() );
901 }
902 else
903 {
904 m_plotter->PlotPoly( outline, FILL_T::FILLED_SHAPE, 0, getMetadata() );
905 }
906 }
907
908 m_plotter->EndBlock( nullptr ); // Clear object attributes
909}
910
911
913{
914 if( !( m_layerMask & aShape->GetLayerSet() ).any() )
915 return;
916
917 int thickness = aShape->GetWidth();
918 int margin = thickness; // unclamped thickness (can be negative)
919 LINE_STYLE lineStyle = aShape->GetStroke().GetLineStyle();
920 bool onCopperLayer = ( LSET::AllCuMask() & m_layerMask ).any();
921 bool onSolderMaskLayer = ( LSET( { F_Mask, B_Mask } ) & m_layerMask ).any();
922 bool isSolidFill = aShape->IsSolidFill();
923 bool isHatchedFill = aShape->IsHatchedFill();
924
925 if( onSolderMaskLayer
926 && aShape->HasSolderMask()
927 && IsExternalCopperLayer( aShape->GetLayer() ) )
928 {
929 margin += 2 * aShape->GetSolderMaskExpansion();
930 thickness = std::max( margin, 0 );
931
932 if( isHatchedFill )
933 {
934 isSolidFill = true;
935 isHatchedFill = false;
936 }
937 }
938
939 m_plotter->SetColor( getColor( aShape->GetLayer() ) );
940
941 const FOOTPRINT* parentFP = aShape->GetParentFootprint();
942 GBR_METADATA gbr_metadata;
943 const wxString variantName = m_board ? m_board->GetCurrentVariant() : wxString();
944 const bool parentDnp = parentFP ? parentFP->GetDNPForVariant( variantName ) : false;
945
946 if( parentFP )
947 {
948 gbr_metadata.SetCmpReference( parentFP->GetReference() );
950 }
951
952 if( parentFP && parentDnp && GetSketchDNPFPsOnFabLayers() )
953 {
954 if( aShape->GetLayer() == F_Fab || aShape->GetLayer() == B_Fab )
955 {
956 thickness = GetSketchPadLineWidth();
957 isSolidFill = false;
958 isHatchedFill = false;
959 }
960 }
961
962 if( aShape->GetLayer() == Edge_Cuts )
963 {
965 }
966 else if( onCopperLayer )
967 {
968 if( parentFP )
969 {
971 gbr_metadata.SetCopper( true );
972 }
973 else if( aShape->GetNetCode() > 0 )
974 {
975 gbr_metadata.SetCopper( true );
978 gbr_metadata.SetNetName( aShape->GetNetname() );
979 }
980 else
981 {
982 // Graphic items (PCB_SHAPE, TEXT) having no net have the NonConductor attribute
983 // Graphic items having a net have the Conductor attribute, but are not (yet?)
984 // supported in Pcbnew
986 }
987 }
988
989 if( lineStyle <= LINE_STYLE::FIRST_TYPE )
990 {
991 switch( aShape->GetShape() )
992 {
993 case SHAPE_T::SEGMENT:
994 m_plotter->ThickSegment( aShape->GetStart(), aShape->GetEnd(), thickness, getMetadata() );
995 break;
996
997 case SHAPE_T::CIRCLE:
998 if( isSolidFill )
999 {
1000 int diameter = aShape->GetRadius() * 2 + thickness;
1001
1002 if( margin < 0 )
1003 {
1004 diameter += margin;
1005 diameter = std::max( diameter, 0 );
1006 }
1007
1008 m_plotter->FilledCircle( aShape->GetStart(), diameter, getMetadata() );
1009 }
1010 else
1011 {
1012 m_plotter->ThickCircle( aShape->GetStart(), aShape->GetRadius() * 2, thickness,
1013 getMetadata() );
1014 }
1015
1016 break;
1017
1018 case SHAPE_T::ARC:
1019 {
1020 // when startAngle == endAngle ThickArc() doesn't know whether it's 0 deg and 360 deg
1021 // but it is a circle
1022 if( std::abs( aShape->GetArcAngle().AsDegrees() ) == 360.0 )
1023 {
1024 m_plotter->ThickCircle( aShape->GetCenter(), aShape->GetRadius() * 2, thickness,
1025 getMetadata() );
1026 }
1027 else
1028 {
1029 m_plotter->ThickArc( *aShape, getMetadata(), thickness );
1030 }
1031
1032 break;
1033 }
1034
1035 case SHAPE_T::BEZIER:
1036 m_plotter->BezierCurve( aShape->GetStart(), aShape->GetBezierC1(),
1037 aShape->GetBezierC2(), aShape->GetEnd(), 0, thickness );
1038 break;
1039
1040 case SHAPE_T::POLY:
1041 if( aShape->IsPolyShapeValid() )
1042 {
1043 if( m_plotter->GetPlotterType() == PLOT_FORMAT::DXF && GetDXFPlotMode() == SKETCH )
1044 {
1045 m_plotter->ThickPoly( aShape->GetPolyShape(), thickness, getMetadata() );
1046 }
1047 else
1048 {
1049 m_plotter->SetCurrentLineWidth( thickness, &gbr_metadata );
1050
1051 // Draw the polygon: only one polygon is expected
1052 // However we provide a multi polygon shape drawing
1053 // ( for the future or to show a non expected shape )
1054 // This must be simplified and fractured to prevent overlapping polygons
1055 // from generating invalid Gerber files
1057 tmpPoly.Fracture();
1058
1059 if( margin < 0 )
1060 tmpPoly.Inflate( margin / 2, CORNER_STRATEGY::ROUND_ALL_CORNERS, aShape->GetMaxError() );
1061
1062 FILL_T fill = isSolidFill ? FILL_T::FILLED_SHAPE : FILL_T::NO_FILL;
1063
1064 for( int jj = 0; jj < tmpPoly.OutlineCount(); ++jj )
1065 {
1066 SHAPE_LINE_CHAIN& poly = tmpPoly.Outline( jj );
1067
1068 // Ensure the polygon is closed:
1069 poly.SetClosed( true );
1070
1071 // Plot the current filled area
1072 // (as region for Gerber plotter to manage attributes)
1073 if( m_plotter->GetPlotterType() == PLOT_FORMAT::GERBER )
1074 {
1075 GERBER_PLOTTER* gbr_plotter = static_cast<GERBER_PLOTTER*>( m_plotter );
1076 gbr_plotter->PlotPolyAsRegion( poly, fill, thickness, &gbr_metadata );
1077 }
1078 else
1079 {
1080 m_plotter->PlotPoly( poly, fill, thickness, getMetadata() );
1081 }
1082 }
1083 }
1084 }
1085
1086 break;
1087
1088 case SHAPE_T::RECTANGLE:
1089 {
1090 int radius = aShape->GetCornerRadius();
1091
1092 if( radius == 0 && m_plotter->GetPlotterType() == PLOT_FORMAT::DXF &&
1093 GetDXFPlotMode() == SKETCH )
1094 {
1095 std::vector<VECTOR2I> pts = aShape->GetRectCorners();
1096 m_plotter->ThickRect( pts[0], pts[2], thickness, getMetadata() );
1097 }
1098 else
1099 {
1100 BOX2I box( aShape->GetStart(), VECTOR2I( aShape->GetEnd().x - aShape->GetStart().x,
1101 aShape->GetEnd().y - aShape->GetStart().y ) );
1102 box.Normalize();
1103
1104 if( margin < 0 )
1105 {
1106 box.Inflate( margin );
1107 radius += margin;
1108 }
1109
1110 SHAPE_RECT rect( box );
1111 rect.SetRadius( radius );
1112
1113 SHAPE_LINE_CHAIN outline = rect.Outline();
1114 SHAPE_POLY_SET poly( outline );
1115
1116 FILL_T fill_mode = isSolidFill ? FILL_T::FILLED_SHAPE : FILL_T::NO_FILL;
1117
1118 if( poly.OutlineCount() > 0 )
1119 {
1120 if( m_plotter->GetPlotterType() == PLOT_FORMAT::GERBER )
1121 {
1122 GERBER_PLOTTER* gbr_plotter = static_cast<GERBER_PLOTTER*>( m_plotter );
1123 gbr_plotter->PlotPolyAsRegion( poly.COutline( 0 ), fill_mode, thickness, &gbr_metadata );
1124 }
1125 else
1126 {
1127 // TODO: PlotPoly needs to handle arcs...
1128 m_plotter->PlotPoly( poly.COutline( 0 ), fill_mode, thickness, getMetadata() );
1129 }
1130 }
1131 }
1132
1133 break;
1134 }
1135
1136 default:
1138 }
1139 }
1140 else
1141 {
1142 std::vector<SHAPE*> shapes = aShape->MakeEffectiveShapes( true );
1143
1144 for( SHAPE* shape : shapes )
1145 {
1146 STROKE_PARAMS::Stroke( shape, lineStyle, aShape->GetWidth(),
1147 m_plotter->RenderSettings(),
1148 [&]( const VECTOR2I& a, const VECTOR2I& b )
1149 {
1150 m_plotter->ThickSegment( a, b, thickness, getMetadata() );
1151 } );
1152 }
1153
1154 for( SHAPE* shape : shapes )
1155 delete shape;
1156 }
1157
1158 if( isHatchedFill )
1159 {
1160 for( int ii = 0; ii < aShape->GetHatching().OutlineCount(); ++ii )
1161 {
1162 if( m_plotter->GetPlotterType() == PLOT_FORMAT::GERBER )
1163 {
1164 GERBER_PLOTTER* gbr_plotter = static_cast<GERBER_PLOTTER*>( m_plotter );
1165 gbr_plotter->PlotPolyAsRegion( aShape->GetHatching().Outline( ii ),
1166 FILL_T::FILLED_SHAPE, 0, &gbr_metadata );
1167 }
1168 else
1169 {
1170 m_plotter->PlotPoly( aShape->GetHatching().Outline( ii ), FILL_T::FILLED_SHAPE,
1171 0, getMetadata() );
1172 }
1173 }
1174 }
1175}
1176
1177
1179{
1180 if( !m_layerMask[aBarCode->GetLayer()] )
1181 return;
1182
1183 // To avoid duplicate code, build a PCB_SHAPE to plot the polygon shape
1184 PCB_SHAPE dummy( aBarCode->GetParent(), SHAPE_T::POLY );
1185 dummy.SetLayer( aBarCode->GetLayer() );
1186 dummy.SetFillMode( FILL_T::FILLED_SHAPE );
1187 dummy.SetWidth( 0 );
1188
1189 SHAPE_POLY_SET shape;
1190 aBarCode->TransformShapeToPolySet( shape, aBarCode->GetLayer(), 0, 0, ERROR_INSIDE );
1191 dummy.SetPolyShape( shape );
1192
1193 PlotShape( &dummy );
1194}
1195
1196
1198{
1199 if( !m_layerMask[aTable->GetLayer()] )
1200 return;
1201
1202 GBR_METADATA gbr_metadata;
1203
1204 if( const FOOTPRINT* parentFP = aTable->GetParentFootprint() )
1205 {
1206 gbr_metadata.SetCmpReference( parentFP->GetReference() );
1208 }
1209
1210 aTable->DrawBorders(
1211 [&]( const VECTOR2I& ptA, const VECTOR2I& ptB, const STROKE_PARAMS& stroke )
1212 {
1213 int lineWidth = stroke.GetWidth();
1214 LINE_STYLE lineStyle = stroke.GetLineStyle();
1215
1216 if( lineStyle <= LINE_STYLE::FIRST_TYPE )
1217 {
1218 m_plotter->ThickSegment( ptA, ptB, lineWidth, getMetadata() );
1219 }
1220 else
1221 {
1222 SHAPE_SEGMENT seg( ptA, ptB );
1223
1224 STROKE_PARAMS::Stroke( &seg, lineStyle, lineWidth, m_plotter->RenderSettings(),
1225 [&]( const VECTOR2I& a, const VECTOR2I& b )
1226 {
1227 m_plotter->ThickSegment( a, b, lineWidth, getMetadata() );
1228 } );
1229 }
1230 } );
1231}
1232
1233
1235 const VECTOR2I& aDrillSize, const VECTOR2I& aPadSize,
1236 const EDA_ANGLE& aOrientation, int aSmallDrill )
1237{
1238 VECTOR2I drillSize = aDrillSize;
1239
1240 // Small drill marks have no significance when applied to slots
1241 if( aSmallDrill && aDrillShape == PAD_DRILL_SHAPE::CIRCLE )
1242 drillSize.x = std::min( aSmallDrill, drillSize.x );
1243
1244 // Round holes only have x diameter, slots have both
1245 drillSize.x -= getFineWidthAdj();
1246 drillSize.x = std::clamp( drillSize.x, 1, aPadSize.x - 1 );
1247
1248 if( aDrillShape == PAD_DRILL_SHAPE::OBLONG )
1249 {
1250 drillSize.y -= getFineWidthAdj();
1251 drillSize.y = std::clamp( drillSize.y, 1, aPadSize.y - 1 );
1252
1253 m_plotter->FlashPadOval( aDrillPos, drillSize, aOrientation, nullptr );
1254 }
1255 else
1256 {
1257 m_plotter->FlashPadCircle( aDrillPos, drillSize.x, nullptr );
1258 }
1259}
1260
1261
1263{
1264 int smallDrill = 0;
1265
1267 smallDrill = pcbIUScale.mmToIU( ADVANCED_CFG::GetCfg().m_SmallDrillMarkSize );
1268
1269 /* Drill marks are drawn white-on-black to knock-out the underlying pad. This works only
1270 * for drivers supporting color change, obviously... it means that:
1271 - PS, SVG and PDF output is correct (i.e. you have a 'donut' pad)
1272 - In gerbers you can't see them. This is arguably the right thing to do since having
1273 drill marks and high speed drill stations is a sure recipe for broken tools and angry
1274 manufacturers. If you *really* want them you could start a layer with negative
1275 polarity to knock-out the film.
1276 - In DXF they go into the 'WHITE' layer. This could be useful.
1277 */
1278 if( m_plotter->GetPlotterType() != PLOT_FORMAT::DXF || GetDXFPlotMode() == FILLED )
1279 m_plotter->SetColor( WHITE );
1280
1281 for( PCB_TRACK* track : m_board->Tracks() )
1282 {
1283 if( track->Type() == PCB_VIA_T )
1284 {
1285 const PCB_VIA* via = static_cast<const PCB_VIA*>( track );
1286
1287 // Via are not always on all layers
1288 if( ( via->GetLayerSet() & m_layerMask ).none() )
1289 continue;
1290
1292 VECTOR2I( via->GetDrillValue(), 0 ),
1293 VECTOR2I( via->GetWidth( PADSTACK::ALL_LAYERS ), 0 ),
1294 ANGLE_0, smallDrill );
1295 }
1296 }
1297
1298 for( FOOTPRINT* footprint : m_board->Footprints() )
1299 {
1300 for( PAD* pad : footprint->Pads() )
1301 {
1302 if( pad->GetDrillSize().x == 0 )
1303 continue;
1304
1305 if( m_plotter->GetPlotterType() != PLOT_FORMAT::DXF || GetDXFPlotMode() == FILLED )
1306 {
1307 // Drill mark is in black unless we can find something to knock it out of
1308 m_plotter->SetColor( BLACK );
1309
1310 for( PCB_LAYER_ID layer : m_layerMask )
1311 {
1312 if( !pad->IsOnLayer( layer ) )
1313 continue;
1314
1315 VECTOR2I padSize = pad->GetSize( layer );
1316
1317 if( padSize.x > pad->GetDrillSizeX() || padSize.y > pad->GetDrillSizeY() )
1318 {
1319 m_plotter->SetColor( WHITE );
1320 break;
1321 }
1322 }
1323 }
1324
1325 plotOneDrillMark( pad->GetDrillShape(), pad->GetPosition(), pad->GetDrillSize(),
1326 pad->GetSize( PADSTACK::ALL_LAYERS ), pad->GetOrientation(), smallDrill );
1327 }
1328 }
1329
1330 if( m_plotter->GetPlotterType() != PLOT_FORMAT::DXF || GetDXFPlotMode() == FILLED )
1331 m_plotter->SetColor( BLACK );
1332}
@ ERROR_INSIDE
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
constexpr int ARC_LOW_DEF
Definition base_units.h:128
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition board_item.h:84
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition board_item.h:237
virtual bool IsKnockout() const
Definition board_item.h:324
FOOTPRINT * GetParentFootprint() const
virtual void TransformShapeToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, KIGFX::RENDER_SETTINGS *aRenderSettings=nullptr) const
Convert the item shape to a polyset.
Definition board_item.h:430
const KIFONT::METRICS & GetFontMetrics() const
BOARD_ITEM_CONTAINER * GetParent() const
Definition board_item.h:215
int GetMaxError() const
constexpr BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition box2.h:558
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition box2.h:146
constexpr Vec Centre() const
Definition box2.h:97
constexpr coord_type GetLeft() const
Definition box2.h:228
constexpr coord_type GetRight() const
Definition box2.h:217
constexpr const SizeVec & GetSize() const
Definition box2.h:206
constexpr coord_type GetTop() const
Definition box2.h:229
constexpr coord_type GetBottom() const
Definition box2.h:222
void PlotDrillMarks()
Draw a drill mark for pads and vias.
void PlotZone(const ZONE *aZone, PCB_LAYER_ID aLayer, const SHAPE_POLY_SET &aPolysList)
void PlotPadNumber(const PAD *aPad, const COLOR4D &aColor)
void PlotBoardGraphicItem(const BOARD_ITEM *item)
Plot items like text and graphics but not tracks and footprints.
void PlotPad(const PAD *aPad, PCB_LAYER_ID aLayer, const COLOR4D &aColor, bool aSketchMode)
Plot a pad.
void PlotDimension(const PCB_DIMENSION_BASE *aDim)
void PlotText(const EDA_TEXT *aText, PCB_LAYER_ID aLayer, bool aIsKnockout, const KIFONT::METRICS &aFontMetrics, bool aStrikeout=false)
BOARD * m_board
Definition pcbplot.h:155
void PlotShape(const PCB_SHAPE *aShape)
PLOTTER * m_plotter
Definition pcbplot.h:154
bool crossoutDNPItems(PCB_LAYER_ID aLayer)
Definition pcbplot.h:140
void PlotBarCode(const PCB_BARCODE *aBarCode)
COLOR4D getColor(int aLayer) const
White color is special because it cannot be seen on a white paper in B&W mode.
void PlotPcbTarget(const PCB_TARGET *aMire)
void PlotTableBorders(const PCB_TABLE *aTable)
void PlotFootprintTextItems(const FOOTPRINT *aFootprint)
int getFineWidthAdj() const
Definition pcbplot.h:78
void plotOneDrillMark(PAD_DRILL_SHAPE aDrillShape, const VECTOR2I &aDrillPos, const VECTOR2I &aDrillSize, const VECTOR2I &aPadSize, const EDA_ANGLE &aOrientation, int aSmallDrill)
Helper function to plot a single drill mark.
bool hideDNPItems(PCB_LAYER_ID aLayer)
Definition pcbplot.h:135
void PlotFootprintGraphicItems(const FOOTPRINT *aFootprint)
static const COLOR4D WHITE
Definition color4d.h:405
COLOR4D GetColor(int aLayer) const
double AsDegrees() const
Definition eda_angle.h:116
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:111
EDA_ANGLE GetArcAngle() const
const VECTOR2I & GetBezierC2() const
Definition eda_shape.h:259
const SHAPE_POLY_SET & GetHatching() const
Definition eda_shape.h:148
virtual std::vector< SHAPE * > MakeEffectiveShapes(bool aEdgeOnly=false) const
Make a set of SHAPE objects representing the EDA_SHAPE.
Definition eda_shape.h:379
SHAPE_POLY_SET & GetPolyShape()
Definition eda_shape.h:337
int GetRadius() const
SHAPE_T GetShape() const
Definition eda_shape.h:169
bool IsHatchedFill() const
Definition eda_shape.h:124
virtual void SetFilled(bool aFlag)
Definition eda_shape.h:136
bool IsSolidFill() const
Definition eda_shape.h:117
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
Definition eda_shape.h:216
void SetStart(const VECTOR2I &aStart)
Definition eda_shape.h:178
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
Definition eda_shape.h:174
void SetShape(SHAPE_T aShape)
Definition eda_shape.h:168
std::vector< VECTOR2I > GetRectCorners() const
void SetEnd(const VECTOR2I &aEnd)
Definition eda_shape.h:220
wxString SHAPE_T_asString() const
const VECTOR2I & GetBezierC1() const
Definition eda_shape.h:256
int GetCornerRadius() const
bool IsPolyShapeValid() const
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:80
const VECTOR2I & GetTextPos() const
Definition eda_text.h:273
bool IsMultilineAllowed() const
Definition eda_text.h:197
virtual bool IsVisible() const
Definition eda_text.h:187
std::vector< std::unique_ptr< KIFONT::GLYPH > > * GetRenderCache(const KIFONT::FONT *aFont, const wxString &forResolvedText, const VECTOR2I &aOffset={ 0, 0 }) const
Definition eda_text.cpp:697
virtual EDA_ANGLE GetDrawRotation() const
Definition eda_text.h:379
virtual KIFONT::FONT * GetDrawFont(const RENDER_SETTINGS *aSettings) const
Definition eda_text.cpp:661
const TEXT_ATTRIBUTES & GetAttributes() const
Definition eda_text.h:231
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition eda_text.cpp:479
void GetLinePositions(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPositions, int aLineCount) const
Populate aPositions with the position of each line of a multiline text, according to the vertical jus...
Definition eda_text.cpp:925
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition eda_text.h:109
PCB_FIELD & Value()
read/write accessors:
Definition footprint.h:787
LSET GetPrivateLayers() const
Definition footprint.h:246
PCB_FIELD & Reference()
Definition footprint.h:788
bool GetDNPForVariant(const wxString &aVariantName) const
Get the DNP status for a specific variant.
void GetFields(std::vector< PCB_FIELD * > &aVector, bool aVisibleOnly) const
Populate a std::vector with PCB_TEXTs.
const wxString & GetReference() const
Definition footprint.h:751
DRAWINGS & GraphicalItems()
Definition footprint.h:309
@ GBR_APERTURE_ATTRIB_CONDUCTOR
Aperture used for connected items like tracks (not vias).
@ GBR_APERTURE_ATTRIB_ETCHEDCMP
Aperture used for etched components.
@ GBR_APERTURE_ATTRIB_BGAPAD_CUDEF
Aperture used for BGA pad with a solder mask defined by the solder mask.
@ GBR_APERTURE_ATTRIB_HEATSINKPAD
Aperture used for heat sink pad (typically for SMDs).
@ GBR_APERTURE_ATTRIB_TESTPOINT
Aperture used for test point pad (outer layers).
@ GBR_APERTURE_ATTRIB_SMDPAD_CUDEF
Aperture used for SMD pad with a solder mask defined by the solder mask.
@ GBR_APERTURE_ATTRIB_CONNECTORPAD
Aperture used for edge connector pad (outer layers).
@ GBR_APERTURE_ATTRIB_NONCONDUCTOR
Aperture used for not connected items (texts, outlines on copper).
@ GBR_APERTURE_ATTRIB_WASHERPAD
Aperture used for mechanical pads (NPTH).
@ GBR_APERTURE_ATTRIB_COMPONENTPAD
Aperture used for through hole component on outer layer.
@ GBR_APERTURE_ATTRIB_FIDUCIAL_GLBL
Aperture used for fiducial pad (outer layers), at board level.
@ GBR_APERTURE_ATTRIB_CASTELLATEDPAD
Aperture used for castellated pads in copper layer files.
@ GBR_APERTURE_ATTRIB_FIDUCIAL_LOCAL
Aperture used for fiducial pad (outer layers), at footprint level.
@ GBR_APERTURE_ATTRIB_EDGECUT
Aperture used for board cutout,.
Metadata which can be added in a gerber file as attribute in X2 format.
void SetCopper(bool aValue)
void SetCmpReference(const wxString &aComponentRef)
void SetNetName(const wxString &aNetname)
void SetPadPinFunction(const wxString &aPadPinFunction, bool aUseUTF8, bool aEscapeString)
void SetApertureAttrib(GBR_APERTURE_METADATA::GBR_APERTURE_ATTRIB aApertAttribute)
GBR_NETLIST_METADATA m_NetlistMetadata
An item to handle object attribute.
void SetNetAttribType(int aNetAttribType)
void SetPadName(const wxString &aPadname, bool aUseUTF8=false, bool aEscapeString=false)
@ GBR_NETINFO_NET
print info associated to a net (TO.N attribute)
@ GBR_NETINFO_CMP
print info associated to a component (TO.C attribute)
bool m_NotInNet
true if a pad of a footprint cannot be connected (for instance a mechanical NPTH, ot a not named pad)...
void FlashPadChamferRoundRect(const VECTOR2I &aShapePos, const VECTOR2I &aPadSize, int aCornerRadius, double aChamferRatio, int aChamferPositions, const EDA_ANGLE &aPadOrient, void *aData)
Flash a chamfered round rect pad.
void PlotPolyAsRegion(const SHAPE_LINE_CHAIN &aPoly, FILL_T aFill, int aWidth, GBR_METADATA *aGbrMetadata)
Similar to PlotPoly(), plot a filled polygon using Gerber region, therefore adding X2 attributes to t...
FONT is an abstract base class for both outline and stroke fonts.
Definition font.h:98
virtual bool IsOutline() const
Definition font.h:106
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:105
virtual void DrawGlyphs(const std::vector< std::unique_ptr< KIFONT::GLYPH > > &aGlyphs)
Draw polygons representing font glyphs.
LSET is a set of PCB_LAYER_IDs.
Definition lset.h:37
static const LSET & ExternalCuMask()
Return a mask holding the Front and Bottom layers.
Definition lset.cpp:634
static LSET AllCuMask()
return AllCuMask( MAX_CU_LAYERS );
Definition lset.cpp:608
static constexpr PCB_LAYER_ID ALL_LAYERS
! Temporary layer identifier to identify code that is not padstack-aware
Definition padstack.h:177
Definition pad.h:55
PAD_PROP GetProperty() const
Definition pad.h:566
static wxString ShowPadShape(PAD_SHAPE aShape)
Definition pad.cpp:2082
const std::vector< std::shared_ptr< PCB_SHAPE > > & GetPrimitives(PCB_LAYER_ID aLayer) const
Accessor to the basic shape list for custom-shaped pads.
Definition pad.h:377
int GetRoundRectCornerRadius(PCB_LAYER_ID aLayer) const
Definition pad.cpp:891
const BOX2I GetBoundingBox() const override
The bounding box is cached, so this will be efficient most of the time.
Definition pad.cpp:1332
PAD_ATTRIB GetAttribute() const
Definition pad.h:563
const wxString & GetPinFunction() const
Definition pad.h:148
const wxString & GetNumber() const
Definition pad.h:137
const VECTOR2I & GetDelta(PCB_LAYER_ID aLayer) const
Definition pad.h:304
PAD_SHAPE GetShape(PCB_LAYER_ID aLayer) const
Definition pad.h:196
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc=ERROR_INSIDE, bool ignoreLineWidth=false) const override
Convert the pad shape to a closed polygon.
Definition pad.cpp:2508
EDA_ANGLE GetOrientation() const
Return the rotation angle of the pad.
Definition pad.h:420
int GetChamferPositions(PCB_LAYER_ID aLayer) const
Definition pad.h:836
const std::shared_ptr< SHAPE_POLY_SET > & GetEffectivePolygon(PCB_LAYER_ID aLayer, ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Definition pad.cpp:949
double GetChamferRectRatio(PCB_LAYER_ID aLayer) const
Definition pad.h:819
VECTOR2I ShapePos(PCB_LAYER_ID aLayer) const
Definition pad.cpp:1536
const VECTOR2I & GetSize(PCB_LAYER_ID aLayer) const
Definition pad.h:264
Abstract dimension API.
int GetLineThickness() const
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
bool GetSketchDNPFPsOnFabLayers() const
PLOT_TEXT_MODE GetTextMode() const override
bool GetPlotReference() const
DXF_OUTLINE_MODE GetDXFPlotMode() const override
int GetSketchPadLineWidth() const
DRILL_MARKS GetDrillMarksType() const
bool GetPlotValue() const
bool GetPlotFPText() const
COLOR_SETTINGS * ColorSettings() const
VECTOR2I GetCenter() const override
This defaults to the center of the bounding box if not overridden.
Definition pcb_shape.h:81
int GetWidth() const override
bool HasSolderMask() const
Definition pcb_shape.h:207
int GetSolderMaskExpansion() const
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
STROKE_PARAMS GetStroke() const override
Definition pcb_shape.h:91
void SetStroke(const STROKE_PARAMS &aStroke) override
Definition pcb_shape.h:92
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition pcb_shape.h:71
void DrawBorders(const std::function< void(const VECTOR2I &aPt1, const VECTOR2I &aPt2, const STROKE_PARAMS &aStroke)> &aCallback) const
int GetShape() const
Definition pcb_target.h:58
int GetWidth() const
Definition pcb_target.h:64
int GetSize() const
Definition pcb_target.h:61
VECTOR2I GetPosition() const override
Definition pcb_target.h:55
bool IsBorderEnabled() const
Disables the border, this is done by changing the stroke internally.
Definition seg.h:42
VECTOR2I A
Definition seg.h:49
VECTOR2I B
Definition seg.h:50
int GetRadius() const
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
void SetClosed(bool aClosed)
Mark the line chain as closed (i.e.
Represent a set of closed polygons.
void Rotate(const EDA_ANGLE &aAngle, const VECTOR2I &aCenter={ 0, 0 }) override
Rotate all vertices by a given angle.
bool IsEmpty() const
Return true if the set is empty (no polygons at all)
void Inflate(int aAmount, CORNER_STRATEGY aCornerStrategy, int aMaxError, bool aSimplify=false)
Perform outline inflation/deflation.
SHAPE_LINE_CHAIN & Outline(int aIndex)
Return the reference to aIndex-th outline in the set.
int OutlineCount() const
Return the number of outlines in the set.
void Fracture(bool aSimplify=true)
Convert a set of polygons with holes to a single outline with "slits"/"fractures" connecting the oute...
SHAPE_POLY_SET CloneDropTriangulation() const
const SHAPE_LINE_CHAIN & COutline(int aIndex) const
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
const SHAPE_LINE_CHAIN Outline() const
void SetRadius(int aRadius)
Definition shape_rect.h:206
const SEG & GetSeg() const
An abstract shape on 2D plane.
Definition shape.h:126
Simple container to manage line stroke parameters.
int GetWidth() const
LINE_STYLE GetLineStyle() const
static void Stroke(const SHAPE *aShape, LINE_STYLE aLineStyle, int aWidth, const KIGFX::RENDER_SETTINGS *aRenderSettings, const std::function< void(const VECTOR2I &a, const VECTOR2I &b)> &aStroker)
Handle a list of polygons defining a copper zone.
Definition zone.h:73
bool IsOnCopperLayer() const override
Definition zone.cpp:543
A type-safe container of any type.
Definition ki_any.h:93
constexpr any() noexcept
Default constructor, creates an empty object.
Definition ki_any.h:156
@ WHITE
Definition color4d.h:48
@ LIGHTGRAY
Definition color4d.h:47
@ BLACK
Definition color4d.h:44
@ ROUND_ALL_CORNERS
All angles are rounded.
static constexpr EDA_ANGLE ANGLE_0
Definition eda_angle.h:411
static constexpr EDA_ANGLE ANGLE_90
Definition eda_angle.h:413
@ SEGMENT
Definition eda_shape.h:45
@ RECTANGLE
Use RECTANGLE instead of RECT to avoid collision in a Windows header.
Definition eda_shape.h:46
FILL_T
Definition eda_shape.h:56
@ NO_FILL
Definition eda_shape.h:57
@ FILLED_SHAPE
Fill with object color.
Definition eda_shape.h:58
Handle special data (items attributes) during plot.
#define GBR_NETINFO_ALL
static const bool FILLED
Definition gr_basic.cpp:30
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition layer_ids.h:677
bool IsExternalCopperLayer(int aLayerId)
Test whether a layer is an external (F_Cu or B_Cu) copper layer.
Definition layer_ids.h:688
PCB_LAYER_ID
A quick note on layer IDs:
Definition layer_ids.h:60
@ Edge_Cuts
Definition layer_ids.h:112
@ B_Mask
Definition layer_ids.h:98
@ F_Mask
Definition layer_ids.h:97
@ F_Fab
Definition layer_ids.h:119
@ PCB_LAYER_ID_COUNT
Definition layer_ids.h:171
@ B_Fab
Definition layer_ids.h:118
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition macros.h:83
#define UNIMPLEMENTED_FOR(type)
Definition macros.h:96
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition eda_angle.h:400
PAD_DRILL_SHAPE
The set of pad drill shapes, used with PAD::{Set,Get}DrillShape()
Definition padstack.h:69
@ NPTH
like PAD_PTH, but not plated mechanical use only, no connection allowed
Definition padstack.h:103
@ SMD
Smd pad, appears on the solder paste layer (default)
Definition padstack.h:99
@ PTH
Plated through hole pad.
Definition padstack.h:98
@ CONN
Like smd, does not appear on the solder paste layer (default) Note: also has a special attribute in G...
Definition padstack.h:100
@ CHAMFERED_RECT
Definition padstack.h:60
@ ROUNDRECT
Definition padstack.h:57
@ TRAPEZOID
Definition padstack.h:56
@ RECTANGLE
Definition padstack.h:54
@ FIDUCIAL_LOCAL
a fiducial (usually a smd) local to the parent footprint
Definition padstack.h:118
@ FIDUCIAL_GLBL
a fiducial (usually a smd) for the full board
Definition padstack.h:117
@ MECHANICAL
a pad used for mechanical support
Definition padstack.h:122
@ PRESSFIT
a PTH with a hole diameter with tight tolerances for press fit pin
Definition padstack.h:123
@ HEATSINK
a pad used as heat sink, usually in SMD footprints
Definition padstack.h:120
@ NONE
no special fabrication property
Definition padstack.h:115
@ TESTPOINT
a test point pad
Definition padstack.h:119
@ CASTELLATED
a pad with a castellated through hole
Definition padstack.h:121
@ BGA
Smd pad, used in BGA footprints.
Definition padstack.h:116
BARCODE class definition.
#define getMetadata()
@ SKETCH
Definition plotter.h:81
@ SH_CIRCLE
circle
Definition shape.h:50
@ SH_SEGMENT
line segment
Definition shape.h:48
std::vector< FAB_LAYER_COLOR > dummy
wxString UnescapeString(const wxString &aSource)
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
int PrintableCharCount(const wxString &aString)
Return the number of printable (ie: non-formatting) chars.
LINE_STYLE
Dashed line types.
int radius
VECTOR2I end
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
Definition trigo.cpp:229
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition typeinfo.h:88
@ PCB_DIM_ORTHOGONAL_T
class PCB_DIM_ORTHOGONAL, a linear dimension constrained to x/y
Definition typeinfo.h:106
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition typeinfo.h:103
@ PCB_VIA_T
class PCB_VIA, a via (like a track segment on a copper layer)
Definition typeinfo.h:97
@ PCB_DIM_CENTER_T
class PCB_DIM_CENTER, a center point marking (graphic item)
Definition typeinfo.h:104
@ PCB_TEXTBOX_T
class PCB_TEXTBOX, wrapped text on a layer
Definition typeinfo.h:93
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition typeinfo.h:92
@ PCB_REFERENCE_IMAGE_T
class PCB_REFERENCE_IMAGE, bitmap on a layer
Definition typeinfo.h:89
@ PCB_BARCODE_T
class PCB_BARCODE, a barcode (graphic item)
Definition typeinfo.h:101
@ PCB_TARGET_T
class PCB_TARGET, a target (graphic item)
Definition typeinfo.h:107
@ PCB_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition typeinfo.h:102
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
Definition typeinfo.h:94
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
Definition typeinfo.h:105
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695