2012-06-08 09:56:42 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
2018-12-19 14:07:07 +00:00
|
|
|
* Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
|
2012-06-08 09:56:42 +00:00
|
|
|
* Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
|
2018-12-19 14:07:07 +00:00
|
|
|
* Copyright (C) 1992-2018 KiCad Developers, see AUTHORS.txt for contributors.
|
2012-06-08 09:56:42 +00:00
|
|
|
*
|
|
|
|
* 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
|
|
|
|
*/
|
2007-10-26 06:08:19 +00:00
|
|
|
|
2012-01-23 04:33:36 +00:00
|
|
|
#include <fctsys.h>
|
|
|
|
#include <gr_basic.h>
|
|
|
|
#include <trigo.h>
|
2013-01-12 17:32:24 +00:00
|
|
|
#include <msgpanel.h>
|
2017-02-20 12:20:39 +00:00
|
|
|
#include <bitmaps.h>
|
2018-01-31 09:08:57 +00:00
|
|
|
#include <base_units.h>
|
2020-02-28 00:05:40 +00:00
|
|
|
#include <class_board.h>
|
|
|
|
#include <class_board_item.h>
|
2012-01-23 04:33:36 +00:00
|
|
|
#include <class_marker_pcb.h>
|
2012-02-09 20:33:38 +00:00
|
|
|
#include <layers_id_colors_and_visibility.h>
|
2020-02-28 00:05:40 +00:00
|
|
|
#include <settings/color_settings.h>
|
|
|
|
#include <settings/settings_manager.h>
|
|
|
|
#include <widgets/ui_common.h>
|
|
|
|
#include <pgm_base.h>
|
2020-03-16 11:05:01 +00:00
|
|
|
#include <drc/drc_item.h>
|
2007-10-26 06:08:19 +00:00
|
|
|
|
2011-09-23 13:57:12 +00:00
|
|
|
|
2018-12-19 14:07:07 +00:00
|
|
|
/// Factor to convert the maker unit shape to internal units:
|
|
|
|
#define SCALING_FACTOR Millimeter2iu( 0.1 )
|
2007-10-26 06:08:19 +00:00
|
|
|
|
2020-02-28 00:05:40 +00:00
|
|
|
|
2020-04-24 13:36:10 +00:00
|
|
|
MARKER_PCB::MARKER_PCB( DRC_ITEM* aItem, const wxPoint& aPosition ) :
|
2020-02-28 00:05:40 +00:00
|
|
|
BOARD_ITEM( nullptr, PCB_MARKER_T ), // parent set during BOARD::Add()
|
2020-04-24 13:36:10 +00:00
|
|
|
MARKER_BASE( SCALING_FACTOR, aItem )
|
2020-02-28 00:05:40 +00:00
|
|
|
{
|
2020-04-24 13:36:10 +00:00
|
|
|
if( m_rcItem )
|
|
|
|
m_rcItem->SetParent( this );
|
2020-04-24 22:12:06 +00:00
|
|
|
|
|
|
|
m_Pos = aPosition;
|
2008-01-12 20:31:56 +00:00
|
|
|
}
|
|
|
|
|
2007-10-26 06:08:19 +00:00
|
|
|
|
2009-08-01 19:26:05 +00:00
|
|
|
/* destructor */
|
|
|
|
MARKER_PCB::~MARKER_PCB()
|
2007-10-26 06:08:19 +00:00
|
|
|
{
|
2008-01-12 20:31:56 +00:00
|
|
|
}
|
|
|
|
|
2020-02-28 00:05:40 +00:00
|
|
|
|
|
|
|
wxString MARKER_PCB::Serialize() const
|
|
|
|
{
|
2020-04-24 13:36:10 +00:00
|
|
|
return wxString::Format( wxT( "%d|%d|%d|%s|%s" ),
|
2020-03-16 11:05:01 +00:00
|
|
|
m_rcItem->GetErrorCode(),
|
2020-02-28 00:05:40 +00:00
|
|
|
m_Pos.x,
|
|
|
|
m_Pos.y,
|
2020-03-16 11:05:01 +00:00
|
|
|
m_rcItem->GetMainItemID().AsString(),
|
|
|
|
m_rcItem->GetAuxItemID().AsString() );
|
2020-02-28 00:05:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
MARKER_PCB* MARKER_PCB::Deserialize( const wxString& data )
|
|
|
|
{
|
|
|
|
wxArrayString props = wxSplit( data, '|' );
|
|
|
|
int errorCode = (int) strtol( props[0].c_str(), nullptr, 10 );
|
2020-04-24 13:36:10 +00:00
|
|
|
wxPoint markerPos( (int) strtol( props[1].c_str(), nullptr, 10 ),
|
|
|
|
(int) strtol( props[2].c_str(), nullptr, 10 ) );
|
|
|
|
|
|
|
|
DRC_ITEM* drcItem = new DRC_ITEM( errorCode );
|
|
|
|
drcItem->SetItems( KIID( props[3] ), KIID( props[4] ) );
|
2020-02-28 00:05:40 +00:00
|
|
|
|
2020-04-24 13:36:10 +00:00
|
|
|
return new MARKER_PCB( drcItem, markerPos );
|
2020-02-28 00:05:40 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
2012-02-09 20:33:38 +00:00
|
|
|
/* tests to see if this object is on the given layer.
|
|
|
|
* DRC markers are not really on a copper layer, but
|
|
|
|
* MARKER_PCB::IsOnCopperLayer return true if aLayer is a cooper layer,
|
|
|
|
* because this test is often used to locad a marker
|
|
|
|
* param aLayer The layer to test for.
|
|
|
|
* return bool - true if on given layer, else false.
|
|
|
|
*/
|
2017-03-13 03:19:33 +00:00
|
|
|
bool MARKER_PCB::IsOnLayer( PCB_LAYER_ID aLayer ) const
|
2012-02-09 20:33:38 +00:00
|
|
|
{
|
2013-04-09 16:00:46 +00:00
|
|
|
return IsCopperLayer( aLayer );
|
2012-02-09 20:33:38 +00:00
|
|
|
}
|
2007-10-26 06:08:19 +00:00
|
|
|
|
2020-02-28 00:05:40 +00:00
|
|
|
|
2020-04-24 13:36:10 +00:00
|
|
|
void MARKER_PCB::GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
|
2007-10-26 06:08:19 +00:00
|
|
|
{
|
2020-03-16 11:05:01 +00:00
|
|
|
aList.emplace_back( _( "Type" ), _( "Marker" ), DARKCYAN );
|
2020-04-24 18:56:44 +00:00
|
|
|
aList.emplace_back( _( "Violation" ), m_rcItem->GetErrorMessage(), RED );
|
2020-04-24 13:36:10 +00:00
|
|
|
|
|
|
|
wxString mainText;
|
|
|
|
wxString auxText;
|
|
|
|
EDA_ITEM* mainItem = nullptr;
|
|
|
|
EDA_ITEM* auxItem = nullptr;
|
|
|
|
|
|
|
|
if( m_rcItem->GetMainItemID() != niluuid )
|
|
|
|
mainItem = aFrame->GetItem( m_rcItem->GetMainItemID() );
|
|
|
|
|
|
|
|
if( m_rcItem->GetAuxItemID() != niluuid )
|
|
|
|
auxItem = aFrame->GetItem( m_rcItem->GetAuxItemID() );
|
|
|
|
|
|
|
|
if( mainItem )
|
|
|
|
mainText = mainItem->GetSelectMenuText( aFrame->GetUserUnits() );
|
|
|
|
|
|
|
|
if( auxItem )
|
|
|
|
auxText = auxItem->GetSelectMenuText( aFrame->GetUserUnits() );
|
|
|
|
|
|
|
|
aList.emplace_back( mainText, auxText, DARKBROWN );
|
2007-10-26 06:08:19 +00:00
|
|
|
}
|
2009-07-13 15:25:41 +00:00
|
|
|
|
2011-09-23 13:57:12 +00:00
|
|
|
|
2011-12-14 04:29:25 +00:00
|
|
|
void MARKER_PCB::Rotate(const wxPoint& aRotCentre, double aAngle)
|
2009-08-01 19:26:05 +00:00
|
|
|
{
|
|
|
|
RotatePoint( &m_Pos, aRotCentre, aAngle );
|
|
|
|
}
|
|
|
|
|
2011-09-23 13:57:12 +00:00
|
|
|
|
2019-07-12 21:02:10 +00:00
|
|
|
void MARKER_PCB::Flip(const wxPoint& aCentre, bool aFlipLeftRight )
|
2009-08-01 19:26:05 +00:00
|
|
|
{
|
2019-07-12 21:02:10 +00:00
|
|
|
if( aFlipLeftRight )
|
|
|
|
m_Pos.x = aCentre.x - ( m_Pos.x - aCentre.x );
|
|
|
|
else
|
|
|
|
m_Pos.y = aCentre.y - ( m_Pos.y - aCentre.y );
|
2009-08-01 19:26:05 +00:00
|
|
|
}
|
|
|
|
|
2011-07-14 15:42:44 +00:00
|
|
|
|
2019-12-20 14:11:39 +00:00
|
|
|
wxString MARKER_PCB::GetSelectMenuText( EDA_UNITS aUnits ) const
|
2011-07-14 15:42:44 +00:00
|
|
|
{
|
2020-04-24 18:56:44 +00:00
|
|
|
// m_rcItem->GetErrorMessage() could be used instead, but is probably too long
|
|
|
|
// for menu duty.
|
|
|
|
return wxString::Format( _( "Marker (%s)" ),
|
|
|
|
m_rcItem->GetErrorText( m_rcItem->GetErrorCode() ) );
|
2011-07-14 15:42:44 +00:00
|
|
|
}
|
2014-03-19 12:42:46 +00:00
|
|
|
|
|
|
|
|
2017-02-20 12:20:39 +00:00
|
|
|
BITMAP_DEF MARKER_PCB::GetMenuImage() const
|
|
|
|
{
|
|
|
|
return drc_xpm;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2014-03-19 12:42:46 +00:00
|
|
|
void MARKER_PCB::ViewGetLayers( int aLayers[], int& aCount ) const
|
|
|
|
{
|
|
|
|
aCount = 1;
|
2020-02-28 00:05:40 +00:00
|
|
|
|
|
|
|
BOARD_ITEM_CONTAINER* ancestor = GetParent();
|
|
|
|
|
|
|
|
while( ancestor->GetParent() )
|
|
|
|
ancestor = ancestor->GetParent();
|
|
|
|
|
|
|
|
BOARD* board = static_cast<BOARD*>( ancestor );
|
|
|
|
|
2020-03-16 11:05:01 +00:00
|
|
|
switch( board->GetDesignSettings().GetSeverity( m_rcItem->GetErrorCode() ) )
|
2020-02-28 00:05:40 +00:00
|
|
|
{
|
|
|
|
default:
|
2020-03-04 09:48:18 +00:00
|
|
|
case SEVERITY::RPT_SEVERITY_ERROR: aLayers[0] = LAYER_DRC_ERROR; break;
|
|
|
|
case SEVERITY::RPT_SEVERITY_WARNING: aLayers[0] = LAYER_DRC_WARNING; break;
|
2020-02-28 00:05:40 +00:00
|
|
|
}
|
2014-03-19 12:42:46 +00:00
|
|
|
}
|
2017-03-03 15:04:58 +00:00
|
|
|
|
2020-02-28 00:05:40 +00:00
|
|
|
|
|
|
|
GAL_LAYER_ID MARKER_PCB::GetColorLayer() const
|
|
|
|
{
|
|
|
|
if( IsExcluded() )
|
|
|
|
return LAYER_AUX_ITEMS;
|
|
|
|
|
|
|
|
BOARD_ITEM_CONTAINER* ancestor = GetParent();
|
|
|
|
|
|
|
|
while( ancestor->GetParent() )
|
|
|
|
ancestor = ancestor->GetParent();
|
|
|
|
|
|
|
|
BOARD* board = static_cast<BOARD*>( ancestor );
|
|
|
|
|
2020-03-16 11:05:01 +00:00
|
|
|
switch( board->GetDesignSettings().GetSeverity( m_rcItem->GetErrorCode() ) )
|
2020-02-28 00:05:40 +00:00
|
|
|
{
|
|
|
|
default:
|
2020-03-04 09:48:18 +00:00
|
|
|
case SEVERITY::RPT_SEVERITY_ERROR: return LAYER_DRC_ERROR;
|
|
|
|
case SEVERITY::RPT_SEVERITY_WARNING: return LAYER_DRC_WARNING;
|
2020-02-28 00:05:40 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
KIGFX::COLOR4D MARKER_PCB::getColor() const
|
|
|
|
{
|
|
|
|
COLOR_SETTINGS* colors = Pgm().GetSettingsManager().GetColorSettings();
|
|
|
|
return colors->GetColor( GetColorLayer() );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2017-03-03 15:04:58 +00:00
|
|
|
const EDA_RECT MARKER_PCB::GetBoundingBox() const
|
|
|
|
{
|
2020-03-16 11:05:01 +00:00
|
|
|
EDA_RECT bbox = m_shapeBoundingBox;
|
2018-12-19 14:07:07 +00:00
|
|
|
|
|
|
|
wxPoint pos = m_Pos;
|
|
|
|
pos.x += int( bbox.GetOrigin().x * MarkerScale() );
|
|
|
|
pos.y += int( bbox.GetOrigin().y * MarkerScale() );
|
|
|
|
|
|
|
|
return EDA_RECT( pos, wxSize( int( bbox.GetWidth() * MarkerScale() ),
|
|
|
|
int( bbox.GetHeight() * MarkerScale() ) ) );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
const BOX2I MARKER_PCB::ViewBBox() const
|
|
|
|
{
|
|
|
|
EDA_RECT bbox = GetBoundingBox();
|
|
|
|
return BOX2I( bbox.GetOrigin(), VECTOR2I( bbox.GetWidth(), bbox.GetHeight() ) );
|
2017-03-03 15:04:58 +00:00
|
|
|
}
|
2020-04-14 12:25:00 +00:00
|
|
|
|
|
|
|
|