kicad/pcbnew/class_dimension.cpp

536 lines
16 KiB
C++
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2012 Jean-Pierre Charras, jean-pierre.charras@ujf-grenoble.fr
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2012 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2012 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 <fctsys.h>
#include <macros.h>
#include <gr_basic.h>
#include <trigo.h>
#include <kicad_string.h>
#include <richio.h>
#include <bitmaps.h>
2018-01-29 20:58:58 +00:00
#include <pcb_edit_frame.h>
#include <base_units.h>
#include <class_board.h>
#include <class_dimension.h>
#include <class_pcb_text.h>
#include <math/util.h> // for KiROUND
#include <pgm_base.h>
#include <settings/color_settings.h>
#include <settings/settings_manager.h>
2019-12-20 14:11:39 +00:00
DIMENSION::DIMENSION( BOARD_ITEM* aParent )
: BOARD_ITEM( aParent, PCB_DIMENSION_T ),
m_Width( Millimeter2iu( 0.2 ) ),
m_Unit( EDA_UNITS::INCHES ),
m_UseMils( false ),
m_Value( 0 ),
m_Height( 0 ),
m_Text( this )
{
m_Layer = Dwgs_User;
m_Shape = 0;
}
2007-08-08 20:51:08 +00:00
DIMENSION::~DIMENSION()
{
}
2007-08-08 20:51:08 +00:00
void DIMENSION::SetPosition( const wxPoint& aPos )
{
m_Text.SetTextPos( aPos );
}
const wxPoint DIMENSION::GetPosition() const
2012-12-19 19:31:36 +00:00
{
return m_Text.GetTextPos();
2012-12-19 19:31:36 +00:00
}
void DIMENSION::SetText( const wxString& aNewText )
{
2011-12-14 04:29:25 +00:00
m_Text.SetText( aNewText );
}
const wxString DIMENSION::GetText() const
{
2011-12-14 04:29:25 +00:00
return m_Text.GetText();
}
void DIMENSION::SetLayer( PCB_LAYER_ID aLayer )
2009-08-03 07:55:08 +00:00
{
m_Layer = aLayer;
2012-12-19 19:31:36 +00:00
m_Text.SetLayer( aLayer );
}
2011-12-14 04:29:25 +00:00
void DIMENSION::Move( const wxPoint& offset )
{
m_Text.Offset( offset );
2012-12-19 19:31:36 +00:00
m_crossBarO += offset;
m_crossBarF += offset;
m_featureLineGO += offset;
m_featureLineGF += offset;
m_featureLineDO += offset;
m_featureLineDF += offset;
m_arrowG1F += offset;
m_arrowG2F += offset;
m_arrowD1F += offset;
m_arrowD2F += offset;
2008-01-06 12:43:57 +00:00
}
2011-12-14 04:29:25 +00:00
void DIMENSION::Rotate( const wxPoint& aRotCentre, double aAngle )
2008-01-06 12:43:57 +00:00
{
wxPoint tmp = m_Text.GetTextPos();
RotatePoint( &tmp, aRotCentre, aAngle );
m_Text.SetTextPos( tmp );
double newAngle = m_Text.GetTextAngle() + aAngle;
if( newAngle >= 3600 )
newAngle -= 3600;
if( newAngle > 900 && newAngle < 2700 )
newAngle -= 1800;
m_Text.SetTextAngle( newAngle );
2008-04-01 05:21:50 +00:00
2012-12-19 19:31:36 +00:00
RotatePoint( &m_crossBarO, aRotCentre, aAngle );
RotatePoint( &m_crossBarF, aRotCentre, aAngle );
RotatePoint( &m_featureLineGO, aRotCentre, aAngle );
RotatePoint( &m_featureLineGF, aRotCentre, aAngle );
RotatePoint( &m_featureLineDO, aRotCentre, aAngle );
RotatePoint( &m_featureLineDF, aRotCentre, aAngle );
RotatePoint( &m_arrowG1F, aRotCentre, aAngle );
RotatePoint( &m_arrowG2F, aRotCentre, aAngle );
RotatePoint( &m_arrowD1F, aRotCentre, aAngle );
RotatePoint( &m_arrowD2F, aRotCentre, aAngle );
2008-01-06 12:43:57 +00:00
}
void DIMENSION::Flip( const wxPoint& aCentre, bool aFlipLeftRight )
2009-08-01 19:26:05 +00:00
{
Mirror( aCentre );
// DIMENSION items are not usually on copper layers, so
// copper layers count is not taken in accoun in Flip transform
SetLayer( FlipLayer( GetLayer() ) );
2009-08-01 19:26:05 +00:00
}
void DIMENSION::Mirror( const wxPoint& axis_pos, bool aMirrorLeftRight )
2008-01-06 12:43:57 +00:00
{
int axis = aMirrorLeftRight ? axis_pos.x : axis_pos.y;
wxPoint newPos = m_Text.GetTextPos();
#define INVERT( pos ) (pos) = axis - ( (pos) - axis )
if( aMirrorLeftRight )
INVERT( newPos.x );
else
INVERT( newPos.y );
m_Text.SetTextPos( newPos );
// invert angle
m_Text.SetTextAngle( -m_Text.GetTextAngle() );
2008-04-01 05:21:50 +00:00
if( aMirrorLeftRight )
{
INVERT( m_crossBarO.y );
INVERT( m_crossBarF.y );
INVERT( m_featureLineGO.y );
INVERT( m_featureLineGF.y );
INVERT( m_featureLineDO.y );
INVERT( m_featureLineDF.y );
INVERT( m_arrowG1F.y );
INVERT( m_arrowG2F.y );
INVERT( m_arrowD1F.y );
INVERT( m_arrowD2F.y );
}
else
{
INVERT( m_crossBarO.y );
INVERT( m_crossBarF.y );
INVERT( m_featureLineGO.y );
INVERT( m_featureLineGF.y );
INVERT( m_featureLineDO.y );
INVERT( m_featureLineDF.y );
INVERT( m_arrowG1F.y );
INVERT( m_arrowG2F.y );
INVERT( m_arrowD1F.y );
INVERT( m_arrowD2F.y );
}
}
2007-10-30 21:30:58 +00:00
void DIMENSION::SetOrigin( const wxPoint& aOrigin, int aPrecision )
{
m_featureLineGO = aOrigin;
AdjustDimensionDetails( aPrecision );
}
void DIMENSION::SetEnd( const wxPoint& aEnd, int aPrecision )
{
m_featureLineDO = aEnd;
AdjustDimensionDetails( aPrecision );
}
void DIMENSION::SetHeight( int aHeight, int aPrecision )
{
m_Height = aHeight;
AdjustDimensionDetails( aPrecision );
}
void DIMENSION::UpdateHeight()
{
VECTOR2D featureLine( m_crossBarO - m_featureLineGO );
VECTOR2D crossBar( m_featureLineDO - m_featureLineGO );
if( featureLine.Cross( crossBar ) > 0 )
m_Height = -featureLine.EuclideanNorm();
else
m_Height = featureLine.EuclideanNorm();
}
void DIMENSION::AdjustDimensionDetails( int aPrecision )
{
const int arrowz = Mils2iu( 50 ); // size of arrows
int ii;
2012-12-19 19:31:36 +00:00
int measure, deltax, deltay; // value of the measure on X and Y axes
int arrow_up_X = 0, arrow_up_Y = 0; // coordinates of arrow line /
int arrow_dw_X = 0, arrow_dw_Y = 0; // coordinates of arrow line '\'
int hx, hy; // dimension line interval
double angle, angle_f;
2011-12-14 04:29:25 +00:00
// Init layer :
m_Text.SetLayer( GetLayer() );
2011-12-14 04:29:25 +00:00
// calculate the size of the dimension (text + line above the text)
2020-04-14 12:25:00 +00:00
ii = m_Text.GetTextHeight() + m_Text.GetEffectiveTextPenWidth() + m_Width;
2012-12-19 19:31:36 +00:00
deltax = m_featureLineDO.x - m_featureLineGO.x;
deltay = m_featureLineDO.y - m_featureLineGO.y;
// Calculate dimension value
2013-05-04 11:57:09 +00:00
measure = KiROUND( hypot( deltax, deltay ) );
angle = atan2( (double)deltay, (double)deltax );
// Calculation of parameters X and Y dimensions of the arrows and lines.
hx = hy = ii;
// Taking into account the slope of the side lines.
if( measure )
{
2013-05-04 11:57:09 +00:00
hx = abs( KiROUND( ( (double) deltay * hx ) / measure ) );
hy = abs( KiROUND( ( (double) deltax * hy ) / measure ) );
2012-12-19 19:31:36 +00:00
if( m_featureLineGO.x > m_crossBarO.x )
hx = -hx;
2012-12-19 19:31:36 +00:00
if( m_featureLineGO.x == m_crossBarO.x )
hx = 0;
2012-12-19 19:31:36 +00:00
if( m_featureLineGO.y > m_crossBarO.y )
hy = -hy;
2012-12-19 19:31:36 +00:00
if( m_featureLineGO.y == m_crossBarO.y )
hy = 0;
angle_f = angle + DEG2RAD( 27.5 );
arrow_up_X = wxRound( arrowz * cos( angle_f ) );
arrow_up_Y = wxRound( arrowz * sin( angle_f ) );
angle_f = angle - DEG2RAD( 27.5 );
arrow_dw_X = wxRound( arrowz * cos( angle_f ) );
arrow_dw_Y = wxRound( arrowz * sin( angle_f ) );
}
int dx = KiROUND( m_Height * cos( angle + M_PI / 2 ) );
int dy = KiROUND( m_Height * sin( angle + M_PI / 2 ) );
m_crossBarO.x = m_featureLineGO.x + dx;
m_crossBarO.y = m_featureLineGO.y + dy;
m_crossBarF.x = m_featureLineDO.x + dx;
m_crossBarF.y = m_featureLineDO.y + dy;
2012-12-19 19:31:36 +00:00
m_arrowG1F.x = m_crossBarO.x + arrow_up_X;
m_arrowG1F.y = m_crossBarO.y + arrow_up_Y;
2012-12-19 19:31:36 +00:00
m_arrowG2F.x = m_crossBarO.x + arrow_dw_X;
m_arrowG2F.y = m_crossBarO.y + arrow_dw_Y;
/* The right arrow is symmetrical to the left.
* / = -\ and \ = -/
*/
2012-12-19 19:31:36 +00:00
m_arrowD1F.x = m_crossBarF.x - arrow_dw_X;
m_arrowD1F.y = m_crossBarF.y - arrow_dw_Y;
2012-12-19 19:31:36 +00:00
m_arrowD2F.x = m_crossBarF.x - arrow_up_X;
m_arrowD2F.y = m_crossBarF.y - arrow_up_Y;
// Length of feature lines
double radius = ( m_Height +
( std::copysign( 1.0, m_Height ) *
arrowz * sin( DEG2RAD( 27.5 ) ) ) );
m_featureLineGF.x = m_featureLineGO.x - wxRound( radius * sin( angle ) );
m_featureLineGF.y = m_featureLineGO.y + wxRound( radius * cos( angle ) );
m_featureLineDF.x = m_featureLineDO.x - wxRound( radius * sin( angle ) );
m_featureLineDF.y = m_featureLineDO.y + wxRound( radius * cos( angle ) );
2011-12-14 04:29:25 +00:00
// Calculate the better text position and orientation:
radius = ( std::copysign( 1.0, m_Height ) * ii );
wxPoint textPos;
textPos.x = ( m_crossBarF.x + m_crossBarO.x ) / 2;
textPos.y = ( m_crossBarF.y + m_crossBarO.y ) / 2;
textPos.x -= KiROUND( radius * sin( angle ) );
textPos.y += KiROUND( radius * cos( angle ) );
m_Text.SetTextPos( textPos );
double newAngle = -RAD2DECIDEG( angle );
2012-12-19 19:31:36 +00:00
NORMALIZE_ANGLE_POS( newAngle );
if( newAngle > 900 && newAngle < 2700 )
newAngle -= 1800;
m_Text.SetTextAngle( newAngle );
m_Value = measure;
2019-12-20 14:11:39 +00:00
if( m_Unit == EDA_UNITS::MILLIMETRES )
aPrecision += 2;
else if( !m_UseMils )
aPrecision += 3;
wxString text;
wxString format = wxT( "%." ) + wxString::Format( "%i", aPrecision ) + wxT( "f" );
text.Printf( format, To_User_Unit( m_Unit, m_Value, m_UseMils ) );
text += " ";
text += GetAbbreviatedUnitsLabel( m_Unit, m_UseMils );
SetText( text );
}
void DIMENSION::Print( PCB_BASE_FRAME* aFrame, wxDC* DC, const wxPoint& offset )
{
BOARD* brd = GetBoard();
if( brd->IsLayerVisible( m_Layer ) == false )
2007-08-08 20:51:08 +00:00
return;
m_Text.Print( aFrame, DC, offset );
2012-12-19 19:31:36 +00:00
COLOR4D gcolor = Pgm().GetSettingsManager().GetColorSettings()->GetColor( m_Layer );
auto displ_opts = aFrame->GetDisplayOptions();
bool filled = displ_opts.m_DisplayDrawItemsFill;
2020-04-14 12:25:00 +00:00
int width = m_Width;
if( filled )
2007-08-08 20:51:08 +00:00
{
GRLine( nullptr, DC, m_crossBarO + offset, m_crossBarF + offset, width, gcolor );
GRLine( nullptr, DC, m_featureLineGO + offset, m_featureLineGF + offset, width, gcolor );
GRLine( nullptr, DC, m_featureLineDO + offset, m_featureLineDF + offset, width, gcolor );
GRLine( nullptr, DC, m_crossBarF + offset, m_arrowD1F + offset, width, gcolor );
GRLine( nullptr, DC, m_crossBarF + offset, m_arrowD2F + offset, width, gcolor );
GRLine( nullptr, DC, m_crossBarO + offset, m_arrowG1F + offset, width, gcolor );
GRLine( nullptr, DC, m_crossBarO + offset, m_arrowG2F + offset, width, gcolor );
}
else
{
GRCSegm( nullptr, DC, m_crossBarO + offset, m_crossBarF + offset, width, gcolor );
GRCSegm( nullptr, DC, m_featureLineGO + offset, m_featureLineGF + offset, width, gcolor );
GRCSegm( nullptr, DC, m_featureLineDO + offset, m_featureLineDF + offset, width, gcolor );
GRCSegm( nullptr, DC, m_crossBarF + offset, m_arrowD1F + offset, width, gcolor );
GRCSegm( nullptr, DC, m_crossBarF + offset, m_arrowD2F + offset, width, gcolor );
GRCSegm( nullptr, DC, m_crossBarO + offset, m_arrowG1F + offset, width, gcolor );
GRCSegm( nullptr, DC, m_crossBarO + offset, m_arrowG2F + offset, width, gcolor );
2007-08-08 20:51:08 +00:00
}
}
// see class_cotation.h
2019-12-20 14:11:39 +00:00
void DIMENSION::GetMsgPanelInfo( EDA_UNITS aUnits, std::vector<MSG_PANEL_ITEM>& aList )
{
// for now, display only the text within the DIMENSION using class TEXTE_PCB.
m_Text.GetMsgPanelInfo( aUnits, aList );
}
bool DIMENSION::HitTest( const wxPoint& aPosition, int aAccuracy ) const
2007-08-08 20:51:08 +00:00
{
if( m_Text.TextHitTest( aPosition ) )
return true;
2007-08-08 20:51:08 +00:00
int dist_max = aAccuracy + ( m_Width / 2 );
2008-04-01 05:21:50 +00:00
// Locate SEGMENTS
2007-08-08 20:51:08 +00:00
if( TestSegmentHit( aPosition, m_crossBarO, m_crossBarF, dist_max ) )
2007-08-08 20:51:08 +00:00
return true;
if( TestSegmentHit( aPosition, m_featureLineGO, m_featureLineGF, dist_max ) )
2007-08-08 20:51:08 +00:00
return true;
if( TestSegmentHit( aPosition, m_featureLineDO, m_featureLineDF, dist_max ) )
2007-08-08 20:51:08 +00:00
return true;
if( TestSegmentHit( aPosition, m_crossBarF, m_arrowD1F, dist_max ) )
2007-08-08 20:51:08 +00:00
return true;
if( TestSegmentHit( aPosition, m_crossBarF, m_arrowD2F, dist_max ) )
2007-08-08 20:51:08 +00:00
return true;
if( TestSegmentHit( aPosition, m_crossBarO, m_arrowG1F, dist_max ) )
2007-08-08 20:51:08 +00:00
return true;
if( TestSegmentHit( aPosition, m_crossBarO, m_arrowG2F, dist_max ) )
2007-08-08 20:51:08 +00:00
return true;
return false;
}
bool DIMENSION::HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy ) const
2008-01-06 12:43:57 +00:00
{
EDA_RECT arect = aRect;
arect.Inflate( aAccuracy );
EDA_RECT rect = GetBoundingBox();
if( aAccuracy )
rect.Inflate( aAccuracy );
if( aContained )
return arect.Contains( rect );
return arect.Intersects( rect );
2008-01-06 12:43:57 +00:00
}
const EDA_RECT DIMENSION::GetBoundingBox() const
{
2012-12-19 19:31:36 +00:00
EDA_RECT bBox;
int xmin, xmax, ymin, ymax;
2020-04-14 12:25:00 +00:00
bBox = m_Text.GetTextBox();
2012-12-19 19:31:36 +00:00
xmin = bBox.GetX();
xmax = bBox.GetRight();
ymin = bBox.GetY();
ymax = bBox.GetBottom();
xmin = std::min( xmin, m_crossBarO.x );
xmin = std::min( xmin, m_crossBarF.x );
ymin = std::min( ymin, m_crossBarO.y );
ymin = std::min( ymin, m_crossBarF.y );
xmax = std::max( xmax, m_crossBarO.x );
xmax = std::max( xmax, m_crossBarF.x );
ymax = std::max( ymax, m_crossBarO.y );
ymax = std::max( ymax, m_crossBarF.y );
xmin = std::min( xmin, m_featureLineGO.x );
xmin = std::min( xmin, m_featureLineGF.x );
ymin = std::min( ymin, m_featureLineGO.y );
ymin = std::min( ymin, m_featureLineGF.y );
xmax = std::max( xmax, m_featureLineGO.x );
xmax = std::max( xmax, m_featureLineGF.x );
ymax = std::max( ymax, m_featureLineGO.y );
ymax = std::max( ymax, m_featureLineGF.y );
2013-09-16 12:44:03 +00:00
xmin = std::min( xmin, m_featureLineDO.x );
xmin = std::min( xmin, m_featureLineDF.x );
ymin = std::min( ymin, m_featureLineDO.y );
ymin = std::min( ymin, m_featureLineDF.y );
xmax = std::max( xmax, m_featureLineDO.x );
xmax = std::max( xmax, m_featureLineDF.x );
ymax = std::max( ymax, m_featureLineDO.y );
ymax = std::max( ymax, m_featureLineDF.y );
bBox.SetX( xmin );
bBox.SetY( ymin );
bBox.SetWidth( xmax - xmin + 1 );
bBox.SetHeight( ymax - ymin + 1 );
bBox.Normalize();
return bBox;
}
2019-12-20 14:11:39 +00:00
wxString DIMENSION::GetSelectMenuText( EDA_UNITS aUnits ) const
{
return wxString::Format( _( "Dimension \"%s\" on %s" ), GetText(), GetLayerName() );
}
BITMAP_DEF DIMENSION::GetMenuImage() const
{
return add_dimension_xpm;
}
2013-09-16 12:44:03 +00:00
const BOX2I DIMENSION::ViewBBox() const
{
BOX2I dimBBox = BOX2I( VECTOR2I( GetBoundingBox().GetPosition() ),
VECTOR2I( GetBoundingBox().GetSize() ) );
dimBBox.Merge( m_Text.ViewBBox() );
return dimBBox;
}
EDA_ITEM* DIMENSION::Clone() const
{
return new DIMENSION( *this );
}
void DIMENSION::SwapData( BOARD_ITEM* aImage )
{
assert( aImage->Type() == PCB_DIMENSION_T );
std::swap( *((DIMENSION*) this), *((DIMENSION*) aImage) );
}