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 The 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 <advanced_config.h>
29#include <pcb_edit_frame.h>
30#include <base_units.h>
31#include <bitmaps.h>
32#include <board.h>
34#include <core/mirror.h>
35#include <footprint.h>
36#include <pcb_text.h>
37#include <pcb_painter.h>
38#include <trigo.h>
39#include <string_utils.h>
41#include <callback_gal.h>
43#include <api/api_enums.h>
44#include <api/api_utils.h>
45#include <api/board/board_types.pb.h>
46
47
49 BOARD_ITEM( parent, idtype ),
51{
52 SetMultilineAllowed( true );
53}
54
55
57 BOARD_ITEM( aParent, idtype ),
59{
60 SetKeepUpright( true );
61
62 // N.B. Do not automatically set text effects
63 // These are optional in the file format and so need to be defaulted to off.
64
66
67 if( aParent )
68 {
69 SetTextPos( aParent->GetPosition() );
70
71 if( IsBackLayer( aParent->GetLayer() ) )
73 }
74}
75
76
78{
79}
80
81
82void PCB_TEXT::CopyFrom( const BOARD_ITEM* aOther )
83{
84 wxCHECK( aOther && aOther->Type() == PCB_TEXT_T, /* void */ );
85 *this = *static_cast<const PCB_TEXT*>( aOther );
86}
87
88
89void PCB_TEXT::Serialize( google::protobuf::Any &aContainer ) const
90{
91 using namespace kiapi::common;
92 kiapi::board::types::BoardText boardText;
93
94 boardText.mutable_id()->set_value( m_Uuid.AsStdString() );
95 boardText.set_layer( ToProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>( GetLayer() ) );
96 boardText.set_knockout( IsKnockout() );
97 boardText.set_locked( IsLocked() ? types::LockedState::LS_LOCKED
98 : types::LockedState::LS_UNLOCKED );
99
100 google::protobuf::Any any;
101 EDA_TEXT::Serialize( any );
102 any.UnpackTo( boardText.mutable_text() );
103
104 // Some of the common Text message fields are not stored in EDA_TEXT
105 types::Text* text = boardText.mutable_text();
106
107 PackVector2( *text->mutable_position(), GetPosition() );
108
109 aContainer.PackFrom( boardText );
110}
111
112
113bool PCB_TEXT::Deserialize( const google::protobuf::Any &aContainer )
114{
115 using namespace kiapi::common;
116 kiapi::board::types::BoardText boardText;
117
118 if( !aContainer.UnpackTo( &boardText ) )
119 return false;
120
121 SetLayer( FromProtoEnum<PCB_LAYER_ID, kiapi::board::types::BoardLayer>( boardText.layer() ) );
122 const_cast<KIID&>( m_Uuid ) = KIID( boardText.id().value() );
123 SetIsKnockout( boardText.knockout() );
124 SetLocked( boardText.locked() == types::LockedState::LS_LOCKED );
125
126 google::protobuf::Any any;
127 any.PackFrom( boardText.text() );
129
130 const types::Text& text = boardText.text();
131
132 SetPosition( UnpackVector2( text.position() ) );
133
134 return true;
135}
136
137
138wxString PCB_TEXT::GetShownText( bool aAllowExtraText, int aDepth ) const
139{
140 const FOOTPRINT* parentFootprint = GetParentFootprint();
141 const BOARD* board = GetBoard();
142
143 std::function<bool( wxString* )> resolver =
144 [&]( wxString* token ) -> bool
145 {
146 if( token->IsSameAs( wxT( "LAYER" ) ) )
147 {
148 *token = GetLayerName();
149 return true;
150 }
151
152 if( parentFootprint && parentFootprint->ResolveTextVar( token, aDepth + 1 ) )
153 return true;
154
155 // board can be null in some cases when saving a footprint in FP editor
156 if( board && board->ResolveTextVar( token, aDepth + 1 ) )
157 return true;
158
159 return false;
160 };
161
162 wxString text = EDA_TEXT::GetShownText( aAllowExtraText, aDepth );
163
164 if( HasTextVars() )
165 {
166 if( aDepth < ADVANCED_CFG::GetCfg().m_ResolveTextRecursionDepth )
168 }
169
170 return text;
171}
172
173
174bool PCB_TEXT::Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
175{
176 return BOARD_ITEM::Matches( UnescapeString( GetText() ), aSearchData );
177}
178
179
181{
182 EDA_ANGLE rotation = GetTextAngle();
183
185 {
186 // Keep angle between ]-90..90] deg. Otherwise the text is not easy to read
187 while( rotation > ANGLE_90 )
188 rotation -= ANGLE_180;
189
190 while( rotation <= -ANGLE_90 )
191 rotation += ANGLE_180;
192 }
193 else
194 {
195 rotation.Normalize();
196 }
197
198 return rotation;
199}
200
201
203{
204 return GetBoundingBox();
205}
206
207
208std::vector<int> PCB_TEXT::ViewGetLayers() const
209{
212
213 return { GetLayer() };
214}
215
216
217double PCB_TEXT::ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const
218{
219 if( !aView )
220 return LOD_SHOW;
221
222 KIGFX::PCB_PAINTER& painter = static_cast<KIGFX::PCB_PAINTER&>( *aView->GetPainter() );
223 KIGFX::PCB_RENDER_SETTINGS& renderSettings = *painter.GetSettings();
224
225 if( !aView->IsLayerVisible( GetLayer() ) )
226 return LOD_HIDE;
227
228 if( aLayer == LAYER_LOCKED_ITEM_SHADOW )
229 {
230 // Hide shadow on dimmed tracks
231 if( renderSettings.GetHighContrast() )
232 {
233 if( m_layer != renderSettings.GetPrimaryHighContrastLayer() )
234 return LOD_HIDE;
235 }
236 }
237
238 if( FOOTPRINT* parentFP = GetParentFootprint() )
239 {
240 // Handle Render tab switches
241 if( GetText() == wxT( "${VALUE}" ) )
242 {
243 if( !aView->IsLayerVisible( LAYER_FP_VALUES ) )
244 return LOD_HIDE;
245 }
246
247 if( GetText() == wxT( "${REFERENCE}" ) )
248 {
249 if( !aView->IsLayerVisible( LAYER_FP_REFERENCES ) )
250 return LOD_HIDE;
251 }
252
253 if( parentFP->GetLayer() == F_Cu && !aView->IsLayerVisible( LAYER_FOOTPRINTS_FR ) )
254 return LOD_HIDE;
255
256 if( parentFP->GetLayer() == B_Cu && !aView->IsLayerVisible( LAYER_FOOTPRINTS_BK ) )
257 return LOD_HIDE;
258
259 if( !aView->IsLayerVisible( LAYER_FP_TEXT ) )
260 return LOD_HIDE;
261 }
262
263 return LOD_SHOW;
264}
265
266
267void PCB_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
268{
269 FOOTPRINT* parentFP = GetParentFootprint();
270
271 if( parentFP && aFrame->GetName() == PCB_EDIT_FRAME_NAME )
272 aList.emplace_back( _( "Footprint" ), parentFP->GetReference() );
273
274 // Don't use GetShownText() here; we want to show the user the variable references
275 if( parentFP )
276 aList.emplace_back( _( "Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
277 else
278 aList.emplace_back( _( "PCB Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
279
280 if( parentFP )
281 aList.emplace_back( _( "Type" ), GetTextTypeDescription() );
282
283 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME && IsLocked() )
284 aList.emplace_back( _( "Status" ), _( "Locked" ) );
285
286 aList.emplace_back( _( "Layer" ), GetLayerName() );
287
288 aList.emplace_back( _( "Mirror" ), IsMirrored() ? _( "Yes" ) : _( "No" ) );
289
290 aList.emplace_back( _( "Angle" ), wxString::Format( wxT( "%g" ), GetTextAngle().AsDegrees() ) );
291
292 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
293
294 if( GetTextThickness() )
295 aList.emplace_back( _( "Text Thickness" ), aFrame->MessageTextFromValue( GetEffectiveTextPenWidth() ) );
296 else
297 aList.emplace_back( _( "Text Thickness" ), _( "Auto" ) );
298
299 aList.emplace_back( _( "Width" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
300 aList.emplace_back( _( "Height" ), aFrame->MessageTextFromValue( GetTextHeight() ) );
301}
302
303
305{
307}
308
309
311{
312 SetTextSize( settings.GetTextSize( GetLayer() ) );
314 SetItalic( settings.GetTextItalic( GetLayer() ) );
315 SetKeepUpright( settings.GetTextUpright( GetLayer() ) );
316
317 if( BOARD* board = GetBoard() )
318 SetMirrored( board->IsBackLayer( GetLayer() ) );
319 else
321}
322
323
325{
326 if( !IsKeepUpright() )
327 return;
328
329 EDA_ANGLE newAngle = GetTextAngle();
330 newAngle.Normalize();
331
332 bool needsFlipped = newAngle >= ANGLE_180;
333
334 if( needsFlipped )
335 {
337 SetVertJustify( static_cast<GR_TEXT_V_ALIGN_T>( -GetVertJustify() ) );
338 newAngle += ANGLE_180;
339 newAngle.Normalize();
340 SetTextAngle( newAngle );
341 }
342}
343
344
346{
347 EDA_ANGLE angle = GetDrawRotation();
348 BOX2I rect = GetTextBox( nullptr );
349
350 if( IsKnockout() )
351 rect.Inflate( getKnockoutMargin() );
352
353 if( !angle.IsZero() )
354 rect = rect.GetBoundingBoxRotated( GetTextPos(), angle );
355
356 return rect;
357}
358
359
360bool PCB_TEXT::TextHitTest( const VECTOR2I& aPoint, int aAccuracy ) const
361{
362 int accuracy = aAccuracy;
363
364 if( IsKnockout() )
366
367 return EDA_TEXT::TextHitTest( aPoint, accuracy );
368}
369
370
371bool PCB_TEXT::TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy ) const
372{
373 BOX2I rect = aRect;
374
375 rect.Inflate( aAccuracy );
376
377 if( aContains )
378 return rect.Contains( GetBoundingBox() );
379
380 return rect.Intersects( GetBoundingBox() );
381}
382
383
384void PCB_TEXT::Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle )
385{
386 VECTOR2I pt = GetTextPos();
387 RotatePoint( pt, aRotCentre, aAngle );
388 SetTextPos( pt );
389
390 EDA_ANGLE new_angle = GetTextAngle() + aAngle;
391 new_angle.Normalize();
392 SetTextAngle( new_angle );
393}
394
395
396void PCB_TEXT::Mirror( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
397{
398 // the position and justification are mirrored, but not the text itself
399
400 if( aFlipDirection == FLIP_DIRECTION::LEFT_RIGHT )
401 {
404
405 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
406 }
407 else
408 {
411
412 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
413 }
414}
415
416
417void PCB_TEXT::Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
418{
419 if( aFlipDirection == FLIP_DIRECTION::LEFT_RIGHT )
420 {
421 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
423 }
424 else
425 {
426 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
428 }
429
431
432 if( IsSideSpecific() )
434}
435
436
438{
439 return _( "Text" );
440}
441
442
443wxString PCB_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
444{
445 wxString content = aFull ? GetShownText( false ) : KIUI::EllipsizeMenuText( GetText() );
446
447 if( FOOTPRINT* parentFP = GetParentFootprint() )
448 {
449 wxString ref = parentFP->GetReference();
450 return wxString::Format( _( "Footprint text of %s (%s)" ), ref, content );
451 }
452
453 return wxString::Format( _( "PCB text '%s' on %s" ), content, GetLayerName() );
454}
455
456
458{
459 return BITMAPS::text;
460}
461
462
464{
465 return new PCB_TEXT( *this );
466}
467
468
470{
471 assert( aImage->Type() == PCB_TEXT_T );
472
473 std::swap( *((PCB_TEXT*) this), *((PCB_TEXT*) aImage) );
474}
475
476
477std::shared_ptr<SHAPE> PCB_TEXT::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING aFlash ) const
478{
479 if( IsKnockout() )
480 {
481 SHAPE_POLY_SET poly;
482
484
485 return std::make_shared<SHAPE_POLY_SET>( std::move( poly ) );
486 }
487
488 return GetEffectiveTextShape();
489}
490
491
492SHAPE_POLY_SET PCB_TEXT::GetKnockoutCache( const KIFONT::FONT* aFont, const wxString& forResolvedText,
493 int aMaxError ) const
494{
496 EDA_ANGLE drawAngle = GetDrawRotation();
497 VECTOR2I drawPos = GetDrawPos();
498
501 || m_knockout_cache_text != forResolvedText
502 || m_knockout_cache_angle != drawAngle )
503 {
505
508
510 m_knockout_cache_angle = drawAngle;
511 m_knockout_cache_text = forResolvedText;
512 m_knockout_cache_pos = drawPos;
513 }
514 else if( m_knockout_cache_pos != drawPos )
515 {
517 m_knockout_cache_pos = drawPos;
518 }
519
520 return m_knockout_cache;
521}
522
523
524void PCB_TEXT::buildBoundingHull( SHAPE_POLY_SET* aBuffer, const SHAPE_POLY_SET& aRenderedText,
525 int aClearance ) const
526{
527 SHAPE_POLY_SET poly( aRenderedText );
528
529 poly.Rotate( -GetDrawRotation(), GetDrawPos() );
530
531 BOX2I rect = poly.BBox( aClearance );
532 VECTOR2I corners[4];
533
534 corners[0].x = rect.GetOrigin().x;
535 corners[0].y = rect.GetOrigin().y;
536 corners[1].y = corners[0].y;
537 corners[1].x = rect.GetRight();
538 corners[2].x = corners[1].x;
539 corners[2].y = rect.GetBottom();
540 corners[3].y = corners[2].y;
541 corners[3].x = corners[0].x;
542
543 aBuffer->NewOutline();
544
545 for( VECTOR2I& corner : corners )
546 {
547 RotatePoint( corner, GetDrawPos(), GetDrawRotation() );
548 aBuffer->Append( corner.x, corner.y );
549 }
550}
551
552
553void PCB_TEXT::TransformTextToPolySet( SHAPE_POLY_SET& aBuffer, int aClearance, int aMaxError,
554 ERROR_LOC aErrorLoc ) const
555{
557 KIFONT::FONT* font = GetDrawFont( nullptr );
558 int penWidth = GetEffectiveTextPenWidth();
560 wxString shownText = GetShownText( true );
561
562 attrs.m_Angle = GetDrawRotation();
563
564 // The polygonal shape of a text can have many basic shapes, so combining these shapes can
565 // be very useful to create a final shape with a lot less vertices to speedup calculations.
566 // Simplify shapes is not usually always efficient, but in this case it is.
567 SHAPE_POLY_SET textShape;
568
569 CALLBACK_GAL callback_gal( empty_opts,
570 // Stroke callback
571 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
572 {
573 TransformOvalToPolygon( textShape, aPt1, aPt2, penWidth, aMaxError, aErrorLoc );
574 },
575 // Triangulation callback
576 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
577 {
578 textShape.NewOutline();
579
580 for( const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
581 textShape.Append( point.x, point.y );
582 } );
583
584 if( auto* cache = GetRenderCache( font, shownText ) )
585 callback_gal.DrawGlyphs( *cache );
586 else
587 font->Draw( &callback_gal, shownText, GetTextPos(), attrs, GetFontMetrics() );
588
589 textShape.Simplify();
590
591 if( IsKnockout() )
592 {
593 SHAPE_POLY_SET finalPoly;
594 int margin = GetKnockoutTextMargin( attrs.m_Size, penWidth );
595
596 buildBoundingHull( &finalPoly, textShape, margin + aClearance );
597 finalPoly.BooleanSubtract( textShape );
598
599 aBuffer.Append( finalPoly );
600 }
601 else
602 {
603 if( aClearance > 0 || aErrorLoc == ERROR_OUTSIDE )
604 {
605 if( aErrorLoc == ERROR_OUTSIDE )
606 aClearance += aMaxError;
607
608 textShape.Inflate( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, aMaxError );
609 }
610
611 aBuffer.Append( textShape );
612 }
613}
614
615
617 int aClearance, int aMaxError, ERROR_LOC aErrorLoc,
618 bool aIgnoreLineWidth ) const
619{
620 SHAPE_POLY_SET poly;
621
622 TransformTextToPolySet( poly, 0, aMaxError, aErrorLoc );
623
624 buildBoundingHull( &aBuffer, poly, aClearance );
625}
626
627
628bool PCB_TEXT::operator==( const BOARD_ITEM& aBoardItem ) const
629{
630 if( aBoardItem.Type() != Type() )
631 return false;
632
633 const PCB_TEXT& other = static_cast<const PCB_TEXT&>( aBoardItem );
634
635 return *this == other;
636}
637
638
639bool PCB_TEXT::operator==( const PCB_TEXT& aOther ) const
640{
641 return EDA_TEXT::operator==( aOther );
642}
643
644
645double PCB_TEXT::Similarity( const BOARD_ITEM& aOther ) const
646{
647 if( aOther.Type() != Type() )
648 return 0.0;
649
650 const PCB_TEXT& other = static_cast<const PCB_TEXT&>( aOther );
651
652 return EDA_TEXT::Similarity( other );
653}
654
655
656static struct PCB_TEXT_DESC
657{
659 {
666
667 propMgr.Mask( TYPE_HASH( PCB_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Color" ) );
668
669 propMgr.AddProperty( new PROPERTY<PCB_TEXT, bool, BOARD_ITEM>( _HKI( "Knockout" ),
671 _HKI( "Text Properties" ) );
672
673 propMgr.AddProperty( new PROPERTY<PCB_TEXT, bool, EDA_TEXT>( _HKI( "Keep Upright" ),
675 _HKI( "Text Properties" ) );
676
677 auto isFootprintText =
678 []( INSPECTABLE* aItem ) -> bool
679 {
680 if( PCB_TEXT* text = dynamic_cast<PCB_TEXT*>( aItem ) )
681 return text->GetParentFootprint();
682
683 return false;
684 };
685
687 _HKI( "Keep Upright" ), isFootprintText );
688
689 propMgr.Mask( TYPE_HASH( PCB_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Hyperlink" ) );
690 }
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
Definition: approximation.h:32
@ ERROR_OUTSIDE
Definition: approximation.h:33
@ ERROR_INSIDE
Definition: approximation.h:34
constexpr EDA_IU_SCALE pcbIUScale
Definition: base_units.h:112
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
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:79
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:232
void SetLocked(bool aLocked) override
Definition: board_item.h:326
PCB_LAYER_ID m_layer
Definition: board_item.h:454
virtual bool IsKnockout() const
Definition: board_item.h:322
bool IsLocked() const override
Definition: board_item.cpp:103
virtual void SetIsKnockout(bool aKnockout)
Definition: board_item.h:323
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:283
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:79
FOOTPRINT * GetParentFootprint() const
Definition: board_item.cpp:97
const KIFONT::METRICS & GetFontMetrics() const
Definition: board_item.cpp:132
bool IsSideSpecific() const
Definition: board_item.cpp:190
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:180
int GetMaxError() const
Definition: board_item.cpp:138
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:317
bool ResolveTextVar(wxString *token, int aDepth) const
Definition: board.cpp:499
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 bool Contains(const Vec &aPoint) const
Definition: box2.h:168
constexpr const Vec & GetOrigin() const
Definition: box2.h:210
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:720
constexpr coord_type GetRight() const
Definition: box2.h:217
constexpr bool Intersects(const BOX2< Vec > &aRect) const
Definition: box2.h:311
constexpr coord_type GetBottom() const
Definition: box2.h:222
EDA_ANGLE Normalize()
Definition: eda_angle.h:229
bool IsZero() const
Definition: eda_angle.h:136
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:97
const KIID m_Uuid
Definition: eda_item.h:502
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:109
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:388
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:79
int GetTextHeight() const
Definition: eda_text.h:264
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition: eda_text.cpp:187
const VECTOR2I & GetTextPos() const
Definition: eda_text.h:270
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:144
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
Definition: eda_text.cpp:533
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:97
bool IsKeepUpright() const
Definition: eda_text.h:203
void SetTextPos(const VECTOR2I &aPoint)
Definition: eda_text.cpp:578
void SetTextX(int aX)
Definition: eda_text.cpp:584
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition: eda_text.cpp:223
KIFONT::FONT * GetFont() const
Definition: eda_text.h:244
void SetMirrored(bool isMirrored)
Definition: eda_text.cpp:393
void SetTextY(int aY)
Definition: eda_text.cpp:590
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:676
virtual VECTOR2I GetDrawPos() const
Definition: eda_text.h:375
int GetTextWidth() const
Definition: eda_text.h:261
BOX2I GetTextBox(const RENDER_SETTINGS *aSettings, int aLine=-1) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:735
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
Definition: eda_text.cpp:417
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition: eda_text.h:197
virtual KIFONT::FONT * GetDrawFont(const RENDER_SETTINGS *aSettings) const
Definition: eda_text.cpp:641
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition: eda_text.h:116
double Similarity(const EDA_TEXT &aOther) const
Definition: eda_text.cpp:1280
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.cpp:284
virtual bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const
Test if aPoint is within the bounds of this object.
Definition: eda_text.cpp:862
const TEXT_ATTRIBUTES & GetAttributes() const
Definition: eda_text.h:228
bool IsMirrored() const
Definition: eda_text.h:187
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition: eda_text.cpp:465
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:1121
void SetKeepUpright(bool aKeepUpright)
Definition: eda_text.cpp:425
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition: eda_text.h:200
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:108
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
Definition: eda_text.cpp:299
int GetTextThickness() const
Definition: eda_text.h:125
void SetItalic(bool aItalic)
Set the text to be italic - this will also update the font if needed.
Definition: eda_text.cpp:307
bool operator==(const EDA_TEXT &aRhs) const
Definition: eda_text.h:393
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.cpp:401
VECTOR2I GetTextSize() const
Definition: eda_text.h:258
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition: eda_text.cpp:409
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the component.
Definition: footprint.cpp:999
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: footprint.h:239
const wxString & GetReference() const
Definition: footprint.h:625
VECTOR2I GetPosition() const override
Definition: footprint.h:227
Class that other classes need to inherit from, in order to be inspectable.
Definition: inspectable.h:37
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:131
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:250
virtual void DrawGlyphs(const std::vector< std::unique_ptr< KIFONT::GLYPH > > &aGlyphs)
Draw polygons representing font glyphs.
Contains methods for drawing PCB-specific items.
Definition: pcb_painter.h:182
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:187
PCB specific render settings.
Definition: pcb_painter.h:80
PCB_LAYER_ID GetPrimaryHighContrastLayer() const
Return the board layer which is in high-contrast mode.
bool GetHighContrast() const
static constexpr double LOD_HIDE
Return this constant from ViewGetLOD() to hide the item unconditionally.
Definition: view_item.h:180
static constexpr double LOD_SHOW
Return this constant from ViewGetLOD() to show the item unconditionally.
Definition: view_item.h:185
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:67
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition: view.h:418
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition: view.h:216
Definition: kiid.h:49
std::string AsStdString() const
Definition: kiid.cpp:252
SHAPE_POLY_SET GetKnockoutCache(const KIFONT::FONT *aFont, const wxString &forResolvedText, int aMaxError) const
Definition: pcb_text.cpp:492
void CopyFrom(const BOARD_ITEM *aOther) override
Definition: pcb_text.cpp:82
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:267
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:645
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:616
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: pcb_text.cpp:443
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: pcb_text.cpp:202
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition: pcb_text.cpp:417
virtual void swapData(BOARD_ITEM *aImage) override
Definition: pcb_text.cpp:469
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:477
void KeepUpright()
Called when rotating the parent footprint.
Definition: pcb_text.cpp:324
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: pcb_text.cpp:174
EDA_ANGLE m_knockout_cache_angle
Definition: pcb_text.h:198
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition: pcb_text.cpp:89
wxString GetShownText(bool aAllowExtraText, int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: pcb_text.cpp:138
void Mirror(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Mirror this object relative to a given horizontal axis the layer is not changed.
Definition: pcb_text.cpp:396
double ViewGetLOD(int aLayer, const KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: pcb_text.cpp:217
~PCB_TEXT()
Definition: pcb_text.cpp:77
virtual VECTOR2I GetPosition() const override
Definition: pcb_text.h:84
PCB_TEXT(BOARD_ITEM *parent, KICAD_T idtype=PCB_TEXT_T)
Definition: pcb_text.cpp:48
wxString m_knockout_cache_text
Definition: pcb_text.h:196
TEXT_ATTRIBUTES m_knockout_cache_text_attrs
Definition: pcb_text.h:197
void StyleFromSettings(const BOARD_DESIGN_SETTINGS &settings) override
Definition: pcb_text.cpp:310
bool operator==(const PCB_TEXT &aOther) const
Definition: pcb_text.cpp:639
int getKnockoutMargin() const
Definition: pcb_text.cpp:304
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:553
SHAPE_POLY_SET m_knockout_cache
Definition: pcb_text.h:200
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_text.cpp:345
virtual wxString GetTextTypeDescription() const
Definition: pcb_text.cpp:437
std::vector< int > ViewGetLayers() const override
Definition: pcb_text.cpp:208
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:524
bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const override
Test if aPoint is within the bounds of this object.
Definition: pcb_text.cpp:360
virtual void SetPosition(const VECTOR2I &aPos) override
Definition: pcb_text.h:89
VECTOR2I m_knockout_cache_pos
Definition: pcb_text.h:199
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_text.cpp:463
EDA_ANGLE GetDrawRotation() const override
Definition: pcb_text.cpp:180
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition: pcb_text.cpp:113
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition: pcb_text.cpp:384
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: pcb_text.cpp:457
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 RemoveAllContours()
Remove all outlines & holes (clears) the polygon set.
bool IsEmpty() const
Return true if the set is empty (no polygons at all)
void Fracture()
Convert a set of polygons with holes to a single outline with "slits"/"fractures" connecting the oute...
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()
Simplify the polyset (merges overlapping polys, eliminates degeneracy/self-intersections)
int NewOutline()
Creates a new empty polygon in the set and returns its index.
void Move(const VECTOR2I &aVector) override
void BooleanSubtract(const SHAPE_POLY_SET &b)
Perform boolean polyset difference.
const BOX2I BBox(int aClearance=0) const override
Compute a bounding box of the shape, with a margin of aClearance a collision.
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, int aFlags)
Definition: common.cpp:59
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:413
static constexpr EDA_ANGLE ANGLE_VERTICAL
Definition: eda_angle.h:408
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
Definition: eda_angle.h:407
static constexpr EDA_ANGLE ANGLE_180
Definition: eda_angle.h:415
#define PCB_EDIT_FRAME_NAME
static FILENAME_RESOLVER * resolver
Definition: export_idf.cpp:53
int GetKnockoutTextMargin(const VECTOR2I &aSize, int aThickness)
Return the margin for knocking out text.
Definition: gr_text.h:95
PCB_LAYER_ID FlipLayer(PCB_LAYER_ID aLayerId, int aCopperLayersCount)
Definition: layer_id.cpp:170
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:184
bool IsBackLayer(PCB_LAYER_ID aLayerId)
Layer classification: check if it's a back layer.
Definition: layer_ids.h:789
@ LAYER_LOCKED_ITEM_SHADOW
Shadow layer for locked items.
Definition: layer_ids.h:306
@ LAYER_FOOTPRINTS_FR
Show footprints on front.
Definition: layer_ids.h:258
@ LAYER_FP_REFERENCES
Show footprints references (when texts are visible).
Definition: layer_ids.h:265
@ LAYER_FP_TEXT
Definition: layer_ids.h:239
@ LAYER_FOOTPRINTS_BK
Show footprints on back.
Definition: layer_ids.h:259
@ LAYER_FP_VALUES
Show footprints values (when texts are visible).
Definition: layer_ids.h:262
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ B_Cu
Definition: layer_ids.h:65
@ F_SilkS
Definition: layer_ids.h:100
@ B_SilkS
Definition: layer_ids.h:101
@ F_Cu
Definition: layer_ids.h:64
constexpr T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:36
FLIP_DIRECTION
Definition: mirror.h:27
KICOMMON_API wxString EllipsizeMenuText(const wxString &aString)
Ellipsize text (at the end) to be no more than 36 characters.
Definition: ui_common.cpp:221
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:203
static struct PCB_TEXT_DESC _PCB_TEXT_DESC
#define TYPE_HASH(x)
Definition: property.h:72
#define REGISTER_TYPE(x)
Definition: property_mgr.h:371
wxString UnescapeString(const wxString &aSource)
const int accuracy
GR_TEXT_H_ALIGN_T
This is API surface mapped to common.types.HorizontalAlignment.
GR_TEXT_V_ALIGN_T
This is API surface mapped to common.types.VertialAlignment.
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
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< int32_t > VECTOR2I
Definition: vector2d.h:695