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>
42#include <callback_gal.h>
44#include <api/api_enums.h>
45#include <api/api_utils.h>
46#include <api/board/board_types.pb.h>
47
48
50 BOARD_ITEM( parent, idtype ),
52{
53 SetMultilineAllowed( true );
54}
55
56
58 BOARD_ITEM( aParent, idtype ),
60{
61 SetKeepUpright( true );
62
63 // N.B. Do not automatically set text effects
64 // These are optional in the file format and so need to be defaulted to off.
65
67
68 if( aParent )
69 {
70 SetTextPos( aParent->GetPosition() );
71
72 if( IsBackLayer( aParent->GetLayer() ) )
74 }
75}
76
77
81
82
83void PCB_TEXT::CopyFrom( const BOARD_ITEM* aOther )
84{
85 wxCHECK( aOther && aOther->Type() == PCB_TEXT_T, /* void */ );
86 *this = *static_cast<const PCB_TEXT*>( aOther );
87}
88
89
90void PCB_TEXT::Serialize( google::protobuf::Any &aContainer ) const
91{
92 using namespace kiapi::common;
93 kiapi::board::types::BoardText boardText;
94
95 boardText.mutable_id()->set_value( m_Uuid.AsStdString() );
97 boardText.set_knockout( IsKnockout() );
98 boardText.set_locked( IsLocked() ? types::LockedState::LS_LOCKED
99 : types::LockedState::LS_UNLOCKED );
100
101 google::protobuf::Any any;
103 any.UnpackTo( boardText.mutable_text() );
104
105 // Some of the common Text message fields are not stored in EDA_TEXT
106 types::Text* text = boardText.mutable_text();
107
108 PackVector2( *text->mutable_position(), GetPosition() );
109
110 aContainer.PackFrom( boardText );
111}
112
113
114bool PCB_TEXT::Deserialize( const google::protobuf::Any &aContainer )
115{
116 using namespace kiapi::common;
117 kiapi::board::types::BoardText boardText;
118
119 if( !aContainer.UnpackTo( &boardText ) )
120 return false;
121
123 const_cast<KIID&>( m_Uuid ) = KIID( boardText.id().value() );
124 SetIsKnockout( boardText.knockout() );
125 SetLocked( boardText.locked() == types::LockedState::LS_LOCKED );
126
127 google::protobuf::Any any;
128 any.PackFrom( boardText.text() );
130
131 const types::Text& text = boardText.text();
132
133 SetPosition( UnpackVector2( text.position() ) );
134
135 return true;
136}
137
138
139wxString PCB_TEXT::GetShownText( bool aAllowExtraText, int aDepth ) const
140{
141 const FOOTPRINT* parentFootprint = GetParentFootprint();
142 const BOARD* board = GetBoard();
143
144 std::function<bool( wxString* )> resolver =
145 [&]( wxString* token ) -> bool
146 {
147 if( token->IsSameAs( wxT( "LAYER" ) ) )
148 {
149 *token = GetLayerName();
150 return true;
151 }
152
153 if( parentFootprint && parentFootprint->ResolveTextVar( token, aDepth + 1 ) )
154 return true;
155
156 // board can be null in some cases when saving a footprint in FP editor
157 if( board && board->ResolveTextVar( token, aDepth + 1 ) )
158 return true;
159
160 return false;
161 };
162
163 wxString text = EDA_TEXT::GetShownText( aAllowExtraText, aDepth );
164
165 if( HasTextVars() )
166 {
167 if( aDepth < ADVANCED_CFG::GetCfg().m_ResolveTextRecursionDepth )
169 }
170
171 if( text.Contains( wxT( "@{" ) ) )
173
174 return text;
175}
176
177
178bool PCB_TEXT::Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
179{
180 return BOARD_ITEM::Matches( UnescapeString( GetText() ), aSearchData );
181}
182
183
185{
186 EDA_ANGLE rotation = GetTextAngle();
187
189 {
190 // Keep angle between ]-90..90] deg. Otherwise the text is not easy to read
191 while( rotation > ANGLE_90 )
192 rotation -= ANGLE_180;
193
194 while( rotation <= -ANGLE_90 )
195 rotation += ANGLE_180;
196 }
197 else
198 {
199 rotation.Normalize();
200 }
201
202 return rotation;
203}
204
205
207{
208 return GetBoundingBox();
209}
210
211
212std::vector<int> PCB_TEXT::ViewGetLayers() const
213{
216
217 return { GetLayer() };
218}
219
220
221double PCB_TEXT::ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const
222{
223 if( !aView )
224 return LOD_SHOW;
225
226 KIGFX::PCB_PAINTER& painter = static_cast<KIGFX::PCB_PAINTER&>( *aView->GetPainter() );
227 KIGFX::PCB_RENDER_SETTINGS& renderSettings = *painter.GetSettings();
228
229 if( !aView->IsLayerVisible( GetLayer() ) )
230 return LOD_HIDE;
231
232 if( aLayer == LAYER_LOCKED_ITEM_SHADOW )
233 {
234 // Hide shadow on dimmed tracks
235 if( renderSettings.GetHighContrast() )
236 {
237 if( m_layer != renderSettings.GetPrimaryHighContrastLayer() )
238 return LOD_HIDE;
239 }
240 }
241
242 if( FOOTPRINT* parentFP = GetParentFootprint() )
243 {
244 // Handle Render tab switches
245 if( GetText() == wxT( "${VALUE}" ) )
246 {
247 if( !aView->IsLayerVisible( LAYER_FP_VALUES ) )
248 return LOD_HIDE;
249 }
250
251 if( GetText() == wxT( "${REFERENCE}" ) )
252 {
253 if( !aView->IsLayerVisible( LAYER_FP_REFERENCES ) )
254 return LOD_HIDE;
255 }
256
257 if( parentFP->GetLayer() == F_Cu && !aView->IsLayerVisible( LAYER_FOOTPRINTS_FR ) )
258 return LOD_HIDE;
259
260 if( parentFP->GetLayer() == B_Cu && !aView->IsLayerVisible( LAYER_FOOTPRINTS_BK ) )
261 return LOD_HIDE;
262
263 if( !aView->IsLayerVisible( LAYER_FP_TEXT ) )
264 return LOD_HIDE;
265 }
266
267 return LOD_SHOW;
268}
269
270
271void PCB_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
272{
273 FOOTPRINT* parentFP = GetParentFootprint();
274
275 if( parentFP && aFrame->GetName() == PCB_EDIT_FRAME_NAME )
276 aList.emplace_back( _( "Footprint" ), parentFP->GetReference() );
277
278 // Don't use GetShownText() here; we want to show the user the variable references
279 if( parentFP )
280 aList.emplace_back( _( "Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
281 else
282 aList.emplace_back( _( "PCB Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
283
284 if( parentFP )
285 aList.emplace_back( _( "Type" ), GetTextTypeDescription() );
286
287 if( aFrame->GetName() == PCB_EDIT_FRAME_NAME && IsLocked() )
288 aList.emplace_back( _( "Status" ), _( "Locked" ) );
289
290 aList.emplace_back( _( "Layer" ), GetLayerName() );
291
292 aList.emplace_back( _( "Mirror" ), IsMirrored() ? _( "Yes" ) : _( "No" ) );
293
294 aList.emplace_back( _( "Angle" ), wxString::Format( wxT( "%g" ), GetTextAngle().AsDegrees() ) );
295
296 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
297
298 if( GetTextThickness() )
299 aList.emplace_back( _( "Text Thickness" ), aFrame->MessageTextFromValue( GetEffectiveTextPenWidth() ) );
300 else
301 aList.emplace_back( _( "Text Thickness" ), _( "Auto" ) );
302
303 aList.emplace_back( _( "Width" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
304 aList.emplace_back( _( "Height" ), aFrame->MessageTextFromValue( GetTextHeight() ) );
305}
306
307
312
313
315{
316 SetTextSize( settings.GetTextSize( GetLayer() ) );
318 SetItalic( settings.GetTextItalic( GetLayer() ) );
319 SetKeepUpright( settings.GetTextUpright( GetLayer() ) );
320
321 if( BOARD* board = GetBoard() )
322 SetMirrored( board->IsBackLayer( GetLayer() ) );
323 else
325}
326
327
329{
330 if( !IsKeepUpright() )
331 return;
332
333 EDA_ANGLE newAngle = GetTextAngle();
334 newAngle.Normalize();
335
336 bool needsFlipped = newAngle >= ANGLE_180;
337
338 if( needsFlipped )
339 {
341 SetVertJustify( static_cast<GR_TEXT_V_ALIGN_T>( -GetVertJustify() ) );
342 newAngle += ANGLE_180;
343 newAngle.Normalize();
344 SetTextAngle( newAngle );
345 }
346}
347
348
350{
351 EDA_ANGLE angle = GetDrawRotation();
352 BOX2I rect = GetTextBox( nullptr );
353
354 if( IsKnockout() )
355 rect.Inflate( getKnockoutMargin() );
356
357 if( !angle.IsZero() )
358 rect = rect.GetBoundingBoxRotated( GetTextPos(), angle );
359
360 return rect;
361}
362
363
364bool PCB_TEXT::TextHitTest( const VECTOR2I& aPoint, int aAccuracy ) const
365{
366 int accuracy = aAccuracy;
367
368 if( IsKnockout() )
370
371 return EDA_TEXT::TextHitTest( aPoint, accuracy );
372}
373
374
375bool PCB_TEXT::TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy ) const
376{
377 BOX2I rect = aRect;
378
379 rect.Inflate( aAccuracy );
380
381 if( aContains )
382 return rect.Contains( GetBoundingBox() );
383
384 return rect.Intersects( GetBoundingBox() );
385}
386
387
388bool PCB_TEXT::TextHitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
389{
390 BOX2I rect = GetTextBox( nullptr );
391
392 if( IsKnockout() )
393 rect.Inflate( getKnockoutMargin() );
394
395 return KIGEOM::BoxHitTest( aPoly, rect, GetDrawRotation(), GetDrawPos(), aContained );
396}
397
398
399void PCB_TEXT::Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle )
400{
401 VECTOR2I pt = GetTextPos();
402 RotatePoint( pt, aRotCentre, aAngle );
403 SetTextPos( pt );
404
405 EDA_ANGLE new_angle = GetTextAngle() + aAngle;
406 new_angle.Normalize();
407 SetTextAngle( new_angle );
408}
409
410
411void PCB_TEXT::Mirror( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
412{
413 // the position and justification are mirrored, but not the text itself
414
415 if( aFlipDirection == FLIP_DIRECTION::LEFT_RIGHT )
416 {
419
420 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
421 }
422 else
423 {
426
427 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
428 }
429}
430
431
432void PCB_TEXT::Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection )
433{
434 if( aFlipDirection == FLIP_DIRECTION::LEFT_RIGHT )
435 {
436 SetTextX( MIRRORVAL( GetTextPos().x, aCentre.x ) );
438 }
439 else
440 {
441 SetTextY( MIRRORVAL( GetTextPos().y, aCentre.y ) );
443 }
444
446
447 if( IsSideSpecific() )
449}
450
451
453{
454 return _( "Text" );
455}
456
457
458wxString PCB_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
459{
460 wxString content = aFull ? GetShownText( false ) : KIUI::EllipsizeMenuText( GetText() );
461
462 if( FOOTPRINT* parentFP = GetParentFootprint() )
463 {
464 wxString ref = parentFP->GetReference();
465 return wxString::Format( _( "Footprint text of %s (%s)" ), ref, content );
466 }
467
468 return wxString::Format( _( "PCB text '%s' on %s" ), content, GetLayerName() );
469}
470
471
473{
474 return BITMAPS::text;
475}
476
477
479{
480 return new PCB_TEXT( *this );
481}
482
483
485{
486 assert( aImage->Type() == PCB_TEXT_T );
487
488 std::swap( *((PCB_TEXT*) this), *((PCB_TEXT*) aImage) );
489}
490
491
492std::shared_ptr<SHAPE> PCB_TEXT::GetEffectiveShape( PCB_LAYER_ID aLayer, FLASHING aFlash ) const
493{
494 if( IsKnockout() )
495 {
496 SHAPE_POLY_SET poly;
497
499
500 return std::make_shared<SHAPE_POLY_SET>( std::move( poly ) );
501 }
502
503 return GetEffectiveTextShape();
504}
505
506
507SHAPE_POLY_SET PCB_TEXT::GetKnockoutCache( const KIFONT::FONT* aFont, const wxString& forResolvedText,
508 int aMaxError ) const
509{
511 EDA_ANGLE drawAngle = GetDrawRotation();
512 VECTOR2I drawPos = GetDrawPos();
513
514 if( m_knockout_cache.IsEmpty()
516 || m_knockout_cache_text != forResolvedText
517 || m_knockout_cache_angle != drawAngle )
518 {
519 m_knockout_cache.RemoveAllContours();
520
522 m_knockout_cache.Fracture();
523
525 m_knockout_cache_angle = drawAngle;
526 m_knockout_cache_text = forResolvedText;
527 m_knockout_cache_pos = drawPos;
528 }
529 else if( m_knockout_cache_pos != drawPos )
530 {
531 m_knockout_cache.Move( drawPos - m_knockout_cache_pos );
532 m_knockout_cache_pos = drawPos;
533 }
534
535 return m_knockout_cache;
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( nullptr );
573 int penWidth = GetEffectiveTextPenWidth();
575 wxString shownText = GetShownText( true );
576
577 attrs.m_Angle = GetDrawRotation();
578
579 // The polygonal shape of a text can have many basic shapes, so combining these shapes can
580 // be very useful to create a final shape with a lot less vertices to speedup calculations.
581 // Simplify shapes is not usually always efficient, but in this case it is.
582 SHAPE_POLY_SET textShape;
583
584 CALLBACK_GAL callback_gal( empty_opts,
585 // Stroke callback
586 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2 )
587 {
588 TransformOvalToPolygon( textShape, aPt1, aPt2, penWidth, aMaxError, aErrorLoc );
589 },
590 // Triangulation callback
591 [&]( const VECTOR2I& aPt1, const VECTOR2I& aPt2, const VECTOR2I& aPt3 )
592 {
593 textShape.NewOutline();
594
595 for( const VECTOR2I& point : { aPt1, aPt2, aPt3 } )
596 textShape.Append( point.x, point.y );
597 } );
598
599 if( auto* cache = GetRenderCache( font, shownText ) )
600 callback_gal.DrawGlyphs( *cache );
601 else
602 font->Draw( &callback_gal, shownText, GetTextPos(), attrs, GetFontMetrics() );
603
604 textShape.Simplify();
605
606 if( IsKnockout() )
607 {
608 SHAPE_POLY_SET finalPoly;
609 int margin = GetKnockoutTextMargin( attrs.m_Size, penWidth );
610
611 buildBoundingHull( &finalPoly, textShape, margin + aClearance );
612 finalPoly.BooleanSubtract( textShape );
613
614 aBuffer.Append( finalPoly );
615 }
616 else
617 {
618 if( aClearance > 0 || aErrorLoc == ERROR_OUTSIDE )
619 {
620 if( aErrorLoc == ERROR_OUTSIDE )
621 aClearance += aMaxError;
622
623 textShape.Inflate( aClearance, CORNER_STRATEGY::ROUND_ALL_CORNERS, aMaxError );
624 }
625
626 aBuffer.Append( textShape );
627 }
628}
629
630
632 int aClearance, int aMaxError, ERROR_LOC aErrorLoc,
633 bool aIgnoreLineWidth ) const
634{
635 SHAPE_POLY_SET poly;
636
637 TransformTextToPolySet( poly, 0, aMaxError, aErrorLoc );
638
639 buildBoundingHull( &aBuffer, poly, aClearance );
640}
641
642
643bool PCB_TEXT::operator==( const BOARD_ITEM& aBoardItem ) const
644{
645 if( aBoardItem.Type() != Type() )
646 return false;
647
648 const PCB_TEXT& other = static_cast<const PCB_TEXT&>( aBoardItem );
649
650 return *this == other;
651}
652
653
654bool PCB_TEXT::operator==( const PCB_TEXT& aOther ) const
655{
656 return EDA_TEXT::operator==( aOther );
657}
658
659
660double PCB_TEXT::Similarity( const BOARD_ITEM& aOther ) const
661{
662 if( aOther.Type() != Type() )
663 return 0.0;
664
665 const PCB_TEXT& other = static_cast<const PCB_TEXT&>( aOther );
666
667 return EDA_TEXT::Similarity( other );
668}
669
670
671static struct PCB_TEXT_DESC
672{
674 {
681
682 propMgr.Mask( TYPE_HASH( PCB_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Color" ) );
683
684 propMgr.AddProperty( new PROPERTY<PCB_TEXT, bool, BOARD_ITEM>( _HKI( "Knockout" ),
686 _HKI( "Text Properties" ) );
687
688 propMgr.AddProperty( new PROPERTY<PCB_TEXT, bool, EDA_TEXT>( _HKI( "Keep Upright" ),
690 _HKI( "Text Properties" ) );
691
692 auto isFootprintText =
693 []( INSPECTABLE* aItem ) -> bool
694 {
695 if( PCB_TEXT* text = dynamic_cast<PCB_TEXT*>( aItem ) )
696 return text->GetParentFootprint();
697
698 return false;
699 };
700
702 _HKI( "Keep Upright" ), isFootprintText );
703
704 propMgr.Mask( TYPE_HASH( PCB_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Hyperlink" ) );
705 }
types::KiCadObjectType ToProtoEnum(KICAD_T aValue)
Definition api_enums.cpp:95
KICAD_T FromProtoEnum(types::KiCadObjectType aValue)
Definition api_enums.cpp:35
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
constexpr EDA_IU_SCALE pcbIUScale
Definition base_units.h:112
BITMAPS
A list of all bitmap identifiers.
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
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
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype, PCB_LAYER_ID aLayer=F_Cu)
Definition board_item.h:81
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:323
PCB_LAYER_ID m_layer
Definition board_item.h:453
virtual bool IsKnockout() const
Definition board_item.h:319
bool IsLocked() const override
virtual void SetIsKnockout(bool aKnockout)
Definition board_item.h:320
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition board_item.h:280
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
FOOTPRINT * GetParentFootprint() const
const KIFONT::METRICS & GetFontMetrics() const
bool IsSideSpecific() const
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
int GetMaxError() const
Information pertinent to a Pcbnew printed circuit board.
Definition board.h:317
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.
const KIID m_Uuid
Definition eda_item.h:516
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition eda_item.h:401
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:39
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:266
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition eda_text.cpp:188
const VECTOR2I & GetTextPos() const
Definition eda_text.h:272
const EDA_ANGLE & GetTextAngle() const
Definition eda_text.h:146
void SetTextSize(VECTOR2I aNewSize, bool aEnforceMinTextSize=true)
Definition eda_text.cpp:534
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:205
void SetTextPos(const VECTOR2I &aPoint)
Definition eda_text.cpp:579
void SetTextX(int aX)
Definition eda_text.cpp:585
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition eda_text.cpp:224
KIFONT::FONT * GetFont() const
Definition eda_text.h:246
void SetMirrored(bool isMirrored)
Definition eda_text.cpp:394
void SetTextY(int aY)
Definition eda_text.cpp:591
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:685
virtual VECTOR2I GetDrawPos() const
Definition eda_text.h:377
int GetTextWidth() const
Definition eda_text.h:263
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:744
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
Definition eda_text.cpp:418
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition eda_text.h:199
virtual KIFONT::FONT * GetDrawFont(const RENDER_SETTINGS *aSettings) const
Definition eda_text.cpp:650
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition eda_text.h:116
EDA_TEXT(const EDA_IU_SCALE &aIuScale, const wxString &aText=wxEmptyString)
Definition eda_text.cpp:96
double Similarity(const EDA_TEXT &aOther) const
wxString EvaluateText(const wxString &aText) const
Definition eda_text.cpp:642
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition eda_text.cpp:285
virtual bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const
Test if aPoint is within the bounds of this object.
Definition eda_text.cpp:871
const TEXT_ATTRIBUTES & GetAttributes() const
Definition eda_text.h:230
bool IsMirrored() const
Definition eda_text.h:189
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition eda_text.cpp:466
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.
void SetKeepUpright(bool aKeepUpright)
Definition eda_text.cpp:426
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition eda_text.h:202
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:300
int GetTextThickness() const
Definition eda_text.h:127
void SetItalic(bool aItalic)
Set the text to be italic - this will also update the font if needed.
Definition eda_text.cpp:308
bool operator==(const EDA_TEXT &aRhs) const
Definition eda_text.h:395
void SetMultilineAllowed(bool aAllow)
Definition eda_text.cpp:402
VECTOR2I GetTextSize() const
Definition eda_text.h:260
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition eda_text.cpp:410
bool ResolveTextVar(wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the component.
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition footprint.h:257
const wxString & GetReference() const
Definition footprint.h:661
VECTOR2I GetPosition() const override
Definition footprint.h:245
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.
virtual PCB_RENDER_SETTINGS * GetSettings() override
Return a pointer to current settings that are going to be used when drawing items.
PCB specific render settings.
Definition pcb_painter.h:81
PCB_LAYER_ID GetPrimaryHighContrastLayer() const
Return the board layer which is in high-contrast mode.
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:66
bool IsLayerVisible(int aLayer) const
Return information about visibility of a particular layer.
Definition view.h:422
PAINTER * GetPainter() const
Return the painter object used by the view for drawing #VIEW_ITEMS.
Definition view.h:220
Definition kiid.h:49
SHAPE_POLY_SET GetKnockoutCache(const KIFONT::FONT *aFont, const wxString &forResolvedText, int aMaxError) const
Definition pcb_text.cpp:507
void CopyFrom(const BOARD_ITEM *aOther) override
Definition pcb_text.cpp:83
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:271
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:660
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:631
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition pcb_text.cpp:458
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition pcb_text.cpp:206
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition pcb_text.cpp:432
virtual void swapData(BOARD_ITEM *aImage) override
Definition pcb_text.cpp:484
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:492
void KeepUpright()
Called when rotating the parent footprint.
Definition pcb_text.cpp:328
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition pcb_text.cpp:178
EDA_ANGLE m_knockout_cache_angle
Definition pcb_text.h:204
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition pcb_text.cpp:90
wxString GetShownText(bool aAllowExtraText, int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition pcb_text.cpp:139
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:411
double ViewGetLOD(int aLayer, const KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition pcb_text.cpp:221
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:49
wxString m_knockout_cache_text
Definition pcb_text.h:202
TEXT_ATTRIBUTES m_knockout_cache_text_attrs
Definition pcb_text.h:203
void StyleFromSettings(const BOARD_DESIGN_SETTINGS &settings) override
Definition pcb_text.cpp:314
bool operator==(const PCB_TEXT &aOther) const
Definition pcb_text.cpp:654
int getKnockoutMargin() const
Definition pcb_text.cpp:308
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
SHAPE_POLY_SET m_knockout_cache
Definition pcb_text.h:206
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition pcb_text.cpp:349
virtual wxString GetTextTypeDescription() const
Definition pcb_text.cpp:452
std::vector< int > ViewGetLayers() const override
Definition pcb_text.cpp:212
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:364
virtual void SetPosition(const VECTOR2I &aPos) override
Definition pcb_text.h:89
VECTOR2I m_knockout_cache_pos
Definition pcb_text.h:205
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition pcb_text.cpp:478
EDA_ANGLE GetDrawRotation() const override
Definition pcb_text.cpp:184
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition pcb_text.cpp:114
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition pcb_text.cpp:399
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition pcb_text.cpp:472
Provide class metadata.Helper macro to map type hashes to names.
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()
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 polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
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 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 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().
A type-safe container of any type.
Definition ki_any.h:93
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.
@ ROUND_ALL_CORNERS
All angles are rounded.
#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
a few functions useful in geometry calculations.
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:799
@ 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
@ LEFT_RIGHT
Flip left to right (around the Y axis)
Definition mirror.h:28
bool BoxHitTest(const VECTOR2I &aHitPoint, const BOX2I &aHittee, int aAccuracy)
Perform a point-to-box hit test.
KICOMMON_API wxString EllipsizeMenuText(const wxString &aString)
Ellipsize text (at the end) to be no more than 36 characters.
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.
KICOMMON_API VECTOR2I UnpackVector2(const types::Vector2 &aInput)
Definition api_utils.cpp:85
KICOMMON_API void PackVector2(types::Vector2 &aOutput, const VECTOR2I &aInput)
Definition api_utils.cpp:78
#define _HKI(x)
Definition page_info.cpp:44
static struct PCB_TEXT_DESC _PCB_TEXT_DESC
#define TYPE_HASH(x)
Definition property.h:73
#define REGISTER_TYPE(x)
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