423 lines
12 KiB
C++
423 lines
12 KiB
C++
/*
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
*
|
|
* Copyright (C) 2004-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
|
|
*/
|
|
|
|
#include <common.h>
|
|
#include <sch_draw_panel.h>
|
|
#include <plotters/plotter.h>
|
|
#include <trigo.h>
|
|
#include <base_units.h>
|
|
#include <widgets/msgpanel.h>
|
|
#include <bitmaps.h>
|
|
#include <eda_draw_frame.h>
|
|
#include <lib_item.h>
|
|
#include <general.h>
|
|
#include <transform.h>
|
|
#include <settings/color_settings.h>
|
|
#include <lib_text.h>
|
|
#include <default_values.h> // For some default values
|
|
#include <string_utils.h>
|
|
|
|
LIB_TEXT::LIB_TEXT( LIB_SYMBOL* aParent ) :
|
|
LIB_ITEM( LIB_TEXT_T, aParent ),
|
|
EDA_TEXT( wxEmptyString )
|
|
{
|
|
SetTextSize( wxSize( Mils2iu( DEFAULT_TEXT_SIZE ), Mils2iu( DEFAULT_TEXT_SIZE ) ) );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::ViewGetLayers( int aLayers[], int& aCount ) const
|
|
{
|
|
aCount = 2;
|
|
aLayers[0] = LAYER_DEVICE;
|
|
aLayers[1] = LAYER_SELECTION_SHADOWS;
|
|
}
|
|
|
|
|
|
bool LIB_TEXT::HitTest( const wxPoint& aPosition, int aAccuracy ) const
|
|
{
|
|
EDA_TEXT tmp_text( *this );
|
|
tmp_text.SetTextPos( DefaultTransform.TransformCoordinate( GetTextPos() ) );
|
|
|
|
/* The text orientation may need to be flipped if the
|
|
* transformation matrix causes xy axes to be flipped.
|
|
* this simple algo works only for schematic matrix (rot 90 or/and mirror)
|
|
*/
|
|
bool t1 = ( DefaultTransform.x1 != 0 ) ^ ( GetTextAngle() != EDA_ANGLE::HORIZONTAL );
|
|
|
|
tmp_text.SetTextAngle( t1 ? EDA_ANGLE::HORIZONTAL : EDA_ANGLE::VERTICAL );
|
|
return tmp_text.TextHitTest( aPosition, aAccuracy );
|
|
}
|
|
|
|
|
|
EDA_ITEM* LIB_TEXT::Clone() const
|
|
{
|
|
LIB_TEXT* newitem = new LIB_TEXT( nullptr );
|
|
|
|
newitem->m_unit = m_unit;
|
|
newitem->m_convert = m_convert;
|
|
newitem->m_flags = m_flags;
|
|
|
|
newitem->SetText( GetText() );
|
|
newitem->SetAttributes( *this );
|
|
|
|
return newitem;
|
|
}
|
|
|
|
|
|
int LIB_TEXT::compare( const LIB_ITEM& aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags ) const
|
|
{
|
|
wxASSERT( aOther.Type() == LIB_TEXT_T );
|
|
|
|
int retv = LIB_ITEM::compare( aOther, aCompareFlags );
|
|
|
|
if( retv )
|
|
return retv;
|
|
|
|
const LIB_TEXT* tmp = ( LIB_TEXT* ) &aOther;
|
|
|
|
int result = GetText().CmpNoCase( tmp->GetText() );
|
|
|
|
if( result != 0 )
|
|
return result;
|
|
|
|
if( GetTextPos().x != tmp->GetTextPos().x )
|
|
return GetTextPos().x - tmp->GetTextPos().x;
|
|
|
|
if( GetTextPos().y != tmp->GetTextPos().y )
|
|
return GetTextPos().y - tmp->GetTextPos().y;
|
|
|
|
if( GetTextWidth() != tmp->GetTextWidth() )
|
|
return GetTextWidth() - tmp->GetTextWidth();
|
|
|
|
if( GetTextHeight() != tmp->GetTextHeight() )
|
|
return GetTextHeight() - tmp->GetTextHeight();
|
|
|
|
return 0;
|
|
}
|
|
|
|
|
|
void LIB_TEXT::Offset( const wxPoint& aOffset )
|
|
{
|
|
EDA_TEXT::Offset( aOffset );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::MoveTo( const wxPoint& newPosition )
|
|
{
|
|
SetTextPos( newPosition );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::NormalizeJustification( bool inverse )
|
|
{
|
|
wxPoint delta( 0, 0 );
|
|
EDA_RECT bbox = GetTextBox();
|
|
|
|
if( GetTextAngle().IsHorizontal() )
|
|
{
|
|
if( GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT )
|
|
delta.x = bbox.GetWidth() / 2;
|
|
else if( GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT )
|
|
delta.x = - bbox.GetWidth() / 2;
|
|
|
|
if( GetVertJustify() == GR_TEXT_V_ALIGN_TOP )
|
|
delta.y = - bbox.GetHeight() / 2;
|
|
else if( GetVertJustify() == GR_TEXT_V_ALIGN_BOTTOM )
|
|
delta.y = bbox.GetHeight() / 2;
|
|
}
|
|
else
|
|
{
|
|
if( GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT )
|
|
delta.y = bbox.GetWidth() / 2;
|
|
else if( GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT )
|
|
delta.y = - bbox.GetWidth() / 2;
|
|
|
|
if( GetVertJustify() == GR_TEXT_V_ALIGN_TOP )
|
|
delta.x = + bbox.GetHeight() / 2;
|
|
else if( GetVertJustify() == GR_TEXT_V_ALIGN_BOTTOM )
|
|
delta.x = - bbox.GetHeight() / 2;
|
|
}
|
|
|
|
if( inverse )
|
|
SetTextPos( GetTextPos() - delta );
|
|
else
|
|
SetTextPos( GetTextPos() + delta );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::MirrorHorizontal( const wxPoint& center )
|
|
{
|
|
NormalizeJustification( false );
|
|
int x = GetTextPos().x;
|
|
|
|
x -= center.x;
|
|
x *= -1;
|
|
x += center.x;
|
|
|
|
if( GetTextAngle().IsHorizontal() )
|
|
{
|
|
if( GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT )
|
|
SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
|
|
else if( GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT )
|
|
SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
}
|
|
else
|
|
{
|
|
if( GetVertJustify() == GR_TEXT_V_ALIGN_TOP )
|
|
SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
|
|
else if( GetVertJustify() == GR_TEXT_V_ALIGN_BOTTOM )
|
|
SetVertJustify( GR_TEXT_V_ALIGN_TOP );
|
|
}
|
|
|
|
SetTextX( x );
|
|
NormalizeJustification( true );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::MirrorVertical( const wxPoint& center )
|
|
{
|
|
NormalizeJustification( false );
|
|
int y = GetTextPos().y;
|
|
|
|
y -= center.y;
|
|
y *= -1;
|
|
y += center.y;
|
|
|
|
if( GetTextAngle().IsHorizontal() )
|
|
{
|
|
if( GetVertJustify() == GR_TEXT_V_ALIGN_TOP )
|
|
SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
|
|
else if( GetVertJustify() == GR_TEXT_V_ALIGN_BOTTOM )
|
|
SetVertJustify( GR_TEXT_V_ALIGN_TOP );
|
|
}
|
|
else
|
|
{
|
|
if( GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT )
|
|
SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
|
|
else if( GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT )
|
|
SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
}
|
|
|
|
SetTextY( y );
|
|
NormalizeJustification( true );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::Rotate( const wxPoint& center, bool aRotateCCW )
|
|
{
|
|
NormalizeJustification( false );
|
|
int rot_angle = aRotateCCW ? -900 : 900;
|
|
|
|
VECTOR2I pt = GetTextPos();
|
|
RotatePoint( pt, center, rot_angle );
|
|
SetTextPos( pt );
|
|
|
|
if( GetTextAngle().IsHorizontal() )
|
|
{
|
|
SetTextAngle( EDA_ANGLE::VERTICAL );
|
|
}
|
|
else
|
|
{
|
|
// 180º of rotation is a mirror
|
|
|
|
if( GetHorizJustify() == GR_TEXT_H_ALIGN_LEFT )
|
|
SetHorizJustify( GR_TEXT_H_ALIGN_RIGHT );
|
|
else if( GetHorizJustify() == GR_TEXT_H_ALIGN_RIGHT )
|
|
SetHorizJustify( GR_TEXT_H_ALIGN_LEFT );
|
|
|
|
if( GetVertJustify() == GR_TEXT_V_ALIGN_TOP )
|
|
SetVertJustify( GR_TEXT_V_ALIGN_BOTTOM );
|
|
else if( GetVertJustify() == GR_TEXT_V_ALIGN_BOTTOM )
|
|
SetVertJustify( GR_TEXT_V_ALIGN_TOP );
|
|
|
|
SetTextAngle( 0 );
|
|
}
|
|
|
|
NormalizeJustification( true );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::Plot( PLOTTER* plotter, const wxPoint& offset, bool fill,
|
|
const TRANSFORM& aTransform ) const
|
|
{
|
|
wxASSERT( plotter != nullptr );
|
|
|
|
EDA_RECT bBox = GetBoundingBox();
|
|
// convert coordinates from draw Y axis to symbol_editor Y axis
|
|
bBox.RevertYAxis();
|
|
VECTOR2I txtpos = bBox.Centre();
|
|
|
|
// The text orientation may need to be flipped if the transformation matrix causes xy
|
|
// axes to be flipped.
|
|
int t1 = ( aTransform.x1 != 0 ) ^ ( GetTextAngle() != EDA_ANGLE::HORIZONTAL );
|
|
VECTOR2I pos = aTransform.TransformCoordinate( txtpos ) + offset;
|
|
|
|
// Get color
|
|
COLOR4D color;
|
|
|
|
if( plotter->GetColorMode() ) // Used normal color or selected color
|
|
color = plotter->RenderSettings()->GetLayerColor( LAYER_DEVICE );
|
|
else
|
|
color = COLOR4D::BLACK;
|
|
|
|
RENDER_SETTINGS* settings = plotter->RenderSettings();
|
|
|
|
int penWidth = std::max( GetEffectiveTextPenWidth(), settings->GetMinPenWidth() );
|
|
|
|
plotter->Text( pos, color, GetText(), t1 ? EDA_ANGLE::HORIZONTAL : EDA_ANGLE::VERTICAL,
|
|
GetTextSize(), GR_TEXT_H_ALIGN_CENTER, GR_TEXT_V_ALIGN_CENTER, penWidth,
|
|
IsItalic(), IsBold() );
|
|
}
|
|
|
|
|
|
int LIB_TEXT::GetPenWidth() const
|
|
{
|
|
return GetEffectiveTextPenWidth();
|
|
}
|
|
|
|
|
|
void LIB_TEXT::print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset, void* aData,
|
|
const TRANSFORM& aTransform )
|
|
{
|
|
wxDC* DC = aSettings->GetPrintDC();
|
|
COLOR4D color = aSettings->GetLayerColor( LAYER_DEVICE );
|
|
int penWidth = std::max( GetEffectiveTextPenWidth(), aSettings->GetDefaultPenWidth() );
|
|
|
|
// Calculate the text orientation, according to the symbol orientation/mirror (needed when
|
|
// draw text in schematic)
|
|
EDA_ANGLE orient = GetTextAngle();
|
|
|
|
if( aTransform.y1 ) // Rotate symbol 90 degrees.
|
|
{
|
|
if( orient == EDA_ANGLE::HORIZONTAL )
|
|
orient = EDA_ANGLE::VERTICAL;
|
|
else
|
|
orient = EDA_ANGLE::HORIZONTAL;
|
|
}
|
|
|
|
/*
|
|
* Calculate the text justification, according to the symbol orientation/mirror.
|
|
* This is a bit complicated due to cumulative calculations:
|
|
* - numerous cases (mirrored or not, rotation)
|
|
* - the GRText function will also recalculate H and V justifications according to the text
|
|
* orientation.
|
|
* - When a symbol is mirrored, the text is not mirrored and justifications are complicated
|
|
* to calculate so the more easily way is to use no justifications (centered text) and
|
|
* use GetBoundingBox to know the text coordinate considered as centered
|
|
*/
|
|
EDA_RECT bBox = GetBoundingBox();
|
|
|
|
// convert coordinates from draw Y axis to symbol_editor Y axis:
|
|
bBox.RevertYAxis();
|
|
VECTOR2I txtpos = bBox.Centre();
|
|
|
|
// Calculate pos according to mirror/rotation.
|
|
txtpos = aTransform.TransformCoordinate( txtpos ) + aOffset;
|
|
|
|
GRText( DC, txtpos, color, GetShownText(), orient, GetTextSize(), GR_TEXT_H_ALIGN_CENTER,
|
|
GR_TEXT_V_ALIGN_CENTER, penWidth, IsItalic(), IsBold(), GetFont() );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
|
|
{
|
|
wxString msg;
|
|
|
|
LIB_ITEM::GetMsgPanelInfo( aFrame, aList );
|
|
|
|
// Don't use GetShownText() here; we want to show the user the variable references
|
|
aList.emplace_back( _( "Text" ), UnescapeString( GetText() ) );
|
|
|
|
aList.emplace_back( _( "Style" ), GetTextStyleName() );
|
|
|
|
aList.emplace_back( _( "Text Size" ), MessageTextFromValue( aFrame->GetUserUnits(),
|
|
GetTextWidth() ) );
|
|
|
|
switch ( GetHorizJustify() )
|
|
{
|
|
case GR_TEXT_H_ALIGN_LEFT: msg = _( "Left" ); break;
|
|
case GR_TEXT_H_ALIGN_CENTER: msg = _( "Center" ); break;
|
|
case GR_TEXT_H_ALIGN_RIGHT: msg = _( "Right" ); break;
|
|
}
|
|
|
|
aList.emplace_back( _( "H Justification" ), msg );
|
|
|
|
switch ( GetVertJustify() )
|
|
{
|
|
case GR_TEXT_V_ALIGN_TOP: msg = _( "Top" ); break;
|
|
case GR_TEXT_V_ALIGN_CENTER: msg = _( "Center" ); break;
|
|
case GR_TEXT_V_ALIGN_BOTTOM: msg = _( "Bottom" ); break;
|
|
}
|
|
|
|
aList.emplace_back( _( "V Justification" ), msg );
|
|
}
|
|
|
|
|
|
const EDA_RECT LIB_TEXT::GetBoundingBox() const
|
|
{
|
|
/* Y coordinates for LIB_ITEMS are bottom to top, so we must invert the Y position when
|
|
* calling GetTextBox() that works using top to bottom Y axis orientation.
|
|
*/
|
|
EDA_RECT rect = GetTextBox( -1, true );
|
|
rect.RevertYAxis();
|
|
|
|
// We are using now a bottom to top Y axis.
|
|
VECTOR2I orig = rect.GetOrigin();
|
|
VECTOR2I end = rect.GetEnd();
|
|
|
|
RotatePoint( orig, GetTextPos(), -GetTextAngle() );
|
|
RotatePoint( end, GetTextPos(), -GetTextAngle() );
|
|
|
|
rect.SetOrigin( orig );
|
|
rect.SetEnd( end );
|
|
|
|
// We are using now a top to bottom Y axis:
|
|
rect.RevertYAxis();
|
|
|
|
return rect;
|
|
}
|
|
|
|
|
|
wxString LIB_TEXT::GetSelectMenuText( EDA_UNITS aUnits ) const
|
|
{
|
|
return wxString::Format( _( "Graphic Text '%s'" ), ShortenedShownText() );
|
|
}
|
|
|
|
|
|
BITMAPS LIB_TEXT::GetMenuImage() const
|
|
{
|
|
return BITMAPS::text;
|
|
}
|
|
|
|
|
|
void LIB_TEXT::BeginEdit( const wxPoint& aPosition )
|
|
{
|
|
SetTextPos( aPosition );
|
|
}
|
|
|
|
|
|
void LIB_TEXT::CalcEdit( const wxPoint& aPosition )
|
|
{
|
|
SetTextPos( aPosition );
|
|
}
|