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 (C) 1992-2023 KiCad Developers, see AUTHORS.txt for contributors.
7 *
8 * This program is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU General Public License
10 * as published by the Free Software Foundation; either version 2
11 * of the License, or (at your option) any later version.
12 *
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
17 *
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, you may find one here:
20 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21 * or you may search the http://www.gnu.org website for the version 2 license,
22 * or you may write to the Free Software Foundation, Inc.,
23 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24 */
25
26#include <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
299void SCH_TEXT::Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
300 const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed )
301{
303 COLOR4D bg = aSettings->GetBackgroundColor();
304 bool blackAndWhiteMode = GetGRForceBlackPenState();
305
306 if( blackAndWhiteMode || color == COLOR4D::UNSPECIFIED )
307 color = aSettings->GetLayerColor( m_layer );
308
309 if( bg == COLOR4D::UNSPECIFIED || GetGRForceBlackPenState() )
310 bg = COLOR4D::WHITE;
311
312 if( !IsVisible() )
313 bg = aSettings->GetLayerColor( LAYER_HIDDEN );
314
315 if( aDimmed )
316 {
317 color.Desaturate( );
318 color = color.Mix( bg, 0.5f );
319 }
320
321 KIFONT::FONT* font = GetFont();
322
323 if( !font )
324 font = KIFONT::FONT::GetFont( aSettings->GetDefaultFont(), IsBold(), IsItalic() );
325
326 if( m_layer == LAYER_DEVICE )
327 {
328 wxDC* DC = aSettings->GetPrintDC();
329 int penWidth = std::max( GetEffectiveTextPenWidth(), aSettings->GetDefaultPenWidth() );
330
331 // Calculate the text orientation, according to the symbol orientation/mirror (needed when
332 // draw text in schematic)
333 EDA_ANGLE orient = GetTextAngle();
334
335 if( aSettings->m_Transform.y1 ) // Rotate symbol 90 degrees.
336 {
337 if( orient == ANGLE_HORIZONTAL )
338 orient = ANGLE_VERTICAL;
339 else
340 orient = ANGLE_HORIZONTAL;
341 }
342
343 /*
344 * Calculate the text justification, according to the symbol orientation/mirror.
345 * This is a bit complicated due to cumulative calculations:
346 * - numerous cases (mirrored or not, rotation)
347 * - the GRText function will also recalculate H and V justifications according to the text
348 * orientation.
349 * - When a symbol is mirrored, the text is not mirrored and justifications are complicated
350 * to calculate so the more easily way is to use no justifications (centered text) and
351 * use GetBoundingBox to know the text coordinate considered as centered
352 */
353 BOX2I bBox = GetBoundingBox();
354 VECTOR2I txtpos = bBox.Centre();
355
356 // Calculate pos according to mirror/rotation.
357 txtpos = aSettings->m_Transform.TransformCoordinate( txtpos ) + aOffset;
358
359 GRPrintText( DC, txtpos, color, GetShownText( true ), orient, GetTextSize(),
361 IsBold(), font, GetFontMetrics() );
362 }
363 else
364 {
365 VECTOR2I text_offset = aOffset + GetSchematicTextOffset( aSettings );
366
367 // Adjust text drawn in an outline font to more closely mimic the positioning of
368 // SCH_FIELD text.
369 if( font->IsOutline() )
370 {
371 BOX2I firstLineBBox = GetTextBox( 0 );
372 int sizeDiff = firstLineBBox.GetHeight() - GetTextSize().y;
373 int adjust = KiROUND( sizeDiff * 0.4 );
374 VECTOR2I adjust_offset( 0, - adjust );
375
376 RotatePoint( adjust_offset, GetDrawRotation() );
377 text_offset += adjust_offset;
378 }
379
380 EDA_TEXT::Print( aSettings, text_offset, color );
381 }
382}
383
384
386{
387 BOX2I bbox = GetTextBox();
388
389 if( !GetTextAngle().IsZero() ) // Rotate bbox.
390 {
391 VECTOR2I pos = bbox.GetOrigin();
392 VECTOR2I end = bbox.GetEnd();
393
396
397 bbox.SetOrigin( pos );
398 bbox.SetEnd( end );
399 }
400
401 bbox.Normalize();
402 return bbox;
403}
404
405
406wxString SCH_TEXT::GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText,
407 int aDepth ) const
408{
409 SCH_SHEET* sheet = nullptr;
410
411 if( aPath )
412 sheet = aPath->Last();
413 else if( SCHEMATIC* schematic = Schematic() )
414 sheet = schematic->CurrentSheet().Last();
415
416 std::function<bool( wxString* )> textResolver =
417 [&]( wxString* token ) -> bool
418 {
419 if( sheet )
420 {
421 if( sheet->ResolveTextVar( aPath, token, aDepth + 1 ) )
422 return true;
423 }
424
425 return false;
426 };
427
428 wxString text = EDA_TEXT::GetShownText( aAllowExtraText, aDepth );
429
430 if( text == wxS( "~" ) ) // Legacy placeholder for empty string
431 {
432 text = wxS( "" );
433 }
434 else if( HasTextVars() )
435 {
436 if( aDepth < ADVANCED_CFG::GetCfg().m_ResolveTextRecursionDepth )
437 text = ExpandTextVars( text, &textResolver );
438 }
439
440 return text;
441}
442
443
445{
446 wxCHECK_MSG( IsHypertext(), /* void */,
447 wxT( "Calling a hypertext menu on a SCH_TEXT with no hyperlink?" ) );
448
450 navTool->HypertextCommand( m_hyperlink );
451}
452
453
454wxString SCH_TEXT::GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const
455{
456 return wxString::Format( _( "Graphic Text '%s'" ),
457 aFull ? GetShownText( false ) : KIUI::EllipsizeMenuText( GetText() ) );
458}
459
460
462{
463 return BITMAPS::text;
464}
465
466
467bool SCH_TEXT::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
468{
469 BOX2I bBox = GetBoundingBox();
470 bBox.Inflate( aAccuracy );
471 return bBox.Contains( aPosition );
472}
473
474
475bool SCH_TEXT::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
476{
478 return false;
479
480 BOX2I rect = aRect;
481 BOX2I bBox = GetBoundingBox();
482
483 rect.Inflate( aAccuracy );
484
485 if( aContained )
486 return aRect.Contains( bBox );
487
488 return aRect.Intersects( bBox );
489}
490
491
492void SCH_TEXT::BeginEdit( const VECTOR2I& aPosition )
493{
494 SetTextPos( aPosition );
495}
496
497
498void SCH_TEXT::CalcEdit( const VECTOR2I& aPosition )
499{
500 SetTextPos( aPosition );
501}
502
503
504void SCH_TEXT::ViewGetLayers( int aLayers[], int& aCount ) const
505{
506 aCount = 2;
507 aLayers[0] = IsPrivate() ? LAYER_PRIVATE_NOTES : m_layer;
508 aLayers[1] = LAYER_SELECTION_SHADOWS;
509}
510
511
512void SCH_TEXT::Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
513 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed )
514{
515 if( aBackground || IsPrivate() )
516 return;
517
518 SCH_RENDER_SETTINGS* renderSettings = getRenderSettings( aPlotter );
520 COLOR4D bg = renderSettings->GetBackgroundColor();
521
522 if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED )
523 {
524 SCH_CONNECTION* connection = Connection();
525
526 if( connection && connection->IsBus() )
527 color = renderSettings->GetLayerColor( LAYER_BUS );
528 else
529 color = renderSettings->GetLayerColor( m_layer );
530 }
531
532 if( !IsVisible() )
533 bg = renderSettings->GetLayerColor( LAYER_HIDDEN );
534 else if( bg == COLOR4D::UNSPECIFIED || !aPlotter->GetColorMode() )
535 bg = COLOR4D::WHITE;
536
537 if( aDimmed )
538 {
539 color.Desaturate( );
540 color = color.Mix( bg, 0.5f );
541 }
542
543 int penWidth = GetEffectiveTextPenWidth( renderSettings->GetDefaultPenWidth() );
544 penWidth = std::max( penWidth, renderSettings->GetMinPenWidth() );
545 aPlotter->SetCurrentLineWidth( penWidth );
546
547 KIFONT::FONT* font = GetFont();
548
549 if( !font )
550 font = KIFONT::FONT::GetFont( renderSettings->GetDefaultFont(), IsBold(), IsItalic() );
551
553 attrs.m_StrokeWidth = penWidth;
554
555 if( m_layer == LAYER_DEVICE )
556 {
557 BOX2I bBox = GetBoundingBox();
558
559 /*
560 * Calculate the text justification, according to the symbol orientation/mirror. This is
561 * a bit complicated due to cumulative calculations:
562 * - numerous cases (mirrored or not, rotation)
563 * - the plotter's Text() function will also recalculate H and V justifications according
564 * to the text orientation
565 * - when a symbol is mirrored the text is not, and justifications become a nightmare
566 *
567 * So the easier way is to use no justifications (centered text) and use GetBoundingBox to
568 * know the text coordinate considered as centered.
569 */
570 VECTOR2I txtpos = bBox.Centre();
573
574 // The text orientation may need to be flipped if the transformation matrix causes xy
575 // axes to be flipped.
576 if( ( renderSettings->m_Transform.x1 != 0 ) ^ ( GetTextAngle() != ANGLE_HORIZONTAL ) )
578 else
579 attrs.m_Angle = ANGLE_VERTICAL;
580
581 aPlotter->PlotText( renderSettings->TransformCoordinate( txtpos ) + aOffset, color,
582 GetText(), attrs, font, GetFontMetrics() );
583 }
584 else
585 {
587 VECTOR2I text_offset = GetSchematicTextOffset( aPlotter->RenderSettings() );
588
589 // Adjust text drawn in an outline font to more closely mimic the positioning of
590 // SCH_FIELD text.
591 if( font->IsOutline() )
592 {
593 BOX2I firstLineBBox = GetTextBox( 0 );
594 int sizeDiff = firstLineBBox.GetHeight() - GetTextSize().y;
595 int adjust = KiROUND( sizeDiff * 0.4 );
596 VECTOR2I adjust_offset( 0, - adjust );
597
598 RotatePoint( adjust_offset, GetDrawRotation() );
599 text_offset += adjust_offset;
600 }
601
602 std::vector<VECTOR2I> positions;
603 wxArrayString strings_list;
604 wxStringSplit( GetShownText( sheet, true ), strings_list, '\n' );
605 positions.reserve( strings_list.Count() );
606
607 GetLinePositions( positions, (int) strings_list.Count() );
608
609 attrs.m_Multiline = false;
610
611 for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
612 {
613 VECTOR2I textpos = positions[ii] + text_offset;
614 wxString& txt = strings_list.Item( ii );
615 aPlotter->PlotText( textpos, color, txt, attrs, font, GetFontMetrics() );
616 }
617
618 if( HasHyperlink() )
619 aPlotter->HyperlinkBox( GetBoundingBox(), GetHyperlink() );
620 }
621}
622
623
624void SCH_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
625{
626 wxString msg;
627
628 // Don't use GetShownText() here; we want to show the user the variable references
629 aList.emplace_back( _( "Text" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
630
632 aList.emplace_back( _( "Exclude from" ), _( "Simulation" ) );
633
634 aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
635
636 wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
637 int style = IsBold() && IsItalic() ? 3 : IsBold() ? 2 : IsItalic() ? 1 : 0;
638 aList.emplace_back( _( "Style" ), textStyle[style] );
639
640 aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
641
642 switch( GetHorizJustify() )
643 {
644 case GR_TEXT_H_ALIGN_LEFT: msg = _( "Align left" ); break;
645 case GR_TEXT_H_ALIGN_CENTER: msg = _( "Align center" ); break;
646 case GR_TEXT_H_ALIGN_RIGHT: msg = _( "Align right" ); break;
648 }
649
650 if( m_layer == LAYER_DEVICE )
651 {
652 aList.emplace_back( _( "H Justification" ), msg );
653
654 switch ( GetVertJustify() )
655 {
656 case GR_TEXT_V_ALIGN_TOP: msg = _( "Top" ); break;
657 case GR_TEXT_V_ALIGN_CENTER: msg = _( "Center" ); break;
658 case GR_TEXT_V_ALIGN_BOTTOM: msg = _( "Bottom" ); break;
660 }
661
662 aList.emplace_back( _( "V Justification" ), msg );
663 }
664 else
665 {
666 aList.emplace_back( _( "Justification" ), msg );
667 }
668}
669
670bool SCH_TEXT::operator==( const SCH_ITEM& aOther ) const
671{
672 if( Type() != aOther.Type() )
673 return false;
674
675 const SCH_TEXT* other = static_cast<const SCH_TEXT*>( &aOther );
676
677 if( GetLayer() != other->GetLayer() )
678 return false;
679
680 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
681 return false;
682
683 return EDA_TEXT::operator==( *other );
684}
685
686
687double SCH_TEXT::Similarity( const SCH_ITEM& aOther ) const
688{
689 if( m_Uuid == aOther.m_Uuid )
690 return 1.0;
691
692 if( Type() != aOther.Type() )
693 return 0.0;
694
695 const SCH_TEXT* other = static_cast<const SCH_TEXT*>( &aOther );
696
697 double retval = SimilarityBase( aOther );
698
699 if( GetLayer() != other->GetLayer() )
700 retval *= 0.9;
701
702 if( GetExcludedFromSim() != other->GetExcludedFromSim() )
703 retval *= 0.9;
704
705 retval *= EDA_TEXT::Similarity( *other );
706
707 return retval;
708}
709
710
711int SCH_TEXT::compare( const SCH_ITEM& aOther, int aCompareFlags ) const
712{
713 wxASSERT( aOther.Type() == SCH_TEXT_T );
714
715 int retv = SCH_ITEM::compare( aOther, aCompareFlags );
716
717 if( retv )
718 return retv;
719
720 const SCH_TEXT& tmp = static_cast<const SCH_TEXT&>( aOther );
721
722 int result = GetText().CmpNoCase( tmp.GetText() );
723
724 if( result != 0 )
725 return result;
726
727 if( GetTextPos().x != tmp.GetTextPos().x )
728 return GetTextPos().x - tmp.GetTextPos().x;
729
730 if( GetTextPos().y != tmp.GetTextPos().y )
731 return GetTextPos().y - tmp.GetTextPos().y;
732
733 if( GetTextWidth() != tmp.GetTextWidth() )
734 return GetTextWidth() - tmp.GetTextWidth();
735
736 if( GetTextHeight() != tmp.GetTextHeight() )
737 return GetTextHeight() - tmp.GetTextHeight();
738
739 return 0;
740}
741
742
743#if defined(DEBUG)
744
745void SCH_TEXT::Show( int nestLevel, std::ostream& os ) const
746{
747 // XML output:
748 wxString s = GetClass();
749
750 NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str()
751 << " layer=\"" << m_layer << '"'
752 << '>'
753 << TO_UTF8( GetText() )
754 << "</" << s.Lower().mb_str() << ">\n";
755}
756
757#endif
758
759
760static struct SCH_TEXT_DESC
761{
763 {
770
771 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Mirrored" ) );
772 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Visible" ) );
773 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Width" ) );
774 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Height" ) );
775 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Thickness" ) );
776
777 propMgr.AddProperty( new PROPERTY<SCH_TEXT, int>( _HKI( "Text Size" ),
778 &SCH_TEXT::SetSchTextSize, &SCH_TEXT::GetSchTextSize, PROPERTY_DISPLAY::PT_SIZE ),
779 _HKI( "Text Properties" ) );
780
781 // Orientation is exposed differently in schematic; mask the base for now
782 propMgr.Mask( TYPE_HASH( SCH_TEXT ), TYPE_HASH( EDA_TEXT ), _HKI( "Orientation" ) );
783 }
int color
Definition: DXF_plotter.cpp:58
constexpr EDA_IU_SCALE schIUScale
Definition: base_units.h:110
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
static const ADVANCED_CFG & GetCfg()
Get the singleton instance's config, which is shared by all consumers.
void SetOrigin(const Vec &pos)
Definition: box2.h:227
BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition: box2.h:136
const Vec & GetOrigin() const
Definition: box2.h:200
size_type GetHeight() const
Definition: box2.h:205
bool Intersects(const BOX2< Vec > &aRect) const
Definition: box2.h:294
size_type GetWidth() const
Definition: box2.h:204
const Vec GetEnd() const
Definition: box2.h:202
bool Contains(const Vec &aPoint) const
Definition: box2.h:158
BOX2< Vec > & Inflate(coord_type dx, coord_type dy)
Inflates the rectangle horizontally by dx and vertically by dy.
Definition: box2.h:541
Vec Centre() const
Definition: box2.h:87
void SetEnd(coord_type x, coord_type y)
Definition: box2.h:280
The base class for create windows for drawing purpose.
const KIID m_Uuid
Definition: eda_item.h:489
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:499
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:224
const VECTOR2I & GetTextPos() const
Definition: eda_text.h:230
COLOR4D GetTextColor() const
Definition: eda_text.h:227
bool IsItalic() const
Definition: eda_text.h:140
const EDA_ANGLE & GetTextAngle() const
Definition: eda_text.h:130
virtual const wxString & GetText() const
Return the string associated with the text object.
Definition: eda_text.h:94
virtual bool IsVisible() const
Definition: eda_text.h:147
void SetTextPos(const VECTOR2I &aPoint)
Definition: eda_text.cpp:418
void SetTextX(int aX)
Definition: eda_text.cpp:424
KIFONT::FONT * GetFont() const
Definition: eda_text.h:207
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:570
void SetTextY(int aY)
Definition: eda_text.cpp:430
virtual EDA_ANGLE GetDrawRotation() const
Definition: eda_text.h:336
wxString m_hyperlink
A hyperlink URL.
Definition: eda_text.h:412
int GetTextWidth() const
Definition: eda_text.h:221
virtual bool HasHyperlink() const
Definition: eda_text.h:357
void SetVertJustify(GR_TEXT_V_ALIGN_T aType)
Definition: eda_text.cpp:275
wxString GetHyperlink() const
Definition: eda_text.h:358
GR_TEXT_H_ALIGN_T GetHorizJustify() const
Definition: eda_text.h:160
bool HasTextVars() const
Indicates the ShownText has text var references which need to be processed.
Definition: eda_text.h:113
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:753
double Similarity(const EDA_TEXT &aOther) const
Definition: eda_text.cpp:1142
void FlipHJustify()
Definition: eda_text.h:168
const TEXT_ATTRIBUTES & GetAttributes() const
Definition: eda_text.h:191
int GetEffectiveTextPenWidth(int aDefaultPenWidth=0) const
The EffectiveTextPenWidth uses the text thickness if > 1 or aDefaultPenWidth.
Definition: eda_text.cpp:323
void SwapAttributes(EDA_TEXT &aTradingPartner)
Swap the text attributes of the two involved instances.
Definition: eda_text.cpp:310
bool IsBold() const
Definition: eda_text.h:144
GR_TEXT_V_ALIGN_T GetVertJustify() const
Definition: eda_text.h:163
virtual wxString GetShownText(bool aAllowExtraText, int aDepth=0) const
Return the string actually shown after processing of the base text.
Definition: eda_text.h:105
virtual void SetTextAngle(const EDA_ANGLE &aAngle)
Definition: eda_text.cpp:204
void Print(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset, const COLOR4D &aColor, OUTLINE_MODE aDisplay_mode=FILLED)
Print this text object to the device context aDC.
Definition: eda_text.cpp:729
void SwapText(EDA_TEXT &aTradingPartner)
Definition: eda_text.cpp:303
bool operator==(const EDA_TEXT &aRhs) const
Definition: eda_text.h:353
void SetMultilineAllowed(bool aAllow)
Definition: eda_text.cpp:259
VECTOR2I GetTextSize() const
Definition: eda_text.h:218
void SetHorizJustify(GR_TEXT_H_ALIGN_T aType)
Definition: eda_text.cpp:267
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)
Definition: font.cpp:146
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.
wxDC * GetPrintDC() const
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:454
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:752
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:76
SCH_SHEET_PATH & CurrentSheet() const override
Definition: schematic.h:144
SCHEMATIC_SETTINGS & Settings() const
Definition: schematic.cpp:297
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:166
const wxString & GetDefaultFont() const
Definition: sch_item.cpp:458
SCH_RENDER_SETTINGS * getRenderSettings(PLOTTER *aPlotter) const
Definition: sch_item.h:670
SCHEMATIC * Schematic() const
Searches the item hierarchy to find a SCHEMATIC.
Definition: sch_item.cpp:150
bool IsPrivate() const
Definition: sch_item.h:235
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:281
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:419
void SwapFlags(SCH_ITEM *aItem)
Swap the non-temp and non-edit flags.
Definition: sch_item.cpp:354
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:221
const KIFONT::METRICS & GetFontMetrics() const
Definition: sch_item.cpp:466
SCH_LAYER_ID m_layer
Definition: sch_item.h:723
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:316
Handle actions specific to the schematic editor.
void HypertextCommand(const wxString &href)
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:57
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:251
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: sch_text.cpp:454
void DoHypertextAction(EDA_DRAW_FRAME *aFrame) const override
Definition: sch_text.cpp:444
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:711
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:461
int GetSchTextSize() const
Definition: sch_text.h:75
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:498
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:141
virtual void Rotate90(bool aClockwise)
Definition: sch_text.cpp:209
KIFONT::FONT * getDrawFont() const override
Definition: sch_text.cpp:288
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
Definition: sch_text.cpp:119
void Print(const SCH_RENDER_SETTINGS *aSettings, int aUnit, int aBodyStyle, const VECTOR2I &offset, bool aForceNoFill, bool aDimmed) override
Print an item.
Definition: sch_text.cpp:299
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:687
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition: sch_text.cpp:231
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: sch_text.cpp:385
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:406
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the layers the item is drawn on (which may be more than its "home" layer)
Definition: sch_text.cpp:504
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:512
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:467
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:624
void BeginEdit(const VECTOR2I &aStartPoint) override
Begin drawing a symbol library draw item at aPosition.
Definition: sch_text.cpp:492
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:670
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 y1
Definition: transform.h:49
VECTOR2I TransformCoordinate(const VECTOR2I &aPoint) const
Calculate a new coordinate according to the mirror/rotation transform.
Definition: transform.cpp:44
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)
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
bool GetGRForceBlackPenState(void)
Definition: gr_basic.cpp:165
void GRPrintText(wxDC *aDC, const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const EDA_ANGLE &aOrient, const VECTOR2I &aSize, enum GR_TEXT_H_ALIGN_T aH_justify, enum GR_TEXT_V_ALIGN_T aV_justify, int aWidth, bool aItalic, bool aBold, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics)
Print a graphic text through wxDC.
Definition: gr_text.cpp:142
SCH_LAYER_ID
Eeschema drawing layers.
Definition: layer_ids.h:354
@ LAYER_DEVICE
Definition: layer_ids.h:371
@ LAYER_HIDDEN
Definition: layer_ids.h:396
@ LAYER_PRIVATE_NOTES
Definition: layer_ids.h:373
@ LAYER_BUS
Definition: layer_ids.h:358
@ LAYER_SELECTION_SHADOWS
Definition: layer_ids.h:397
T MIRRORVAL(T aPoint, T aMirrorRef)
Returns the mirror of aPoint relative to the aMirrorRef.
Definition: mirror.h:31
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:213
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:195
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:391
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:228
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
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:121
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:673