KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_text.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) 2012 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 1992-2023 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
26#include <google/protobuf/any.pb.h>
27
28#include <pcb_edit_frame.h>
29#include <base_units.h>
30#include <bitmaps.h>
31#include <board.h>
33#include <core/mirror.h>
34#include <footprint.h>
35#include <pcb_text.h>
36#include <pcb_painter.h>
37#include <trigo.h>
38#include <string_utils.h>
40#include <callback_gal.h>
42#include <api/api_enums.h>
43#include <api/api_utils.h>
44#include <api/board/board_types.pb.h>
45
46
47using namespace kiapi::common;
48
49
51 BOARD_ITEM( parent, idtype ),
53{
54 SetMultilineAllowed( true );
55}
56
57
59 BOARD_ITEM( aParent, idtype ),
61{
62 SetKeepUpright( true );
63
64 // Set text thickness to a default value
67
68 if( aParent )
69 {
70 SetTextPos( aParent->GetPosition() );
71
72 // N.B. Do not automatically set text effects
73 // These are optional in the file format and so need to be defaulted
74 // to off.
75 if( IsBackLayer( aParent->GetLayer() ) )
77 }
78}
79
80
82{
83}
84
85
86void PCB_TEXT::Serialize( google::protobuf::Any &aContainer ) const
87{
88 kiapi::board::types::Text boardText;
89 boardText.set_layer( ToProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>( GetLayer() ) );
90
91 kiapi::common::types::Text& text = *boardText.mutable_text();
92
93 text.mutable_id()->set_value( m_Uuid.AsStdString() );
94 text.mutable_position()->set_x_nm( GetPosition().x );
95 text.mutable_position()->set_y_nm( GetPosition().y );
96 text.set_text( GetText().ToStdString() );
97 text.set_hyperlink( GetHyperlink().ToStdString() );
98 text.set_locked( IsLocked() ? types::LockedState::LS_LOCKED
99 : types::LockedState::LS_UNLOCKED );
100
101 kiapi::common::types::TextAttributes* attrs = text.mutable_attributes();
102
103 if( GetFont() )
104 attrs->set_font_name( GetFont()->GetName().ToStdString() );
105
106 attrs->set_horizontal_alignment(
107 ToProtoEnum<GR_TEXT_H_ALIGN_T, types::HorizontalAlignment>( GetHorizJustify() ) );
108
109 attrs->set_vertical_alignment(
110 ToProtoEnum<GR_TEXT_V_ALIGN_T, types::VerticalAlignment>( GetVertJustify() ) );
111
112 attrs->mutable_angle()->set_value_degrees( GetTextAngleDegrees() );
113 attrs->set_line_spacing( GetLineSpacing() );
114 attrs->mutable_stroke_width()->set_value_nm( GetTextThickness() );
115 attrs->set_italic( IsItalic() );
116 attrs->set_bold( IsBold() );
117 attrs->set_underlined( GetAttributes().m_Underlined );
118 attrs->set_visible( IsVisible() );
119 attrs->set_mirrored( IsMirrored() );
120 attrs->set_multiline( IsMultilineAllowed() );
121 attrs->set_keep_upright( IsKeepUpright() );
122 attrs->mutable_size()->set_x_nm( GetTextSize().x );
123 attrs->mutable_size()->set_y_nm( GetTextSize().y );
124
125 text.set_knockout( IsKnockout() );
126
127 aContainer.PackFrom( boardText );
128}
129
130
131bool PCB_TEXT::Deserialize( const google::protobuf::Any &aContainer )
132{
133 kiapi::board::types::Text textWrapper;
134
135 if( !aContainer.UnpackTo( &textWrapper ) )
136 return false;
137
138 SetLayer( FromProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>( textWrapper.layer() ) );
139
140 const kiapi::common::types::Text& text = textWrapper.text();
141
142 const_cast<KIID&>( m_Uuid ) = KIID( text.id().value() );
143 SetPosition( VECTOR2I( text.position().x_nm(), text.position().y_nm() ) );
144 SetLocked( text.locked() == kiapi::common::types::LockedState::LS_LOCKED );
145 SetText( wxString( text.text().c_str(), wxConvUTF8 ) );
146 SetHyperlink( wxString( text.hyperlink().c_str(), wxConvUTF8 ) );
147 SetIsKnockout( text.knockout() );
148
149 if( text.has_attributes() )
150 {
152
153 attrs.m_Bold = text.attributes().bold();
154 attrs.m_Italic = text.attributes().italic();
155 attrs.m_Underlined = text.attributes().underlined();
156 attrs.m_Visible = text.attributes().visible();
157 attrs.m_Mirrored = text.attributes().mirrored();
158 attrs.m_Multiline = text.attributes().multiline();
159 attrs.m_KeepUpright = text.attributes().keep_upright();
160 attrs.m_Size = VECTOR2I( text.attributes().size().x_nm(), text.attributes().size().y_nm() );
161
162 if( !text.attributes().font_name().empty() )
163 {
165 wxString( text.attributes().font_name().c_str(), wxConvUTF8 ), attrs.m_Bold,
166 attrs.m_Italic );
167 }
168
169 attrs.m_Angle = EDA_ANGLE( text.attributes().angle().value_degrees(), DEGREES_T );
170 attrs.m_LineSpacing = text.attributes().line_spacing();
171 SetTextThickness( text.attributes().stroke_width().value_nm() );
172
173 attrs.m_Halign = FromProtoEnum<GR_TEXT_H_ALIGN_T, types::HorizontalAlignment>(
174 text.attributes().horizontal_alignment() );
175
176 attrs.m_Valign = FromProtoEnum<GR_TEXT_V_ALIGN_T, types::VerticalAlignment>(
177 text.attributes().vertical_alignment() );
178
179 SetAttributes( attrs );
180 }
181
182 return true;
183}
184
185
186wxString PCB_TEXT::GetShownText( bool aAllowExtraText, int aDepth ) const
187{
188 const FOOTPRINT* parentFootprint = GetParentFootprint();
189 const BOARD* board = GetBoard();
190
191 std::function<bool( wxString* )> resolver =
192 [&]( wxString* token ) -> bool
193 {
194 if( parentFootprint && parentFootprint->ResolveTextVar( token, aDepth + 1 ) )
195 return true;
196
197 if( token->IsSameAs( wxT( "LAYER" ) ) )
198 {
199 *token = GetLayerName();
200 return true;
201 }
202
203 if( board->ResolveTextVar( token, aDepth + 1 ) )
204 return true;
205
206 return false;
207 };
208
209 wxString text = EDA_TEXT::GetShownText( aAllowExtraText, aDepth );
210
211 if( HasTextVars() )
212 {
213 if( aDepth < 10 )
215 }
216
217 return text;
218}
219
220
221bool PCB_TEXT::Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
222{
223 return BOARD_ITEM::Matches( UnescapeString( GetText() ), aSearchData );
224}
225
226
228{
229 EDA_ANGLE rotation = GetTextAngle();
230
232 {
233 // Keep angle between ]-90..90] deg. Otherwise the text is not easy to read
234 while( rotation > ANGLE_90 )
235 rotation -= ANGLE_180;
236
237 while( rotation <= -ANGLE_90 )
238 rotation += ANGLE_180;
239 }
240 else
241 {
242 rotation.Normalize();
243 }
244
245 return rotation;
246}
247
248
250{
251 return GetBoundingBox();
252}
253
254
255void PCB_TEXT::ViewGetLayers( int aLayers[], int& aCount ) const
256{
257 if( GetParentFootprint() == nullptr || IsVisible() )
258 aLayers[0] = GetLayer();
259 else
260 aLayers[0] = LAYER_HIDDEN_TEXT;
261
262 aCount = 1;
263
264 if( IsLocked() )
265 aLayers[ aCount++ ] = LAYER_LOCKED_ITEM_SHADOW;
266}
267
268
269double PCB_TEXT::ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const
270{
271 constexpr double HIDE = std::numeric_limits<double>::max();
272
273 if( !aView )
274 return 0.0;
275
276 KIGFX::PCB_PAINTER* painter = static_cast<KIGFX::PCB_PAINTER*>( aView->GetPainter() );
277 KIGFX::PCB_RENDER_SETTINGS* renderSettings = painter->GetSettings();
278
279 // Hidden text gets put on the LAYER_HIDDEN_TEXT for rendering, but
280 // should only render if its native layer is visible.
281 if( !aView->IsLayerVisible( GetLayer() ) )
282 return HIDE;
283
284 if( aLayer == LAYER_LOCKED_ITEM_SHADOW )
285 {
286 // Hide shadow on dimmed tracks
287 if( renderSettings->GetHighContrast() )
288 {
289 if( m_layer != renderSettings->GetPrimaryHighContrastLayer() )
290 return HIDE;
291 }
292 }
293
294 if( FOOTPRINT* parentFP = GetParentFootprint() )
295 {
296 // Handle Render tab switches
297 if( GetText() == wxT( "${VALUE}" ) )
298 {
299 if( !aView->IsLayerVisible( LAYER_FP_VALUES ) )
300 return HIDE;
301 }
302
303 if( GetText() == wxT( "${REFERENCE}" ) )
304 {
305 if( !aView->IsLayerVisible( LAYER_FP_REFERENCES ) )
306 return HIDE;
307 }
308
309 if( parentFP->GetLayer() == F_Cu && !aView->IsLayerVisible( LAYER_FOOTPRINTS_FR ) )
310 return HIDE;
311
312 if( parentFP->GetLayer() == B_Cu && !aView->IsLayerVisible( LAYER_FOOTPRINTS_BK ) )
313 return HIDE;
314
315 if( !aView->IsLayerVisible( LAYER_FP_TEXT ) )
316 return HIDE;
317 }
318
319 return 0.0;
320}
321
322
323void PCB_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
324{
325 FOOTPRINT* parentFP = GetParentFootprint();
326
327 if( parentFP && aFrame->GetName() == PCB_EDIT_FRAME_NAME )
328 aList.emplace_back( _( "Footprint" ), parentFP->GetReference() );
329
330 // Don't use GetShownText() here; we want to show the user the variable references
331 if( parentFP )
332 aList.emplace_back( _( "Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
333 else
334 aList.emplace_back( _( "PCB Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
335
336 if( parentFP )
337 aList.emplace_back( _( "Type" ), GetTextTypeDescription() );
338
339 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME && IsLocked() )
340 aList.emplace_back( _( "Status" ), _( "Locked" ) );
341
342 if( parentFP )
343 aList.emplace_back( _( "Display" ), IsVisible() ? _( "Yes" ) : _( "No" ) );
344
345 aList.emplace_back( _( "Layer" ), GetLayerName() );
346
347 aList.emplace_back( _( "Mirror" ), IsMirrored() ? _( "Yes" ) : _( "No" ) );
348
349 aList.emplace_back( _( "Angle" ), wxString::Format( wxT( "%g" ), GetTextAngle().AsDegrees() ) );
350
351 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
352 aList.emplace_back( _( "Thickness" ), aFrame->MessageTextFromValue( GetTextThickness() ) );
353 aList.emplace_back( _( "Width" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
354 aList.emplace_back( _( "Height" ), aFrame->MessageTextFromValue( GetTextHeight() ) );
355}
356
357
359{
361}
362
363
365{
366 SetTextSize( settings.GetTextSize( GetLayer() ) );
368 SetItalic( settings.GetTextItalic( GetLayer() ) );
369 SetKeepUpright( settings.GetTextUpright( GetLayer() ) );
371}
372
373
374void PCB_TEXT::KeepUpright( const EDA_ANGLE& aNewOrientation )
375{
376 if( !IsKeepUpright() )
377 return;
378
379 EDA_ANGLE newAngle = GetTextAngle() + aNewOrientation;
380 newAngle.Normalize();
381
382 bool needsFlipped = newAngle >= ANGLE_180;
383
384 if( needsFlipped )
385 {
388 }
389}
390
391
393{
394 EDA_ANGLE angle = GetDrawRotation();
395 BOX2I rect = GetTextBox();
396
397 if( IsKnockout() )
398 rect.Inflate( getKnockoutMargin() );
399
400 if( !angle.IsZero() )
402
403 return rect;
404}
405
406
407bool PCB_TEXT::TextHitTest( const VECTOR2I& aPoint, int aAccuracy ) const
408{
409 int accuracy = aAccuracy;
410
411 if( IsKnockout() )
413
414 return EDA_TEXT::TextHitTest( aPoint, accuracy );
415}
416
417
418bool PCB_TEXT::TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy ) const
419{
420 BOX2I rect = aRect;
421
422 rect.Inflate( aAccuracy );
423
424 if( aContains )
425 return rect.Contains( GetBoundingBox() );
426
427 return rect.Intersects( GetBoundingBox() );
428}
429
430
431void PCB_TEXT::Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle )
432{
433 VECTOR2I pt = GetTextPos();
434 RotatePoint( pt, aRotCentre, aAngle );
435 SetTextPos( pt );
436
437 EDA_ANGLE new_angle = GetTextAngle() + aAngle;
438 new_angle.Normalize180();
439 SetTextAngle( new_angle );
440}
441
442
443void PCB_TEXT::Mirror( const VECTOR2I& aCentre, bool aMirrorAroundXAxis )
444{
445 // the position and justification are mirrored, but not the text itself
446
447 if( aMirrorAroundXAxis )
448 {
451
452 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
453 }
454 else
455 {
458
459 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
460 }
461}
462
463
464void PCB_TEXT::Flip( const VECTOR2I& aCentre, bool aFlipLeftRight )
465{
466 if( aFlipLeftRight )
467 {
468 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
470 }
471 else
472 {
473 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
475 }
476
477 SetLayer( FlipLayer( GetLayer(), GetBoard()->GetCopperLayerCount() ) );
478
479 if( ( GetLayerSet() & LSET::SideSpecificMask() ).any() )
481}
482
483
485{
486 return _( "Text" );
487}
488
489
490wxString PCB_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const
491{
492 if( FOOTPRINT* parentFP = GetParentFootprint() )
493 {
494 return wxString::Format( _( "Footprint Text '%s' of %s" ),
495 KIUI::EllipsizeMenuText( GetText() ), parentFP->GetReference() );
496 }
497
498 return wxString::Format( _( "PCB Text '%s' on %s" ),
500 GetLayerName() );
501}
502
503
505{
506 return BITMAPS::text;
507}
508
509
511{
512 return new PCB_TEXT( *this );
513}
514
515
517{
518 assert( aImage->Type() == PCB_TEXT_T );
519
520 std::swap( *((PCB_TEXT*) this), *((PCB_TEXT*) aImage) );
521}
522
523
524std::shared_ptr<SHAPE> PCB_TEXT::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING aFlash ) const
525{
526 if( IsKnockout() )
527 {
528 SHAPE_POLY_SET poly;
529
530 TransformTextToPolySet( poly, 0, GetBoard()->GetDesignSettings().m_MaxError, ERROR_INSIDE );
531
532 return std::make_shared<SHAPE_POLY_SET>( poly );
533 }
534
535 return GetEffectiveTextShape();
536}
537
538
539void PCB_TEXT::buildBoundingHull( SHAPE_POLY_SET* aBuffer, const SHAPE_POLY_SET& aRenderedText,
540 int aClearance ) const
541{
542 SHAPE_POLY_SET poly( aRenderedText );
543
544 poly.Rotate( -GetDrawRotation(), GetDrawPos() );
545
546 BOX2I rect = poly.BBox( aClearance );
547 VECTOR2I corners[4];
548
549 corners[0].x = rect.GetOrigin().x;
550 corners[0].y = rect.GetOrigin().y;
551 corners[1].y = corners[0].y;
552 corners[1].x = rect.GetRight();
553 corners[2].x = corners[1].x;
554 corners[2].y = rect.GetBottom();
555 corners[3].y = corners[2].y;
556 corners[3].x = corners[0].x;
557
558 aBuffer->NewOutline();
559
560 for( VECTOR2I& corner : corners )
561 {
562 RotatePoint( corner, GetDrawPos(), GetDrawRotation() );
563 aBuffer->Append( corner.x, corner.y );
564 }
565}
566
567
568void PCB_TEXT::TransformTextToPolySet( SHAPE_POLY_SET& aBuffer, int aClearance, int aMaxError,
569 ERROR_LOC aErrorLoc ) const
570{
572 KIFONT::FONT* font = getDrawFont();
573 int penWidth = GetEffectiveTextPenWidth();
575
576 attrs.m_Angle = GetDrawRotation();
577
578 // The polygonal shape of a text can have many basic shapes, so combining these shapes can
579 // be very useful to create a final shape with a lot less vertices to speedup calculations.
580 // Simplify shapes is not usually always efficient, but in this case it is.
581 SHAPE_POLY_SET textShape;
582
583 CALLBACK_GAL callback_gal( empty_opts,
584 // Stroke callback
585 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
586 {
587 TransformOvalToPolygon( textShape, aPt1, aPt2, penWidth, aMaxError, aErrorLoc );
588 },
589 // Triangulation callback
590 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
591 {
592 textShape.NewOutline();
593
594 for( const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
595 textShape.Append( point.x, point.y );
596 } );
597
598 font->Draw( &callback_gal, GetShownText( true ), GetTextPos(), attrs, GetFontMetrics() );
600
601 if( IsKnockout() )
602 {
603 SHAPE_POLY_SET finalPoly;
604 int margin = GetKnockoutTextMargin( attrs.m_Size, penWidth );
605
606 buildBoundingHull( &finalPoly, textShape, margin + aClearance );
607 finalPoly.BooleanSubtract( textShape, SHAPE_POLY_SET::PM_FAST );
608
609 aBuffer.Append( finalPoly );
610 }
611 else
612 {
613 if( aClearance > 0 || aErrorLoc == ERROR_OUTSIDE )
614 {
615 if( aErrorLoc == ERROR_OUTSIDE )
616 aClearance += aMaxError;
617
618 textShape.Inflate( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, aMaxError );
619 }
620
621 aBuffer.Append( textShape );
622 }
623}
624
625
627 int aClearance, int aMaxError, ERROR_LOC aErrorLoc,
628 bool aIgnoreLineWidth ) const
629{
630 SHAPE_POLY_SET poly;
631
632 TransformTextToPolySet( poly, 0, aMaxError, aErrorLoc );
633
634 buildBoundingHull( &aBuffer, poly, aClearance );
635}
636
637
638bool PCB_TEXT::operator==( const BOARD_ITEM& aOther ) const
639{
640 if( aOther.Type() != Type() )
641 return false;
642
643 const PCB_TEXT& other = static_cast<const PCB_TEXT&>( aOther );
644
645 return EDA_TEXT::operator==( other );
646}
647
648
649double PCB_TEXT::Similarity( const BOARD_ITEM& aOther ) const
650{
651 if( aOther.Type() != Type() )
652 return 0.0;
653
654 const PCB_TEXT& other = static_cast<const PCB_TEXT&>( aOther );
655
656 return EDA_TEXT::Similarity( other );
657}
658
659
660static struct PCB_TEXT_DESC
661{
663 {
670
671 propMgr.Mask( TYPE_HASH( PCB_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Color" ) );
672
673 propMgr.AddProperty( new PROPERTY<PCB_TEXT, bool, BOARD_ITEM>( _HKI( "Knockout" ),
675 _HKI( "Text Properties" ) );
676
677 propMgr.AddProperty( new PROPERTY<PCB_TEXT, bool, EDA_TEXT>( _HKI( "Keep Upright" ),
679 _HKI( "Text Properties" ) );
680
681 auto isFootprintText =
682 []( INSPECTABLE* aItem ) -> bool
683 {
684 if( PCB_TEXT* text = dynamic_cast<PCB_TEXT*>( aItem ) )
685 return text->GetParentFootprint();
686
687 return false;
688 };
689
691 _HKI( "Visible" ), isFootprintText );
692
694 _HKI( "Keep Upright" ), isFootprintText );
695
697 _HKI( "Hyperlink" ),
698 []( INSPECTABLE* aItem ) { return false; } );
699 }
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:108
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
#define DEFAULT_TEXT_WIDTH
Container for design settings for a BOARD object.
bool GetTextUpright(PCB_LAYER_ID aLayer) const
int GetTextThickness(PCB_LAYER_ID aLayer) const
Return the default text thickness from the layer class for the given layer.
bool GetTextItalic(PCB_LAYER_ID aLayer) const
VECTOR2I GetTextSize(PCB_LAYER_ID aLayer) const
Return the default text size from the layer class for the given layer.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:77
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:226
virtual void SetLocked(bool aLocked)
Definition: board_item.h:300
PCB_LAYER_ID m_layer
Definition: board_item.h:388
virtual bool IsKnockout() const
Definition: board_item.h:296
virtual void SetIsKnockout(bool aKnockout)
Definition: board_item.h:297
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:260
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:46
FOOTPRINT * GetParentFootprint() const
Definition: board_item.cpp:248
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition: board_item.h:231
const KIFONT::METRICS & GetFontMetrics() const
Definition: board_item.cpp:97
virtual bool IsLocked() const
Definition: board_item.cpp:74
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:103
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:281
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: board.cpp:424
const Vec & GetOrigin() const
Definition: box2.h:200
bool Intersects(const BOX2< Vec > &aRect) const
Definition: box2.h:294
bool Contains(const Vec &aPoint) const
Definition: box2.h:158
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:541
coord_type GetRight() const
Definition: box2.h:207
const BOX2< Vec > GetBoundingBoxRotated(const VECTOR2I &aRotCenter, const EDA_ANGLE &aAngle) const
Useful to calculate bounding box of rotated items, when rotation is not cardinal.
Definition: box2.h:685
coord_type GetBottom() const
Definition: box2.h:212
EDA_ANGLE Normalize()
Definition: eda_angle.h:255
bool IsZero() const
Definition: eda_angle.h:175
EDA_ANGLE Normalize180()
Definition: eda_angle.h:294
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:88
const KIID m_Uuid
Definition: eda_item.h:485
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:100
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:375
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:83
int GetTextHeight() const
Definition: eda_text.h:228
BOX2I GetTextBox(int aLine=-1, bool aInvertY=false) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:567
const VECTOR2I & GetTextPos() const
Definition: eda_text.h:234
bool IsItalic() const
Definition: eda_text.h:144
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:134
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
Definition: eda_text.cpp:374
bool IsMultilineAllowed() const
Definition: eda_text.h:161
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:98
bool IsKeepUpright() const
Definition: eda_text.h:170
virtual bool IsVisible() const
Definition: eda_text.h:151
void SetTextPos(const VECTOR2I &aPoint)
Definition: eda_text.cpp:419
void SetTextX(int aX)
Definition: eda_text.cpp:425
KIFONT::FONT * GetFont() const
Definition: eda_text.h:211
void SetAttributes(const EDA_TEXT &aSrc, bool aSetPosition=true)
Set the text attributes from another instance.
Definition: eda_text.cpp:292
void SetMirrored(bool isMirrored)
Definition: eda_text.cpp:252
void SetTextY(int aY)
Definition: eda_text.cpp:431
virtual VECTOR2I GetDrawPos() const
Definition: eda_text.h:342
int GetTextWidth() const
Definition: eda_text.h:225
wxString GetHyperlink() const
Definition: eda_text.h:362
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition: eda_text.h:164
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition: eda_text.h:117
virtual KIFONT::FONT * getDrawFont() const
Definition: eda_text.cpp:482
double GetLineSpacing() const
Definition: eda_text.h:219
double Similarity(const EDA_TEXT &aOther) const
Definition: eda_text.cpp:1151
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.cpp:197
virtual bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const
Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:706
const TEXT_ATTRIBUTES & GetAttributes() const
Definition: eda_text.h:195
bool IsMirrored() const
Definition: eda_text.h:154
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition: eda_text.cpp:324
double GetTextAngleDegrees() const
Definition: eda_text.h:141
std::shared_ptr< SHAPE_COMPOUND > GetEffectiveTextShape(bool aTriangulate=true, const BOX2I &aBBox=BOX2I(), const EDA_ANGLE &aAngle=ANGLE_0) const
build a list of segments (SHAPE_SEGMENT) to describe a text shape.
Definition: eda_text.cpp:985
bool IsBold() const
Definition: eda_text.h:148
void SetHyperlink(wxString aLink)
Definition: eda_text.h:363
void SetKeepUpright(bool aKeepUpright)
Definition: eda_text.cpp:284
GR_TEXT_V_ALIGN_T GetVertJustify() 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:109
virtual void SetText(const wxString &aText)
Definition: eda_text.cpp:183
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
Definition: eda_text.cpp:205
int GetTextThickness() const
Definition: eda_text.h:126
void SetItalic(bool aItalic)
Definition: eda_text.cpp:213
bool operator==(const EDA_TEXT &aRhs) const
Definition: eda_text.h:357
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.cpp:260
VECTOR2I GetTextSize() const
Definition: eda_text.h:222
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition: eda_text.cpp:268
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the component.
Definition: footprint.cpp:891
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: footprint.h:221
const wxString & GetReference() const
Definition: footprint.h:588
VECTOR2I GetPosition() const override
Definition: footprint.h:209
Class that other classes need to inherit from, in order to be inspectable.
Definition: inspectable.h:36
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)
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:257
Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:164
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
Definition: pcb_painter.h:169
PCB specific render settings.
Definition: pcb_painter.h:77
PCB_LAYER_ID GetPrimaryHighContrastLayer() const
Return the board layer which is in high-contrast mode.
bool GetHighContrast() const
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:412
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:215
Definition: kiid.h:49
std::string AsStdString() const
Definition: kiid.cpp:263
static LSET SideSpecificMask()
Definition: lset.cpp:998
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: pcb_text.cpp:323
double Similarity(const BOARD_ITEM &aBoardItem) const override
Return a measure of how likely the other object is to represent the same object.
Definition: pcb_text.cpp:649
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=false) const override
Convert the item shape to a closed polygon.
Definition: pcb_text.cpp:626
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: pcb_text.cpp:249
virtual void swapData(BOARD_ITEM *aImage) override
Definition: pcb_text.cpp:516
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: pcb_text.cpp:524
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: pcb_text.cpp:221
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition: pcb_text.cpp:86
void KeepUpright(const EDA_ANGLE &aNewOrientation)
Called when rotating the parent footprint.
Definition: pcb_text.cpp:374
wxString GetShownText(bool aAllowExtraText, int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: pcb_text.cpp:186
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: pcb_text.cpp:464
~PCB_TEXT()
Definition: pcb_text.cpp:81
virtual VECTOR2I GetPosition() const override
Definition: pcb_text.h:82
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
Definition: pcb_text.cpp:490
PCB_TEXT(BOARD_ITEM *parent, KICAD_T idtype=PCB_TEXT_T)
Definition: pcb_text.cpp:50
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: pcb_text.cpp:269
void StyleFromSettings(const BOARD_DESIGN_SETTINGS &settings) override
Definition: pcb_text.cpp:364
int getKnockoutMargin() const
Definition: pcb_text.cpp:358
void Mirror(const VECTOR2I &aCentre, bool aMirrorAroundXAxis)
Definition: pcb_text.cpp:443
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:568
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_text.cpp:392
virtual wxString GetTextTypeDescription() const
Definition: pcb_text.cpp:484
void buildBoundingHull(SHAPE_POLY_SET *aBuffer, const SHAPE_POLY_SET &aRenderedText, int aClearance) const
Build a nominally rectangular bounding box for the rendered text.
Definition: pcb_text.cpp:539
bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const override
Test if aPoint is within the bounds of this object.
Definition: pcb_text.cpp:407
virtual void SetPosition(const VECTOR2I &aPos) override
Definition: pcb_text.h:87
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_text.cpp:510
EDA_ANGLE GetDrawRotation() const override
Definition: pcb_text.cpp:227
void ViewGetLayers(int aLayers[], int &aCount) const override
Definition: pcb_text.cpp:255
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition: pcb_text.cpp:131
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition: pcb_text.cpp:431
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: pcb_text.cpp:504
bool operator==(const BOARD_ITEM &aBoardItem) const override
Definition: pcb_text.cpp:638
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:85
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
void Mask(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName)
Sets a base class property as masked in a derived class.
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:87
PROPERTY_BASE & AddProperty(PROPERTY_BASE *aProperty, const wxString &aGroup=wxEmptyString)
Register a property.
void OverrideAvailability(TYPE_ID aDerived, TYPE_ID aBase, const wxString &aName, std::function< bool(INSPECTABLE *)> aFunc)
Sets an override availability functor for a base class property of a given derived class.
void AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
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.
void BooleanSubtract(const SHAPE_POLY_SET &b, POLYGON_MODE aFastMode)
Perform boolean polyset difference For aFastMode meaning, see function booleanOp.
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 BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
KIFONT::FONT * m_Font
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
wxString ExpandTextVars(const wxString &aSource, const PROJECT *aProject)
Definition: common.cpp:58
void TransformOvalToPolygon(SHAPE_POLY_SET &aBuffer, const VECTOR2I &aStart, const VECTOR2I &aEnd, int aWidth, int aError, ERROR_LOC aErrorLoc, int aMinSegCount=0)
Convert a oblong shape to a polygon, using multiple segments.
#define _HKI(x)
#define _(s)
static constexpr EDA_ANGLE ANGLE_90
Definition: eda_angle.h:437
@ DEGREES_T
Definition: eda_angle.h:31
static constexpr EDA_ANGLE ANGLE_VERTICAL
Definition: eda_angle.h:432
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
Definition: eda_angle.h:431
static constexpr EDA_ANGLE ANGLE_180
Definition: eda_angle.h:439
#define PCB_EDIT_FRAME_NAME
static FILENAME_RESOLVER * resolver
Definition: export_idf.cpp:53
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
@ ERROR_OUTSIDE
@ ERROR_INSIDE
int GetKnockoutTextMargin(const VECTOR2I &aSize, int aThickness)
Returns the margin for knocking out text.
Definition: gr_text.h:92
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:149
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition: layer_ids.h:977
@ LAYER_LOCKED_ITEM_SHADOW
shadow layer for locked items
Definition: layer_ids.h:243
@ LAYER_FOOTPRINTS_FR
show footprints on front
Definition: layer_ids.h:212
@ LAYER_FP_REFERENCES
show footprints references (when texts are visible)
Definition: layer_ids.h:215
@ LAYER_HIDDEN_TEXT
text marked as invisible
Definition: layer_ids.h:204
@ LAYER_FP_TEXT
Definition: layer_ids.h:202
@ LAYER_FOOTPRINTS_BK
show footprints on back
Definition: layer_ids.h:213
@ 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
@ B_Cu
Definition: layer_ids.h:95
@ F_SilkS
Definition: layer_ids.h:104
@ B_SilkS
Definition: layer_ids.h:103
@ F_Cu
Definition: layer_ids.h:64
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Definition: lset.cpp:634
T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:31
KICOMMON_API wxString EllipsizeMenuText(const wxString &aString)
Ellipsize text (at the end) to be no more than 36 characters.
Definition: ui_common.cpp:210
KICOMMON_API wxString EllipsizeStatusText(wxWindow *aWindow, const wxString &aString)
Ellipsize text (at the end) to be no more than 1/3 of the window width.
Definition: ui_common.cpp:192
static struct PCB_TEXT_DESC _PCB_TEXT_DESC
#define TYPE_HASH(x)
Definition: property.h:71
#define REGISTER_TYPE(x)
Definition: property_mgr.h:366
wxString UnescapeString(const wxString &aSource)
constexpr int mmToIU(double mm) const
Definition: base_units.h:88
GR_TEXT_H_ALIGN_T
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:228
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:92
VECTOR2< int > VECTOR2I
Definition: vector2d.h:588