KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_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) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2015 Wayne Stambaugh <[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 "markup_parser.h"
27#include <advanced_config.h>
28#include <base_units.h>
29#include <pgm_base.h>
30#include <sch_edit_frame.h>
31#include <sch_plotter.h>
32#include <widgets/msgpanel.h>
33#include <bitmaps.h>
34#include <string_utils.h>
36#include <sch_text.h>
37#include <schematic.h>
39#include <sch_painter.h>
40#include <default_values.h>
41#include <wx/debug.h>
42#include <wx/log.h>
46#include <core/mirror.h>
47#include <core/kicad_algo.h>
49#include <trigo.h>
50#include <markup_parser.h>
51
52
53SCH_TEXT::SCH_TEXT( const VECTOR2I& aPos, const wxString& aText, SCH_LAYER_ID aLayer, KICAD_T aType ) :
54 SCH_ITEM( nullptr, aType ),
55 EDA_TEXT( schIUScale, aText )
56{
57 m_layer = aLayer;
58
59 SetTextPos( aPos );
60 SetMultilineAllowed( true );
61
62 m_excludedFromSim = false;
63}
64
65
67 SCH_ITEM( aText ),
68 EDA_TEXT( aText )
69{
71}
72
73
75{
76 // Fudge factor to match KiCad 6
77 return VECTOR2I( 0, -2500 );
78}
79
80
82{
84 return;
85
86 VECTOR2I delta( 0, 0 );
87 BOX2I bbox = GetTextBox( nullptr );
88
89 if( GetTextAngle().IsHorizontal() )
90 {
92 delta.x = bbox.GetWidth() / 2;
94 delta.x = -bbox.GetWidth() / 2;
95
97 delta.y = -bbox.GetHeight() / 2;
99 delta.y = bbox.GetHeight() / 2;
100 }
101 else
102 {
104 delta.y = bbox.GetWidth() / 2;
106 delta.y = -bbox.GetWidth() / 2;
107
109 delta.x = +bbox.GetHeight() / 2;
111 delta.x = -bbox.GetHeight() / 2;
112 }
113
114 if( inverse )
116 else
118}
119
120
122{
123 if( m_layer == LAYER_DEVICE )
124 {
125 NormalizeJustification( false );
126 int x = GetTextPos().x;
127
128 x -= aCenter;
129 x *= -1;
130 x += aCenter;
131
132 if( GetTextAngle().IsHorizontal() )
133 {
138 }
139 else
140 {
145 }
146
147 SetTextX( x );
149 }
150 else
151 {
153 FlipHJustify();
154
155 SetTextX( MIRRORVAL( GetTextPos().x, aCenter ) );
156 }
157}
158
159
160void SCH_TEXT::MirrorVertically( int aCenter )
161{
162 if( m_layer == LAYER_DEVICE )
163 {
164 NormalizeJustification( false );
165 int y = GetTextPos().y;
166
167 y -= aCenter;
168 y *= -1;
169 y += aCenter;
170
171 if( GetTextAngle().IsHorizontal() )
172 {
177 }
178 else
179 {
184 }
185
186 SetTextY( y );
188 }
189 else
190 {
192 FlipHJustify();
193
194 SetTextY( MIRRORVAL( GetTextPos().y, aCenter ) );
195 }
196}
197
198
199void SCH_TEXT::Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
200{
201 VECTOR2I pt = GetTextPos();
202 RotatePoint( pt, aCenter, aRotateCCW ? ANGLE_90 : ANGLE_270 );
203 VECTOR2I offset = pt - GetTextPos();
204
205 Rotate90( false );
206
207 SetTextPos( GetTextPos() + offset );
208}
209
210
211void SCH_TEXT::Rotate90( bool aClockwise )
212{
213 if( ( GetTextAngle() == ANGLE_HORIZONTAL && aClockwise ) || ( GetTextAngle() == ANGLE_VERTICAL && !aClockwise ) )
214 {
215 FlipHJustify();
216 }
217
219}
220
221
222void SCH_TEXT::MirrorSpinStyle( bool aLeftRight )
223{
224 if( ( GetTextAngle() == ANGLE_HORIZONTAL && aLeftRight ) || ( GetTextAngle() == ANGLE_VERTICAL && !aLeftRight ) )
225 {
226 FlipHJustify();
227 }
228}
229
230
232{
233 SCH_TEXT* item = static_cast<SCH_TEXT*>( aItem );
234
235 SwapText( *item );
236 SwapAttributes( *item );
237}
238
239
240bool SCH_TEXT::operator<( const SCH_ITEM& aItem ) const
241{
242 if( Type() != aItem.Type() )
243 return Type() < aItem.Type();
244
245 auto other = static_cast<const SCH_TEXT*>( &aItem );
246
247 if( GetLayer() != other->GetLayer() )
248 return GetLayer() < other->GetLayer();
249
250 if( GetPosition().x != other->GetPosition().x )
251 return GetPosition().x < other->GetPosition().x;
252
253 if( GetPosition().y != other->GetPosition().y )
254 return GetPosition().y < other->GetPosition().y;
255
256 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
257 return GetExcludedFromSim() - other->GetExcludedFromSim();
258
259 return GetText() < other->GetText();
260}
261
262
263int SCH_TEXT::GetTextOffset( const RENDER_SETTINGS* aSettings ) const
264{
265 double ratio;
266
267 if( aSettings )
268 ratio = static_cast<const SCH_RENDER_SETTINGS*>( aSettings )->m_TextOffsetRatio;
269 else if( Schematic() )
271 else
272 ratio = DEFAULT_TEXT_OFFSET_RATIO; // For previews (such as in Preferences), etc.
273
274 return KiROUND( ratio * GetTextSize().y );
275}
276
277
279{
281}
282
283
285{
287
288 if( !font )
289 font = KIFONT::FONT::GetFont( GetDefaultFont( aSettings ), IsBold(), IsItalic() );
290
291 return font;
292}
293
294
296{
297 BOX2I bbox = GetTextBox( nullptr );
298
299 if( !GetTextAngle().IsZero() ) // Rotate bbox.
300 {
301 VECTOR2I pos = bbox.GetOrigin();
302 VECTOR2I end = bbox.GetEnd();
303
306
307 bbox.SetOrigin( pos );
308 bbox.SetEnd( end );
309 }
310
311 bbox.Normalize();
312 return bbox;
313}
314
315
316wxString SCH_TEXT::GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText, int aDepth ) const
317{
318 // Use local depth counter so each text element starts fresh
319 int depth = 0;
320
321 SCH_SHEET* sheet = nullptr;
322
323 if( aPath )
324 sheet = aPath->Last();
325 else if( SCHEMATIC* schematic = Schematic() )
326 sheet = schematic->CurrentSheet().Last();
327
328 std::function<bool( wxString* )> textResolver = [&]( wxString* token ) -> bool
329 {
330 if( SCH_SYMBOL* sch_symbol = dynamic_cast<SCH_SYMBOL*>( m_parent ) )
331 {
332 if( sch_symbol->ResolveTextVar( aPath, token, depth + 1 ) )
333 return true;
334 }
335 else if( LIB_SYMBOL* lib_symbol = dynamic_cast<LIB_SYMBOL*>( m_parent ) )
336 {
337 if( lib_symbol->ResolveTextVar( token, depth + 1 ) )
338 return true;
339 }
340
341 if( sheet )
342 {
343 if( sheet->ResolveTextVar( aPath, token, depth + 1 ) )
344 return true;
345 }
346
347 return false;
348 };
349
350 wxString text = EDA_TEXT::GetShownText( aAllowExtraText, depth );
351
352 if( HasTextVars() )
353 text = ResolveTextVars( text, &textResolver, depth );
354
355 // Convert escape markers back to literals for final display
356 text.Replace( wxT( "<<<ESC_DOLLAR:" ), wxT( "${" ) );
357 text.Replace( wxT( "<<<ESC_AT:" ), wxT( "@{" ) );
358
359 return text;
360}
361
362
364{
365 return HasHyperlink() || containsURL();
366}
367
368
370{
371 return !m_activeUrl.IsEmpty();
372}
373
374
375void SCH_TEXT::DoHypertextAction( EDA_DRAW_FRAME* aFrame, const VECTOR2I& aMousePos ) const
376{
378
379 if( HasHyperlink() )
380 navTool->HypertextCommand( m_hyperlink );
381 else if( !m_activeUrl.IsEmpty() )
382 navTool->HypertextCommand( m_activeUrl );
383}
384
385
386wxString SCH_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
387{
388 return wxString::Format( _( "Graphic Text '%s'" ),
389 aFull ? GetShownText( false ) : KIUI::EllipsizeMenuText( GetText() ) );
390}
391
392
394{
395 return BITMAPS::text;
396}
397
398
399bool SCH_TEXT::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
400{
401 BOX2I bBox = GetBoundingBox();
402 bBox.Inflate( aAccuracy );
403 return bBox.Contains( aPosition );
404}
405
406
407bool SCH_TEXT::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
408{
410 return false;
411
412 BOX2I rect = aRect;
413 BOX2I bBox = GetBoundingBox();
414
415 rect.Inflate( aAccuracy );
416
417 if( aContained )
418 return aRect.Contains( bBox );
419
420 return aRect.Intersects( bBox );
421}
422
423
424bool SCH_TEXT::HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
425{
427 return false;
428
429 return KIGEOM::BoxHitTest( aPoly, GetBoundingBox(), aContained );
430}
431
432
433void SCH_TEXT::BeginEdit( const VECTOR2I& aPosition )
434{
435 SetTextPos( aPosition );
436}
437
438
439void SCH_TEXT::CalcEdit( const VECTOR2I& aPosition )
440{
441 SetTextPos( aPosition );
442}
443
444
445std::vector<int> SCH_TEXT::ViewGetLayers() const
446{
447 if( IsPrivate() )
449
451}
452
453
454void SCH_TEXT::Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts, int aUnit, int aBodyStyle,
455 const VECTOR2I& aOffset, bool aDimmed )
456{
457 if( aBackground || IsPrivate() )
458 return;
459
460 SCH_RENDER_SETTINGS* renderSettings = getRenderSettings( aPlotter );
461 COLOR4D color = GetTextColor();
462 COLOR4D bg = renderSettings->GetBackgroundColor();
463
464 if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED )
465 {
466 SCH_CONNECTION* connection = Connection();
467
468 if( connection && connection->IsBus() )
469 color = renderSettings->GetLayerColor( LAYER_BUS );
470 else
471 color = renderSettings->GetLayerColor( m_layer );
472 }
473
474 if( !IsVisible() )
475 bg = renderSettings->GetLayerColor( LAYER_HIDDEN );
476 else if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
477 bg = COLOR4D::WHITE;
478
479 if( color.m_text.has_value() && Schematic() )
480 color = COLOR4D( ResolveText( color.m_text.value(), &Schematic()->CurrentSheet() ) );
481
482 if( aDimmed )
483 {
484 color.Desaturate();
485 color = color.Mix( bg, 0.5f );
486 }
487
488 int penWidth = GetEffectiveTextPenWidth( renderSettings->GetDefaultPenWidth() );
489 penWidth = std::max( penWidth, renderSettings->GetMinPenWidth() );
490 aPlotter->SetCurrentLineWidth( penWidth );
491
492 KIFONT::FONT* font = GetDrawFont( renderSettings );
494 attrs.m_StrokeWidth = penWidth;
495
496 if( m_layer == LAYER_DEVICE )
497 {
498 BOX2I bBox = GetBoundingBox();
499
500 /*
501 * Calculate the text justification, according to the symbol orientation/mirror. This is
502 * a bit complicated due to cumulative calculations:
503 * - numerous cases (mirrored or not, rotation)
504 * - the plotter's Text() function will also recalculate H and V justifications according
505 * to the text orientation
506 * - when a symbol is mirrored the text is not, and justifications become a nightmare
507 *
508 * So the easier way is to use no justifications (centered text) and use GetBoundingBox to
509 * know the text coordinate considered as centered.
510 */
511 VECTOR2I txtpos = bBox.Centre();
514
515 // The text orientation may need to be flipped if the transformation matrix causes xy
516 // axes to be flipped.
517 if( ( renderSettings->m_Transform.x1 != 0 ) ^ ( GetTextAngle() != ANGLE_HORIZONTAL ) )
519 else
520 attrs.m_Angle = ANGLE_VERTICAL;
521
522 aPlotter->PlotText( renderSettings->TransformCoordinate( txtpos ) + aOffset, color, GetText(), attrs, font,
523 GetFontMetrics() );
524 }
525 else
526 {
528 VECTOR2I text_offset = GetSchematicTextOffset( aPlotter->RenderSettings() );
529
530 // Adjust text drawn in an outline font to more closely mimic the positioning of
531 // SCH_FIELD text.
532 if( font->IsOutline() )
533 {
534 BOX2I firstLineBBox = GetTextBox( renderSettings, 0 );
535 int sizeDiff = firstLineBBox.GetHeight() - GetTextSize().y;
536 int adjust = KiROUND( sizeDiff * 0.4 );
537 VECTOR2I adjust_offset( 0, -adjust );
538
539 RotatePoint( adjust_offset, GetDrawRotation() );
540 text_offset += adjust_offset;
541 }
542
543 std::vector<VECTOR2I> positions;
544 wxArrayString strings_list;
545 wxStringSplit( GetShownText( sheet, true ), strings_list, '\n' );
546 positions.reserve( strings_list.Count() );
547
548 GetLinePositions( renderSettings, positions, (int) strings_list.Count() );
549
550 attrs.m_Multiline = false;
551
552 for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
553 {
554 VECTOR2I textpos = positions[ii] + text_offset;
555 wxString& txt = strings_list.Item( ii );
556 aPlotter->PlotText( textpos, color, txt, attrs, font, GetFontMetrics() );
557 }
558
559 if( HasHyperlink() )
560 aPlotter->HyperlinkBox( GetBoundingBox(), GetHyperlink() );
561 }
562}
563
564
565void SCH_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
566{
567 wxString msg;
568
569 // Don't use GetShownText() here; we want to show the user the variable references
570 aList.emplace_back( _( "Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
571
572 SCH_ITEM::GetMsgPanelInfo( aFrame, aList );
573
575 aList.emplace_back( _( "Exclude from" ), _( "Simulation" ) );
576
577 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
578
579 wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
580 int style = IsBold() && IsItalic() ? 3 : IsBold() ? 2 : IsItalic() ? 1 : 0;
581 aList.emplace_back( _( "Style" ), textStyle[style] );
582
583 aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
584
585 switch( GetHorizJustify() )
586 {
587 case GR_TEXT_H_ALIGN_LEFT: msg = _( "Align left" ); break;
588 case GR_TEXT_H_ALIGN_CENTER: msg = _( "Align center" ); break;
589 case GR_TEXT_H_ALIGN_RIGHT: msg = _( "Align right" ); break;
591 }
592
593 if( m_layer == LAYER_DEVICE )
594 {
595 aList.emplace_back( _( "H Justification" ), msg );
596
597 switch( GetVertJustify() )
598 {
599 case GR_TEXT_V_ALIGN_TOP: msg = _( "Top" ); break;
600 case GR_TEXT_V_ALIGN_CENTER: msg = _( "Center" ); break;
601 case GR_TEXT_V_ALIGN_BOTTOM: msg = _( "Bottom" ); break;
603 }
604
605 aList.emplace_back( _( "V Justification" ), msg );
606 }
607 else
608 {
609 aList.emplace_back( _( "Justification" ), msg );
610 }
611}
612
613
614bool SCH_TEXT::operator==( const SCH_ITEM& aOther ) const
615{
616 if( Type() != aOther.Type() )
617 return false;
618
619 const SCH_TEXT* other = static_cast<const SCH_TEXT*>( &aOther );
620
621 if( GetLayer() != other->GetLayer() )
622 return false;
623
624 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
625 return false;
626
627 return EDA_TEXT::operator==( *other );
628}
629
630
631double SCH_TEXT::Similarity( const SCH_ITEM& aOther ) const
632{
633 if( m_Uuid == aOther.m_Uuid )
634 return 1.0;
635
636 if( Type() != aOther.Type() )
637 return 0.0;
638
639 const SCH_TEXT* other = static_cast<const SCH_TEXT*>( &aOther );
640
641 double retval = SimilarityBase( aOther );
642
643 if( GetLayer() != other->GetLayer() )
644 retval *= 0.9;
645
646 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
647 retval *= 0.9;
648
649 retval *= EDA_TEXT::Similarity( *other );
650
651 return retval;
652}
653
654
655int SCH_TEXT::compare( const SCH_ITEM& aOther, int aCompareFlags ) const
656{
657 wxASSERT( aOther.Type() == SCH_TEXT_T );
658
659 int retv = SCH_ITEM::compare( aOther, aCompareFlags );
660
661 if( retv )
662 return retv;
663
664 const SCH_TEXT& tmp = static_cast<const SCH_TEXT&>( aOther );
665
666 int result = GetText().CmpNoCase( tmp.GetText() );
667
668 if( result != 0 )
669 return result;
670
671 if( GetTextPos().x != tmp.GetTextPos().x )
672 return GetTextPos().x - tmp.GetTextPos().x;
673
674 if( GetTextPos().y != tmp.GetTextPos().y )
675 return GetTextPos().y - tmp.GetTextPos().y;
676
677 if( GetTextWidth() != tmp.GetTextWidth() )
678 return GetTextWidth() - tmp.GetTextWidth();
679
680 if( GetTextHeight() != tmp.GetTextHeight() )
681 return GetTextHeight() - tmp.GetTextHeight();
682
683 return 0;
684}
685
686
687#if defined( DEBUG )
688
689void SCH_TEXT::Show( int nestLevel, std::ostream& os ) const
690{
691 // XML output:
692 wxString s = GetClass();
693
694 NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str() << " layer=\"" << m_layer << '"' << '>'
695 << TO_UTF8( GetText() ) << "</" << s.Lower().mb_str() << ">\n";
696}
697
698#endif
699
700
701static struct SCH_TEXT_DESC
702{
704 {
711
712 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Mirrored" ) );
713 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Width" ) );
714 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Height" ) );
715 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Thickness" ) );
716
719 _HKI( "Text Properties" ) );
720
721 // Orientation is exposed differently in schematic; mask the base for now
722 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Orientation" ) );
723 }
constexpr EDA_IU_SCALE schIUScale
Definition base_units.h:114
BITMAPS
A list of all bitmap identifiers.
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition box2.h:990
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 const Vec GetEnd() const
Definition box2.h:212
constexpr void SetOrigin(const Vec &pos)
Definition box2.h:237
constexpr BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition box2.h:146
constexpr size_type GetWidth() const
Definition box2.h:214
constexpr Vec Centre() const
Definition box2.h:97
constexpr size_type GetHeight() const
Definition box2.h:215
constexpr bool Contains(const Vec &aPoint) const
Definition box2.h:168
constexpr const Vec & GetOrigin() const
Definition box2.h:210
constexpr void SetEnd(coord_type x, coord_type y)
Definition box2.h:297
constexpr bool Intersects(const BOX2< Vec > &aRect) const
Definition box2.h:311
static const COLOR4D WHITE
Definition color4d.h:405
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition color4d.h:402
The base class for create windows for drawing purpose.
const KIID m_Uuid
Definition eda_item.h:522
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
EDA_ITEM_FLAGS m_flags
Definition eda_item.h:533
wxString m_activeUrl
Definition eda_item.h:540
EDA_ITEM * m_parent
Owner.
Definition eda_item.h:534
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition eda_text.h:80
int GetTextHeight() const
Definition eda_text.h:267
const VECTOR2I & GetTextPos() const
Definition eda_text.h:273
COLOR4D GetTextColor() const
Definition eda_text.h:270
bool IsItalic() const
Definition eda_text.h:169
const EDA_ANGLE & GetTextAngle() const
Definition eda_text.h:147
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition eda_text.h:98
virtual bool IsVisible() const
Definition eda_text.h:187
void SetTextPos(const VECTOR2I &aPoint)
Definition eda_text.cpp:585
void SetTextX(int aX)
Definition eda_text.cpp:591
KIFONT::FONT * GetFont() const
Definition eda_text.h:247
void SetTextY(int aY)
Definition eda_text.cpp:597
virtual EDA_ANGLE GetDrawRotation() const
Definition eda_text.h:377
wxString m_hyperlink
A hyperlink URL.
Definition eda_text.h:453
int GetTextWidth() const
Definition eda_text.h:264
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:746
virtual bool HasHyperlink() const
Definition eda_text.h:400
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
Definition eda_text.cpp:426
wxString GetHyperlink() const
Definition eda_text.h:401
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition eda_text.h:200
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition eda_text.h:117
bool containsURL() const
Definition eda_text.cpp:994
EDA_TEXT(const EDA_IU_SCALE &aIuScale, const wxString &aText=wxEmptyString)
Definition eda_text.cpp:98
double Similarity(const EDA_TEXT &aOther) const
void FlipHJustify()
Definition eda_text.h:208
const TEXT_ATTRIBUTES & GetAttributes() const
Definition eda_text.h:231
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition eda_text.cpp:474
void SwapAttributes(EDA_TEXT &aTradingPartner)
Swap the text attributes of the two involved instances.
Definition eda_text.cpp:461
void GetLinePositions(const RENDER_SETTINGS *aSettings, std::vector< VECTOR2I > &aPositions, int aLineCount) const
Populate aPositions with the position of each line of a multiline text, according to the vertical jus...
Definition eda_text.cpp:916
bool IsBold() const
Definition eda_text.h:184
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition eda_text.h:203
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 SetTextAngle(const EDA_ANGLE &aAngle)
Definition eda_text.cpp:308
void SwapText(EDA_TEXT &aTradingPartner)
Definition eda_text.cpp:454
bool operator==(const EDA_TEXT &aRhs) const
Definition eda_text.h:396
void SetMultilineAllowed(bool aAllow)
Definition eda_text.cpp:410
VECTOR2I GetTextSize() const
Definition eda_text.h:261
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition eda_text.cpp:418
FONT is an abstract base class for both outline and stroke fonts.
Definition font.h:131
static FONT * GetFont(const wxString &aFontName=wxEmptyString, bool aBold=false, bool aItalic=false, const std::vector< wxString > *aEmbeddedFiles=nullptr, bool aForDrawingSheet=false)
Definition font.cpp:147
virtual bool IsOutline() const
Definition font.h:139
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:105
std::optional< wxString > m_text
Definition color4d.h:399
COLOR4D & Desaturate()
Removes color (in HSL model)
Definition color4d.cpp:532
COLOR4D Mix(const COLOR4D &aColor, double aFactor) const
Return a color that is mixed with the input by a factor.
Definition color4d.h:296
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
Base plotter engine class.
Definition plotter.h:136
RENDER_SETTINGS * RenderSettings()
Definition plotter.h:167
virtual void HyperlinkBox(const BOX2I &aBox, const wxString &aDestinationURL)
Create a clickable hyperlink with a rectangular click area.
Definition plotter.h:506
bool GetColorMode() const
Definition plotter.h:164
virtual void SetCurrentLineWidth(int width, void *aData=nullptr)=0
Set the line width for the next drawing.
virtual void PlotText(const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const TEXT_ATTRIBUTES &aAttributes, KIFONT::FONT *aFont=nullptr, const KIFONT::METRICS &aFontMetrics=KIFONT::METRICS::Default(), void *aData=nullptr)
Definition plotter.cpp:696
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 AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
Holds all the data relating to one schematic.
Definition schematic.h:88
SCHEMATIC_SETTINGS & Settings() const
SCH_SHEET_PATH & CurrentSheet() const
Definition schematic.h:187
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
bool IsBus() const
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
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 sch_item.cpp:796
SCH_RENDER_SETTINGS * getRenderSettings(PLOTTER *aPlotter) const
Definition sch_item.h:721
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
Definition sch_item.cpp:247
friend class LIB_SYMBOL
Definition sch_item.h:792
bool IsPrivate() const
Definition sch_item.h:253
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition sch_item.h:340
virtual int compare(const SCH_ITEM &aOther, int aCompareFlags=0) const
Provide the draw object specific comparison called by the == and < operators.
Definition sch_item.cpp:691
const wxString & GetDefaultFont(const RENDER_SETTINGS *aSettings) const
Definition sch_item.cpp:739
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
Definition sch_item.cpp:54
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition sch_item.cpp:466
wxString ResolveText(const wxString &aText, const SCH_SHEET_PATH *aPath, int aDepth=0) const
Definition sch_item.cpp:356
const KIFONT::METRICS & GetFontMetrics() const
Definition sch_item.cpp:752
SCH_LAYER_ID m_layer
Definition sch_item.h:772
double SimilarityBase(const SCH_ITEM &aItem) const
Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure vir...
Definition sch_item.h:379
Handle actions specific to the schematic editor.
void HypertextCommand(const wxString &aHref)
VECTOR2I TransformCoordinate(const VECTOR2I &aPoint) const
const KIGFX::COLOR4D & GetBackgroundColor() const override
Return current background color settings.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
SCH_SHEET * Last() const
Return a pointer to the last SCH_SHEET of the list.
Sheet symbol placed in a schematic, and is the entry point for a sub schematic.
Definition sch_sheet.h:48
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the sheet.
Schematic symbol object.
Definition sch_symbol.h:76
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition sch_text.cpp:386
int compare(const SCH_ITEM &aOther, int aCompareFlags=0) const override
Provide the draw object specific comparison called by the == and < operators.
Definition sch_text.cpp:655
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition sch_text.cpp:393
int GetSchTextSize() const
Definition sch_text.h:77
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition sch_text.cpp:231
KIFONT::FONT * GetDrawFont(const RENDER_SETTINGS *aSettings) const override
Definition sch_text.cpp:284
bool m_excludedFromSim
Definition sch_text.h:195
bool GetExcludedFromSim(const SCH_SHEET_PATH *aInstance=nullptr, const wxString &aVariantName=wxEmptyString) const override
Definition sch_text.h:90
void DoHypertextAction(EDA_DRAW_FRAME *aFrame, const VECTOR2I &aMousePos) const override
Definition sch_text.cpp:375
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
Definition sch_text.cpp:160
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
Definition sch_text.cpp:199
void CalcEdit(const VECTOR2I &aPosition) override
Calculate the attributes of an item at aPosition when it is being edited.
Definition sch_text.cpp:439
wxString GetClass() const override
Return the class name.
Definition sch_text.h:52
void NormalizeJustification(bool inverse)
Definition sch_text.cpp:81
bool operator<(const SCH_ITEM &aItem) const override
Definition sch_text.cpp:240
VECTOR2I GetPosition() const override
Definition sch_text.h:147
virtual void Rotate90(bool aClockwise)
Definition sch_text.cpp:211
std::vector< int > ViewGetLayers() const override
Return the layers the item is drawn on (which may be more than its "home" layer)
Definition sch_text.cpp:445
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
Definition sch_text.cpp:121
double Similarity(const SCH_ITEM &aItem) const override
Return a measure of how likely the other object is to represent the same object.
Definition sch_text.cpp:631
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition sch_text.cpp:295
int GetPenWidth() const override
Definition sch_text.cpp:278
bool HasHoveredHypertext() const override
Indicates that a hypertext link is currently active.
Definition sch_text.cpp:369
void SetSchTextSize(int aSize)
Definition sch_text.h:78
virtual wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
Definition sch_text.cpp:316
void Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
Plot the item to aPlotter.
Definition sch_text.cpp:454
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition sch_text.cpp:399
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 sch_text.cpp:565
void BeginEdit(const VECTOR2I &aStartPoint) override
Begin drawing a symbol library draw item at aPosition.
Definition sch_text.cpp:433
virtual VECTOR2I GetSchematicTextOffset(const RENDER_SETTINGS *aSettings) const
This offset depends on the orientation, the type of text, and the area required to draw the associate...
Definition sch_text.cpp:74
virtual void MirrorSpinStyle(bool aLeftRight)
Definition sch_text.cpp:222
bool HasHypertext() const override
Indicates that the item has at least one hypertext action.
Definition sch_text.cpp:363
bool operator==(const SCH_ITEM &aItem) const override
Definition sch_text.cpp:614
int GetTextOffset(const RENDER_SETTINGS *aSettings=nullptr) const
Definition sch_text.cpp:263
SCH_TEXT(const VECTOR2I &aPos={ 0, 0 }, const wxString &aText=wxEmptyString, SCH_LAYER_ID aLayer=LAYER_NOTES, KICAD_T aType=SCH_TEXT_T)
Definition sch_text.cpp:53
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE) const
A lower-precision version of StringFromValue().
wxString ResolveTextVars(const wxString &aSource, const std::function< bool(wxString *)> *aResolver, int &aDepth)
Multi-pass text variable expansion and math expression evaluation.
Definition common.cpp:295
#define DEFAULT_TEXT_OFFSET_RATIO
Ratio of the font height to space around global labels.
#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_270
Definition eda_angle.h:416
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
a few functions useful in geometry calculations.
SCH_LAYER_ID
Eeschema drawing layers.
Definition layer_ids.h:449
@ LAYER_DEVICE
Definition layer_ids.h:466
@ LAYER_HIDDEN
Definition layer_ids.h:492
@ LAYER_PRIVATE_NOTES
Definition layer_ids.h:468
@ LAYER_BUS
Definition layer_ids.h:453
@ LAYER_SELECTION_SHADOWS
Definition layer_ids.h:495
constexpr T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Definition mirror.h:36
Message panel definition file.
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.
#define _HKI(x)
Definition page_info.cpp:44
see class PGM_BASE
#define TYPE_HASH(x)
Definition property.h:74
@ PT_SIZE
Size expressed in distance units (mm/inch)
Definition property.h:63
#define REGISTER_TYPE(x)
static struct SCH_TEXT_DESC _SCH_TEXT_DESC
void wxStringSplit(const wxString &aText, wxArrayString &aStrings, wxChar aSplitter)
Split aString to a string list separated at aSplitter.
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
VECTOR2I end
wxString result
Test unit parsing edge cases and error handling.
int delta
@ GR_TEXT_H_ALIGN_CENTER
@ GR_TEXT_H_ALIGN_RIGHT
@ GR_TEXT_H_ALIGN_LEFT
@ GR_TEXT_H_ALIGN_INDETERMINATE
@ GR_TEXT_V_ALIGN_BOTTOM
@ GR_TEXT_V_ALIGN_INDETERMINATE
@ GR_TEXT_V_ALIGN_CENTER
@ GR_TEXT_V_ALIGN_TOP
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
@ SCH_TEXT_T
Definition typeinfo.h:155
#define INDETERMINATE_STATE
Used for holding indeterminate values, such as with multiple selections holding different values or c...
Definition ui_common.h:46
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695