KiCad PCB EDA Suite
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages Concepts
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 <stambaughw@gmail.com>
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 <advanced_config.h>
27#include <base_units.h>
28#include <pgm_base.h>
29#include <sch_edit_frame.h>
30#include <sch_plotter.h>
31#include <widgets/msgpanel.h>
32#include <bitmaps.h>
33#include <string_utils.h>
34#include <sch_text.h>
35#include <schematic.h>
37#include <sch_painter.h>
38#include <default_values.h>
39#include <wx/debug.h>
40#include <wx/log.h>
44#include <core/mirror.h>
45#include <core/kicad_algo.h>
47#include <trigo.h>
48
49
50SCH_TEXT::SCH_TEXT( const VECTOR2I& aPos, const wxString& aText, SCH_LAYER_ID aLayer,
51 KICAD_T aType ) :
52 SCH_ITEM( nullptr, aType ),
53 EDA_TEXT( schIUScale, aText )
54{
55 m_layer = aLayer;
56
57 SetTextPos( aPos );
58 SetMultilineAllowed( true );
59
60 m_excludedFromSim = false;
61}
62
63
65 SCH_ITEM( aText ),
66 EDA_TEXT( aText )
67{
69}
70
71
73{
74 // Fudge factor to match KiCad 6
75 return VECTOR2I( 0, -2500 );
76}
77
78
80{
82 return;
83
84 VECTOR2I delta( 0, 0 );
85 BOX2I bbox = GetTextBox();
86
87 if( GetTextAngle().IsHorizontal() )
88 {
90 delta.x = bbox.GetWidth() / 2;
92 delta.x = - bbox.GetWidth() / 2;
93
95 delta.y = - bbox.GetHeight() / 2;
97 delta.y = bbox.GetHeight() / 2;
98 }
99 else
100 {
102 delta.y = bbox.GetWidth() / 2;
104 delta.y = - bbox.GetWidth() / 2;
105
107 delta.x = + bbox.GetHeight() / 2;
109 delta.x = - bbox.GetHeight() / 2;
110 }
111
112 if( inverse )
114 else
116}
117
118
120{
121 if( m_layer == LAYER_DEVICE )
122 {
123 NormalizeJustification( false );
124 int x = GetTextPos().x;
125
126 x -= aCenter;
127 x *= -1;
128 x += aCenter;
129
130 if( GetTextAngle().IsHorizontal() )
131 {
136 }
137 else
138 {
143 }
144
145 SetTextX( x );
147 }
148 else
149 {
151 FlipHJustify();
152
153 SetTextX( MIRRORVAL( GetTextPos().x, aCenter ) );
154 }
155}
156
157
158void SCH_TEXT::MirrorVertically( int aCenter )
159{
160 if( m_layer == LAYER_DEVICE )
161 {
162 NormalizeJustification( false );
163 int y = GetTextPos().y;
164
165 y -= aCenter;
166 y *= -1;
167 y += aCenter;
168
169 if( GetTextAngle().IsHorizontal() )
170 {
175 }
176 else
177 {
182 }
183
184 SetTextY( y );
186 }
187 else
188 {
190 FlipHJustify();
191
192 SetTextY( MIRRORVAL( GetTextPos().y, aCenter ) );
193 }
194}
195
196
197void SCH_TEXT::Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
198{
199 VECTOR2I pt = GetTextPos();
200 RotatePoint( pt, aCenter, aRotateCCW ? ANGLE_90 : ANGLE_270 );
201 VECTOR2I offset = pt - GetTextPos();
202
203 Rotate90( false );
204
205 SetTextPos( GetTextPos() + offset );
206}
207
208
209void SCH_TEXT::Rotate90( bool aClockwise )
210{
211 if( ( GetTextAngle() == ANGLE_HORIZONTAL && aClockwise )
212 || ( GetTextAngle() == ANGLE_VERTICAL && !aClockwise ) )
213 {
214 FlipHJustify();
215 }
216
218}
219
220
221void SCH_TEXT::MirrorSpinStyle( bool aLeftRight )
222{
223 if( ( GetTextAngle() == ANGLE_HORIZONTAL && aLeftRight )
224 || ( GetTextAngle() == ANGLE_VERTICAL && !aLeftRight ) )
225 {
226 FlipHJustify();
227 }
228}
229
230
232{
233 SCH_ITEM::SwapFlags( aItem );
234
235 SCH_TEXT* item = static_cast<SCH_TEXT*>( aItem );
236
237 std::swap( m_layer, item->m_layer );
238
239 SwapText( *item );
240 SwapAttributes( *item );
241}
242
243
244bool SCH_TEXT::operator<( const SCH_ITEM& aItem ) const
245{
246 if( Type() != aItem.Type() )
247 return Type() < aItem.Type();
248
249 auto other = static_cast<const SCH_TEXT*>( &aItem );
250
251 if( GetLayer() != other->GetLayer() )
252 return GetLayer() < other->GetLayer();
253
254 if( GetPosition().x != other->GetPosition().x )
255 return GetPosition().x < other->GetPosition().x;
256
257 if( GetPosition().y != other->GetPosition().y )
258 return GetPosition().y < other->GetPosition().y;
259
260 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
261 return GetExcludedFromSim() - other->GetExcludedFromSim();
262
263 return GetText() < other->GetText();
264}
265
266
267int SCH_TEXT::GetTextOffset( const RENDER_SETTINGS* aSettings ) const
268{
269 double ratio;
270
271 if( aSettings )
272 ratio = static_cast<const SCH_RENDER_SETTINGS*>( aSettings )->m_TextOffsetRatio;
273 else if( Schematic() )
275 else
276 ratio = DEFAULT_TEXT_OFFSET_RATIO; // For previews (such as in Preferences), etc.
277
278 return KiROUND( ratio * GetTextSize().y );
279}
280
281
283{
285}
286
287
289{
291
292 if( !font )
294
295 return font;
296}
297
298
300{
301 BOX2I bbox = GetTextBox();
302
303 if( !GetTextAngle().IsZero() ) // Rotate bbox.
304 {
305 VECTOR2I pos = bbox.GetOrigin();
306 VECTOR2I end = bbox.GetEnd();
307
310
311 bbox.SetOrigin( pos );
312 bbox.SetEnd( end );
313 }
314
315 bbox.Normalize();
316 return bbox;
317}
318
319
320wxString SCH_TEXT::GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText,
321 int aDepth ) const
322{
323 SCH_SHEET* sheet = nullptr;
324
325 if( aPath )
326 sheet = aPath->Last();
327 else if( SCHEMATIC* schematic = Schematic() )
328 sheet = schematic->CurrentSheet().Last();
329
330 std::function<bool( wxString* )> textResolver =
331 [&]( wxString* token ) -> bool
332 {
333 if( SCH_SYMBOL* sch_symbol = dynamic_cast<SCH_SYMBOL*>( m_parent ) )
334 {
335 if( sch_symbol->ResolveTextVar( aPath, token, aDepth + 1 ) )
336 return true;
337 }
338 else if( LIB_SYMBOL* lib_symbol = dynamic_cast<LIB_SYMBOL*>( m_parent ) )
339 {
340 if( lib_symbol->ResolveTextVar( token, aDepth + 1 ) )
341 return true;
342 }
343
344 if( sheet )
345 {
346 if( sheet->ResolveTextVar( aPath, token, aDepth + 1 ) )
347 return true;
348 }
349
350 return false;
351 };
352
353 wxString text = EDA_TEXT::GetShownText( aAllowExtraText, aDepth );
354
355 if( HasTextVars() )
356 {
357 if( aDepth < ADVANCED_CFG::GetCfg().m_ResolveTextRecursionDepth )
358 text = ExpandTextVars( text, &textResolver );
359 }
360
361 return text;
362}
363
364
366{
367 wxCHECK_MSG( IsHypertext(), /* void */,
368 wxT( "Calling a hypertext menu on a SCH_TEXT with no hyperlink?" ) );
369
371 navTool->HypertextCommand( m_hyperlink );
372}
373
374
375wxString SCH_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
376{
377 return wxString::Format( _( "Graphic Text '%s'" ),
378 aFull ? GetShownText( false ) : KIUI::EllipsizeMenuText( GetText() ) );
379}
380
381
383{
384 return BITMAPS::text;
385}
386
387
388bool SCH_TEXT::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
389{
390 BOX2I bBox = GetBoundingBox();
391 bBox.Inflate( aAccuracy );
392 return bBox.Contains( aPosition );
393}
394
395
396bool SCH_TEXT::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
397{
399 return false;
400
401 BOX2I rect = aRect;
402 BOX2I bBox = GetBoundingBox();
403
404 rect.Inflate( aAccuracy );
405
406 if( aContained )
407 return aRect.Contains( bBox );
408
409 return aRect.Intersects( bBox );
410}
411
412
413void SCH_TEXT::BeginEdit( const VECTOR2I& aPosition )
414{
415 SetTextPos( aPosition );
416}
417
418
419void SCH_TEXT::CalcEdit( const VECTOR2I& aPosition )
420{
421 SetTextPos( aPosition );
422}
423
424
425std::vector<int> SCH_TEXT::ViewGetLayers() const
426{
427 if( IsPrivate() )
429
431}
432
433
434void SCH_TEXT::Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
435 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed )
436{
437 if( aBackground || IsPrivate() )
438 return;
439
440 SCH_RENDER_SETTINGS* renderSettings = getRenderSettings( aPlotter );
442 COLOR4D bg = renderSettings->GetBackgroundColor();
443
444 if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED )
445 {
446 SCH_CONNECTION* connection = Connection();
447
448 if( connection && connection->IsBus() )
449 color = renderSettings->GetLayerColor( LAYER_BUS );
450 else
451 color = renderSettings->GetLayerColor( m_layer );
452 }
453
454 if( !IsVisible() )
455 bg = renderSettings->GetLayerColor( LAYER_HIDDEN );
456 else if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
457 bg = COLOR4D::WHITE;
458
459 if( aDimmed )
460 {
461 color.Desaturate( );
462 color = color.Mix( bg, 0.5f );
463 }
464
465 int penWidth = GetEffectiveTextPenWidth( renderSettings->GetDefaultPenWidth() );
466 penWidth = std::max( penWidth, renderSettings->GetMinPenWidth() );
467 aPlotter->SetCurrentLineWidth( penWidth );
468
469 KIFONT::FONT* font = GetFont();
470
471 if( !font )
472 font = KIFONT::FONT::GetFont( renderSettings->GetDefaultFont(), IsBold(), IsItalic() );
473
475 attrs.m_StrokeWidth = penWidth;
476
477 if( m_layer == LAYER_DEVICE )
478 {
479 BOX2I bBox = GetBoundingBox();
480
481 /*
482 * Calculate the text justification, according to the symbol orientation/mirror. This is
483 * a bit complicated due to cumulative calculations:
484 * - numerous cases (mirrored or not, rotation)
485 * - the plotter's Text() function will also recalculate H and V justifications according
486 * to the text orientation
487 * - when a symbol is mirrored the text is not, and justifications become a nightmare
488 *
489 * So the easier way is to use no justifications (centered text) and use GetBoundingBox to
490 * know the text coordinate considered as centered.
491 */
492 VECTOR2I txtpos = bBox.Centre();
495
496 // The text orientation may need to be flipped if the transformation matrix causes xy
497 // axes to be flipped.
498 if( ( renderSettings->m_Transform.x1 != 0 ) ^ ( GetTextAngle() != ANGLE_HORIZONTAL ) )
500 else
501 attrs.m_Angle = ANGLE_VERTICAL;
502
503 aPlotter->PlotText( renderSettings->TransformCoordinate( txtpos ) + aOffset, color,
504 GetText(), attrs, font, GetFontMetrics() );
505 }
506 else
507 {
509 VECTOR2I text_offset = GetSchematicTextOffset( aPlotter->RenderSettings() );
510
511 // Adjust text drawn in an outline font to more closely mimic the positioning of
512 // SCH_FIELD text.
513 if( font->IsOutline() )
514 {
515 BOX2I firstLineBBox = GetTextBox( 0 );
516 int sizeDiff = firstLineBBox.GetHeight() - GetTextSize().y;
517 int adjust = KiROUND( sizeDiff * 0.4 );
518 VECTOR2I adjust_offset( 0, - adjust );
519
520 RotatePoint( adjust_offset, GetDrawRotation() );
521 text_offset += adjust_offset;
522 }
523
524 std::vector<VECTOR2I> positions;
525 wxArrayString strings_list;
526 wxStringSplit( GetShownText( sheet, true ), strings_list, '\n' );
527 positions.reserve( strings_list.Count() );
528
529 GetLinePositions( positions, (int) strings_list.Count() );
530
531 attrs.m_Multiline = false;
532
533 for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
534 {
535 VECTOR2I textpos = positions[ii] + text_offset;
536 wxString& txt = strings_list.Item( ii );
537 aPlotter->PlotText( textpos, color, txt, attrs, font, GetFontMetrics() );
538 }
539
540 if( HasHyperlink() )
541 aPlotter->HyperlinkBox( GetBoundingBox(), GetHyperlink() );
542 }
543}
544
545
546void SCH_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
547{
548 wxString msg;
549
550 // Don't use GetShownText() here; we want to show the user the variable references
551 aList.emplace_back( _( "Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
552
554 aList.emplace_back( _( "Exclude from" ), _( "Simulation" ) );
555
556 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
557
558 wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
559 int style = IsBold() && IsItalic() ? 3 : IsBold() ? 2 : IsItalic() ? 1 : 0;
560 aList.emplace_back( _( "Style" ), textStyle[style] );
561
562 aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
563
564 switch( GetHorizJustify() )
565 {
566 case GR_TEXT_H_ALIGN_LEFT: msg = _( "Align left" ); break;
567 case GR_TEXT_H_ALIGN_CENTER: msg = _( "Align center" ); break;
568 case GR_TEXT_H_ALIGN_RIGHT: msg = _( "Align right" ); break;
570 }
571
572 if( m_layer == LAYER_DEVICE )
573 {
574 aList.emplace_back( _( "H Justification" ), msg );
575
576 switch ( GetVertJustify() )
577 {
578 case GR_TEXT_V_ALIGN_TOP: msg = _( "Top" ); break;
579 case GR_TEXT_V_ALIGN_CENTER: msg = _( "Center" ); break;
580 case GR_TEXT_V_ALIGN_BOTTOM: msg = _( "Bottom" ); break;
582 }
583
584 aList.emplace_back( _( "V Justification" ), msg );
585 }
586 else
587 {
588 aList.emplace_back( _( "Justification" ), msg );
589 }
590}
591
592
593bool SCH_TEXT::operator==( const SCH_ITEM& aOther ) const
594{
595 if( Type() != aOther.Type() )
596 return false;
597
598 const SCH_TEXT* other = static_cast<const SCH_TEXT*>( &aOther );
599
600 if( GetLayer() != other->GetLayer() )
601 return false;
602
603 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
604 return false;
605
606 return EDA_TEXT::operator==( *other );
607}
608
609
610double SCH_TEXT::Similarity( const SCH_ITEM& aOther ) const
611{
612 if( m_Uuid == aOther.m_Uuid )
613 return 1.0;
614
615 if( Type() != aOther.Type() )
616 return 0.0;
617
618 const SCH_TEXT* other = static_cast<const SCH_TEXT*>( &aOther );
619
620 double retval = SimilarityBase( aOther );
621
622 if( GetLayer() != other->GetLayer() )
623 retval *= 0.9;
624
625 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
626 retval *= 0.9;
627
628 retval *= EDA_TEXT::Similarity( *other );
629
630 return retval;
631}
632
633
634int SCH_TEXT::compare( const SCH_ITEM& aOther, int aCompareFlags ) const
635{
636 wxASSERT( aOther.Type() == SCH_TEXT_T );
637
638 int retv = SCH_ITEM::compare( aOther, aCompareFlags );
639
640 if( retv )
641 return retv;
642
643 const SCH_TEXT& tmp = static_cast<const SCH_TEXT&>( aOther );
644
645 int result = GetText().CmpNoCase( tmp.GetText() );
646
647 if( result != 0 )
648 return result;
649
650 if( GetTextPos().x != tmp.GetTextPos().x )
651 return GetTextPos().x - tmp.GetTextPos().x;
652
653 if( GetTextPos().y != tmp.GetTextPos().y )
654 return GetTextPos().y - tmp.GetTextPos().y;
655
656 if( GetTextWidth() != tmp.GetTextWidth() )
657 return GetTextWidth() - tmp.GetTextWidth();
658
659 if( GetTextHeight() != tmp.GetTextHeight() )
660 return GetTextHeight() - tmp.GetTextHeight();
661
662 return 0;
663}
664
665
666#if defined(DEBUG)
667
668void SCH_TEXT::Show( int nestLevel, std::ostream& os ) const
669{
670 // XML output:
671 wxString s = GetClass();
672
673 NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str()
674 << " layer=\"" << m_layer << '"'
675 << '>'
676 << TO_UTF8( GetText() )
677 << "</" << s.Lower().mb_str() << ">\n";
678}
679
680#endif
681
682
683static struct SCH_TEXT_DESC
684{
686 {
693
694 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Mirrored" ) );
695 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Width" ) );
696 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Height" ) );
697 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Thickness" ) );
698
699 propMgr.AddProperty( new PROPERTY<SCH_TEXT, int>( _HKI( "Text Size" ),
700 &SCH_TEXT::SetSchTextSize, &SCH_TEXT::GetSchTextSize, PROPERTY_DISPLAY::PT_SIZE ),
701 _HKI( "Text Properties" ) );
702
703 // Orientation is exposed differently in schematic; mask the base for now
704 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Orientation" ) );
705 }
int color
Definition: DXF_plotter.cpp:60
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:110
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
constexpr BOX2I KiROUND(const BOX2D &aBoxD)
Definition: box2.h:990
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
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
The base class for create windows for drawing purpose.
const KIID m_Uuid
Definition: eda_item.h:494
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:107
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:505
EDA_ITEM * m_parent
Linked list: Link (parent struct).
Definition: eda_item.h:506
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:254
const VECTOR2I & GetTextPos() const
Definition: eda_text.h:260
COLOR4D GetTextColor() const
Definition: eda_text.h:257
bool IsItalic() const
Definition: eda_text.h:156
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:134
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:174
void SetTextPos(const VECTOR2I &aPoint)
Definition: eda_text.cpp:571
void SetTextX(int aX)
Definition: eda_text.cpp:577
KIFONT::FONT * GetFont() const
Definition: eda_text.h:234
BOX2I GetTextBox(int aLine=-1) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:723
void SetTextY(int aY)
Definition: eda_text.cpp:583
virtual EDA_ANGLE GetDrawRotation() const
Definition: eda_text.h:365
wxString m_hyperlink
A hyperlink URL.
Definition: eda_text.h:441
int GetTextWidth() const
Definition: eda_text.h:251
virtual bool HasHyperlink() const
Definition: eda_text.h:386
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
Definition: eda_text.cpp:410
wxString GetHyperlink() const
Definition: eda_text.h:387
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition: eda_text.h:187
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition: eda_text.h:117
void GetLinePositions(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:896
double Similarity(const EDA_TEXT &aOther) const
Definition: eda_text.cpp:1279
void FlipHJustify()
Definition: eda_text.h:195
const TEXT_ATTRIBUTES & GetAttributes() const
Definition: eda_text.h:218
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition: eda_text.cpp:458
void SwapAttributes(EDA_TEXT &aTradingPartner)
Swap the text attributes of the two involved instances.
Definition: eda_text.cpp:445
bool IsBold() const
Definition: eda_text.h:171
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition: eda_text.h:190
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:292
void SwapText(EDA_TEXT &aTradingPartner)
Definition: eda_text.cpp:438
bool operator==(const EDA_TEXT &aRhs) const
Definition: eda_text.h:382
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.cpp:394
VECTOR2I GetTextSize() const
Definition: eda_text.h:248
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition: eda_text.cpp:402
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:104
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
int GetDefaultPenWidth() const
const wxString & GetDefaultFont() const
const COLOR4D & GetLayerColor(int aLayer) const
Return the color used to draw a layer.
Define a library symbol object.
Definition: lib_symbol.h:85
Base plotter engine class.
Definition: plotter.h:105
RENDER_SETTINGS * RenderSettings()
Definition: plotter.h:136
virtual void HyperlinkBox(const BOX2I &aBox, const wxString &aDestinationURL)
Create a clickable hyperlink with a rectangular click area.
Definition: plotter.h:459
bool GetColorMode() const
Definition: plotter.h:133
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:754
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 AddTypeCast(TYPE_CAST_BASE *aCast)
Register a type converter.
Holds all the data relating to one schematic.
Definition: schematic.h:69
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:306
SCH_SHEET_PATH & CurrentSheet() const
Definition: schematic.h:148
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:168
const wxString & GetDefaultFont() const
Definition: sch_item.cpp:480
SCH_RENDER_SETTINGS * getRenderSettings(PLOTTER *aPlotter) const
Definition: sch_item.h:657
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:156
bool IsPrivate() const
Definition: sch_item.h:246
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:295
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:441
void SwapFlags(SCH_ITEM *aItem)
Swap the non-temp and non-edit flags.
Definition: sch_item.cpp:376
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:224
const KIFONT::METRICS & GetFontMetrics() const
Definition: sch_item.cpp:489
SCH_LAYER_ID m_layer
Definition: sch_item.h:710
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:332
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:47
bool ResolveTextVar(const SCH_SHEET_PATH *aPath, wxString *token, int aDepth=0) const
Resolve any references to system tokens supported by the sheet.
Definition: sch_sheet.cpp:220
Schematic symbol object.
Definition: sch_symbol.h:75
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: sch_text.cpp:375
void DoHypertextAction(EDA_DRAW_FRAME *aFrame) const override
Definition: sch_text.cpp:365
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:634
bool IsHypertext() const override
Allow items to support hypertext actions when hovered/clicked.
Definition: sch_text.h:78
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: sch_text.cpp:382
int GetSchTextSize() const
Definition: sch_text.h:75
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition: sch_text.cpp:231
bool m_excludedFromSim
Definition: sch_text.h:188
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
Definition: sch_text.cpp:158
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
Definition: sch_text.cpp:197
void CalcEdit(const VECTOR2I &aPosition) override
Calculate the attributes of an item at aPosition when it is being edited.
Definition: sch_text.cpp:419
wxString GetClass() const override
Return the class name.
Definition: sch_text.h:52
void NormalizeJustification(bool inverse)
Definition: sch_text.cpp:79
bool operator<(const SCH_ITEM &aItem) const override
Definition: sch_text.cpp:244
VECTOR2I GetPosition() const override
Definition: sch_text.h:139
virtual void Rotate90(bool aClockwise)
Definition: sch_text.cpp:209
KIFONT::FONT * getDrawFont() const override
Definition: sch_text.cpp:288
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:425
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
Definition: sch_text.cpp:119
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:610
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: sch_text.cpp:299
int GetPenWidth() const override
Definition: sch_text.cpp:282
void SetSchTextSize(int aSize)
Definition: sch_text.h:76
virtual wxString GetShownText(const SCH_SHEET_PATH *aPath, bool aAllowExtraText, int aDepth=0) const
Definition: sch_text.cpp:320
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:434
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:388
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:546
void BeginEdit(const VECTOR2I &aStartPoint) override
Begin drawing a symbol library draw item at aPosition.
Definition: sch_text.cpp:413
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:72
bool GetExcludedFromSim() const override
Definition: sch_text.h:86
virtual void MirrorSpinStyle(bool aLeftRight)
Definition: sch_text.cpp:221
bool operator==(const SCH_ITEM &aItem) const override
Definition: sch_text.cpp:593
int GetTextOffset(const RENDER_SETTINGS *aSettings=nullptr) const
Definition: sch_text.cpp:267
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:50
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
TOOL_MANAGER * GetToolManager() const
Return the MVC controller.
Definition: tools_holder.h:55
int x1
Definition: transform.h:48
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
#define DEFAULT_TEXT_OFFSET_RATIO
Ratio of the font height to space around global labels.
#define _HKI(x)
#define _(s)
static constexpr EDA_ANGLE ANGLE_90
Definition: eda_angle.h:403
static constexpr EDA_ANGLE ANGLE_VERTICAL
Definition: eda_angle.h:398
static constexpr EDA_ANGLE ANGLE_HORIZONTAL
Definition: eda_angle.h:397
static constexpr EDA_ANGLE ANGLE_270
Definition: eda_angle.h:406
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
SCH_LAYER_ID
Eeschema drawing layers.
Definition: layer_ids.h:438
@ LAYER_DEVICE
Definition: layer_ids.h:455
@ LAYER_HIDDEN
Definition: layer_ids.h:481
@ LAYER_PRIVATE_NOTES
Definition: layer_ids.h:457
@ LAYER_BUS
Definition: layer_ids.h:442
@ LAYER_SELECTION_SHADOWS
Definition: layer_ids.h:483
constexpr T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:36
Message panel definition file.
KICOMMON_API wxString EllipsizeMenuText(const wxString &aString)
Ellipsize text (at the end) to be no more than 36 characters.
Definition: ui_common.cpp:215
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:197
see class PGM_BASE
#define TYPE_HASH(x)
Definition: property.h:71
#define REGISTER_TYPE(x)
Definition: property_mgr.h:371
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.
Definition: string_utils.h:403
VECTOR2I end
constexpr 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:151
#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