2012-06-08 09:56:42 +00:00
|
|
|
/*
|
|
|
|
* 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>
|
2020-10-16 15:51:24 +00:00
|
|
|
* Copyright (C) 1992-2020 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
|
|
|
|
*/
|
|
|
|
|
2017-11-29 18:51:01 +00:00
|
|
|
#include <wx/debug.h>
|
2020-10-16 15:51:24 +00:00
|
|
|
#include <i18n_utility.h>
|
2020-11-12 20:19:22 +00:00
|
|
|
#include <board.h>
|
2013-06-10 12:24:01 +00:00
|
|
|
#include <string>
|
2008-05-05 19:52:09 +00:00
|
|
|
|
2020-10-04 14:19:33 +00:00
|
|
|
wxString BOARD_ITEM::ShowShape( PCB_SHAPE_TYPE_T aShape )
|
2008-05-05 19:52:09 +00:00
|
|
|
{
|
|
|
|
switch( aShape )
|
|
|
|
{
|
|
|
|
case S_SEGMENT: return _( "Line" );
|
|
|
|
case S_RECT: return _( "Rect" );
|
|
|
|
case S_ARC: return _( "Arc" );
|
|
|
|
case S_CIRCLE: return _( "Circle" );
|
2009-06-25 20:45:27 +00:00
|
|
|
case S_CURVE: return _( "Bezier Curve" );
|
2011-08-01 15:29:27 +00:00
|
|
|
case S_POLYGON: return _( "Polygon" );
|
2008-05-05 19:52:09 +00:00
|
|
|
default: return wxT( "??" );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2009-08-17 02:59:38 +00:00
|
|
|
BOARD* BOARD_ITEM::GetBoard() const
|
|
|
|
{
|
2011-10-01 19:24:27 +00:00
|
|
|
if( Type() == PCB_T )
|
2009-08-17 16:56:02 +00:00
|
|
|
return (BOARD*) this;
|
2009-08-17 02:59:38 +00:00
|
|
|
|
2009-08-17 16:56:02 +00:00
|
|
|
BOARD_ITEM* parent = GetParent();
|
|
|
|
|
|
|
|
if( parent )
|
|
|
|
return parent->GetBoard();
|
|
|
|
|
|
|
|
return NULL;
|
2009-08-17 02:59:38 +00:00
|
|
|
}
|
|
|
|
|
2011-07-14 15:42:44 +00:00
|
|
|
|
|
|
|
wxString BOARD_ITEM::GetLayerName() const
|
|
|
|
{
|
2012-11-10 06:39:18 +00:00
|
|
|
BOARD* board = GetBoard();
|
2011-07-14 15:42:44 +00:00
|
|
|
|
2012-11-10 06:39:18 +00:00
|
|
|
if( board )
|
2013-03-20 04:46:32 +00:00
|
|
|
return board->GetLayerName( m_Layer );
|
2011-07-14 15:42:44 +00:00
|
|
|
|
2013-03-20 04:46:32 +00:00
|
|
|
// If no parent, return standard name
|
|
|
|
return BOARD::GetStandardLayerName( m_Layer );
|
2011-07-14 15:42:44 +00:00
|
|
|
}
|
2012-04-01 20:51:56 +00:00
|
|
|
|
|
|
|
|
2020-09-19 16:12:00 +00:00
|
|
|
wxString BOARD_ITEM::LayerMaskDescribe() const
|
2020-05-21 17:42:42 +00:00
|
|
|
{
|
2020-09-19 16:12:00 +00:00
|
|
|
BOARD* board = GetBoard();
|
|
|
|
LSET layers = GetLayerSet();
|
|
|
|
|
2020-05-21 17:42:42 +00:00
|
|
|
// Try to be smart and useful. Check all copper first.
|
2020-09-19 16:12:00 +00:00
|
|
|
if( layers[F_Cu] && layers[B_Cu] )
|
|
|
|
return _( "all copper layers" );
|
2020-05-21 17:42:42 +00:00
|
|
|
|
2020-09-19 16:12:00 +00:00
|
|
|
LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
|
|
|
|
LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
|
2020-05-21 17:42:42 +00:00
|
|
|
|
2020-09-19 16:12:00 +00:00
|
|
|
for( LSET testLayers : { copperLayers, techLayers, layers } )
|
2020-05-21 17:42:42 +00:00
|
|
|
{
|
|
|
|
for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
|
|
|
|
{
|
2020-09-19 16:12:00 +00:00
|
|
|
if( testLayers[ bit ] )
|
2020-05-21 17:42:42 +00:00
|
|
|
{
|
2020-09-19 16:12:00 +00:00
|
|
|
wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
|
2020-05-21 17:42:42 +00:00
|
|
|
|
2020-09-19 16:12:00 +00:00
|
|
|
if( testLayers.count() > 1 )
|
2020-10-20 19:05:04 +00:00
|
|
|
layerInfo << wxS( " " ) + _( "and others" );
|
2020-05-21 17:42:42 +00:00
|
|
|
|
|
|
|
return layerInfo;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
// No copper, no technicals: no layer
|
|
|
|
return _( "no layers" );
|
|
|
|
}
|
|
|
|
|
|
|
|
|
Introduction of Graphics Abstraction Layer based rendering for pcbnew.
New classes:
- VIEW - represents view that is seen by user, takes care of layer ordering & visibility and how it is displayed (which location, how much zoomed, etc.)
- VIEW_ITEM - Base class for every item that can be displayed on VIEW (the biggest change is that now it may be necessary to override ViewBBox & ViewGetLayers method for derived classes).
- EDA_DRAW_PANEL_GAL - Inherits after EDA_DRAW_PANEL, displays VIEW output, right now it is not editable (in opposite to usual EDA_DRAW_PANEL).
- GAL/OPENGL_GAL/CAIRO_GAL - Base Graphics Abstraction Layer class + two different flavours (Cairo is not fully supported yet), that offers methods to draw primitives using different libraries.
- WX_VIEW_CONTROLS - Controller for VIEW, handles user events, allows zooming, panning, etc.
- PAINTER/PCB_PAINTER - Classes that uses GAL interface to draw items (as you may have already guessed - PCB_PAINTER is a class for drawing PCB specific object, PAINTER is an abstract class). Its methods are invoked by VIEW, when an item has to be drawn. To display a new type of item - you need to implement draw(ITEM_TYPE*) method that draws it using GAL methods.
- STROKE_FONT - Implements stroke font drawing using GAL methods.
Most important changes to Kicad original code:
* EDA_ITEM now inherits from VIEW_ITEM, which is a base class for all drawable objects.
* EDA_DRAW_FRAME contains both usual EDA_DRAW_PANEL and new EDA_DRAW_PANEL_GAL, that can be switched anytime.
* There are some new layers for displaying multilayer pads, vias & pads holes (these are not shown yet on the right sidebar in pcbnew)
* Display order of layers is different than in previous versions (if you are curious - you may check m_galLayerOrder@pcbnew/basepcbframe.cpp). Preserving usual order would result in not very natural display, such as showing silkscreen texts on the bottom.
* Introduced new hotkey (Alt+F12) and new menu option (View->Switch canvas) for switching canvas during runtime.
* Some of classes (mostly derived from BOARD_ITEM) now includes ViewBBox & ViewGetLayers methods.
* Removed tools/class_painter.h, as now it is extended and included in source code.
Build changes:
* GAL-based rendering option is turned on by a new compilation CMake option KICAD_GAL.
* When compiling with CMake option KICAD_GAL=ON, GLEW and Cairo libraries are required.
* GAL-related code is compiled into a static library (common/libgal).
* Build with KICAD_GAL=OFF should not need any new libraries and should come out as a standard version of Kicad
Currently most of items in pcbnew can be displayed using OpenGL (to be done are DIMENSIONS and MARKERS).
More details about GAL can be found in: http://www.ohwr.org/attachments/1884/view-spec.pdf
2013-04-02 06:54:03 +00:00
|
|
|
void BOARD_ITEM::ViewGetLayers( int aLayers[], int& aCount ) const
|
|
|
|
{
|
|
|
|
// Basic fallback
|
|
|
|
aCount = 1;
|
|
|
|
aLayers[0] = m_Layer;
|
|
|
|
}
|
2015-02-12 03:22:24 +00:00
|
|
|
|
|
|
|
|
2016-12-10 15:20:21 +00:00
|
|
|
void BOARD_ITEM::DeleteStructure()
|
|
|
|
{
|
2016-12-13 16:24:19 +00:00
|
|
|
auto parent = GetParent();
|
2016-12-10 15:20:21 +00:00
|
|
|
|
2019-06-11 14:47:54 +00:00
|
|
|
if( parent )
|
2016-12-13 16:24:19 +00:00
|
|
|
parent->Remove( this );
|
2016-12-10 15:20:21 +00:00
|
|
|
|
|
|
|
delete this;
|
|
|
|
}
|
2017-10-31 13:59:03 +00:00
|
|
|
|
|
|
|
|
|
|
|
void BOARD_ITEM::SwapData( BOARD_ITEM* aImage )
|
|
|
|
{
|
|
|
|
}
|
2017-11-29 18:51:01 +00:00
|
|
|
|
2020-02-02 18:40:14 +00:00
|
|
|
|
2020-07-19 21:22:49 +00:00
|
|
|
void BOARD_ITEM::TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
|
2020-10-13 10:55:24 +00:00
|
|
|
PCB_LAYER_ID aLayer, int aClearanceValue,
|
|
|
|
int aError, ERROR_LOC aErrorLoc,
|
2020-07-19 21:22:49 +00:00
|
|
|
bool ignoreLineWidth ) const
|
2018-11-14 23:34:32 +00:00
|
|
|
{
|
|
|
|
wxASSERT_MSG( false, "Called TransformShapeWithClearanceToPolygon() on unsupported BOARD_ITEM." );
|
2017-11-29 18:51:01 +00:00
|
|
|
};
|
2020-02-02 18:40:14 +00:00
|
|
|
|
|
|
|
|
2020-07-24 22:08:36 +00:00
|
|
|
bool BOARD_ITEM::ptr_cmp::operator() ( const BOARD_ITEM* a, const BOARD_ITEM* b ) const
|
|
|
|
{
|
|
|
|
if( a->Type() != b->Type() )
|
|
|
|
return a->Type() < b->Type();
|
|
|
|
|
|
|
|
if( a->GetLayer() != b->GetLayer() )
|
|
|
|
return a->GetLayer() < b->GetLayer();
|
|
|
|
|
2020-10-11 17:02:38 +00:00
|
|
|
if( a->m_Uuid != b->m_Uuid ) // shopuld be always the case foer valid boards
|
|
|
|
return a->m_Uuid < b->m_Uuid;
|
|
|
|
|
|
|
|
return a < b;
|
2020-07-24 22:08:36 +00:00
|
|
|
}
|
|
|
|
|
2020-07-15 16:23:36 +00:00
|
|
|
|
2020-07-22 23:05:22 +00:00
|
|
|
std::shared_ptr<SHAPE> BOARD_ITEM::GetEffectiveShape( PCB_LAYER_ID aLayer ) const
|
2020-07-15 16:23:36 +00:00
|
|
|
{
|
|
|
|
std::shared_ptr<SHAPE> shape;
|
|
|
|
|
2020-08-03 22:09:23 +00:00
|
|
|
int unimplemented_get_effective_shape = 0;
|
|
|
|
assert( unimplemented_get_effective_shape );
|
|
|
|
(void) unimplemented_get_effective_shape;
|
|
|
|
|
2020-07-15 16:23:36 +00:00
|
|
|
return shape;
|
|
|
|
}
|
|
|
|
|
|
|
|
|
2020-02-02 18:40:14 +00:00
|
|
|
static struct BOARD_ITEM_DESC
|
|
|
|
{
|
|
|
|
BOARD_ITEM_DESC()
|
|
|
|
{
|
2020-07-19 21:22:49 +00:00
|
|
|
ENUM_MAP<PCB_LAYER_ID>& layerEnum = ENUM_MAP<PCB_LAYER_ID>::Instance();
|
2020-02-05 15:04:12 +00:00
|
|
|
|
2020-07-06 16:16:55 +00:00
|
|
|
if( layerEnum.Choices().GetCount() == 0 )
|
2020-02-05 15:04:12 +00:00
|
|
|
{
|
2020-07-23 10:35:05 +00:00
|
|
|
layerEnum.Undefined( UNDEFINED_LAYER );
|
2020-07-19 21:22:49 +00:00
|
|
|
|
2020-07-06 16:16:55 +00:00
|
|
|
for( LSEQ seq = LSET::AllLayersMask().Seq(); seq; ++seq )
|
|
|
|
layerEnum.Map( *seq, LSET::Name( *seq ) );
|
2020-02-05 15:04:12 +00:00
|
|
|
}
|
2020-02-02 18:40:14 +00:00
|
|
|
|
|
|
|
PROPERTY_MANAGER& propMgr = PROPERTY_MANAGER::Instance();
|
|
|
|
REGISTER_TYPE( BOARD_ITEM );
|
|
|
|
propMgr.InheritsAfter( TYPE_HASH( BOARD_ITEM ), TYPE_HASH( EDA_ITEM ) );
|
|
|
|
|
2020-10-16 15:51:24 +00:00
|
|
|
propMgr.AddProperty( new PROPERTY<BOARD_ITEM, int>( _HKI( "Position X" ),
|
2020-02-02 18:40:14 +00:00
|
|
|
&BOARD_ITEM::SetX, &BOARD_ITEM::GetX, PROPERTY_DISPLAY::DISTANCE ) );
|
2020-10-16 15:51:24 +00:00
|
|
|
propMgr.AddProperty( new PROPERTY<BOARD_ITEM, int>( _HKI( "Position Y" ),
|
2020-02-02 18:40:14 +00:00
|
|
|
&BOARD_ITEM::SetY, &BOARD_ITEM::GetY, PROPERTY_DISPLAY::DISTANCE ) );
|
2020-10-16 15:51:24 +00:00
|
|
|
propMgr.AddProperty( new PROPERTY_ENUM<BOARD_ITEM, PCB_LAYER_ID>( _HKI( "Layer" ),
|
2020-02-02 18:40:14 +00:00
|
|
|
&BOARD_ITEM::SetLayer, &BOARD_ITEM::GetLayer ) );
|
2020-10-16 15:51:24 +00:00
|
|
|
propMgr.AddProperty( new PROPERTY<BOARD_ITEM, bool>( _HKI( "Locked" ),
|
2020-02-02 18:40:14 +00:00
|
|
|
&BOARD_ITEM::SetLocked, &BOARD_ITEM::IsLocked ) );
|
|
|
|
}
|
|
|
|
} _BOARD_ITEM_DESC;
|
|
|
|
|
|
|
|
IMPLEMENT_ENUM_TO_WXANY( PCB_LAYER_ID )
|