kicad/pcbnew/class_pad.h

689 lines
25 KiB
C
Raw Normal View History

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2018 Jean-Pierre Charras, jp.charras at wanadoo.fr
2020-02-20 12:11:04 +00:00
* Copyright (C) 1992-2020 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
*/
2011-09-17 15:31:21 +00:00
/**
* @file class_pad.h
* @brief Pad object description
*/
2012-02-19 04:02:19 +00:00
#ifndef PAD_H_
#define PAD_H_
#include "zones.h"
2018-02-02 20:57:12 +00:00
#include <board_connected_item.h>
#include <class_board_item.h>
#include <convert_to_biu.h>
2018-12-12 14:28:59 +00:00
#include <geometry/shape_poly_set.h>
#include <pad_shapes.h>
#include <pcbnew.h>
2011-09-17 15:31:21 +00:00
class DRAWSEGMENT;
class PARAM_CFG;
class SHAPE;
class SHAPE_SEGMENT;
enum CUST_PAD_SHAPE_IN_ZONE
{
CUST_PAD_SHAPE_IN_ZONE_OUTLINE,
CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL
};
class LINE_READER;
2011-09-17 15:31:21 +00:00
class EDA_3D_CANVAS;
class MODULE;
class EDGE_MODULE;
class TRACK;
2011-09-17 15:31:21 +00:00
namespace KIGFX
{
class VIEW;
2017-11-02 20:41:29 +00:00
}
2011-09-17 15:31:21 +00:00
class D_PAD : public BOARD_CONNECTED_ITEM
{
public:
D_PAD( MODULE* parent );
// Do not create a copy constructor & operator=.
// The ones generated by the compiler are adequate.
/* Default layers used for pads, according to the pad type.
* this is default values only, they can be changed for a given pad
*/
static LSET StandardMask(); ///< layer set for a through hole pad
static LSET SMDMask(); ///< layer set for a SMD pad on Front layer
static LSET ConnSMDMask(); ///< layer set for a SMD pad on Front layer
///< used for edge board connectors
static LSET UnplatedHoleMask(); ///< layer set for a mechanical unplated through hole pad
static LSET ApertureMask(); ///< layer set for an aperture pad
2015-02-18 16:53:46 +00:00
static inline bool ClassOf( const EDA_ITEM* aItem )
{
return aItem && PCB_PAD_T == aItem->Type();
}
bool IsType( const KICAD_T aScanTypes[] ) const override
{
if( BOARD_CONNECTED_ITEM::IsType( aScanTypes ) )
return true;
for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
{
if( m_Drill.x > 0 && m_Drill.y > 0 )
{
if( *p == PCB_LOCATE_HOLE_T )
return true;
else if( *p == PCB_LOCATE_PTH_T && m_Attribute != PAD_ATTRIB_HOLE_NOT_PLATED )
return true;
else if( *p == PCB_LOCATE_NPTH_T && m_Attribute == PAD_ATTRIB_HOLE_NOT_PLATED )
return true;
}
}
return false;
}
2012-02-19 04:02:19 +00:00
MODULE* GetParent() const { return (MODULE*) m_Parent; }
/**
* Imports the pad settings from aMasterPad.
* The result is "this" has the same settinds (sizes, shapes ... )
* as aMasterPad
* @param aMasterPad = the template pad
*/
void ImportSettingsFrom( const D_PAD& aMasterPad );
2016-04-06 18:15:49 +00:00
/**
* @return true if the pad has a footprint parent flipped
* (on the back/bottom layer)
*/
bool IsFlipped() const;
2016-04-06 18:15:49 +00:00
/**
* Set the pad name (sometimes called pad number, although
* it can be an array reference like AA12).
*/
void SetName( const wxString& aName ) { m_name = aName; }
const wxString& GetName() const { return m_name; }
/**
* Set the pad function (pin name in schematic)
*/
void SetPinFunction( const wxString& aName ) { m_pinFunction = aName; }
const wxString& GetPinFunction() const { return m_pinFunction; }
2011-12-16 17:03:25 +00:00
bool PadNameEqual( const D_PAD* other ) const
{
return m_name == other->m_name; // hide tricks behind sensible API
2011-12-16 17:03:25 +00:00
}
/**
* Function GetShape
* @return the shape of this pad.
*/
void SetShape( PAD_SHAPE_T aShape ) { m_padShape = aShape; m_shapesDirty = true; }
PAD_SHAPE_T GetShape() const { return m_padShape; }
2016-09-24 18:53:15 +00:00
void SetPosition( const wxPoint& aPos ) override { m_Pos = aPos; }
const wxPoint GetPosition() const override { return m_Pos; }
2012-02-19 04:02:19 +00:00
/**
* Function GetAnchorPadShape
* @return the shape of the anchor pad shape, for custom shaped pads.
*/
PAD_SHAPE_T GetAnchorPadShape() const { return m_anchorPadShape; }
/**
* @return the option for the custom pad shape to use as clearance area
* in copper zones
*/
CUST_PAD_SHAPE_IN_ZONE GetCustomShapeInZoneOpt() const
{
return m_customShapeClearanceArea;
}
/**
* Set the option for the custom pad shape to use as clearance area
* in copper zones
* @param aOption is the clearance area shape CUST_PAD_SHAPE_IN_ZONE option
*/
void SetCustomShapeInZoneOpt( CUST_PAD_SHAPE_IN_ZONE aOption )
{
m_customShapeClearanceArea = aOption;
}
/**
* Function SetAnchorPadShape
* Set the shape of the anchor pad for custm shped pads.
* @param the shape of the anchor pad shape( currently, only
* PAD_SHAPE_RECT or PAD_SHAPE_CIRCLE.
*/
void SetAnchorPadShape( PAD_SHAPE_T aShape )
{
m_anchorPadShape = ( aShape == PAD_SHAPE_RECT ) ? PAD_SHAPE_RECT : PAD_SHAPE_CIRCLE;
m_shapesDirty = true;
}
/**
* @return true if the pad is on any copper layer, false otherwise.
* pads can be only on tech layers to build special pads.
* they are therefore not always on a copper layer
*/
bool IsOnCopperLayer() const override
{
return ( GetLayerSet() & LSET::AllCuMask() ) != 0;
}
void SetY( int y ) { m_Pos.y = y; m_shapesDirty = true; }
void SetX( int x ) { m_Pos.x = x; m_shapesDirty = true; }
2008-01-28 18:44:14 +00:00
void SetPos0( const wxPoint& aPos ) { m_Pos0 = aPos; }
2011-12-12 08:37:05 +00:00
const wxPoint& GetPos0() const { return m_Pos0; }
2012-02-19 04:02:19 +00:00
void SetY0( int y ) { m_Pos0.y = y; }
void SetX0( int x ) { m_Pos0.x = x; }
void SetSize( const wxSize& aSize ) { m_Size = aSize; m_shapesDirty = true; }
2011-12-12 08:37:05 +00:00
const wxSize& GetSize() const { return m_Size; }
void SetDelta( const wxSize& aSize ) { m_DeltaSize = aSize; m_shapesDirty = true; }
2011-12-12 08:37:05 +00:00
const wxSize& GetDelta() const { return m_DeltaSize; }
void SetDrillSize( const wxSize& aSize ) { m_Drill = aSize; m_shapesDirty = true; }
2011-12-12 08:37:05 +00:00
const wxSize& GetDrillSize() const { return m_Drill; }
void SetOffset( const wxPoint& aOffset ) { m_Offset = aOffset; m_shapesDirty = true; }
2012-02-19 04:02:19 +00:00
const wxPoint& GetOffset() const { return m_Offset; }
/**
* Has meaning only for free shape pads.
* add a free shape to the shape list.
* the shape can be
* a polygon (outline can have a thickness)
* a thick segment
* a filled circle or ring ( if thickness == 0, this is a filled circle, else a ring)
* a arc
* a curve
*/
void AddPrimitivePoly( const SHAPE_POLY_SET& aPoly, int aThickness );
void AddPrimitivePoly( const std::vector<wxPoint>& aPoly, int aThickness );
void AddPrimitiveSegment( const wxPoint& aStart, const wxPoint& aEnd, int aThickness );
void AddPrimitiveCircle( const wxPoint& aCenter, int aRadius, int aThickness );
void AddPrimitiveRect( const wxPoint& aStart, const wxPoint& aEnd, int aThickness );
void AddPrimitiveArc( const wxPoint& aCenter, const wxPoint& aStart, int aArcAngle,
int aThickness );
void AddPrimitiveCurve( const wxPoint& aStart, const wxPoint& aEnd, const wxPoint& aCtrl1,
const wxPoint& aCtrl2, int aThickness );
bool GetBestAnchorPosition( VECTOR2I& aPos );
/**
* Merge all basic shapes to a SHAPE_POLY_SET
* Note: The corners coordinates are relative to the pad position, orientation 0,
*/
void MergePrimitivesAsPolygon( SHAPE_POLY_SET* aMergedPolygon ) const;
/**
* clear the basic shapes list
*/
void DeletePrimitivesList();
/**
* Accessor to the basic shape list
*/
const std::vector<std::shared_ptr<DRAWSEGMENT>>& GetPrimitives() const
{
return m_editPrimitives;
}
void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;
/**
* Flip the basic shapes, in custom pads
*/
void FlipPrimitives();
/**
* Mirror the primitives about a coordinate
*/
void MirrorXPrimitives( int aX );
/**
* Import to the basic shape list
*/
void SetPrimitives( const std::vector<std::shared_ptr<DRAWSEGMENT>>& aPrimitivesList );
/**
* Add to the basic shape list
*/
void AddPrimitives( const std::vector<std::shared_ptr<DRAWSEGMENT>>& aPrimitivesList );
2016-04-06 18:15:49 +00:00
/**
* Function SetOrientation
* sets the rotation angle of the pad.
2012-02-19 04:02:19 +00:00
* @param aAngle is tenths of degrees, but will soon be degrees. If it is
* outside of 0 - 3600, then it will be normalized before being saved.
*/
2012-02-19 04:02:19 +00:00
void SetOrientation( double aAngle );
/**
* Set orientation in degrees
*/
void SetOrientationDegrees( double aOrientation ) { SetOrientation( aOrientation*10.0 ); }
/**
* Function GetOrientation
* returns the rotation angle of the pad in tenths of degrees, but soon degrees.
*/
double GetOrientation() const { return m_Orient; }
double GetOrientationDegrees() const { return m_Orient/10.0; }
double GetOrientationRadians() const { return m_Orient*M_PI/1800; }
void SetDrillShape( PAD_DRILL_SHAPE_T aShape ) { m_drillShape = aShape; m_shapesDirty = true; }
PAD_DRILL_SHAPE_T GetDrillShape() const { return m_drillShape; }
2011-12-12 08:37:05 +00:00
2014-05-17 19:29:15 +00:00
/**
* JEY TODO: temporary until Tom is done with DRC stuff....
2014-05-17 19:29:15 +00:00
*/
void GetOblongGeometry( const wxSize& aDrillOrPadSize,
wxPoint* aStartPoint, wxPoint* aEndPoint, int* aWidth ) const;
2014-05-17 19:29:15 +00:00
void SetLayerSet( LSET aLayerMask ) { m_layerMask = aLayerMask; }
2016-09-24 18:53:15 +00:00
LSET GetLayerSet() const override { return m_layerMask; }
2011-12-12 08:37:05 +00:00
void SetAttribute( PAD_ATTR_T aAttribute );
2012-02-19 04:02:19 +00:00
PAD_ATTR_T GetAttribute() const { return m_Attribute; }
2011-12-12 08:37:05 +00:00
void SetProperty( PAD_PROP_T aProperty );
PAD_PROP_T GetProperty() const { return m_Property; }
// We don't currently have an attribute for APERTURE, and adding one will change the file
// format, so for now just infer a copper-less pad to be an APERTURE pad.
bool IsAperturePad() const { return ( m_layerMask & LSET::AllCuMask() ).none(); }
void SetPadToDieLength( int aLength ) { m_LengthPadToDie = aLength; }
int GetPadToDieLength() const { return m_LengthPadToDie; }
2011-12-12 08:37:05 +00:00
int GetLocalSolderMaskMargin() const { return m_LocalSolderMaskMargin; }
2011-12-12 08:37:05 +00:00
void SetLocalSolderMaskMargin( int aMargin ) { m_LocalSolderMaskMargin = aMargin; }
int GetLocalClearance( wxString* aSource = nullptr ) const override;
2012-02-19 04:02:19 +00:00
void SetLocalClearance( int aClearance ) { m_LocalClearance = aClearance; }
2011-12-12 08:37:05 +00:00
2012-02-19 04:02:19 +00:00
int GetLocalSolderPasteMargin() const { return m_LocalSolderPasteMargin; }
2011-12-12 08:37:05 +00:00
void SetLocalSolderPasteMargin( int aMargin ) { m_LocalSolderPasteMargin = aMargin; }
double GetLocalSolderPasteMarginRatio() const { return m_LocalSolderPasteMarginRatio; }
void SetLocalSolderPasteMarginRatio( double aRatio ) { m_LocalSolderPasteMarginRatio = aRatio; }
2010-11-12 15:17:10 +00:00
/**
* Function TransformShapeWithClearanceToPolygon
* Convert the pad shape to a closed polygon. Circles and arcs are approximated by segments.
* @param aCornerBuffer = a buffer to store the polygon
* @param aClearanceValue = the clearance around the pad
* @param aMaxError = maximum error from true when converting arcs
* @param ignoreLineWidth = used for edge cuts where the line width is only for visualization
*/
void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer, int aClearanceValue,
int aMaxError = ARC_HIGH_DEF,
bool ignoreLineWidth = false ) const override;
/**
* Function TransformHoleWithClearanceToPolygon
* Build the Corner list of the polygonal drill shape in the board coordinate system.
* @param aCornerBuffer = a buffer to fill.
* @param aInflateValue = the clearance or margin value.
* @param aError = maximum deviation of an arc from the polygon approximation
* @return false if the pad has no hole, true otherwise
*/
bool TransformHoleWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer, int aInflateValue,
int aError = ARC_HIGH_DEF ) const;
/**
* Function GetEffectiveShapes
* Returns a list of SHAPE objects representing the pad's copper.
*/
const std::vector<std::shared_ptr<SHAPE>>& GetEffectiveShapes() const;
/**
* Function GetEffectiveHoleShape
* Returns a list of SHAPE objects representing the pad's hole.
*/
const std::shared_ptr<SHAPE_SEGMENT>& GetEffectiveHoleShape() const;
/**
* Function GetBoundingRadius
* returns the radius of a minimum sized circle which fully encloses this pad.
* The center is the pad position NOT THE SHAPE POS!
*/
int GetBoundingRadius() const;
/**
* Function GetLocalClearanceOverrides
* returns any local clearance overrides set in the "classic" (ie: pre-rule) system.
* @param aSource [out] optionally reports the source as a user-readable string
* @return int - the clearance in internal units.
*/
int GetLocalClearanceOverrides( wxString* aSource = nullptr ) const override;
// Mask margins handling:
2010-11-12 15:17:10 +00:00
/**
* Function GetSolderMaskMargin
* @return the margin for the solder mask layer
* usually > 0 (mask shape bigger than pad
* For pads also on copper layers, the value (used to build a default shape) is
* 1 - the local value
* 2 - if 0, the parent footprint value
* 3 - if 0, the global value
* For pads NOT on copper layers, the value is the local value because there is
* not default shape to build
*/
2013-07-26 16:15:11 +00:00
int GetSolderMaskMargin() const;
2010-11-12 15:17:10 +00:00
/**
* Function GetSolderPasteMargin
* @return the margin for the solder mask layer
* usually < 0 (mask shape smaller than pad)
* because the margin can be dependent on the pad size, the margin has a x and a y value
*
* For pads also on copper layers, the value (used to build a default shape) is
* 1 - the local value
* 2 - if 0, the parent footprint value
* 3 - if 0, the global value
*
* For pads NOT on copper layers, the value is the local value because there is
* not default shape to build
*/
wxSize GetSolderPasteMargin() const;
void SetZoneConnection( ZONE_CONNECTION aType ) { m_ZoneConnection = aType; }
ZONE_CONNECTION GetZoneConnection() const { return m_ZoneConnection; }
2019-12-28 00:55:11 +00:00
/**
* Return the zone connection in effect (either locally overridden or overridden in the
* parent module).
*/
ZONE_CONNECTION GetEffectiveZoneConnection() const;
void SetThermalWidth( int aWidth ) { m_ThermalWidth = aWidth; }
int GetThermalWidth() const;
void SetThermalGap( int aGap ) { m_ThermalGap = aGap; }
int GetThermalGap() const;
2010-11-12 15:17:10 +00:00
/**
* Function SetRoundRectCornerRadius
2016-04-06 18:15:49 +00:00
* Has meaning only for rounded rect pads
* @return The radius of the rounded corners for this pad.
*/
void SetRoundRectCornerRadius( double aRadius );
int GetRoundRectCornerRadius() const;
wxPoint ShapePos() const;
2008-01-28 18:44:14 +00:00
2016-04-06 18:15:49 +00:00
/**
* has meaning only for rounded rect pads
* @return the scaling factor between the smaller Y or Y size and the radius
* of the rounded corners.
* Cannot be > 0.5
* the normalized IPC-7351C value is 0.25
*/
void SetRoundRectRadiusRatio( double aRadiusScale );
double GetRoundRectRadiusRatio() const { return m_padRoundRectRadiusScale; }
/**
* has meaning only for chamfered rect pads
* Set the ratio between the smaller Y or Y size and the radius
* of the rounded corners.
* Cannot be < 0.5 and obviously must be > 0
*/
void SetChamferRectRatio( double aChamferScale );
double GetChamferRectRatio() const { return m_padChamferRectScale; }
/**
* has meaning only for chamfered rect pads
* set the position of the chamfer for a 0 orientation, one of
* RECT_CHAMFER_TOP_LEFT, RECT_CHAMFER_TOP_RIGHT,
* RECT_CHAMFER_BOTTOM_LEFT, RECT_CHAMFER_BOTTOM_RIGHT
*/
void SetChamferPositions( int aPositions ) { m_chamferPositions = aPositions; }
int GetChamferPositions() const { return m_chamferPositions; }
2007-10-13 06:18:44 +00:00
/**
2012-02-19 04:02:19 +00:00
* Function GetSubRatsnest
2007-10-13 06:18:44 +00:00
* @return int - the netcode
*/
int GetSubRatsnest() const { return m_SubRatsnest; }
void SetSubRatsnest( int aSubRatsnest ) { m_SubRatsnest = aSubRatsnest; }
2008-01-28 18:44:14 +00:00
void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
bool IsOnLayer( PCB_LAYER_ID aLayer ) const override
{
return m_layerMask[aLayer];
}
2008-01-28 18:44:14 +00:00
bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
2017-04-22 06:49:15 +00:00
bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
2016-09-24 18:53:15 +00:00
wxString GetClass() const override
{
return wxT( "PAD" );
}
2008-01-28 18:44:14 +00:00
// Virtual function:
2016-09-24 18:53:15 +00:00
const EDA_RECT GetBoundingBox() const override;
2008-04-18 13:28:56 +00:00
///> Set absolute coordinates.
void SetDrawCoord();
//todo: Remove SetLocalCoord along with m_pos
///> Set relative coordinates.
void SetLocalCoord();
2008-01-24 21:50:12 +00:00
/**
* Function Compare
* compares two pads and return 0 if they are equal.
* @return int - <0 if left less than right, 0 if equal, >0 if left greater than right.
*/
2008-01-28 18:44:14 +00:00
static int Compare( const D_PAD* padref, const D_PAD* padcmp );
2008-01-24 21:50:12 +00:00
2016-09-24 18:53:15 +00:00
void Move( const wxPoint& aMoveVector ) override
2009-08-01 19:26:05 +00:00
{
m_Pos += aMoveVector;
SetLocalCoord();
2009-08-01 19:26:05 +00:00
}
2016-09-24 18:53:15 +00:00
void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
2019-12-20 14:11:39 +00:00
wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
BITMAP_DEF GetMenuImage() const override;
/**
* Function ShowPadShape
* @return the name of the shape
*/
wxString ShowPadShape() const;
/**
* Function ShowPadAttr
* @return the name of the pad type (attribute) : STD, SMD ...
*/
wxString ShowPadAttr() const;
2012-02-19 04:02:19 +00:00
/**
* Function AppendConfigs
* appends to @a aResult the configuration setting accessors which will later
* allow reading or writing of configuration file information directly into
* this object.
*/
void AppendConfigs( std::vector<PARAM_CFG*>* aResult );
2012-02-19 04:02:19 +00:00
2016-09-24 18:53:15 +00:00
EDA_ITEM* Clone() const override;
/**
* same as Clone, but returns a D_PAD item.
2020-02-20 12:11:04 +00:00
* Useful mainly for python scripts, because Clone returns an EDA_ITEM.
*/
2020-02-20 12:11:04 +00:00
D_PAD* ClonePad() const
{
return (D_PAD*) Clone();
}
/**
* A pad whose hole is the same size as the pad is a NPTH. However, if the user
* fails to mark this correctly then the pad will become invisible on the board.
* This check allows us to special-case this error-condition.
*/
bool PadShouldBeNPTH() const;
2016-09-24 18:53:15 +00:00
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
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
virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
2013-07-08 09:30:50 +00:00
2016-09-24 18:53:15 +00:00
virtual const BOX2I ViewBBox() const override;
2013-07-26 16:15:11 +00:00
virtual void SwapData( BOARD_ITEM* aImage ) override;
#if defined(DEBUG)
2016-09-24 18:53:15 +00:00
virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
2012-02-19 04:02:19 +00:00
private:
2012-02-19 04:02:19 +00:00
/**
* Function calcBoundingRadius
2012-02-19 04:02:19 +00:00
* returns a calculated radius of a bounding circle for this pad.
*/
int calcBoundingRadius() const;
2012-02-19 04:02:19 +00:00
void addPadPrimitivesToPolygon( SHAPE_POLY_SET* aMergedPolygon, int aError ) const;
void buildEffectiveShapes() const;
private:
wxString m_name; ///< pad name (pin number in schematic)
wxString m_pinFunction; ///< pin function in schematic
2012-02-19 04:02:19 +00:00
wxPoint m_Pos; ///< pad Position on board
2016-04-06 18:15:49 +00:00
PAD_SHAPE_T m_padShape; ///< Shape: PAD_SHAPE_CIRCLE, PAD_SHAPE_RECT,
///< PAD_SHAPE_OVAL, PAD_SHAPE_TRAPEZOID,
///< PAD_SHAPE_ROUNDRECT, PAD_SHAPE_POLYGON
2012-02-19 04:02:19 +00:00
// Edit definitions of primitives for custom pad shapes. In local coordinates relative
// to m_Pos (NOT shapePos) at orient 0.
std::vector<std::shared_ptr<DRAWSEGMENT>> m_editPrimitives;
mutable bool m_shapesDirty;
mutable int m_effectiveBoundingRadius;
mutable std::vector<std::shared_ptr<SHAPE>> m_effectiveShapes;
mutable std::shared_ptr<SHAPE_SEGMENT> m_effectiveHoleShape;
/**
* How to build the custom shape in zone, to create the clearance area:
* CUST_PAD_SHAPE_IN_ZONE_OUTLINE = use pad shape
* CUST_PAD_SHAPE_IN_ZONE_CONVEXHULL = use the convex hull of the pad shape
* other values are currently reserved
*/
CUST_PAD_SHAPE_IN_ZONE m_customShapeClearanceArea;
2012-02-19 04:02:19 +00:00
int m_SubRatsnest; ///< variable used in rats nest computations
///< handle subnet (block) number in ratsnest connection
wxSize m_Drill; ///< Drill diam (drill shape = PAD_CIRCLE) or drill size
///< (shape = OVAL) for drill shape = PAD_CIRCLE, drill
///< diam = m_Drill.x
wxSize m_Size; ///< X and Y size ( relative to orient 0)
PAD_DRILL_SHAPE_T m_drillShape; ///< PAD_DRILL_SHAPE_CIRCLE, PAD_DRILL_SHAPE_OBLONG
2016-04-06 18:15:49 +00:00
double m_padRoundRectRadiusScale; ///< scaling factor from smallest m_Size coord
///< to corner radius, default 0.25
double m_padChamferRectScale; ///< scaling factor from smallest m_Size coord
///< to chamfer value, default 0.25
int m_chamferPositions; ///< the positions of the chamfers for a 0 orientation
2012-02-19 04:02:19 +00:00
PAD_SHAPE_T m_anchorPadShape; ///< for custom shaped pads: shape of pad anchor,
///< PAD_SHAPE_RECT, PAD_SHAPE_CIRCLE
2012-02-19 04:02:19 +00:00
/**
2016-04-06 18:15:49 +00:00
* m_Offset is useful only for oblong and rect pads (it can be used for other
2012-02-19 04:02:19 +00:00
* shapes, but without any interest).
2012-03-17 02:11:44 +00:00
* This is the offset between the pad hole and the pad shape (you must
2012-02-19 04:02:19 +00:00
* understand here pad shape = copper area around the hole)
* Most of cases, the hole is the center of the shape (m_Offset = 0).
2016-04-06 18:15:49 +00:00
* But some board designers use oblong/rect pads with a hole moved to one of the
* oblong/rect pad shape ends.
2012-02-19 04:02:19 +00:00
* In all cases the pad position is the pad hole.
* The physical shape position (used to draw it for instance) is pad
* position (m_Pos) + m_Offset.
* KIWAY Milestone A): Make major modules into DLL/DSOs. ! The initial testing of this commit should be done using a Debug build so that all the wxASSERT()s are enabled. Also, be sure and keep enabled the USE_KIWAY_DLLs option. The tree won't likely build without it. Turning it off is senseless anyways. If you want stable code, go back to a prior version, the one tagged with "stable". * Relocate all functionality out of the wxApp derivative into more finely targeted purposes: a) DLL/DSO specific b) PROJECT specific c) EXE or process specific d) configuration file specific data e) configuration file manipulations functions. All of this functionality was blended into an extremely large wxApp derivative and that was incompatible with the desire to support multiple concurrently loaded DLL/DSO's ("KIFACE")s and multiple concurrently open projects. An amazing amount of organization come from simply sorting each bit of functionality into the proper box. * Switch to wxConfigBase from wxConfig everywhere except instantiation. * Add classes KIWAY, KIFACE, KIFACE_I, SEARCH_STACK, PGM_BASE, PGM_KICAD, PGM_SINGLE_TOP, * Remove "Return" prefix on many function names. * Remove obvious comments from CMakeLists.txt files, and from else() and endif()s. * Fix building boost for use in a DSO on linux. * Remove some of the assumptions in the CMakeLists.txt files that windows had to be the host platform when building windows binaries. * Reduce the number of wxStrings being constructed at program load time via static construction. * Pass wxConfigBase* to all SaveSettings() and LoadSettings() functions so that these functions are useful even when the wxConfigBase comes from another source, as is the case in the KICAD_MANAGER_FRAME. * Move the setting of the KIPRJMOD environment variable into class PROJECT, so that it can be moved into a project variable soon, and out of FP_LIB_TABLE. * Add the KIWAY_PLAYER which is associated with a particular PROJECT, and all its child wxFrames and wxDialogs now have a Kiway() member function which returns a KIWAY& that that window tree branch is in support of. This is like wxWindows DNA in that child windows get this member with proper value at time of construction. * Anticipate some of the needs for milestones B) and C) and make code adjustments now in an effort to reduce work in those milestones. * No testing has been done for python scripting, since milestone C) has that being largely reworked and re-thought-out.
2014-03-20 00:42:08 +00:00
* D_PAD::ShapePos() returns the physical shape position according to
2012-02-19 04:02:19 +00:00
* the offset and the pad rotation.
*/
wxPoint m_Offset;
LSET m_layerMask; ///< Bitwise layer :1= copper layer, 15= cmp,
2012-02-19 04:02:19 +00:00
///< 2..14 = internal layers
///< 16 .. 31 = technical layers
wxSize m_DeltaSize; ///< delta on rectangular shapes
wxPoint m_Pos0; ///< Initial Pad position (i.e. pad position relative to the
///< module anchor, orientation 0)
PAD_ATTR_T m_Attribute; ///< PAD_ATTRIB_NORMAL, PAD_ATTRIB_SMD,
///< PAD_ATTRIB_CONN, PAD_ATTRIB_HOLE_NOT_PLATED
PAD_PROP_T m_Property; ///< property in fab files (BGA, FIDUCIAL, TEST POINT, CASTELLATED)
2012-02-19 04:02:19 +00:00
double m_Orient; ///< in 1/10 degrees
int m_LengthPadToDie; ///< Length net from pad to die, inside the package
2012-02-19 04:02:19 +00:00
/// Local clearance. When null, the module default value is used.
/// when the module default value is null, the netclass value is used
/// Usually the local clearance is null
int m_LocalClearance;
2016-04-06 18:15:49 +00:00
/// Local mask margins: when 0, the parent footprint design values are used
2012-02-19 04:02:19 +00:00
int m_LocalSolderMaskMargin; ///< Local solder mask margin
int m_LocalSolderPasteMargin; ///< Local solder paste margin absolute value
double m_LocalSolderPasteMarginRatio; ///< Local solder mask margin ratio value of pad size
///< The final margin is the sum of these 2 values
2016-04-06 18:15:49 +00:00
/// how the connection to zone is made: no connection, thermal relief ...
2019-12-28 00:55:11 +00:00
ZONE_CONNECTION m_ZoneConnection;
2016-04-06 18:15:49 +00:00
2012-05-24 15:00:59 +00:00
int m_ThermalWidth;
int m_ThermalGap;
2012-02-19 04:02:19 +00:00
};
2012-02-19 04:02:19 +00:00
#endif // PAD_H_