KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_shape.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2018 Jean-Pierre Charras jp.charras at wanadoo.fr
5 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25#pragma once
26
28#include <eda_shape.h>
29
30
31class LINE_READER;
32class EDA_DRAW_FRAME;
33class FOOTPRINT;
34class MSG_PANEL_ITEM;
35
36
38{
39public:
40 PCB_SHAPE( BOARD_ITEM* aParent, KICAD_T aItemType, SHAPE_T aShapeType );
41
42 PCB_SHAPE( BOARD_ITEM* aParent = nullptr, SHAPE_T aShapeType = SHAPE_T::SEGMENT );
43
44 // Do not create a copy constructor & operator=.
45 // The ones generated by the compiler are adequate.
46
47 ~PCB_SHAPE() override;
48
49 static bool ClassOf( const EDA_ITEM* aItem )
50 {
51 return aItem && PCB_SHAPE_T == aItem->Type();
52 }
53
54 wxString GetClass() const override
55 {
56 return wxT( "PCB_SHAPE" );
57 }
58
59 void Serialize( google::protobuf::Any &aContainer ) const override;
60 bool Deserialize( const google::protobuf::Any &aContainer ) override;
61
62 bool IsConnected() const override;
63
64 wxString GetFriendlyName() const override { return getFriendlyName(); }
65
66 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override;
67
68 void SetLayer( PCB_LAYER_ID aLayer ) override;
69 PCB_LAYER_ID GetLayer() const override { return m_layer; }
70
71 bool IsOnLayer( PCB_LAYER_ID aLayer ) const override;
72
73 virtual LSET GetLayerSet() const override;
74 virtual void SetLayerSet( const LSET& aLayers ) override;
75
76 void SetPosition( const VECTOR2I& aPos ) override { setPosition( aPos ); }
77 VECTOR2I GetPosition() const override { return getPosition(); }
78
79 VECTOR2I GetCenter() const override { return getCenter(); }
80
85 std::vector<VECTOR2I> GetConnectionPoints() const;
86
87 bool HasLineStroke() const override { return true; }
88
89 STROKE_PARAMS GetStroke() const override { return m_stroke; }
90 void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }
91
92 int GetWidth() const override;
93
94 void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings ) override;
95
100 virtual std::vector<VECTOR2I> GetCorners() const;
101
106 const VECTOR2I GetFocusPosition() const override;
107
111 std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
112 FLASHING aFlash = FLASHING::DEFAULT ) const override;
113
114 bool IsProxyItem() const override { return m_proxyItem; }
115 void SetIsProxyItem( bool aIsProxy = true ) override;
116
117 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
118
119 const BOX2I GetBoundingBox() const override { return getBoundingBox(); }
120
121 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override
122 {
123 return hitTest( aPosition, aAccuracy );
124 }
125
126 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override
127 {
128 return hitTest( aRect, aContained, aAccuracy );
129 }
130
131 void Normalize() override;
132
138 void NormalizeForCompare() override;
139
140 void Move( const VECTOR2I& aMoveVector ) override;
141
142 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
143
144 void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection ) override;
145
146 virtual void Mirror( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection ) override;
147
148 void Scale( double aScale );
149
160 void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
161 int aError, ERROR_LOC aErrorLoc,
162 bool ignoreLineWidth = false ) const override;
163
164 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
165
166 BITMAPS GetMenuImage() const override;
167
168 EDA_ITEM* Clone() const override;
169
170 const BOX2I ViewBBox() const override;
171
172 std::vector<int> ViewGetLayers() const override;
173
175 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
176
177 double Similarity( const BOARD_ITEM& aBoardItem ) const override;
178
179 bool operator==( const PCB_SHAPE& aShape ) const;
180 bool operator==( const BOARD_ITEM& aBoardItem ) const override;
181
182 void SetHasSolderMask( bool aVal ) { m_hasSolderMask = aVal; }
183 bool HasSolderMask() const { return m_hasSolderMask; }
184
185 void SetLocalSolderMaskMargin( std::optional<int> aMargin ) { m_solderMaskMargin = aMargin; }
186 std::optional<int> GetLocalSolderMaskMargin() const { return m_solderMaskMargin; }
187
188 int GetSolderMaskExpansion() const;
189
190#if defined(DEBUG)
191 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
192#endif
193
194protected:
195 void swapData( BOARD_ITEM* aImage ) override;
196
198 {
199 bool operator()( const BOARD_ITEM* aFirst, const BOARD_ITEM* aSecond ) const;
200 };
201
203 std::optional<int> m_solderMaskMargin;
204};
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
Definition: approximation.h:32
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
A base class derived from BOARD_ITEM for items that can be connected and have a net,...
Container for design settings for a BOARD object.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:79
PCB_LAYER_ID m_layer
Definition: board_item.h:436
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:89
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
bool m_proxyItem
Definition: eda_shape.h:445
VECTOR2I getCenter() const
Definition: eda_shape.cpp:752
bool hitTest(const VECTOR2I &aPosition, int aAccuracy=0) const
Definition: eda_shape.cpp:1077
void setPosition(const VECTOR2I &aPos)
Definition: eda_shape.cpp:357
const BOX2I getBoundingBox() const
Definition: eda_shape.cpp:1023
VECTOR2I getPosition() const
Definition: eda_shape.cpp:363
STROKE_PARAMS m_stroke
Definition: eda_shape.h:422
wxString getFriendlyName() const
Definition: eda_shape.cpp:939
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:93
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:36
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_shape.h:119
virtual void Mirror(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Mirror this object relative to a given horizontal axis the layer is not changed.
Definition: pcb_shape.cpp:494
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: pcb_shape.cpp:634
void swapData(BOARD_ITEM *aImage) override
Definition: pcb_shape.cpp:732
bool IsConnected() const override
Returns information if the object is derived from BOARD_CONNECTED_ITEM.
Definition: pcb_shape.cpp:163
std::optional< int > GetLocalSolderMaskMargin() const
Definition: pcb_shape.h:186
VECTOR2I GetCenter() const override
This defaults to the center of the bounding box if not overridden.
Definition: pcb_shape.h:79
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition: pcb_shape.cpp:480
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: pcb_shape.cpp:700
bool HasLineStroke() const override
Check if this item has line stoke properties.
Definition: pcb_shape.h:87
int GetWidth() const override
Definition: pcb_shape.cpp:301
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: pcb_shape.cpp:715
bool HasSolderMask() const
Definition: pcb_shape.h:183
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition: pcb_shape.h:121
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Make a set of SHAPE objects representing the PCB_SHAPE.
Definition: pcb_shape.cpp:726
void SetHasSolderMask(bool aVal)
Definition: pcb_shape.h:182
std::optional< int > m_solderMaskMargin
Definition: pcb_shape.h:203
int GetSolderMaskExpansion() const
Definition: pcb_shape.cpp:179
void NormalizeForCompare() override
Normalize coordinates to compare 2 similar PCB_SHAPES similat to Normalize(), but also normalize SEGM...
Definition: pcb_shape.cpp:458
void SetPosition(const VECTOR2I &aPos) override
Definition: pcb_shape.h:76
const VECTOR2I GetFocusPosition() const override
Allows items to return their visual center rather than their anchor.
Definition: pcb_shape.cpp:317
virtual void SetLayerSet(const LSET &aLayers) override
Definition: pcb_shape.cpp:235
void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection) override
Flip this object, i.e.
Definition: pcb_shape.cpp:486
virtual std::vector< VECTOR2I > GetCorners() const
Return 4 corners for a rectangle or rotated rectangle (stored as a poly).
Definition: pcb_shape.cpp:359
bool IsProxyItem() const override
Definition: pcb_shape.h:114
bool m_hasSolderMask
Definition: pcb_shape.h:202
~PCB_SHAPE() override
Definition: pcb_shape.cpp:67
virtual LSET GetLayerSet() const override
Return a std::bitset of all layers on which the item physically resides.
Definition: pcb_shape.cpp:218
static bool ClassOf(const EDA_ITEM *aItem)
Definition: pcb_shape.h:49
bool operator==(const PCB_SHAPE &aShape) const
Definition: pcb_shape.cpp:793
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
Definition: pcb_shape.cpp:170
wxString GetFriendlyName() const override
Definition: pcb_shape.h:64
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const override
Convert the shape to a closed polygon.
Definition: pcb_shape.cpp:774
STROKE_PARAMS GetStroke() const override
Definition: pcb_shape.h:89
void SetIsProxyItem(bool aIsProxy=true) override
Definition: pcb_shape.cpp:530
void StyleFromSettings(const BOARD_DESIGN_SETTINGS &settings) override
Definition: pcb_shape.cpp:311
void SetLocalSolderMaskMargin(std::optional< int > aMargin)
Definition: pcb_shape.h:185
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition: pcb_shape.cpp:387
std::vector< VECTOR2I > GetConnectionPoints() const
Definition: pcb_shape.cpp:248
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition: pcb_shape.cpp:94
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_shape.cpp:709
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: pcb_shape.cpp:572
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test to see if this object is on the given layer.
Definition: pcb_shape.cpp:200
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: pcb_shape.cpp:653
void Scale(double aScale)
Definition: pcb_shape.cpp:393
bool HitTest(const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
Test if aRect intersects this item.
Definition: pcb_shape.h:126
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition: pcb_shape.cpp:72
void SetStroke(const STROKE_PARAMS &aStroke) override
Definition: pcb_shape.h:90
void Normalize() override
Perform any normalization required after a user rotate and/or flip.
Definition: pcb_shape.cpp:399
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: pcb_shape.cpp:131
std::vector< int > ViewGetLayers() const override
Definition: pcb_shape.cpp:607
wxString GetClass() const override
Return the class name.
Definition: pcb_shape.h:54
double Similarity(const BOARD_ITEM &aBoardItem) const override
Return a measure of how likely the other object is to represent the same object.
Definition: pcb_shape.cpp:828
VECTOR2I GetPosition() const override
Definition: pcb_shape.h:77
PCB_LAYER_ID GetLayer() const override
Return the primary layer this item is on.
Definition: pcb_shape.h:69
Represent a set of closed polygons.
Simple container to manage line stroke parameters.
Definition: stroke_params.h:79
SHAPE_T
Definition: eda_shape.h:43
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:147
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
FLIP_DIRECTION
Definition: mirror.h:27
bool operator()(const BOARD_ITEM *aFirst, const BOARD_ITEM *aSecond) const
Definition: pcb_shape.cpp:752
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_SHAPE_T
class PCB_SHAPE, a segment not on copper layers
Definition: typeinfo.h:88