kicad/pcbnew/class_board_item.cpp

282 lines
7.0 KiB
C++
Raw Normal View History

/**
* @file class_board_item.cpp
* @brief Class BOARD_ITEM definition and some basic functions.
*/
2007-09-25 19:39:00 +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>
* Copyright (C) 1992-2016 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 <common.h>
#include <pcbnew.h>
#include <wx/debug.h>
2007-09-25 19:39:00 +00:00
#include <class_board.h>
#include <string>
2011-12-01 22:50:41 +00:00
wxString BOARD_ITEM::ShowShape( STROKE_T aShape )
{
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" );
case S_POLYGON: return _( "Polygon" );
default: return wxT( "??" );
}
}
void BOARD_ITEM::UnLink()
{
DLIST<BOARD_ITEM>* list = (DLIST<BOARD_ITEM>*) GetList();
wxASSERT( list );
if( list )
list->Remove( this );
}
2009-08-17 02:59:38 +00:00
BOARD* BOARD_ITEM::GetBoard() const
{
if( Type() == PCB_T )
return (BOARD*) this;
2009-08-17 02:59:38 +00:00
BOARD_ITEM* parent = GetParent();
if( parent )
return parent->GetBoard();
return NULL;
2009-08-17 02:59:38 +00:00
}
wxString BOARD_ITEM::GetLayerName() const
{
BOARD* board = GetBoard();
if( board )
return board->GetLayerName( m_Layer );
// If no parent, return standard name
return BOARD::GetStandardLayerName( m_Layer );
}
std::string BOARD_ITEM::FormatInternalUnits( int aValue )
{
#if 1
2013-05-30 21:46:14 +00:00
char buf[50];
int len;
2013-05-30 21:46:14 +00:00
double mm = aValue / IU_PER_MM;
if( mm != 0.0 && fabs( mm ) <= 0.0001 )
{
len = sprintf( buf, "%.10f", mm );
while( --len > 0 && buf[len] == '0' )
buf[len] = '\0';
2013-05-30 21:46:14 +00:00
if( buf[len] == '.' )
buf[len] = '\0';
else
++len;
}
else
{
len = sprintf( buf, "%.10g", mm );
}
return std::string( buf, len );
#else
// Assume aValue is in nanometers, and that we want the result in millimeters,
2013-06-13 11:43:29 +00:00
// and that int is 32 bits wide. Then perform an alternative algorithm.
// Can be used to verify that the above algorithm is correctly generating text.
// Convert aValue into an integer string, then insert a decimal point manually.
// Results are the same as above general purpose algorithm.
wxASSERT( sizeof(int) == 4 );
if( aValue == 0 )
return std::string( 1, '0' );
else
{
char buf[50];
2013-06-13 11:43:29 +00:00
int len = sprintf( buf, aValue > 0 ? "%06d" : "%07d", aValue ); // optionally pad w/leading zeros
std::string ret( buf, len );
std::string::iterator it = ret.end() - 1; // last byte
2013-06-13 11:43:29 +00:00
// insert '.' at 6 positions from end, dividing by 10e6 (a million), nm => mm
std::string::iterator decpoint = ret.end() - 6;
// truncate trailing zeros, up to decimal point position
for( ; *it=='0' && it >= decpoint; --it )
ret.erase( it ); // does not invalidate iterators it or decpoint
if( it >= decpoint )
{
ret.insert( decpoint, '.' );
// decpoint is invalidated here, after insert()
2013-06-13 11:43:29 +00:00
#if 1 // want a leading zero when decimal point is in first position?
if( ret[0] == '.' )
{
2013-06-13 11:43:29 +00:00
// insert leading zero ahead of decimal point.
ret.insert( ret.begin(), '0' );
}
else if( ret[0]=='-' && ret[1]=='.' )
{
ret.insert( ret.begin() + 1, '0' );
}
#endif
}
return ret;
}
#endif
}
std::string BOARD_ITEM::FormatAngle( double aAngle )
{
char temp[50];
int len = snprintf( temp, sizeof(temp), "%.10g", aAngle / 10.0 );
return std::string( temp, len );
}
std::string BOARD_ITEM::FormatInternalUnits( const wxPoint& aPoint )
{
return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
}
std::string BOARD_ITEM::FormatInternalUnits( const VECTOR2I& aPoint )
{
return FormatInternalUnits( aPoint.x ) + " " + FormatInternalUnits( aPoint.y );
}
std::string BOARD_ITEM::FormatInternalUnits( const wxSize& aSize )
{
return FormatInternalUnits( aSize.GetWidth() ) + " " + FormatInternalUnits( aSize.GetHeight() );
}
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;
}
int BOARD_ITEM::getTrailingInt( const wxString& aStr )
{
int number = 0;
int base = 1;
// Trim and extract the trailing numeric part
int index = aStr.Len() - 1;
while( index >= 0 )
{
const char chr = aStr.GetChar( index );
if( chr < '0' || chr > '9' )
break;
number += ( chr - '0' ) * base;
base *= 10;
index--;
}
return number;
}
int BOARD_ITEM::getNextNumberInSequence( const std::set<int>& aSeq, bool aFillSequenceGaps)
{
if( aSeq.empty() )
return 1;
// By default go to the end of the sequence
2015-02-21 13:58:39 +00:00
int candidate = *aSeq.rbegin();
// Filling in gaps in pad numbering
if( aFillSequenceGaps )
{
// start at the beginning
candidate = *aSeq.begin();
for( auto it : aSeq )
{
if( it - candidate > 1 )
break;
candidate = it;
}
}
++candidate;
return candidate;
}
void BOARD_ITEM::DeleteStructure()
{
auto parent = GetParent();
if( parent && GetList() )
parent->Remove( this );
delete this;
}
void BOARD_ITEM::SwapData( BOARD_ITEM* aImage )
{
}
void BOARD_ITEM::TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
int aClearanceValue,
int aCircleToSegmentsCount,
double aCorrectionFactor ) const
{
wxASSERT_MSG(false, wxT("Called TransformShapeWithClearanceToPolygon() on unsupported BOARD_ITEM."));
};