KiCad PCB EDA Suite
Loading...
Searching...
No Matches
create_3Dgraphic_brd_items.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) 2015-2016 Mario Luzeiro <[email protected]>
5 * Copyright (C) 2023 CERN
6 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
32#include "../3d_rendering/raytracing/shapes2D/ring_2d.h"
33#include "../3d_rendering/raytracing/shapes2D/filled_circle_2d.h"
34#include "../3d_rendering/raytracing/shapes2D/round_segment_2d.h"
35#include "../3d_rendering/raytracing/shapes2D/triangle_2d.h"
36#include <board_adapter.h>
37#include <board.h>
38#include <footprint.h>
39#include <pad.h>
40#include <pcb_text.h>
41#include <pcb_textbox.h>
42#include <pcb_table.h>
44#include <pcb_painter.h> // for PCB_RENDER_SETTINGS
45#include <zone.h>
47#include <trigo.h>
51#include <geometry/shape_rect.h>
53#include <utility>
54#include <vector>
55#include <wx/log.h>
56#include <macros.h>
57#include <callback_gal.h>
58
59
60#define TO_3DU( x ) ( ( x ) * m_biuTo3Dunits )
61
62#define TO_SFVEC2F( vec ) SFVEC2F( TO_3DU( vec.x ), TO_3DU( -vec.y ) )
63
64
65void addFILLED_CIRCLE_2D( CONTAINER_2D_BASE* aContainer, const SFVEC2F& aCenter, float aRadius,
66 const BOARD_ITEM& aBoardItem )
67{
68 if( aRadius > 0.0f )
69 aContainer->Add( new FILLED_CIRCLE_2D( aCenter, aRadius, aBoardItem ) );
70}
71
72
73void addRING_2D( CONTAINER_2D_BASE* aContainer, const SFVEC2F& aCenter, float aInnerRadius,
74 float aOuterRadius, const BOARD_ITEM& aBoardItem )
75{
76 if( aOuterRadius > aInnerRadius && aInnerRadius > 0.0f )
77 aContainer->Add( new RING_2D( aCenter, aInnerRadius, aOuterRadius, aBoardItem ) );
78}
79
80
81void addROUND_SEGMENT_2D( CONTAINER_2D_BASE* aContainer, const SFVEC2F& aStart, const SFVEC2F& aEnd,
82 float aWidth, const BOARD_ITEM& aBoardItem )
83{
84 if( Is_segment_a_circle( aStart, aEnd ) )
85 {
86 // Cannot add segments that have the same start and end point
87 addFILLED_CIRCLE_2D( aContainer, aStart, aWidth / 2, aBoardItem );
88 return;
89 }
90
91 if( aWidth > 0.0f )
92 aContainer->Add( new ROUND_SEGMENT_2D( aStart, aEnd, aWidth, aBoardItem ) );
93}
94
95
96void BOARD_ADAPTER::addText( const EDA_TEXT* aText, CONTAINER_2D_BASE* aContainer,
97 const BOARD_ITEM* aOwner )
98{
100 TEXT_ATTRIBUTES attrs = aText->GetAttributes();
101 float penWidth_3DU = TO_3DU( aText->GetEffectiveTextPenWidth() );
102 KIFONT::FONT* font = aText->GetFont();
103
104 if( !font )
105 font = KIFONT::FONT::GetFont( wxEmptyString, aText->IsBold(), aText->IsItalic() );
106
107 if( aOwner && aOwner->IsKnockout() )
108 {
109 SHAPE_POLY_SET finalPoly;
110 const PCB_TEXT* pcbText = static_cast<const PCB_TEXT*>( aOwner );
111
113 ERROR_INSIDE );
114
115 // Do not call finalPoly.Fracture() here: ConvertPolygonToTriangles() call it
116 // if needed, and Fracture() called twice can create bad results and is useless
117 ConvertPolygonToTriangles( finalPoly, *aContainer, m_biuTo3Dunits, *aOwner );
118 }
119 else
120 {
121 CALLBACK_GAL callback_gal( empty_opts,
122 // Stroke callback
123 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
124 {
125 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( aPt1 ), TO_SFVEC2F( aPt2 ),
126 penWidth_3DU, *aOwner );
127 },
128 // Triangulation callback
129 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
130 {
131 aContainer->Add( new TRIANGLE_2D( TO_SFVEC2F( aPt1 ), TO_SFVEC2F( aPt2 ),
132 TO_SFVEC2F( aPt3 ), *aOwner ) );
133 } );
134
135 attrs.m_Angle = aText->GetDrawRotation();
136
137 font->Draw( &callback_gal, aText->GetShownText( true ), aText->GetDrawPos(), attrs,
138 aOwner->GetFontMetrics() );
139 }
140}
141
142
144 const BOARD_ITEM* aOwner )
145{
146 addText( aDimension, aContainer, aDimension );
147
148 const int linewidth = aDimension->GetLineThickness();
149
150 for( const std::shared_ptr<SHAPE>& shape : aDimension->GetShapes() )
151 {
152 switch( shape->Type() )
153 {
154 case SH_SEGMENT:
155 {
156 const SEG& seg = static_cast<const SHAPE_SEGMENT*>( shape.get() )->GetSeg();
157
158 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( seg.A ), TO_SFVEC2F( seg.B ),
159 TO_3DU( linewidth ), *aOwner );
160 break;
161 }
162
163 case SH_CIRCLE:
164 {
165 int radius = static_cast<const SHAPE_CIRCLE*>( shape.get() )->GetRadius();
166 float innerR3DU = TO_3DU( radius ) - TO_3DU( aDimension->GetLineThickness() ) / 2.0f;
167 float outerR3DU = TO_3DU( radius ) + TO_3DU( aDimension->GetLineThickness() ) / 2.0f;
168
169 addRING_2D( aContainer, TO_SFVEC2F( shape->Centre() ), innerR3DU, outerR3DU, *aOwner );
170
171 break;
172 }
173
174 default:
175 break;
176 }
177 }
178}
179
180
182 PCB_LAYER_ID aLayerId,
183 const std::bitset<LAYER_3D_END>& aVisibilityFlags )
184{
186
187 for( PCB_FIELD* field : aFootprint->GetFields() )
188 {
189 if( field->GetLayer() == aLayerId && field->IsVisible() )
190 {
191 if( !aVisibilityFlags.test( LAYER_FP_TEXT ) )
192 continue;
193 else if( field->IsReference() && !aVisibilityFlags.test( LAYER_FP_REFERENCES ) )
194 continue;
195 else if( field->IsValue() && !aVisibilityFlags.test( LAYER_FP_VALUES ) )
196 continue;
197
198 addText( field, aContainer, field );
199 }
200 }
201
202 for( BOARD_ITEM* item : aFootprint->GraphicalItems() )
203 {
204 switch( item->Type() )
205 {
206 case PCB_TEXT_T:
207 {
208 PCB_TEXT* text = static_cast<PCB_TEXT*>( item );
209
210 if( text->GetLayer() == aLayerId && text->IsVisible() )
211 {
212 if( !aVisibilityFlags.test( LAYER_FP_TEXT ) )
213 continue;
214 else if( text->GetText() == wxT( "${REFERENCE}" ) && !aVisibilityFlags.test( LAYER_FP_REFERENCES ) )
215 continue;
216 else if( text->GetText() == wxT( "${VALUE}" ) && !aVisibilityFlags.test( LAYER_FP_VALUES ) )
217 continue;
218
219 addText( text, aContainer, text );
220 }
221
222 break;
223 }
224
225 case PCB_TEXTBOX_T:
226 {
227 PCB_TEXTBOX* textbox = static_cast<PCB_TEXTBOX*>( item );
228
229 if( textbox->GetLayer() == aLayerId )
230 addShape( textbox, aContainer, aFootprint );
231
232 break;
233 }
234
235 case PCB_TABLE_T:
236 {
237 PCB_TABLE* table = static_cast<PCB_TABLE*>( item );
238
239 if( table->GetLayer() == aLayerId )
240 addTable( table, aContainer, aFootprint );
241
242 break;
243 }
244
246 case PCB_DIM_CENTER_T:
248 case PCB_DIM_RADIAL_T:
249 case PCB_DIM_LEADER_T:
250 {
251 PCB_DIMENSION_BASE* dimension = static_cast<PCB_DIMENSION_BASE*>( item );
252
253 if( dimension->GetLayer() == aLayerId )
254 addShape( dimension, aContainer, aFootprint );
255
256 break;
257 }
258
259 case PCB_SHAPE_T:
260 {
261 PCB_SHAPE* shape = static_cast<PCB_SHAPE*>( item );
262
263 if( shape->GetLayer() == aLayerId )
264 addShape( shape, aContainer, aFootprint );
265
266 break;
267 }
268
269 default:
270 break;
271 }
272 }
273}
274
275
277 int aMargin )
278{
279 SFVEC2F start3DU = TO_SFVEC2F( aTrack->GetStart() );
280 SFVEC2F end3DU = TO_SFVEC2F( aTrack->GetEnd() );
281 const float radius3DU = TO_3DU( ( aTrack->GetWidth() / 2.0 ) + aMargin );
282
283 addFILLED_CIRCLE_2D( aDstContainer, start3DU, radius3DU, *aTrack );
284}
285
286
287void BOARD_ADAPTER::createTrack( const PCB_TRACK* aTrack, CONTAINER_2D_BASE* aDstContainer )
288{
289 SFVEC2F start3DU = TO_SFVEC2F( aTrack->GetStart() );
290 SFVEC2F end3DU = TO_SFVEC2F( aTrack->GetEnd() );
291
292 switch( aTrack->Type() )
293 {
294 case PCB_VIA_T:
295 addFILLED_CIRCLE_2D( aDstContainer, start3DU, TO_3DU( aTrack->GetWidth() / 2.0 ), *aTrack );
296 break;
297
298 case PCB_ARC_T:
299 {
300 const PCB_ARC* arc = static_cast<const PCB_ARC*>( aTrack );
301
302 if( arc->IsDegenerated() )
303 {
304 // Draw this very small arc like a track segment (a PCB_TRACE_T)
305 PCB_TRACK track( arc->GetParent() );
306 track.SetStart( arc->GetStart() );
307 track.SetEnd( arc->GetEnd() );
308 track.SetWidth( arc->GetWidth() );
309 track.SetLayer( arc->GetLayer() );
310
311 createTrack( &track, aDstContainer );
312 return;
313 }
314
315 VECTOR2I center( arc->GetCenter() );
316 EDA_ANGLE arc_angle = arc->GetAngle();
317 double radius = arc->GetRadius();
318 int arcsegcount = GetArcToSegmentCount( KiROUND( radius ), ARC_HIGH_DEF, arc_angle );
319 int circlesegcount;
320
321 // Avoid arcs that cannot be drawn
322 if( radius < std::numeric_limits<double>::min() || arc_angle.IsZero() )
323 break;
324
325 // We need a circle to segment count. However, the arc angle can be small, and the
326 // radius very big. so we calculate a reasonable value for circlesegcount.
327 if( arcsegcount <= 1 ) // The arc will be approximated by a segment
328 {
329 circlesegcount = 1;
330 }
331 else
332 {
333 circlesegcount = KiROUND( arcsegcount * 360.0 / std::abs( arc_angle.AsDegrees() ) );
334 circlesegcount = alg::clamp( 1, circlesegcount, 128 );
335 }
336
337 createArcSegments( center, arc->GetStart(), arc_angle, circlesegcount, arc->GetWidth(),
338 aDstContainer, *arc );
339 break;
340 }
341
342 case PCB_TRACE_T: // Track is a usual straight segment
343 {
344 addROUND_SEGMENT_2D( aDstContainer, start3DU, end3DU, TO_3DU( aTrack->GetWidth() ), *aTrack );
345 break;
346 }
347
348 default:
349 break;
350 }
351}
352
353
355 PCB_LAYER_ID aLayer, const VECTOR2I& aMargin ) const
356{
357 SHAPE_POLY_SET poly;
358 int maxError = GetBoard()->GetDesignSettings().m_MaxError;
359 VECTOR2I clearance = aMargin;
360
361 // Our shape-based builder can't handle negative or differing x:y clearance values (the
362 // former are common for solder paste while the later get generated when a relative paste
363 // margin is used with an oblong pad). So we apply this huge hack and fake a larger pad to
364 // run the general-purpose polygon builder on.
365 // Of course being a hack it falls down when dealing with custom shape pads (where the size
366 // is only the size of the anchor), so for those we punt and just use aMargin.x.
367
368 if( ( clearance.x < 0 || clearance.x != clearance.y )
369 && aPad->GetShape() != PAD_SHAPE::CUSTOM )
370 {
371 VECTOR2I dummySize = VECTOR2I( aPad->GetSize() ) + clearance + clearance;
372
373 if( dummySize.x <= 0 || dummySize.y <= 0 )
374 return;
375
376 PAD dummy( *aPad );
377 dummy.SetSize( VECTOR2I( dummySize.x, dummySize.y ) );
378 dummy.TransformShapeToPolygon( poly, aLayer, 0, maxError, ERROR_INSIDE );
379 clearance = { 0, 0 };
380
381 // Remove group membership from dummy item before deleting
382 dummy.SetParentGroup( nullptr );
383 }
384 else if( aPad->GetShape() == PAD_SHAPE::CUSTOM )
385 {
386 // A custom pad can have many complex subshape items. To avoid issues, use its
387 // final polygon shape, not its basic shape set. One cannot apply the clearance
388 // to each subshape: it does no work
389 aPad->TransformShapeToPolygon( poly, aLayer, 0, maxError );
390 }
391 else
392 {
393 auto padShapes = std::static_pointer_cast<SHAPE_COMPOUND>( aPad->GetEffectiveShape() );
394
395 for( const SHAPE* shape : padShapes->Shapes() )
396 {
397 switch( shape->Type() )
398 {
399 case SH_SEGMENT:
400 {
401 const SHAPE_SEGMENT* seg = static_cast<const SHAPE_SEGMENT*>( shape );
402
403 addROUND_SEGMENT_2D( aContainer,
404 TO_SFVEC2F( seg->GetSeg().A ),
405 TO_SFVEC2F( seg->GetSeg().B ),
406 TO_3DU( seg->GetWidth() + clearance.x * 2 ),
407 *aPad );
408 break;
409 }
410
411 case SH_CIRCLE:
412 {
413 const SHAPE_CIRCLE* circle = static_cast<const SHAPE_CIRCLE*>( shape );
414
415 addFILLED_CIRCLE_2D( aContainer,
416 TO_SFVEC2F( circle->GetCenter() ),
417 TO_3DU( circle->GetRadius() + clearance.x ),
418 *aPad );
419 break;
420 }
421
422 case SH_RECT:
423 {
424 const SHAPE_RECT* rect = static_cast<const SHAPE_RECT*>( shape );
425
426 poly.NewOutline();
427 poly.Append( rect->GetPosition() );
428 poly.Append( rect->GetPosition().x + rect->GetSize().x, rect->GetPosition().y );
429 poly.Append( rect->GetPosition() + rect->GetSize() );
430 poly.Append( rect->GetPosition().x, rect->GetPosition().y + rect->GetSize().y );
431 break;
432 }
433
434 case SH_SIMPLE:
435 poly.AddOutline( static_cast<const SHAPE_SIMPLE*>( shape )->Vertices() );
436 break;
437
438 case SH_POLY_SET:
439 poly.Append( *static_cast<const SHAPE_POLY_SET*>( shape ) );
440 break;
441
442 case SH_ARC:
443 {
444 const SHAPE_ARC* arc = static_cast<const SHAPE_ARC*>( shape );
445 SHAPE_LINE_CHAIN l = arc->ConvertToPolyline( maxError );
446
447 for( int i = 0; i < l.SegmentCount(); i++ )
448 {
449 SHAPE_SEGMENT seg( l.Segment( i ).A, l.Segment( i ).B, arc->GetWidth() );
450
451 addROUND_SEGMENT_2D( aContainer,
452 TO_SFVEC2F( seg.GetSeg().A ),
453 TO_SFVEC2F( seg.GetSeg().B ),
454 TO_3DU( arc->GetWidth() + clearance.x * 2 ),
455 *aPad );
456 }
457
458 break;
459 }
460
461 default:
462 UNIMPLEMENTED_FOR( SHAPE_TYPE_asString( shape->Type() ) );
463 break;
464 }
465 }
466 }
467
468 if( !poly.IsEmpty() )
469 {
470 if( clearance.x )
471 poly.Inflate( clearance.x, CORNER_STRATEGY::ROUND_ALL_CORNERS, maxError );
472
473 // Add the PAD polygon
474 ConvertPolygonToTriangles( poly, *aContainer, m_biuTo3Dunits, *aPad );
475 }
476}
477
478
480 int aInflateValue )
481{
482 if( !aPad->HasHole() )
483 {
484 wxLogTrace( m_logTrace, wxT( "BOARD_ADAPTER::createPadWithHole - found an invalid pad" ) );
485 return;
486 }
487
488 std::shared_ptr<SHAPE_SEGMENT> slot = aPad->GetEffectiveHoleShape();
489
490 addROUND_SEGMENT_2D( aDstContainer,
491 TO_SFVEC2F( slot->GetSeg().A ),
492 TO_SFVEC2F( slot->GetSeg().B ),
493 TO_3DU( slot->GetWidth() + aInflateValue * 2 ),
494 *aPad );
495}
496
497
498void BOARD_ADAPTER::addPads( const FOOTPRINT* aFootprint, CONTAINER_2D_BASE* aContainer,
499 PCB_LAYER_ID aLayerId, bool aSkipPlatedPads, bool aSkipNonPlatedPads )
500{
501 for( PAD* pad : aFootprint->Pads() )
502 {
503 if( !pad->IsOnLayer( aLayerId ) )
504 continue;
505
506 if( IsCopperLayer( aLayerId ) )
507 {
508 // Skip pad annulus when there isn't one (note: this is more discerning than
509 // pad->IsOnLayer(), which doesn't check for NPTH pads with holes that consume
510 // the entire pad).
511 if( !pad->IsOnCopperLayer() )
512 continue;
513
514 // Skip pad annulus when not connected on this layer (if removing is enabled)
515 if( !pad->FlashLayer( aLayerId ) )
516 continue;
517 }
518
519 VECTOR2I margin( 0, 0 );
520
521 switch( aLayerId )
522 {
523 case F_Cu:
524 if( aSkipPlatedPads && pad->FlashLayer( F_Mask ) )
525 continue;
526
527 if( aSkipNonPlatedPads && !pad->FlashLayer( F_Mask ) )
528 continue;
529
530 break;
531
532 case B_Cu:
533 if( aSkipPlatedPads && pad->FlashLayer( B_Mask ) )
534 continue;
535
536 if( aSkipNonPlatedPads && !pad->FlashLayer( B_Mask ) )
537 continue;
538
539 break;
540
541 case F_Mask:
542 case B_Mask:
543 margin.x += pad->GetSolderMaskExpansion();
544 margin.y += pad->GetSolderMaskExpansion();
545 break;
546
547 case F_Paste:
548 case B_Paste:
549 margin += pad->GetSolderPasteMargin();
550 break;
551
552 default:
553 break;
554 }
555
556 createPadWithMargin( pad, aContainer, aLayerId, margin );
557 }
558}
559
560
561// based on TransformArcToPolygon function from
562// common/convert_basic_shapes_to_polygon.cpp
563void BOARD_ADAPTER::createArcSegments( const VECTOR2I& aCentre, const VECTOR2I& aStart,
564 const EDA_ANGLE& aArcAngle, int aCircleToSegmentsCount,
565 int aWidth, CONTAINER_2D_BASE* aContainer,
566 const BOARD_ITEM& aOwner )
567{
568 // Don't attempt to render degenerate shapes
569 if( aWidth == 0 )
570 return;
571
572 VECTOR2I arc_start, arc_end;
573 EDA_ANGLE arcAngle( aArcAngle );
574 EDA_ANGLE delta = ANGLE_360 / aCircleToSegmentsCount; // rotate angle
575
576 arc_end = arc_start = aStart;
577
578 if( arcAngle != ANGLE_360 )
579 RotatePoint( arc_end, aCentre, -arcAngle );
580
581 if( arcAngle < ANGLE_0 )
582 {
583 std::swap( arc_start, arc_end );
584 arcAngle = -arcAngle;
585 }
586
587 // Compute the ends of segments and creates poly
588 VECTOR2I curr_end = arc_start;
589 VECTOR2I curr_start = arc_start;
590
591 for( EDA_ANGLE ii = delta; ii < arcAngle; ii += delta )
592 {
593 curr_end = arc_start;
594 RotatePoint( curr_end, aCentre, -ii );
595
596 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( curr_start ), TO_SFVEC2F( curr_end ),
597 TO_3DU( aWidth ), aOwner );
598
599 curr_start = curr_end;
600 }
601
602 if( curr_end != arc_end )
603 {
604 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( curr_end ), TO_SFVEC2F( arc_end ),
605 TO_3DU( aWidth ), aOwner );
606 }
607}
608
609
610void BOARD_ADAPTER::addShape( const PCB_SHAPE* aShape, CONTAINER_2D_BASE* aContainer,
611 const BOARD_ITEM* aOwner )
612{
613 // The full width of the lines to create
614 const float linewidth3DU = TO_3DU( aShape->GetWidth() );
615 LINE_STYLE lineStyle = aShape->GetStroke().GetLineStyle();
616
617 if( lineStyle <= LINE_STYLE::FIRST_TYPE )
618 {
619 switch( aShape->GetShape() )
620 {
621 case SHAPE_T::CIRCLE:
622 {
623 SFVEC2F center3DU = TO_SFVEC2F( aShape->GetCenter() );
624 float innerR3DU = TO_3DU( aShape->GetRadius() ) - linewidth3DU / 2.0;
625 float outerR3DU = TO_3DU( aShape->GetRadius() ) + linewidth3DU / 2.0;
626
627 if( aShape->IsFilled() || innerR3DU <= 0.0 )
628 addFILLED_CIRCLE_2D( aContainer, center3DU, outerR3DU, *aOwner );
629 else
630 addRING_2D( aContainer, center3DU, innerR3DU, outerR3DU, *aOwner );
631
632 break;
633 }
634
635 case SHAPE_T::RECTANGLE:
636 if( aShape->IsFilled() )
637 {
638 SHAPE_POLY_SET polyList;
639
641 ERROR_INSIDE );
642
644
645 ConvertPolygonToTriangles( polyList, *aContainer, m_biuTo3Dunits, *aOwner );
646 }
647 else
648 {
649 std::vector<VECTOR2I> pts = aShape->GetRectCorners();
650
651 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( pts[0] ), TO_SFVEC2F( pts[1] ),
652 linewidth3DU, *aOwner );
653 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( pts[1] ), TO_SFVEC2F( pts[2] ),
654 linewidth3DU, *aOwner );
655 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( pts[2] ), TO_SFVEC2F( pts[3] ),
656 linewidth3DU, *aOwner );
657 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( pts[3] ), TO_SFVEC2F( pts[0] ),
658 linewidth3DU, *aOwner );
659 }
660 break;
661
662 case SHAPE_T::ARC:
663 {
664 unsigned int segCount = GetCircleSegmentCount( aShape->GetBoundingBox().GetSizeMax() );
665
666 createArcSegments( aShape->GetCenter(), aShape->GetStart(), aShape->GetArcAngle(),
667 segCount, aShape->GetWidth(), aContainer, *aOwner );
668 break;
669 }
670
671 case SHAPE_T::SEGMENT:
672 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( aShape->GetStart() ),
673 TO_SFVEC2F( aShape->GetEnd() ), linewidth3DU, *aOwner );
674 break;
675
676 case SHAPE_T::BEZIER:
677 case SHAPE_T::POLY:
678 {
679 SHAPE_POLY_SET polyList;
680
682 ERROR_INSIDE );
683
684 // Some polygons can be a bit complex (especially when coming from a
685 // picture ot a text converted to a polygon
686 // So call Simplify before calling ConvertPolygonToTriangles, just in case.
688
689 if( polyList.IsEmpty() ) // Just for caution
690 break;
691
692 ConvertPolygonToTriangles( polyList, *aContainer, m_biuTo3Dunits, *aOwner );
693 break;
694 }
695
696 default:
697 wxFAIL_MSG( wxT( "BOARD_ADAPTER::addShape no implementation for " )
698 + aShape->SHAPE_T_asString() );
699 break;
700 }
701 }
702 else
703 {
704 std::vector<SHAPE*> shapes = aShape->MakeEffectiveShapes( true );
705 SFVEC2F a3DU;
706 SFVEC2F b3DU;
707
708 const PCB_PLOT_PARAMS& plotParams = aShape->GetBoard()->GetPlotOptions();
709 KIGFX::PCB_RENDER_SETTINGS renderSettings;
710
711 renderSettings.SetDashLengthRatio( plotParams.GetDashedLineDashRatio() );
712 renderSettings.SetGapLengthRatio( plotParams.GetDashedLineGapRatio() );
713
714 for( SHAPE* shape : shapes )
715 {
716 STROKE_PARAMS::Stroke( shape, lineStyle, aShape->GetWidth(), &renderSettings,
717 [&]( const VECTOR2I& a, const VECTOR2I& b )
718 {
719 addROUND_SEGMENT_2D( aContainer, TO_SFVEC2F( a ), TO_SFVEC2F( b ),
720 linewidth3DU, *aOwner );
721 } );
722 }
723
724 for( SHAPE* shape : shapes )
725 delete shape;
726 }
727}
728
729
730void BOARD_ADAPTER::addShape( const PCB_TEXTBOX* aTextBox, CONTAINER_2D_BASE* aContainer,
731 const BOARD_ITEM* aOwner )
732{
733 addText( aTextBox, aContainer, aOwner );
734
735 if( !aTextBox->IsBorderEnabled() )
736 return;
737
738 // We cannot use PCB_TEXTBOX::TransformShapeToPolygon because it convert the textbox
739 // as filled polygon even if there's no background colour.
740 // So for polygon, we use PCB_SHAPE::TransformShapeToPolygon
741
742 if( aTextBox->GetShape() == SHAPE_T::RECTANGLE )
743 {
744 addShape( static_cast<const PCB_SHAPE*>( aTextBox ), aContainer, aOwner );
745 }
746 else
747 {
748 SHAPE_POLY_SET polyList;
749
750 aTextBox->PCB_SHAPE::TransformShapeToPolygon( polyList, UNDEFINED_LAYER, 0,
752
753 ConvertPolygonToTriangles( polyList, *aContainer, m_biuTo3Dunits, *aOwner );
754 }
755}
756
757
758void BOARD_ADAPTER::addTable( const PCB_TABLE* aTable, CONTAINER_2D_BASE* aContainer,
759 const BOARD_ITEM* aOwner )
760{
761 // JEY TODO: tables
762 // add borders
763
764 for( PCB_TABLECELL* cell : aTable->GetCells() )
765 addText( cell, aContainer, aOwner );
766}
767
768
770 PCB_LAYER_ID aLayerId )
771{
772 // This convert the poly in outline and holes
773 ConvertPolygonToTriangles( *aZone->GetFilledPolysList( aLayerId ), *aContainer, m_biuTo3Dunits,
774 *aZone );
775}
776
777
779 int aWidth )
780{
781 if( aPad->GetShape() == PAD_SHAPE::CIRCLE ) // Draw a ring
782 {
783 const SFVEC2F center3DU = TO_SFVEC2F( aPad->ShapePos() );
784 const int radius = aPad->GetSize().x / 2;
785 const float inner_radius3DU = TO_3DU( radius - aWidth / 2.0 );
786 const float outer_radius3DU = TO_3DU( radius + aWidth / 2.0 );
787
788 addRING_2D( aContainer, center3DU, inner_radius3DU, outer_radius3DU, *aPad );
789 }
790 else
791 {
792 // For other shapes, add outlines as thick segments in polygon buffer
793 const std::shared_ptr<SHAPE_POLY_SET>& corners = aPad->GetEffectivePolygon( ERROR_INSIDE );
794 const SHAPE_LINE_CHAIN& path = corners->COutline( 0 );
795
796 for( int j = 0; j < path.PointCount(); j++ )
797 {
798 SFVEC2F start3DU = TO_SFVEC2F( path.CPoint( j ) );
799 SFVEC2F end3DU = TO_SFVEC2F( path.CPoint( j + 1 ) );
800
801 addROUND_SEGMENT_2D( aContainer, start3DU, end3DU, TO_3DU( aWidth ), *aPad );
802 }
803 }
804}
constexpr int ARC_HIGH_DEF
Definition: base_units.h:120
void addSolidAreasShapes(const ZONE *aZone, CONTAINER_2D_BASE *aDstContainer, PCB_LAYER_ID aLayerId)
void addFootprintShapes(const FOOTPRINT *aFootprint, CONTAINER_2D_BASE *aDstContainer, PCB_LAYER_ID aLayerId, const std::bitset< LAYER_3D_END > &aVisibilityFlags)
void createArcSegments(const VECTOR2I &aCentre, const VECTOR2I &aStart, const EDA_ANGLE &aArcAngle, int aCircleToSegmentsCount, int aWidth, CONTAINER_2D_BASE *aContainer, const BOARD_ITEM &aOwner)
void createPadWithMargin(const PAD *aPad, CONTAINER_2D_BASE *aDstContainer, PCB_LAYER_ID aLayer, const VECTOR2I &aMargin) const
void addPads(const FOOTPRINT *aFootprint, CONTAINER_2D_BASE *aDstContainer, PCB_LAYER_ID aLayerId, bool aSkipPlatedPads, bool aSkipNonPlatedPads)
const BOARD * GetBoard() const noexcept
void createPadWithHole(const PAD *aPad, CONTAINER_2D_BASE *aDstContainer, int aInflateValue)
void buildPadOutlineAsSegments(const PAD *aPad, CONTAINER_2D_BASE *aDstContainer, int aWidth)
void addShape(const PCB_SHAPE *aShape, CONTAINER_2D_BASE *aContainer, const BOARD_ITEM *aOwner)
void createTrack(const PCB_TRACK *aTrack, CONTAINER_2D_BASE *aDstContainer)
void addTable(const PCB_TABLE *aTable, CONTAINER_2D_BASE *aContainer, const BOARD_ITEM *aOwner)
unsigned int GetCircleSegmentCount(float aDiameter3DU) const
void createViaWithMargin(const PCB_TRACK *aTrack, CONTAINER_2D_BASE *aDstContainer, int aMargin)
double m_biuTo3Dunits
Scale factor to convert board internal units to 3D units normalized between -1.0 and 1....
void addText(const EDA_TEXT *aText, CONTAINER_2D_BASE *aDstContainer, const BOARD_ITEM *aOwner)
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:240
virtual bool IsKnockout() const
Definition: board_item.h:312
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:276
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:47
const KIFONT::METRICS & GetFontMetrics() const
Definition: board_item.cpp:100
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:218
const PCB_PLOT_PARAMS & GetPlotOptions() const
Definition: board.h:685
BOARD_DESIGN_SETTINGS & GetDesignSettings() const
Definition: board.cpp:877
int GetSizeMax() const
Definition: box2.h:225
void Add(OBJECT_2D *aObject)
Definition: container_2d.h:49
double AsDegrees() const
Definition: eda_angle.h:113
bool IsZero() const
Definition: eda_angle.h:133
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
EDA_ANGLE GetArcAngle() const
Definition: eda_shape.cpp:680
virtual std::vector< SHAPE * > MakeEffectiveShapes(bool aEdgeOnly=false) const
Make a set of SHAPE objects representing the EDA_SHAPE.
Definition: eda_shape.h:319
bool IsFilled() const
Definition: eda_shape.h:91
int GetRadius() const
Definition: eda_shape.cpp:610
SHAPE_T GetShape() const
Definition: eda_shape.h:125
const VECTOR2I & GetEnd() const
Return the ending point of the graphic.
Definition: eda_shape.h:167
const VECTOR2I & GetStart() const
Return the starting point of the graphic.
Definition: eda_shape.h:130
std::vector< VECTOR2I > GetRectCorners() const
Definition: eda_shape.cpp:1169
wxString SHAPE_T_asString() const
Definition: eda_shape.cpp:89
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:79
bool IsItalic() const
Definition: eda_text.h:152
KIFONT::FONT * GetFont() const
Definition: eda_text.h:230
virtual EDA_ANGLE GetDrawRotation() const
Definition: eda_text.h:359
virtual VECTOR2I GetDrawPos() const
Definition: eda_text.h:360
const TEXT_ATTRIBUTES & GetAttributes() const
Definition: eda_text.h:214
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition: eda_text.cpp:354
bool IsBold() const
Definition: eda_text.h:167
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:105
std::deque< PAD * > & Pads()
Definition: footprint.h:205
void GetFields(std::vector< PCB_FIELD * > &aVector, bool aVisibleOnly)
Populate a std::vector with PCB_TEXTs.
Definition: footprint.cpp:580
DRAWINGS & GraphicalItems()
Definition: footprint.h:208
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:131
static FONT * GetFont(const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false, const std::vector< wxString > *aEmbeddedFiles=nullptr, bool aForDrawingSheet=false)
Definition: font.cpp:146
void Draw(KIGFX::GAL *aGal, const wxString &aText, const VECTOR2I &aPosition, const VECTOR2I &aCursor, const TEXT_ATTRIBUTES &aAttributes, const METRICS &aFontMetrics) const
Draw a string.
Definition: font.cpp:258
PCB specific render settings.
Definition: pcb_painter.h:78
void SetGapLengthRatio(double aRatio)
void SetDashLengthRatio(double aRatio)
Definition: pad.h:54
VECTOR2I ShapePos() const
Definition: pad.cpp:869
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:1781
const std::shared_ptr< SHAPE_POLY_SET > & GetEffectivePolygon(ERROR_LOC aErrorLoc=ERROR_INSIDE) const
Definition: pad.cpp:426
PAD_SHAPE GetShape() const
Definition: pad.h:193
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING flashPTHPads=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: pad.cpp:435
bool HasHole() const override
Definition: pad.h:104
std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const override
Return a SHAPE_SEGMENT object representing the pad's hole.
Definition: pad.cpp:472
const VECTOR2I & GetSize() const
Definition: pad.h:256
bool IsDegenerated(int aThreshold=5) const
Definition: pcb_track.cpp:1627
double GetRadius() const
Definition: pcb_track.cpp:1592
EDA_ANGLE GetAngle() const
Definition: pcb_track.cpp:1599
virtual VECTOR2I GetCenter() const override
This defaults to the center of the bounding box if not overridden.
Definition: pcb_track.h:288
Abstract dimension API.
int GetLineThickness() const
const std::vector< std::shared_ptr< SHAPE > > & GetShapes() const
Parameters and options when plotting/printing a board.
double GetDashedLineGapRatio() const
double GetDashedLineDashRatio() const
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_shape.h:115
VECTOR2I GetCenter() const override
This defaults to the center of the bounding box if not overridden.
Definition: pcb_shape.h:75
int GetWidth() const override
Definition: pcb_shape.cpp:369
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the shape to a closed polygon.
Definition: pcb_shape.cpp:836
STROKE_PARAMS GetStroke() const override
Definition: pcb_shape.h:85
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: pcb_shape.h:70
std::vector< PCB_TABLECELL * > GetCells() const
Definition: pcb_table.h:141
bool IsBorderEnabled() const
Disables the border, this is done by changing the stroke internally.
void TransformTextToPolySet(SHAPE_POLY_SET &aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc) const
Function TransformTextToPolySet Convert the text to a polygonSet describing the actual character stro...
Definition: pcb_text.cpp:569
void SetEnd(const VECTOR2I &aEnd)
Definition: pcb_track.h:118
void SetStart(const VECTOR2I &aStart)
Definition: pcb_track.h:121
const VECTOR2I & GetStart() const
Definition: pcb_track.h:122
const VECTOR2I & GetEnd() const
Definition: pcb_track.h:119
virtual void SetWidth(int aWidth)
Definition: pcb_track.h:115
virtual int GetWidth() const
Definition: pcb_track.h:116
Definition: seg.h:42
VECTOR2I A
Definition: seg.h:49
VECTOR2I B
Definition: seg.h:50
int GetWidth() const
Definition: shape_arc.h:168
const SHAPE_LINE_CHAIN ConvertToPolyline(double aAccuracy=DefaultAccuracyForPCB(), double *aEffectiveAccuracy=nullptr) const
Construct a SHAPE_LINE_CHAIN of segments from a given arc.
Definition: shape_arc.cpp:560
int GetRadius() const
Definition: shape_circle.h:118
const VECTOR2I GetCenter() const
Definition: shape_circle.h:123
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
SEG Segment(int aIndex) const
Return a copy of the aIndex-th segment in the line chain.
int SegmentCount() const
Return the number of segments in this line chain.
Represent a set of closed polygons.
int AddOutline(const SHAPE_LINE_CHAIN &aOutline)
Adds a new outline to the set and returns its index.
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.
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)
void Simplify(POLYGON_MODE aFastMode)
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections) For aFastMo...
int NewOutline()
Creates a new empty polygon in the set and returns its index.
const VECTOR2I & GetPosition() const
Definition: shape_rect.h:137
const VECTOR2I GetSize() const
Definition: shape_rect.h:145
const SEG & GetSeg() const
int GetWidth() const
Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.
Definition: shape_simple.h:42
const SHAPE_LINE_CHAIN & Vertices() const
Return the list of vertices defining this simple polygon.
Definition: shape_simple.h:124
An abstract shape on 2D plane.
Definition: shape.h:126
LINE_STYLE GetLineStyle() const
Definition: stroke_params.h:94
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
const std::shared_ptr< SHAPE_POLY_SET > & GetFilledPolysList(PCB_LAYER_ID aLayer) const
Definition: zone.h:616
#define TO_3DU(x)
void addFILLED_CIRCLE_2D(CONTAINER_2D_BASE *aContainer, const SFVEC2F &aCenter, float aRadius, const BOARD_ITEM &aBoardItem)
#define TO_SFVEC2F(vec)
void addROUND_SEGMENT_2D(CONTAINER_2D_BASE *aContainer, const SFVEC2F &aStart, const SFVEC2F &aEnd, float aWidth, const BOARD_ITEM &aBoardItem)
void addRING_2D(CONTAINER_2D_BASE *aContainer, const SFVEC2F &aCenter, float aInnerRadius, float aOuterRadius, const BOARD_ITEM &aBoardItem)
static constexpr EDA_ANGLE ANGLE_0
Definition: eda_angle.h:401
static constexpr EDA_ANGLE ANGLE_360
Definition: eda_angle.h:407
a few functions useful in geometry calculations.
@ ERROR_INSIDE
int GetArcToSegmentCount(int aRadius, int aErrorMax, const EDA_ANGLE &aArcAngle)
static const wxChar * m_logTrace
Trace mask used to enable or disable debug output for this class.
bool IsCopperLayer(int aLayerId)
Tests whether a layer is a copper layer.
Definition: layer_ids.h:532
@ LAYER_FP_REFERENCES
show footprints references (when texts are visible)
Definition: layer_ids.h:215
@ LAYER_FP_TEXT
Definition: layer_ids.h:202
@ LAYER_FP_VALUES
show footprints values (when texts are visible)
Definition: layer_ids.h:214
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ F_Paste
Definition: layer_ids.h:101
@ B_Mask
Definition: layer_ids.h:106
@ B_Cu
Definition: layer_ids.h:95
@ F_Mask
Definition: layer_ids.h:107
@ B_Paste
Definition: layer_ids.h:100
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
@ F_Cu
Definition: layer_ids.h:64
This file contains miscellaneous commonly used macros and functions.
#define UNIMPLEMENTED_FOR(type)
Definition: macros.h:96
T clamp(T min, T value, T max)
Definition: kicad_algo.h:205
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:390
bool Is_segment_a_circle(const SFVEC2F &aStart, const SFVEC2F &aEnd)
Check if segment start and end is very close to each other.
@ SH_POLY_SET
set of polygons (with holes, etc.)
Definition: shape.h:52
@ SH_RECT
axis-aligned rectangle
Definition: shape.h:47
@ SH_CIRCLE
circle
Definition: shape.h:50
@ SH_SIMPLE
simple polygon
Definition: shape.h:51
@ SH_SEGMENT
line segment
Definition: shape.h:48
@ SH_ARC
circular arc
Definition: shape.h:54
static wxString SHAPE_TYPE_asString(SHAPE_TYPE a)
Definition: shape.h:59
std::vector< FAB_LAYER_COLOR > dummy
LINE_STYLE
Dashed line types.
Definition: stroke_params.h:48
constexpr int delta
void ConvertPolygonToTriangles(const SHAPE_POLY_SET &aPolyList, CONTAINER_2D_BASE &aDstContainer, float aBiuTo3dUnitsScale, const BOARD_ITEM &aBoardItem)
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:105
@ PCB_DIM_LEADER_T
class PCB_DIM_LEADER, a leader dimension (graphic item)
Definition: typeinfo.h:102
@ 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:103
@ 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_DIM_ALIGNED_T
class PCB_DIM_ALIGNED, a linear dimension (graphic item)
Definition: typeinfo.h:101
@ PCB_ARC_T
class PCB_ARC, an arc track segment on a copper layer
Definition: typeinfo.h:98
@ PCB_TABLE_T
class PCB_TABLE, table of PCB_TABLECELLs
Definition: typeinfo.h:94
@ PCB_TRACE_T
class PCB_TRACK, a track segment (segment on a copper layer)
Definition: typeinfo.h:96
@ PCB_DIM_RADIAL_T
class PCB_DIM_RADIAL, a radius or diameter dimension
Definition: typeinfo.h:104
constexpr ret_type KiROUND(fp_type v, bool aQuiet=false)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:100
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:676
glm::vec2 SFVEC2F
Definition: xv3d_types.h:42