490 lines
15 KiB
C++
490 lines
15 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2022 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
|
|
*/
|
|
|
|
#include <base_units.h>
|
|
#include <pgm_base.h>
|
|
#include <sch_edit_frame.h>
|
|
#include <plotters/plotter.h>
|
|
#include <widgets/msgpanel.h>
|
|
#include <bitmaps.h>
|
|
#include <string_utils.h>
|
|
#include <schematic.h>
|
|
#include <settings/color_settings.h>
|
|
#include <sch_painter.h>
|
|
#include <wx/log.h>
|
|
#include <dialogs/html_message_box.h>
|
|
#include <project/project_file.h>
|
|
#include <project/net_settings.h>
|
|
#include <core/kicad_algo.h>
|
|
#include <trigo.h>
|
|
#include <sch_textbox.h>
|
|
#include <tools/sch_navigate_tool.h>
|
|
|
|
using KIGFX::SCH_RENDER_SETTINGS;
|
|
|
|
|
|
SCH_TEXTBOX::SCH_TEXTBOX( int aLineWidth, FILL_T aFillType, const wxString& text ) :
|
|
SCH_SHAPE( SHAPE_T::RECTANGLE, aLineWidth, aFillType, SCH_TEXTBOX_T ),
|
|
EDA_TEXT( schIUScale, text )
|
|
{
|
|
m_layer = LAYER_NOTES;
|
|
|
|
SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
SetVertJustify( GR_TEXT_V_ALIGN_TOP );
|
|
SetMultilineAllowed( true );
|
|
|
|
m_excludeFromSim = false;
|
|
}
|
|
|
|
|
|
SCH_TEXTBOX::SCH_TEXTBOX( const SCH_TEXTBOX& aText ) :
|
|
SCH_SHAPE( aText ),
|
|
EDA_TEXT( aText )
|
|
{
|
|
m_excludeFromSim = aText.m_excludeFromSim;
|
|
}
|
|
|
|
|
|
int SCH_TEXTBOX::GetTextMargin() const
|
|
{
|
|
return KiROUND( GetStroke().GetWidth() / 2.0 ) + KiROUND( GetTextSize().y * 0.75 );
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::MirrorHorizontally( int aCenter )
|
|
{
|
|
// Text is NOT really mirrored; it just has its justification flipped
|
|
if( GetTextAngle() == ANGLE_HORIZONTAL )
|
|
{
|
|
switch( GetHorizJustify() )
|
|
{
|
|
case GR_TEXT_H_ALIGN_LEFT: SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT ); break;
|
|
case GR_TEXT_H_ALIGN_CENTER: break;
|
|
case GR_TEXT_H_ALIGN_RIGHT: SetHorizJustify( GR_TEXT_H_ALIGN_LEFT ); break;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::MirrorVertically( int aCenter )
|
|
{
|
|
// Text is NOT really mirrored; it just has its justification flipped
|
|
if( GetTextAngle() == ANGLE_VERTICAL )
|
|
{
|
|
switch( GetHorizJustify() )
|
|
{
|
|
case GR_TEXT_H_ALIGN_LEFT: SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT ); break;
|
|
case GR_TEXT_H_ALIGN_CENTER: break;
|
|
case GR_TEXT_H_ALIGN_RIGHT: SetHorizJustify( GR_TEXT_H_ALIGN_LEFT ); break;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::Rotate( const VECTOR2I& aCenter )
|
|
{
|
|
SCH_SHAPE::Rotate( aCenter );
|
|
SetTextAngle( GetTextAngle() == ANGLE_VERTICAL ? ANGLE_HORIZONTAL : ANGLE_VERTICAL );
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::Rotate90( bool aClockwise )
|
|
{
|
|
SetTextAngle( GetTextAngle() == ANGLE_VERTICAL ? ANGLE_HORIZONTAL : ANGLE_VERTICAL );
|
|
}
|
|
|
|
|
|
VECTOR2I SCH_TEXTBOX::GetDrawPos() const
|
|
{
|
|
int margin = GetTextMargin();
|
|
BOX2I bbox( m_start, m_end - m_start );
|
|
|
|
bbox.Normalize();
|
|
|
|
VECTOR2I pos( bbox.GetLeft() + margin, bbox.GetBottom() - margin );
|
|
|
|
if( GetTextAngle() == ANGLE_VERTICAL )
|
|
{
|
|
switch( GetHorizJustify() )
|
|
{
|
|
case GR_TEXT_H_ALIGN_LEFT:
|
|
pos.y = bbox.GetBottom() - margin;
|
|
break;
|
|
case GR_TEXT_H_ALIGN_CENTER:
|
|
pos.y = ( bbox.GetTop() + bbox.GetBottom() ) / 2;
|
|
break;
|
|
case GR_TEXT_H_ALIGN_RIGHT:
|
|
pos.y = bbox.GetTop() + margin;
|
|
break;
|
|
}
|
|
|
|
switch( GetVertJustify() )
|
|
{
|
|
case GR_TEXT_V_ALIGN_TOP:
|
|
pos.x = bbox.GetLeft() + margin;
|
|
break;
|
|
case GR_TEXT_V_ALIGN_CENTER:
|
|
pos.x = ( bbox.GetLeft() + bbox.GetRight() ) / 2;
|
|
break;
|
|
case GR_TEXT_V_ALIGN_BOTTOM:
|
|
pos.x = bbox.GetRight() - margin;
|
|
break;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
switch( GetHorizJustify() )
|
|
{
|
|
case GR_TEXT_H_ALIGN_LEFT:
|
|
pos.x = bbox.GetLeft() + margin;
|
|
break;
|
|
case GR_TEXT_H_ALIGN_CENTER:
|
|
pos.x = ( bbox.GetLeft() + bbox.GetRight() ) / 2;
|
|
break;
|
|
case GR_TEXT_H_ALIGN_RIGHT:
|
|
pos.x = bbox.GetRight() - margin;
|
|
break;
|
|
}
|
|
|
|
switch( GetVertJustify() )
|
|
{
|
|
case GR_TEXT_V_ALIGN_TOP:
|
|
pos.y = bbox.GetTop() + margin;
|
|
break;
|
|
case GR_TEXT_V_ALIGN_CENTER:
|
|
pos.y = ( bbox.GetTop() + bbox.GetBottom() ) / 2;
|
|
break;
|
|
case GR_TEXT_V_ALIGN_BOTTOM:
|
|
pos.y = bbox.GetBottom() - margin;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return pos;
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::SwapData( SCH_ITEM* aItem )
|
|
{
|
|
SCH_SHAPE::SwapData( aItem );
|
|
|
|
SCH_TEXTBOX* item = static_cast<SCH_TEXTBOX*>( aItem );
|
|
|
|
std::swap( m_layer, item->m_layer );
|
|
|
|
SwapText( *item );
|
|
SwapAttributes( *item );
|
|
}
|
|
|
|
|
|
bool SCH_TEXTBOX::operator<( const SCH_ITEM& aItem ) const
|
|
{
|
|
if( Type() != aItem.Type() )
|
|
return Type() < aItem.Type();
|
|
|
|
auto other = static_cast<const SCH_TEXTBOX*>( &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;
|
|
|
|
if( GetExcludeFromSim() != other->GetExcludeFromSim() )
|
|
return GetExcludeFromSim() - other->GetExcludeFromSim();
|
|
|
|
return GetText() < other->GetText();
|
|
}
|
|
|
|
|
|
KIFONT::FONT* SCH_TEXTBOX::getDrawFont() const
|
|
{
|
|
KIFONT::FONT* font = EDA_TEXT::GetFont();
|
|
|
|
if( !font )
|
|
font = KIFONT::FONT::GetFont( GetDefaultFont(), IsBold(), IsItalic() );
|
|
|
|
return font;
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset )
|
|
{
|
|
wxDC* DC = aSettings->GetPrintDC();
|
|
int penWidth = GetPenWidth();
|
|
bool blackAndWhiteMode = GetGRForceBlackPenState();
|
|
VECTOR2I pt1 = GetStart();
|
|
VECTOR2I pt2 = GetEnd();
|
|
COLOR4D color = GetStroke().GetColor();
|
|
PLOT_DASH_TYPE lineStyle = GetStroke().GetPlotStyle();
|
|
|
|
if( GetFillMode() == FILL_T::FILLED_WITH_COLOR && !blackAndWhiteMode )
|
|
GRFilledRect( DC, pt1, pt2, 0, GetFillColor(), GetFillColor() );
|
|
|
|
if( penWidth > 0 )
|
|
{
|
|
penWidth = std::max( penWidth, aSettings->GetMinPenWidth() );
|
|
|
|
if( blackAndWhiteMode || color == COLOR4D::UNSPECIFIED )
|
|
color = aSettings->GetLayerColor( m_layer );
|
|
|
|
if( lineStyle == PLOT_DASH_TYPE::DEFAULT )
|
|
lineStyle = PLOT_DASH_TYPE::SOLID;
|
|
|
|
if( lineStyle == PLOT_DASH_TYPE::SOLID )
|
|
{
|
|
GRRect( DC, pt1, pt2, penWidth, color );
|
|
}
|
|
else
|
|
{
|
|
std::vector<SHAPE*> shapes = MakeEffectiveShapes( true );
|
|
|
|
for( SHAPE* shape : shapes )
|
|
{
|
|
STROKE_PARAMS::Stroke( shape, lineStyle, penWidth, aSettings,
|
|
[&]( const VECTOR2I& a, const VECTOR2I& b )
|
|
{
|
|
GRLine( DC, a.x, a.y, b.x, b.y, penWidth, color );
|
|
} );
|
|
}
|
|
|
|
for( SHAPE* shape : shapes )
|
|
delete shape;
|
|
}
|
|
}
|
|
|
|
color = GetTextColor();
|
|
|
|
if( blackAndWhiteMode || color == COLOR4D::UNSPECIFIED )
|
|
color = aSettings->GetLayerColor( m_layer );
|
|
|
|
EDA_TEXT::Print( aSettings, aOffset, color );
|
|
}
|
|
|
|
|
|
wxString SCH_TEXTBOX::GetShownText( const SCH_SHEET_PATH* aPath, bool aAllowExtraText,
|
|
int aDepth ) const
|
|
{
|
|
SCH_SHEET* sheet = nullptr;
|
|
|
|
if( aPath )
|
|
sheet = aPath->Last();
|
|
else if( Schematic() )
|
|
sheet = Schematic()->CurrentSheet().Last();
|
|
|
|
std::function<bool( wxString* )> textResolver =
|
|
[&]( wxString* token ) -> bool
|
|
{
|
|
if( sheet )
|
|
{
|
|
if( sheet->ResolveTextVar( token, aDepth + 1 ) )
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
};
|
|
|
|
wxString text = EDA_TEXT::GetShownText( aAllowExtraText, aDepth );
|
|
|
|
if( HasTextVars() )
|
|
{
|
|
if( aDepth < 10 )
|
|
text = ExpandTextVars( text, &textResolver );
|
|
}
|
|
|
|
KIFONT::FONT* font = GetFont();
|
|
|
|
if( !font )
|
|
font = KIFONT::FONT::GetFont( GetDefaultFont(), IsBold(), IsItalic() );
|
|
|
|
VECTOR2D size = GetEnd() - GetStart();
|
|
int colWidth = GetTextAngle() == ANGLE_HORIZONTAL ? size.x : size.y;
|
|
|
|
colWidth = abs( colWidth ) - GetTextMargin() * 2;
|
|
font->LinebreakText( text, colWidth, GetTextSize(), GetTextThickness(), IsBold(), IsItalic() );
|
|
|
|
return text;
|
|
}
|
|
|
|
|
|
bool SCH_TEXTBOX::HitTest( const VECTOR2I& aPosition, int aAccuracy ) const
|
|
{
|
|
BOX2I rect = GetBoundingBox();
|
|
|
|
rect.Inflate( aAccuracy );
|
|
|
|
return rect.Contains( aPosition );
|
|
}
|
|
|
|
|
|
bool SCH_TEXTBOX::HitTest( const BOX2I& aRect, bool aContained, int aAccuracy ) const
|
|
{
|
|
BOX2I rect = aRect;
|
|
|
|
rect.Inflate( aAccuracy );
|
|
|
|
if( aContained )
|
|
return rect.Contains( GetBoundingBox() );
|
|
|
|
return rect.Intersects( GetBoundingBox() );
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::DoHypertextAction( EDA_DRAW_FRAME* aFrame ) const
|
|
{
|
|
wxCHECK_MSG( IsHypertext(), /* void */,
|
|
"Calling a hypertext menu on a SCH_TEXTBOX with no hyperlink?" );
|
|
|
|
SCH_NAVIGATE_TOOL* navTool = aFrame->GetToolManager()->GetTool<SCH_NAVIGATE_TOOL>();
|
|
navTool->HypertextCommand( m_hyperlink );
|
|
}
|
|
|
|
|
|
wxString SCH_TEXTBOX::GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const
|
|
{
|
|
return wxString::Format( _( "Graphic Text Box" ) );
|
|
}
|
|
|
|
|
|
BITMAPS SCH_TEXTBOX::GetMenuImage() const
|
|
{
|
|
return BITMAPS::add_textbox;
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::Plot( PLOTTER* aPlotter, bool aBackground ) const
|
|
{
|
|
if( aBackground )
|
|
{
|
|
SCH_SHAPE::Plot( aPlotter, aBackground );
|
|
return;
|
|
}
|
|
|
|
RENDER_SETTINGS* settings = aPlotter->RenderSettings();
|
|
int penWidth = GetPenWidth();
|
|
COLOR4D color = GetStroke().GetColor();
|
|
PLOT_DASH_TYPE lineStyle = GetStroke().GetPlotStyle();
|
|
|
|
if( penWidth > 0 )
|
|
{
|
|
penWidth = std::max( penWidth, settings->GetMinPenWidth() );
|
|
|
|
if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED )
|
|
color = settings->GetLayerColor( m_layer );
|
|
|
|
if( lineStyle == PLOT_DASH_TYPE::DEFAULT )
|
|
lineStyle = PLOT_DASH_TYPE::SOLID;
|
|
|
|
aPlotter->SetColor( color );
|
|
aPlotter->SetDash( penWidth, lineStyle );
|
|
aPlotter->Rect( m_start, m_end, FILL_T::NO_FILL, penWidth );
|
|
aPlotter->SetDash( penWidth, PLOT_DASH_TYPE::SOLID );
|
|
}
|
|
|
|
KIFONT::FONT* font = GetFont();
|
|
|
|
if( !font )
|
|
font = KIFONT::FONT::GetFont( settings->GetDefaultFont(), IsBold(), IsItalic() );
|
|
|
|
color = GetTextColor();
|
|
|
|
if( !aPlotter->GetColorMode() || color == COLOR4D::UNSPECIFIED )
|
|
color = settings->GetLayerColor( m_layer );
|
|
|
|
penWidth = GetEffectiveTextPenWidth( settings->GetDefaultPenWidth() );
|
|
penWidth = std::max( penWidth, settings->GetMinPenWidth() );
|
|
aPlotter->SetCurrentLineWidth( penWidth );
|
|
|
|
std::vector<VECTOR2I> positions;
|
|
wxArrayString strings_list;
|
|
wxStringSplit( GetShownText( true ), strings_list, '\n' );
|
|
positions.reserve( strings_list.Count() );
|
|
|
|
GetLinePositions( positions, (int) strings_list.Count() );
|
|
|
|
TEXT_ATTRIBUTES attrs = GetAttributes();
|
|
attrs.m_StrokeWidth = penWidth;
|
|
attrs.m_Multiline = false;
|
|
|
|
for( unsigned ii = 0; ii < strings_list.Count(); ii++ )
|
|
{
|
|
aPlotter->PlotText( positions[ii], color, strings_list.Item( ii ), attrs, font );
|
|
}
|
|
|
|
if( HasHyperlink() )
|
|
aPlotter->HyperlinkBox( GetBoundingBox(), GetHyperlink() );
|
|
}
|
|
|
|
|
|
void SCH_TEXTBOX::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
|
|
{
|
|
// Don't use GetShownText() here; we want to show the user the variable references
|
|
aList.emplace_back( _( "Text Box" ), KIUI::EllipsizeStatusText( aFrame, GetText() ) );
|
|
|
|
if( m_excludeFromSim )
|
|
aList.emplace_back( _( "Exclude from" ), _( "Simulation" ) );
|
|
|
|
aList.emplace_back( _( "Font" ), GetFont() ? GetFont()->GetName() : _( "Default" ) );
|
|
|
|
wxString textStyle[] = { _( "Normal" ), _( "Italic" ), _( "Bold" ), _( "Bold Italic" ) };
|
|
int style = IsBold() && IsItalic() ? 3 : IsBold() ? 2 : IsItalic() ? 1 : 0;
|
|
aList.emplace_back( _( "Style" ), textStyle[style] );
|
|
|
|
aList.emplace_back( _( "Text Size" ), aFrame->MessageTextFromValue( GetTextWidth() ) );
|
|
|
|
aList.emplace_back( _( "Box Width" ),
|
|
aFrame->MessageTextFromValue( std::abs( GetEnd().x - GetStart().x ) ) );
|
|
|
|
aList.emplace_back( _( "Box Height" ),
|
|
aFrame->MessageTextFromValue( std::abs( GetEnd().y - GetStart().y ) ) );
|
|
|
|
m_stroke.GetMsgPanelInfo( aFrame, aList );
|
|
}
|
|
|
|
|
|
static struct SCH_TEXTBOX_DESC
|
|
{
|
|
SCH_TEXTBOX_DESC()
|
|
{
|
|
PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
|
|
REGISTER_TYPE( SCH_TEXTBOX );
|
|
|
|
propMgr.AddTypeCast( new TYPE_CAST<SCH_TEXTBOX, SCH_SHAPE> );
|
|
propMgr.AddTypeCast( new TYPE_CAST<SCH_TEXTBOX, EDA_TEXT> );
|
|
propMgr.InheritsAfter( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( SCH_SHAPE ) );
|
|
propMgr.InheritsAfter( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ) );
|
|
|
|
propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ), _HKI( "Shape" ) );
|
|
propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ), _HKI( "Start X" ) );
|
|
propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ), _HKI( "Start Y" ) );
|
|
propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ), _HKI( "End X" ) );
|
|
propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ), _HKI( "End Y" ) );
|
|
propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_SHAPE ), _HKI( "Line Width" ) );
|
|
|
|
propMgr.Mask( TYPE_HASH( SCH_TEXTBOX ), TYPE_HASH( EDA_TEXT ), _HKI( "Orientation" ) );
|
|
}
|
|
} _SCH_TEXTBOX_DESC;
|