/* * This program source code file is part of KiCad, a free EDA CAD application. * * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr * Copyright (C) 2015 Wayne Stambaugh * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors. * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * as published by the Free Software Foundation; either version 2 * of the License, or (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, you may find one here: * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html * or you may search the http://www.gnu.org website for the version 2 license, * or you may write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA */ /** * @file sch_text.cpp * @brief Code for handling schematic texts (texts, labels, hlabels and global labels). */ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using KIGFX::SCH_RENDER_SETTINGS; bool IncrementLabelMember( wxString& name, int aIncrement ) { if( name.IsEmpty() ) return true; wxString suffix; wxString digits; wxString outputFormat; wxString outputNumber; int ii = name.Len() - 1; int dCount = 0; while( ii >= 0 && !wxIsdigit( name.GetChar( ii ) ) ) { suffix = name.GetChar( ii ) + suffix; ii--; } while( ii >= 0 && wxIsdigit( name.GetChar( ii ) ) ) { digits = name.GetChar( ii ) + digits; ii--; dCount++; } if( digits.IsEmpty() ) return true; long number = 0; if( digits.ToLong( &number ) ) { number += aIncrement; // Don't let result go below zero if( number > -1 ) { name.Remove( ii + 1 ); //write out a format string with correct number of leading zeroes outputFormat.Printf( wxT( "%%0%dd" ), dCount ); //write out the number using the format string outputNumber.Printf( outputFormat, number ); name << outputNumber << suffix; return true; } } return false; } /* Coding polygons for global symbol graphic shapes. * the first parml is the number of corners * others are the corners coordinates in reduced units * the real coordinate is the reduced coordinate * text half size */ static int TemplateIN_HN[] = { 6, 0, 0, -1, -1, -2, -1, -2, 1, -1, 1, 0, 0 }; static int TemplateIN_HI[] = { 6, 0, 0, 1, 1, 2, 1, 2, -1, 1, -1, 0, 0 }; static int TemplateIN_UP[] = { 6, 0, 0, 1, -1, 1, -2, -1, -2, -1, -1, 0, 0 }; static int TemplateIN_BOTTOM[] = { 6, 0, 0, 1, 1, 1, 2, -1, 2, -1, 1, 0, 0 }; static int TemplateOUT_HN[] = { 6, -2, 0, -1, 1, 0, 1, 0, -1, -1, -1, -2, 0 }; static int TemplateOUT_HI[] = { 6, 2, 0, 1, -1, 0, -1, 0, 1, 1, 1, 2, 0 }; static int TemplateOUT_UP[] = { 6, 0, -2, 1, -1, 1, 0, -1, 0, -1, -1, 0, -2 }; static int TemplateOUT_BOTTOM[] = { 6, 0, 2, 1, 1, 1, 0, -1, 0, -1, 1, 0, 2 }; static int TemplateUNSPC_HN[] = { 5, 0, -1, -2, -1, -2, 1, 0, 1, 0, -1 }; static int TemplateUNSPC_HI[] = { 5, 0, -1, 2, -1, 2, 1, 0, 1, 0, -1 }; static int TemplateUNSPC_UP[] = { 5, 1, 0, 1, -2, -1, -2, -1, 0, 1, 0 }; static int TemplateUNSPC_BOTTOM[] = { 5, 1, 0, 1, 2, -1, 2, -1, 0, 1, 0 }; static int TemplateBIDI_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 }; static int TemplateBIDI_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 }; static int TemplateBIDI_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 }; static int TemplateBIDI_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 }; static int Template3STATE_HN[] = { 5, 0, 0, -1, -1, -2, 0, -1, 1, 0, 0 }; static int Template3STATE_HI[] = { 5, 0, 0, 1, -1, 2, 0, 1, 1, 0, 0 }; static int Template3STATE_UP[] = { 5, 0, 0, -1, -1, 0, -2, 1, -1, 0, 0 }; static int Template3STATE_BOTTOM[] = { 5, 0, 0, -1, 1, 0, 2, 1, 1, 0, 0 }; static int* TemplateShape[5][4] = { { TemplateIN_HN, TemplateIN_UP, TemplateIN_HI, TemplateIN_BOTTOM }, { TemplateOUT_HN, TemplateOUT_UP, TemplateOUT_HI, TemplateOUT_BOTTOM }, { TemplateBIDI_HN, TemplateBIDI_UP, TemplateBIDI_HI, TemplateBIDI_BOTTOM }, { Template3STATE_HN, Template3STATE_UP, Template3STATE_HI, Template3STATE_BOTTOM }, { TemplateUNSPC_HN, TemplateUNSPC_UP, TemplateUNSPC_HI, TemplateUNSPC_BOTTOM } }; LABEL_SPIN_STYLE LABEL_SPIN_STYLE::RotateCW() { SPIN newSpin = m_spin; switch( m_spin ) { case LABEL_SPIN_STYLE::LEFT: newSpin = LABEL_SPIN_STYLE::UP; break; case LABEL_SPIN_STYLE::UP: newSpin = LABEL_SPIN_STYLE::RIGHT; break; case LABEL_SPIN_STYLE::RIGHT: newSpin = LABEL_SPIN_STYLE::BOTTOM; break; case LABEL_SPIN_STYLE::BOTTOM: newSpin = LABEL_SPIN_STYLE::LEFT; break; default: wxLogWarning( wxT( "RotateCW encountered unknown current spin style" ) ); break; } return LABEL_SPIN_STYLE( newSpin ); } LABEL_SPIN_STYLE LABEL_SPIN_STYLE::RotateCCW() { SPIN newSpin = m_spin; switch( m_spin ) { case LABEL_SPIN_STYLE::LEFT: newSpin = LABEL_SPIN_STYLE::BOTTOM; break; case LABEL_SPIN_STYLE::BOTTOM: newSpin = LABEL_SPIN_STYLE::RIGHT; break; case LABEL_SPIN_STYLE::RIGHT: newSpin = LABEL_SPIN_STYLE::UP; break; case LABEL_SPIN_STYLE::UP: newSpin = LABEL_SPIN_STYLE::LEFT; break; default: wxLogWarning( wxT( "RotateCCW encountered unknown current spin style" ) ); break; } return LABEL_SPIN_STYLE( newSpin ); } LABEL_SPIN_STYLE LABEL_SPIN_STYLE::MirrorX() { SPIN newSpin = m_spin; switch( m_spin ) { case LABEL_SPIN_STYLE::UP: newSpin = LABEL_SPIN_STYLE::BOTTOM; break; case LABEL_SPIN_STYLE::BOTTOM: newSpin = LABEL_SPIN_STYLE::UP; break; case LABEL_SPIN_STYLE::LEFT: break; case LABEL_SPIN_STYLE::RIGHT: break; default: wxLogWarning( wxT( "MirrorX encountered unknown current spin style" ) ); break; } return LABEL_SPIN_STYLE( newSpin ); } LABEL_SPIN_STYLE LABEL_SPIN_STYLE::MirrorY() { SPIN newSpin = m_spin; switch( m_spin ) { case LABEL_SPIN_STYLE::LEFT: newSpin = LABEL_SPIN_STYLE::RIGHT; break; case LABEL_SPIN_STYLE::RIGHT: newSpin = LABEL_SPIN_STYLE::LEFT; break; case LABEL_SPIN_STYLE::UP: break; case LABEL_SPIN_STYLE::BOTTOM: break; default: wxLogWarning( wxT( "MirrorY encountered unknown current spin style" ) ); break; } return LABEL_SPIN_STYLE( newSpin ); } SCH_TEXT::SCH_TEXT( const wxPoint& pos, const wxString& text, KICAD_T aType ) : SCH_ITEM( nullptr, aType ), EDA_TEXT( text ), m_shape( PINSHEETLABEL_SHAPE::PS_INPUT ), m_isDangling( false ), m_connectionType( CONNECTION_TYPE::NONE ) { m_layer = LAYER_NOTES; SetTextPos( pos ); SetLabelSpinStyle( LABEL_SPIN_STYLE::LEFT ); SetMultilineAllowed( true ); } SCH_TEXT::SCH_TEXT( const SCH_TEXT& aText ) : SCH_ITEM( aText ), EDA_TEXT( aText ), m_shape( aText.m_shape ), m_isDangling( aText.m_isDangling ), m_connectionType( aText.m_connectionType ), m_spin_style( aText.m_spin_style ) { } EDA_ITEM* SCH_TEXT::Clone() const { return new SCH_TEXT( *this ); } bool SCH_TEXT::IncrementLabel( int aIncrement ) { wxString text = GetText(); bool ReturnVal = IncrementLabelMember( text, aIncrement ); if( ReturnVal ) SetText( text ); return ReturnVal; } wxPoint SCH_TEXT::GetSchematicTextOffset( const RENDER_SETTINGS* aSettings ) const { wxPoint text_offset; // add an offset to x (or y) position to aid readability of text on a wire or line int dist = GetTextOffset( aSettings ) + GetPenWidth(); switch( GetLabelSpinStyle() ) { case LABEL_SPIN_STYLE::UP: case LABEL_SPIN_STYLE::BOTTOM: text_offset.x = -dist; break; // Vert Orientation default: case LABEL_SPIN_STYLE::LEFT: case LABEL_SPIN_STYLE::RIGHT: text_offset.y = -dist; break; // Horiz Orientation } return text_offset; } void SCH_TEXT::MirrorHorizontally( int aCenter ) { // Text is NOT really mirrored; it is moved to a suitable horizontal position SetLabelSpinStyle( GetLabelSpinStyle().MirrorY() ); SetTextX( MIRRORVAL( GetTextPos().x, aCenter ) ); } void SCH_TEXT::MirrorVertically( int aCenter ) { // Text is NOT really mirrored; it is moved to a suitable vertical position SetLabelSpinStyle( GetLabelSpinStyle().MirrorX() ); SetTextY( MIRRORVAL( GetTextPos().y, aCenter ) ); } void SCH_TEXT::Rotate( const wxPoint& aCenter ) { wxPoint pt = GetTextPos(); RotatePoint( &pt, aCenter, 900 ); wxPoint offset = pt - GetTextPos(); Rotate90( false ); SetTextPos( GetTextPos() + offset ); } void SCH_TEXT::Rotate90( bool aClockwise ) { if( aClockwise ) SetLabelSpinStyle( GetLabelSpinStyle().RotateCW() ); else SetLabelSpinStyle( GetLabelSpinStyle().RotateCCW() ); } void SCH_TEXT::MirrorSpinStyle( bool aLeftRight ) { if( aLeftRight ) SetLabelSpinStyle( GetLabelSpinStyle().MirrorY() ); else SetLabelSpinStyle( GetLabelSpinStyle().MirrorX() ); } void SCH_TEXT::SetLabelSpinStyle( LABEL_SPIN_STYLE aSpinStyle ) { m_spin_style = aSpinStyle; // Assume "Right" and Left" mean which side of the anchor the text will be on // Thus we want to left justify text up against the anchor if we are on the right switch( aSpinStyle ) { default: wxASSERT_MSG( 1, wxT( "Bad spin style" ) ); break; case LABEL_SPIN_STYLE::RIGHT: // Horiz Normal Orientation // m_spin_style = LABEL_SPIN_STYLE::RIGHT; // Handle the error spin style by resetting SetTextAngle( TEXT_ANGLE_HORIZ ); SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM ); break; case LABEL_SPIN_STYLE::UP: // Vert Orientation UP SetTextAngle( TEXT_ANGLE_VERT ); SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM ); break; case LABEL_SPIN_STYLE::LEFT: // Horiz Orientation - Right justified SetTextAngle( TEXT_ANGLE_HORIZ ); SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM ); break; case LABEL_SPIN_STYLE::BOTTOM: // Vert Orientation BOTTOM SetTextAngle( TEXT_ANGLE_VERT ); SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); SetVertJustify( GR_TEXT_VJUSTIFY_BOTTOM ); break; } } void SCH_TEXT::SwapData( SCH_ITEM* aItem ) { SCH_TEXT* item = (SCH_TEXT*) aItem; std::swap( m_layer, item->m_layer ); std::swap( m_shape, item->m_shape ); std::swap( m_isDangling, item->m_isDangling ); std::swap( m_spin_style, item->m_spin_style ); SwapText( *item ); SwapEffects( *item ); } bool SCH_TEXT::operator<( const SCH_ITEM& aItem ) const { if( Type() != aItem.Type() ) return Type() < aItem.Type(); auto other = static_cast( &aItem ); if( GetLayer() != other->GetLayer() ) return GetLayer() < other->GetLayer(); if( GetPosition().x != other->GetPosition().x ) return GetPosition().x < other->GetPosition().x; if( GetPosition().y != other->GetPosition().y ) return GetPosition().y < other->GetPosition().y; return GetText() < other->GetText(); } int SCH_TEXT::GetTextOffset( const RENDER_SETTINGS* aSettings ) const { double ratio; if( aSettings ) ratio = static_cast( aSettings )->m_TextOffsetRatio; else if( Schematic() ) ratio = Schematic()->Settings().m_TextOffsetRatio; else ratio = DEFAULT_TEXT_OFFSET_RATIO; // For previews (such as in Preferences), etc. return KiROUND( ratio * GetTextSize().y ); return 0; } int SCH_TEXT::GetLabelBoxExpansion( const RENDER_SETTINGS* aSettings ) const { double ratio; if( aSettings ) ratio = static_cast( aSettings )->m_LabelSizeRatio; else if( Schematic() ) ratio = Schematic()->Settings().m_LabelSizeRatio; else ratio = DEFAULT_LABEL_SIZE_RATIO; // For previews (such as in Preferences), etc. return KiROUND( ratio * GetTextSize().y ); return 0; } int SCH_TEXT::GetPenWidth() const { return GetEffectiveTextPenWidth(); } void SCH_TEXT::Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) { COLOR4D color = aSettings->GetLayerColor( m_layer ); wxPoint text_offset = aOffset + GetSchematicTextOffset( aSettings ); EDA_TEXT::Print( aSettings, text_offset, color ); } void SCH_TEXT::GetEndPoints( std::vector & aItemList ) { // Normal text labels cannot be tested for dangling ends. if( Type() == SCH_TEXT_T ) return; DANGLING_END_ITEM item( LABEL_END, this, GetTextPos() ); aItemList.push_back( item ); } bool SCH_TEXT::UpdateDanglingState( std::vector& aItemList, const SCH_SHEET_PATH* aPath ) { // Normal text labels cannot be tested for dangling ends. if( Type() == SCH_TEXT_T ) return false; bool previousState = m_isDangling; m_isDangling = true; m_connectionType = CONNECTION_TYPE::NONE; for( unsigned ii = 0; ii < aItemList.size(); ii++ ) { DANGLING_END_ITEM& item = aItemList[ii]; if( item.GetItem() == this ) continue; switch( item.GetType() ) { case PIN_END: case LABEL_END: case SHEET_LABEL_END: case NO_CONNECT_END: if( GetTextPos() == item.GetPosition() ) { m_isDangling = false; if( aPath && item.GetType() != PIN_END ) AddConnectionTo( *aPath, static_cast( item.GetItem() ) ); } break; case BUS_END: m_connectionType = CONNECTION_TYPE::BUS; KI_FALLTHROUGH; case WIRE_END: { DANGLING_END_ITEM& nextItem = aItemList[++ii]; int accuracy = 1; // We have rounding issues with an accuracy of 0 m_isDangling = !TestSegmentHit( GetTextPos(), item.GetPosition(), nextItem.GetPosition(), accuracy ); if( !m_isDangling ) { if( m_connectionType != CONNECTION_TYPE::BUS ) m_connectionType = CONNECTION_TYPE::NET; // Add the line to the connected items, since it won't be picked // up by a search of intersecting connection points if( aPath ) { auto sch_item = static_cast( item.GetItem() ); AddConnectionTo( *aPath, sch_item ); sch_item->AddConnectionTo( *aPath, this ); } } } break; default: break; } if( !m_isDangling ) break; } if( m_isDangling ) m_connectionType = CONNECTION_TYPE::NONE; return previousState != m_isDangling; } std::vector SCH_TEXT::GetConnectionPoints() const { // Normal text labels do not have connection points. All others do. if( Type() == SCH_TEXT_T ) return {}; return { GetTextPos() }; } const EDA_RECT SCH_TEXT::GetBoundingBox() const { EDA_RECT rect = GetTextBox(); if( GetTextAngle() != 0 ) // Rotate rect. { wxPoint pos = rect.GetOrigin(); wxPoint end = rect.GetEnd(); RotatePoint( &pos, GetTextPos(), GetTextAngle() ); RotatePoint( &end, GetTextPos(), GetTextAngle() ); rect.SetOrigin( pos ); rect.SetEnd( end ); } rect.Normalize(); return rect; } wxString getElectricalTypeLabel( PINSHEETLABEL_SHAPE aType ) { switch( aType ) { case PINSHEETLABEL_SHAPE::PS_INPUT: return _( "Input" ); case PINSHEETLABEL_SHAPE::PS_OUTPUT: return _( "Output" ); case PINSHEETLABEL_SHAPE::PS_BIDI: return _( "Bidirectional" ); case PINSHEETLABEL_SHAPE::PS_TRISTATE: return _( "Tri-State" ); case PINSHEETLABEL_SHAPE::PS_UNSPECIFIED: return _( "Passive" ); default: return wxT( "???" ); } } void SCH_TEXT::GetContextualTextVars( wxArrayString* aVars ) const { if( Type() == SCH_GLOBAL_LABEL_T || Type() == SCH_HIER_LABEL_T || Type() == SCH_SHEET_PIN_T ) aVars->push_back( wxT( "CONNECTION_TYPE" ) ); if( Type() == SCH_SHEET_PIN_T && m_parent ) static_cast( m_parent )->GetContextualTextVars( aVars ); } wxString SCH_TEXT::GetShownText( int aDepth ) const { std::function textResolver = [&]( wxString* token ) -> bool { if( ( Type() == SCH_GLOBAL_LABEL_T || Type() == SCH_HIER_LABEL_T || Type() == SCH_SHEET_PIN_T ) && token->IsSameAs( wxT( "CONNECTION_TYPE" ) ) ) { *token = getElectricalTypeLabel( GetShape() ); return true; } if( Type() == SCH_SHEET_PIN_T && m_parent ) { SCH_SHEET* sheet = static_cast( m_parent ); if( sheet->ResolveTextVar( token, aDepth ) ) return true; } if( token->Contains( ':' ) ) { if( Schematic()->ResolveCrossReference( token, aDepth ) ) return true; } else { SCHEMATIC* schematic = Schematic(); SCH_SHEET* sheet = schematic ? schematic->CurrentSheet().Last() : nullptr; if( sheet && sheet->ResolveTextVar( token, aDepth + 1 ) ) return true; } return false; }; std::function schematicTextResolver = [&]( wxString* token ) -> bool { return Schematic()->ResolveTextVar( token, aDepth + 1 ); }; wxString text = EDA_TEXT::GetShownText(); if( text == wxT( "~" ) ) // Legacy placeholder for empty string { text = ""; } else if( HasTextVars() ) { wxCHECK_MSG( Schematic(), wxEmptyString, wxT( "No parent SCHEMATIC set for SCH_TEXT!" ) ); PROJECT* project = nullptr; if( Schematic() ) project = &Schematic()->Prj(); if( aDepth < 10 ) text = ExpandTextVars( text, &textResolver, &schematicTextResolver, project ); } return text; } wxString SCH_TEXT::GetSelectMenuText( EDA_UNITS aUnits ) const { return wxString::Format( _( "Graphic Text '%s'" ), ShortenedShownText() ); } BITMAPS SCH_TEXT::GetMenuImage() const { return BITMAPS::text; } bool SCH_TEXT::HitTest( const wxPoint& aPosition, int aAccuracy ) const { EDA_RECT bBox = GetBoundingBox(); bBox.Inflate( aAccuracy ); return bBox.Contains( aPosition ); } bool SCH_TEXT::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const { EDA_RECT bBox = GetBoundingBox(); bBox.Inflate( aAccuracy ); if( aContained ) return aRect.Contains( bBox ); return aRect.Intersects( bBox ); } void SCH_TEXT::Plot( PLOTTER* aPlotter ) const { static std::vector s_poly; RENDER_SETTINGS* settings = aPlotter->RenderSettings(); SCH_CONNECTION* connection = Connection(); int layer = ( connection && connection->IsBus() ) ? LAYER_BUS : m_layer; COLOR4D color = settings->GetLayerColor( layer ); int penWidth = GetEffectiveTextPenWidth( settings->GetDefaultPenWidth() ); penWidth = std::max( penWidth, settings->GetMinPenWidth() ); aPlotter->SetCurrentLineWidth( penWidth ); if( IsMultilineAllowed() ) { std::vector positions; wxArrayString strings_list; wxStringSplit( GetShownText(), strings_list, '\n' ); positions.reserve( strings_list.Count() ); GetLinePositions( positions, (int) strings_list.Count() ); for( unsigned ii = 0; ii < strings_list.Count(); ii++ ) { wxPoint textpos = positions[ii] + GetSchematicTextOffset( aPlotter->RenderSettings() ); wxString& txt = strings_list.Item( ii ); aPlotter->Text( textpos, color, txt, GetTextAngle(), GetTextSize(), GetHorizJustify(), GetVertJustify(), penWidth, IsItalic(), IsBold() ); } } else { wxPoint textpos = GetTextPos() + GetSchematicTextOffset( aPlotter->RenderSettings() ); aPlotter->Text( textpos, color, GetShownText(), GetTextAngle(), GetTextSize(), GetHorizJustify(), GetVertJustify(), penWidth, IsItalic(), IsBold() ); } // Draw graphic symbol for global or hierarchical labels CreateGraphicShape( aPlotter->RenderSettings(), s_poly, GetTextPos() ); if( s_poly.size() ) aPlotter->PlotPoly( s_poly, FILL_T::NO_FILL, penWidth ); } void SCH_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector& aList ) { wxString msg; switch( Type() ) { case SCH_TEXT_T: msg = _( "Graphic Text" ); break; case SCH_LABEL_T: msg = _( "Label" ); break; case SCH_GLOBAL_LABEL_T: msg = _( "Global Label" ); break; case SCH_HIER_LABEL_T: msg = _( "Hierarchical Label" ); break; case SCH_SHEET_PIN_T: msg = _( "Hierarchical Sheet Pin" ); break; default: return; } // Don't use GetShownText() here; we want to show the user the variable references aList.emplace_back( msg, UnescapeString( GetText() ) ); // Display electrical type if it is relevant if( Type() == SCH_GLOBAL_LABEL_T || Type() == SCH_HIER_LABEL_T || Type() == SCH_SHEET_PIN_T ) aList.emplace_back( _( "Type" ), getElectricalTypeLabel( GetShape() ) ); wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) }; int style = 0; if( IsItalic() ) style = 1; if( IsBold() ) style += 2; aList.emplace_back( _( "Style" ), textStyle[style] ); aList.emplace_back( _( "Text Size" ), MessageTextFromValue( aFrame->GetUserUnits(), GetTextWidth() ) ); switch( GetLabelSpinStyle() ) { case LABEL_SPIN_STYLE::LEFT: msg = _( "Align right" ); break; case LABEL_SPIN_STYLE::UP: msg = _( "Align bottom" ); break; case LABEL_SPIN_STYLE::RIGHT: msg = _( "Align left" ); break; case LABEL_SPIN_STYLE::BOTTOM: msg = _( "Align top" ); break; default: msg = wxT( "???" ); break; } aList.emplace_back( _( "Justification" ), msg ); SCH_CONNECTION* conn = nullptr; if( !IsConnectivityDirty() && dynamic_cast( aFrame ) ) conn = Connection(); if( conn ) { conn->AppendInfoToMsgPanel( aList ); if( !conn->IsBus() ) { NET_SETTINGS& netSettings = Schematic()->Prj().GetProjectFile().NetSettings(); const wxString& netname = conn->Name( true ); if( netSettings.m_NetClassAssignments.count( netname ) ) { const wxString& netclassName = netSettings.m_NetClassAssignments[ netname ]; aList.emplace_back( _( "Assigned Netclass" ), netclassName ); } } } } #if defined(DEBUG) void SCH_TEXT::Show( int nestLevel, std::ostream& os ) const { // XML output: wxString s = GetClass(); NestedSpace( nestLevel, os ) << '<' << s.Lower().mb_str() << " layer=\"" << m_layer << '"' << " shape=\"" << static_cast( m_shape ) << '"' << " dangling=\"" << m_isDangling << '"' << '>' << TO_UTF8( GetText() ) << "\n"; } #endif SCH_LABEL::SCH_LABEL( const wxPoint& pos, const wxString& text ) : SCH_TEXT( pos, text, SCH_LABEL_T ) { m_layer = LAYER_LOCLABEL; m_shape = PINSHEETLABEL_SHAPE::PS_INPUT; m_isDangling = true; SetMultilineAllowed( false ); } EDA_ITEM* SCH_LABEL::Clone() const { return new SCH_LABEL( *this ); } bool SCH_LABEL::IsType( const KICAD_T aScanTypes[] ) const { static KICAD_T wireTypes[] = { SCH_LINE_LOCATE_WIRE_T, SCH_PIN_T, EOT }; static KICAD_T busTypes[] = { SCH_LINE_LOCATE_BUS_T, EOT }; if( SCH_ITEM::IsType( aScanTypes ) ) return true; wxCHECK_MSG( Schematic(), false, wxT( "No parent SCHEMATIC set for SCH_LABEL!" ) ); // Ensure m_connected_items for Schematic()->CurrentSheet() exists. // Can be not the case when "this" is living in clipboard if( m_connected_items.find( Schematic()->CurrentSheet() ) == m_connected_items.end() ) return false; const SCH_ITEM_SET& item_set = m_connected_items.at( Schematic()->CurrentSheet() ); for( const KICAD_T* p = aScanTypes; *p != EOT; ++p ) { if( *p == SCH_LABEL_LOCATE_WIRE_T ) { for( SCH_ITEM* connection : item_set ) { if( connection->IsType( wireTypes ) ) return true; } } else if ( *p == SCH_LABEL_LOCATE_BUS_T ) { for( SCH_ITEM* connection : item_set ) { if( connection->IsType( busTypes ) ) return true; } } } return false; } const EDA_RECT SCH_LABEL::GetBoundingBox() const { EDA_RECT rect = GetTextBox(); rect.Offset( 0, -GetTextOffset() ); if( GetTextAngle() != 0.0 ) { // Rotate rect wxPoint pos = rect.GetOrigin(); wxPoint end = rect.GetEnd(); RotatePoint( &pos, GetTextPos(), GetTextAngle() ); RotatePoint( &end, GetTextPos(), GetTextAngle() ); rect.SetOrigin( pos ); rect.SetEnd( end ); rect.Normalize(); } // Labels have a position point that is outside of the TextBox rect.Merge( GetPosition() ); return rect; } void SCH_TEXT::ViewGetLayers( int aLayers[], int& aCount ) const { aCount = 0; if( m_layer != LAYER_NOTES ) aLayers[ aCount++ ] = LAYER_DANGLING; aLayers[ aCount++ ] = m_layer; aLayers[ aCount++ ] = LAYER_SELECTION_SHADOWS; } wxString SCH_LABEL::GetSelectMenuText( EDA_UNITS aUnits ) const { return wxString::Format( _( "Label '%s'" ), ShortenedShownText() ); } BITMAPS SCH_LABEL::GetMenuImage() const { return BITMAPS::add_line_label; } SCH_GLOBALLABEL::SCH_GLOBALLABEL( const wxPoint& pos, const wxString& text ) : SCH_TEXT( pos, text, SCH_GLOBAL_LABEL_T ), m_intersheetRefsField( { 0, 0 }, 0, this ) { m_layer = LAYER_GLOBLABEL; m_shape = PINSHEETLABEL_SHAPE::PS_BIDI; m_isDangling = true; SetMultilineAllowed( false ); SetVertJustify( GR_TEXT_VJUSTIFY_CENTER ); m_intersheetRefsField.SetText( wxT( "${INTERSHEET_REFS}" ) ); m_intersheetRefsField.SetLayer( LAYER_GLOBLABEL ); m_intersheetRefsField.SetVertJustify( GR_TEXT_VJUSTIFY_CENTER ); m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; } SCH_GLOBALLABEL::SCH_GLOBALLABEL( const SCH_GLOBALLABEL& aGlobalLabel ) : SCH_TEXT( aGlobalLabel ), m_intersheetRefsField( { 0, 0 }, 0, this ) { m_intersheetRefsField = aGlobalLabel.m_intersheetRefsField; // Re-parent the fields, which before this had aGlobalLabel as parent m_intersheetRefsField.SetParent( this ); m_fieldsAutoplaced = aGlobalLabel.m_fieldsAutoplaced; } EDA_ITEM* SCH_GLOBALLABEL::Clone() const { return new SCH_GLOBALLABEL( *this ); } void SCH_GLOBALLABEL::SwapData( SCH_ITEM* aItem ) { SCH_TEXT::SwapData( aItem ); SCH_GLOBALLABEL* globalLabel = static_cast( aItem ); // Swap field data wholesale... std::swap( m_intersheetRefsField, globalLabel->m_intersheetRefsField ); // ...and then reset parent pointers. globalLabel->m_intersheetRefsField.SetParent( globalLabel ); m_intersheetRefsField.SetParent( this ); } SEARCH_RESULT SCH_GLOBALLABEL::Visit( INSPECTOR aInspector, void* testData, const KICAD_T aFilterTypes[] ) { KICAD_T stype; for( const KICAD_T* p = aFilterTypes; (stype = *p) != EOT; ++p ) { // If caller wants to inspect my type if( stype == SCH_LOCATE_ANY_T || stype == Type() ) { if( SEARCH_RESULT::QUIT == aInspector( this, nullptr ) ) return SEARCH_RESULT::QUIT; } if( stype == SCH_LOCATE_ANY_T || stype == SCH_FIELD_T ) { if( SEARCH_RESULT::QUIT == aInspector( GetIntersheetRefs(), this ) ) return SEARCH_RESULT::QUIT; } } return SEARCH_RESULT::CONTINUE; } void SCH_GLOBALLABEL::RunOnChildren( const std::function& aFunction ) { aFunction( &m_intersheetRefsField ); } wxPoint SCH_GLOBALLABEL::GetSchematicTextOffset( const RENDER_SETTINGS* aSettings ) const { int horiz = GetLabelBoxExpansion( aSettings ); // Center the text on the center line of "E" instead of "R" to make room for an overbar int vert = GetTextHeight() * 0.0715; switch( m_shape ) { case PINSHEETLABEL_SHAPE::PS_INPUT: case PINSHEETLABEL_SHAPE::PS_BIDI: case PINSHEETLABEL_SHAPE::PS_TRISTATE: horiz += GetTextHeight() * 3 / 4; // Use three-quarters-height as proxy for triangle size break; case PINSHEETLABEL_SHAPE::PS_OUTPUT: case PINSHEETLABEL_SHAPE::PS_UNSPECIFIED: default: break; } switch( GetLabelSpinStyle() ) { default: case LABEL_SPIN_STYLE::LEFT: return wxPoint( -horiz, vert ); case LABEL_SPIN_STYLE::UP: return wxPoint( vert, -horiz ); case LABEL_SPIN_STYLE::RIGHT: return wxPoint( horiz, vert ); case LABEL_SPIN_STYLE::BOTTOM: return wxPoint( vert, horiz ); } } void SCH_GLOBALLABEL::SetLabelSpinStyle( LABEL_SPIN_STYLE aSpinStyle ) { m_spin_style = aSpinStyle; switch( aSpinStyle ) { default: wxASSERT_MSG( 1, wxT( "Bad spin style" ) ); m_spin_style = LABEL_SPIN_STYLE::RIGHT; KI_FALLTHROUGH; case LABEL_SPIN_STYLE::RIGHT: // Horiz Normal Orientation SetTextAngle( TEXT_ANGLE_HORIZ ); SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); break; case LABEL_SPIN_STYLE::UP: // Vert Orientation UP SetTextAngle( TEXT_ANGLE_VERT ); SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); break; case LABEL_SPIN_STYLE::LEFT: // Horiz Orientation SetTextAngle( TEXT_ANGLE_HORIZ ); SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); break; case LABEL_SPIN_STYLE::BOTTOM: // Vert Orientation BOTTOM SetTextAngle( TEXT_ANGLE_VERT ); SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); break; } } void SCH_GLOBALLABEL::Rotate( const wxPoint& aCenter ) { wxPoint pt = GetTextPos(); RotatePoint( &pt, aCenter, 900 ); wxPoint offset = pt - GetTextPos(); Rotate90( false ); SetTextPos( GetTextPos() + offset ); m_intersheetRefsField.SetTextPos( m_intersheetRefsField.GetTextPos() + offset ); } void SCH_GLOBALLABEL::Rotate90( bool aClockwise ) { SCH_TEXT::Rotate90( aClockwise ); if( m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_VERT && m_intersheetRefsField.GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT ) { if( !aClockwise ) m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_HORIZ ); } else if( m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_VERT && m_intersheetRefsField.GetHorizJustify() == GR_TEXT_HJUSTIFY_RIGHT ) { if( !aClockwise ) m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_HORIZ ); } else if( m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_HORIZ && m_intersheetRefsField.GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT ) { if( aClockwise ) m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_VERT ); } else if( m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_HORIZ && m_intersheetRefsField.GetHorizJustify() == GR_TEXT_HJUSTIFY_RIGHT ) { if( aClockwise ) m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_VERT ); } wxPoint pos = m_intersheetRefsField.GetTextPos(); RotatePoint( &pos, GetPosition(), aClockwise ? -900 : 900 ); m_intersheetRefsField.SetTextPos( pos ); } void SCH_GLOBALLABEL::MirrorSpinStyle( bool aLeftRight ) { SCH_TEXT::MirrorSpinStyle( aLeftRight ); if( ( aLeftRight && m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_HORIZ ) || ( !aLeftRight && m_intersheetRefsField.GetTextAngle() == TEXT_ANGLE_VERT ) ) { if( m_intersheetRefsField.GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT ) m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); else m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); } wxPoint pos = m_intersheetRefsField.GetTextPos(); wxPoint delta = GetPosition() - pos; if( aLeftRight ) pos.x = GetPosition().x + delta.x; else pos.y = GetPosition().y + delta.y; m_intersheetRefsField.SetTextPos( pos ); } void SCH_GLOBALLABEL::MirrorHorizontally( int aCenter ) { wxPoint old_pos = GetPosition(); SCH_TEXT::MirrorHorizontally( aCenter ); if( m_intersheetRefsField.GetHorizJustify() == GR_TEXT_HJUSTIFY_LEFT ) m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); else m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); wxPoint pos = m_intersheetRefsField.GetTextPos(); wxPoint delta = old_pos - pos; pos.x = GetPosition().x + delta.x; m_intersheetRefsField.SetPosition( pos ); } void SCH_GLOBALLABEL::MirrorVertically( int aCenter ) { wxPoint old_pos = GetPosition(); SCH_TEXT::MirrorVertically( aCenter ); wxPoint pos = m_intersheetRefsField.GetTextPos(); wxPoint delta = old_pos - pos; pos.y = GetPosition().y + delta.y; m_intersheetRefsField.SetPosition( pos ); } void SCH_GLOBALLABEL::UpdateIntersheetRefProps() { m_intersheetRefsField.SetTextSize( GetTextSize() ); m_intersheetRefsField.SetItalic( IsItalic() ); m_intersheetRefsField.SetBold( IsBold() ); m_intersheetRefsField.SetTextThickness( GetTextThickness() ); if( m_fieldsAutoplaced == FIELDS_AUTOPLACED_AUTO ) AutoplaceFields( nullptr, false ); } void SCH_GLOBALLABEL::AutoplaceFields( SCH_SCREEN* aScreen, bool aManual ) { int margin = GetTextOffset() * 2; int labelLen = GetBoundingBoxBase().GetSizeMax(); int penOffset = GetPenWidth() / 2; // Set both axes to penOffset; we're going to overwrite the text axis below wxPoint offset( -penOffset, -penOffset ); switch( GetLabelSpinStyle() ) { default: case LABEL_SPIN_STYLE::LEFT: m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_HORIZ ); m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); offset.x = - ( labelLen + margin / 2 ); break; case LABEL_SPIN_STYLE::UP: m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_VERT ); m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); offset.y = - ( labelLen + margin / 2 ); break; case LABEL_SPIN_STYLE::RIGHT: m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_HORIZ ); m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); offset.x = labelLen + margin /2 ; break; case LABEL_SPIN_STYLE::BOTTOM: m_intersheetRefsField.SetTextAngle( TEXT_ANGLE_VERT ); m_intersheetRefsField.SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); offset.y = labelLen + margin / 2; break; } m_intersheetRefsField.SetTextPos( GetPosition() + offset ); m_fieldsAutoplaced = FIELDS_AUTOPLACED_AUTO; } bool SCH_GLOBALLABEL::ResolveTextVar( wxString* token, int aDepth ) const { if( token->IsSameAs( wxT( "INTERSHEET_REFS" ) ) && Schematic() ) { SCHEMATIC_SETTINGS& settings = Schematic()->Settings(); wxString ref; auto it = Schematic()->GetPageRefsMap().find( GetText() ); if( it == Schematic()->GetPageRefsMap().end() ) { ref = wxT( "?" ); } else { std::vector pageListCopy; pageListCopy.insert( pageListCopy.end(), it->second.begin(), it->second.end() ); std::sort( pageListCopy.begin(), pageListCopy.end(), []( const wxString& a, const wxString& b ) -> bool { return StrNumCmp( a, b, true ) < 0; } ); if( !settings.m_IntersheetRefsListOwnPage ) { wxString currentPage = Schematic()->CurrentSheet().GetPageNumber(); alg::delete_matching( pageListCopy, currentPage ); } if( ( settings.m_IntersheetRefsFormatShort ) && ( pageListCopy.size() > 2 ) ) { ref.Append( wxString::Format( wxT( "%s..%s" ), pageListCopy.front(), pageListCopy.back() ) ); } else { for( const wxString& pageNo : pageListCopy ) ref.Append( wxString::Format( wxT( "%s," ), pageNo ) ); if( !ref.IsEmpty() && ref.Last() == ',' ) ref.RemoveLast(); } } *token = settings.m_IntersheetRefsPrefix + ref + settings.m_IntersheetRefsSuffix; return true; } return false; } void SCH_GLOBALLABEL::Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) { static std::vector s_poly; SCH_CONNECTION* connection = Connection(); int layer = ( connection && connection->IsBus() ) ? LAYER_BUS : m_layer; wxDC* DC = aSettings->GetPrintDC(); COLOR4D color = aSettings->GetLayerColor( layer ); int penWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() ); wxPoint text_offset = aOffset + GetSchematicTextOffset( aSettings ); EDA_TEXT::Print( aSettings, text_offset, color ); CreateGraphicShape( aSettings, s_poly, GetTextPos() + aOffset ); GRPoly( nullptr, DC, s_poly.size(), &s_poly[0], false, penWidth, color, color ); if( Schematic()->Settings().m_IntersheetRefsShow ) m_intersheetRefsField.Print( aSettings, aOffset ); } void SCH_GLOBALLABEL::Plot( PLOTTER* aPlotter ) const { SCH_TEXT::Plot( aPlotter ); bool show = Schematic()->Settings().m_IntersheetRefsShow; if ( show ) m_intersheetRefsField.Plot( aPlotter ); } void SCH_GLOBALLABEL::CreateGraphicShape( const RENDER_SETTINGS* aRenderSettings, std::vector& aPoints, const wxPoint& Pos ) const { int margin = GetLabelBoxExpansion( aRenderSettings ); int halfSize = ( GetTextHeight() / 2 ) + margin; int linewidth = GetPenWidth(); int symb_len = LenSize( GetShownText(), linewidth ) + 2 * margin; int x = symb_len + linewidth + 3; int y = halfSize + linewidth + 3; aPoints.clear(); // Create outline shape : 6 points aPoints.emplace_back( wxPoint( 0, 0 ) ); aPoints.emplace_back( wxPoint( 0, -y ) ); // Up aPoints.emplace_back( wxPoint( -x, -y ) ); // left aPoints.emplace_back( wxPoint( -x, 0 ) ); // Up left aPoints.emplace_back( wxPoint( -x, y ) ); // left down aPoints.emplace_back( wxPoint( 0, y ) ); // down int x_offset = 0; switch( m_shape ) { case PINSHEETLABEL_SHAPE::PS_INPUT: x_offset = -halfSize; aPoints[0].x += halfSize; break; case PINSHEETLABEL_SHAPE::PS_OUTPUT: aPoints[3].x -= halfSize; break; case PINSHEETLABEL_SHAPE::PS_BIDI: case PINSHEETLABEL_SHAPE::PS_TRISTATE: x_offset = -halfSize; aPoints[0].x += halfSize; aPoints[3].x -= halfSize; break; case PINSHEETLABEL_SHAPE::PS_UNSPECIFIED: default: break; } int angle = 0; switch( GetLabelSpinStyle() ) { default: case LABEL_SPIN_STYLE::LEFT: break; case LABEL_SPIN_STYLE::UP: angle = -900; break; case LABEL_SPIN_STYLE::RIGHT: angle = 1800; break; case LABEL_SPIN_STYLE::BOTTOM: angle = 900; break; } // Rotate outlines and move corners in real position for( wxPoint& aPoint : aPoints ) { aPoint.x += x_offset; if( angle ) RotatePoint( &aPoint, angle ); aPoint += Pos; } aPoints.push_back( aPoints[0] ); // closing } const EDA_RECT SCH_GLOBALLABEL::GetBoundingBoxBase() const { // build the bounding box on the global label only, without taking in account // the intersheets references, just the bounding box of the graphic shape int x = GetTextPos().x; int y = GetTextPos().y; int penWidth = GetEffectiveTextPenWidth(); int margin = GetTextOffset(); int height = ( ( GetTextHeight() * 15 ) / 10 ) + penWidth + margin; int length = LenSize( GetShownText(), penWidth ) + height // add height for triangular shapes - margin; // margin added to height not needed here int dx, dy; switch( GetLabelSpinStyle() ) // respect orientation { default: case LABEL_SPIN_STYLE::LEFT: dx = -length; dy = height; y -= height / 2; break; case LABEL_SPIN_STYLE::UP: dx = height; dy = -length; x -= height / 2; break; case LABEL_SPIN_STYLE::RIGHT: dx = length; dy = height; y -= height / 2; break; case LABEL_SPIN_STYLE::BOTTOM: dx = height; dy = length; x -= height / 2; break; } EDA_RECT box( wxPoint( x, y ), wxSize( dx, dy ) ); box.Normalize(); return box; } const EDA_RECT SCH_GLOBALLABEL::GetBoundingBox() const { // build the bounding box on the global label only, including the intersheets references // full bounding box if they are shown EDA_RECT box( GetBoundingBoxBase() ); // Note: Schematic() can be null in preference preview panel if( Schematic() && Schematic()->Settings().m_IntersheetRefsShow ) { box.Merge( m_intersheetRefsField.GetBoundingBox() ); box.Normalize(); } return box; } wxString SCH_GLOBALLABEL::GetSelectMenuText( EDA_UNITS aUnits ) const { return wxString::Format( _( "Global Label '%s'" ), ShortenedShownText() ); } BITMAPS SCH_GLOBALLABEL::GetMenuImage() const { return BITMAPS::add_glabel; } bool SCH_GLOBALLABEL::HitTest( const wxPoint& aPosition, int aAccuracy ) const { EDA_RECT bbox = GetBoundingBoxBase(); bbox.Inflate( aAccuracy ); if( !bbox.Contains( aPosition ) ) { if( Schematic() && Schematic()->Settings().m_IntersheetRefsShow ) { bbox = m_intersheetRefsField.GetBoundingBox(); bbox.Inflate( aAccuracy ); return bbox.Contains( aPosition ); } return false; } return true; } bool SCH_GLOBALLABEL::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const { EDA_RECT bbox = GetBoundingBoxBase(); if( aContained ) { if( Schematic() && Schematic()->Settings().m_IntersheetRefsShow ) bbox.Merge( m_intersheetRefsField.GetBoundingBox() ); bbox.Inflate( aAccuracy ); return aRect.Contains( bbox ); } bbox.Inflate( aAccuracy ); if( aRect.Intersects( bbox ) ) return true; if( Schematic() && Schematic()->Settings().m_IntersheetRefsShow ) { bbox = m_intersheetRefsField.GetBoundingBox(); bbox.Inflate( aAccuracy ); return aRect.Intersects( bbox ); } return false; } SCH_HIERLABEL::SCH_HIERLABEL( const wxPoint& pos, const wxString& text, KICAD_T aType ) : SCH_TEXT( pos, text, aType ) { m_layer = LAYER_HIERLABEL; m_shape = PINSHEETLABEL_SHAPE::PS_INPUT; m_isDangling = true; SetMultilineAllowed( false ); } EDA_ITEM* SCH_HIERLABEL::Clone() const { return new SCH_HIERLABEL( *this ); } void SCH_HIERLABEL::SetLabelSpinStyle( LABEL_SPIN_STYLE aSpinStyle ) { m_spin_style = aSpinStyle; // Assume "Right" and Left" mean which side of the port symbol the text will be on // If we are left of the symbol, we want to right justify to line up with the symbol switch( aSpinStyle ) { default: wxLogWarning( wxT( "SetLabelSpinStyle bad spin style" ) ); break; case LABEL_SPIN_STYLE::LEFT: // m_spin_style = LABEL_SPIN_STYLE::LEFT; // Handle the error spin style by resetting SetTextAngle( TEXT_ANGLE_HORIZ ); SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); SetVertJustify( GR_TEXT_VJUSTIFY_CENTER ); break; case LABEL_SPIN_STYLE::UP: SetTextAngle( TEXT_ANGLE_VERT ); SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); SetVertJustify( GR_TEXT_VJUSTIFY_CENTER ); break; case LABEL_SPIN_STYLE::RIGHT: SetTextAngle( TEXT_ANGLE_HORIZ ); SetHorizJustify( GR_TEXT_HJUSTIFY_LEFT ); SetVertJustify( GR_TEXT_VJUSTIFY_CENTER ); break; case LABEL_SPIN_STYLE::BOTTOM: SetTextAngle( TEXT_ANGLE_VERT ); SetHorizJustify( GR_TEXT_HJUSTIFY_RIGHT ); SetVertJustify( GR_TEXT_VJUSTIFY_CENTER ); break; } } void SCH_HIERLABEL::Print( const RENDER_SETTINGS* aSettings, const wxPoint& offset ) { wxCHECK_RET( Schematic(), wxT( "No parent SCHEMATIC set for SCH_LABEL!" ) ); static std::vector Poly; wxDC* DC = aSettings->GetPrintDC(); SCH_CONNECTION* conn = Connection(); bool isBus = conn && conn->IsBus(); COLOR4D color = aSettings->GetLayerColor( isBus ? LAYER_BUS : m_layer ); int penWidth = std::max( GetPenWidth(), aSettings->GetDefaultPenWidth() ); wxPoint textOffset = offset + GetSchematicTextOffset( aSettings ); EDA_TEXT::Print( aSettings, textOffset, color ); CreateGraphicShape( aSettings, Poly, GetTextPos() + offset ); GRPoly( nullptr, DC, Poly.size(), &Poly[0], false, penWidth, color, color ); } void SCH_HIERLABEL::CreateGraphicShape( const RENDER_SETTINGS* aSettings, std::vector& aPoints, const wxPoint& aPos ) const { CreateGraphicShape( aSettings, aPoints, aPos, m_shape ); } void SCH_HIERLABEL::CreateGraphicShape( const RENDER_SETTINGS* aSettings, std::vector& aPoints, const wxPoint& aPos, PINSHEETLABEL_SHAPE aShape ) const { int* Template = TemplateShape[static_cast( aShape )][static_cast( m_spin_style )]; int halfSize = GetTextHeight() / 2; int imax = *Template; Template++; aPoints.clear(); for( int ii = 0; ii < imax; ii++ ) { wxPoint corner; corner.x = ( halfSize * (*Template) ) + aPos.x; Template++; corner.y = ( halfSize * (*Template) ) + aPos.y; Template++; aPoints.push_back( corner ); } } const EDA_RECT SCH_HIERLABEL::GetBoundingBox() const { int penWidth = GetEffectiveTextPenWidth(); int margin = GetTextOffset(); int x = GetTextPos().x; int y = GetTextPos().y; int height = GetTextHeight() + penWidth + margin; int length = LenSize( GetShownText(), penWidth ) + height; // add height for triangular shapes int dx, dy; switch( GetLabelSpinStyle() ) { default: case LABEL_SPIN_STYLE::LEFT: dx = -length; dy = height; x += Mils2iu( DANGLING_SYMBOL_SIZE ); y -= height / 2; break; case LABEL_SPIN_STYLE::UP: dx = height; dy = -length; x -= height / 2; y += Mils2iu( DANGLING_SYMBOL_SIZE ); break; case LABEL_SPIN_STYLE::RIGHT: dx = length; dy = height; x -= Mils2iu( DANGLING_SYMBOL_SIZE ); y -= height / 2; break; case LABEL_SPIN_STYLE::BOTTOM: dx = height; dy = length; x -= height / 2; y -= Mils2iu( DANGLING_SYMBOL_SIZE ); break; } EDA_RECT box( wxPoint( x, y ), wxSize( dx, dy ) ); box.Normalize(); return box; } wxPoint SCH_HIERLABEL::GetSchematicTextOffset( const RENDER_SETTINGS* aSettings ) const { wxPoint text_offset; int dist = GetTextOffset( aSettings ); dist += GetTextWidth(); switch( GetLabelSpinStyle() ) { default: case LABEL_SPIN_STYLE::LEFT: text_offset.x = -dist; break; // Orientation horiz normale case LABEL_SPIN_STYLE::UP: text_offset.y = -dist; break; // Orientation vert UP case LABEL_SPIN_STYLE::RIGHT: text_offset.x = dist; break; // Orientation horiz inverse case LABEL_SPIN_STYLE::BOTTOM: text_offset.y = dist; break; // Orientation vert BOTTOM } return text_offset; } wxString SCH_HIERLABEL::GetSelectMenuText( EDA_UNITS aUnits ) const { return wxString::Format( _( "Hierarchical Label '%s'" ), ShortenedShownText() ); } BITMAPS SCH_HIERLABEL::GetMenuImage() const { return BITMAPS::add_hierarchical_label; } HTML_MESSAGE_BOX* SCH_TEXT::ShowSyntaxHelp( wxWindow* aParentWindow ) { wxString msg = #include "sch_text_help_md.h" ; HTML_MESSAGE_BOX* dlg = new HTML_MESSAGE_BOX( nullptr, _( "Syntax Help" ) ); wxSize sz( 320, 320 ); dlg->SetMinSize( dlg->ConvertDialogToPixels( sz ) ); dlg->SetDialogSizeInDU( sz.x, sz.y ); wxString html_txt; ConvertMarkdown2Html( wxGetTranslation( msg ), html_txt ); dlg->AddHTML_Text( html_txt ); dlg->ShowModeless(); return dlg; }