KiCad PCB EDA Suite
Loading...
Searching...
No Matches
board_item.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 wandadoo.fr
5 * Copyright The 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
27
28#include <core/mirror.h>
29#include <eda_item.h>
31#include <layer_ids.h>
32#include <lseq.h>
33#include <lset.h>
34#include <stroke_params.h>
35#include <geometry/eda_angle.h>
36
37class BOARD;
40class SHAPE_POLY_SET;
41class SHAPE_SEGMENT;
42class PCB_BASE_FRAME;
43class SHAPE;
44class PCB_GROUP;
45class FOOTPRINT;
46
47namespace KIFONT
48{
49class METRICS;
50}
51
52
66{
70};
71
77class BOARD_ITEM : public EDA_ITEM
78{
79public:
80 BOARD_ITEM( BOARD_ITEM* aParent, KICAD_T idtype, PCB_LAYER_ID aLayer = F_Cu ) :
81 EDA_ITEM( aParent, idtype, false, true ),
82 m_layer( aLayer ),
83 m_isKnockout( false ),
84 m_isLocked( false )
85 {
86 }
87
88 virtual void CopyFrom( const BOARD_ITEM* aOther );
89
90 // Do not create a copy constructor & operator=.
91 // The ones generated by the compiler are adequate.
92 int GetX() const
93 {
95 return p.x;
96 }
97
98 int GetY() const
99 {
100 VECTOR2I p = GetPosition();
101 return p.y;
102 }
103
109 virtual VECTOR2I GetCenter() const
110 {
111 return GetBoundingBox().GetCenter();
112 }
113
114 void SetX( int aX )
115 {
116 VECTOR2I p( aX, GetY() );
117 SetPosition( p );
118 }
119
120 void SetY( int aY )
121 {
122 VECTOR2I p( GetX(), aY );
123 SetPosition( p );
124 }
125
131 virtual bool IsConnected() const
132 {
133 return false;
134 }
135
142 virtual double Similarity( const BOARD_ITEM& aItem ) const = 0;
143 virtual bool operator==( const BOARD_ITEM& aItem ) const = 0;
144
148 virtual bool IsOnCopperLayer() const
149 {
150 return IsCopperLayer( GetLayer() );
151 }
152
153 virtual bool HasHole() const
154 {
155 return false;
156 }
157
158 virtual bool HasDrilledHole() const
159 {
160 return false;
161 }
162
170 virtual bool IsTented( PCB_LAYER_ID aLayer ) const
171 {
172 return false;
173 }
174
179
195 virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
196 FLASHING aFlash = FLASHING::DEFAULT ) const;
197
198 virtual std::shared_ptr<SHAPE_SEGMENT> GetEffectiveHoleShape() const;
199
205 virtual void RunOnChildren( const std::function<void( BOARD_ITEM* )>& aFunction, RECURSE_MODE aMode ) const {}
206
208
210
212 void SetFPRelativePosition( const VECTOR2I& aPos );
213
219 virtual bool HasLineStroke() const { return false; }
220
221 virtual STROKE_PARAMS GetStroke() const;
222 virtual void SetStroke( const STROKE_PARAMS& aStroke );
223
224 const KIFONT::METRICS& GetFontMetrics() const;
225
229 virtual PCB_LAYER_ID GetLayer() const { return m_layer; }
230
234 virtual int BoardLayerCount() const;
235
239 virtual int BoardCopperLayerCount() const;
240
244 virtual LSET BoardLayerSet() const;
245
249 virtual LSET GetLayerSet() const
250 {
251 if( m_layer == UNDEFINED_LAYER )
252 return LSET();
253 else
254 return LSET( { m_layer } );
255 }
256
257 virtual void SetLayerSet( const LSET& aLayers )
258 {
259 if( aLayers.count() == 1 )
260 {
261 SetLayer( aLayers.Seq()[0] );
262 return;
263 }
264
265 wxFAIL_MSG( wxT( "Attempted to SetLayerSet() on a single-layer object." ) );
266
267 // Derived classes which support multiple layers must implement this
268 }
269
270 bool IsSideSpecific() const;
271
280 virtual void SetLayer( PCB_LAYER_ID aLayer )
281 {
282 m_layer = aLayer;
283 }
284
288 virtual BOARD_ITEM* Duplicate() const;
289
300 void SwapItemData( BOARD_ITEM* aImage );
301
311 virtual bool IsOnLayer( PCB_LAYER_ID aLayer ) const
312 {
313 return m_layer == aLayer;
314 }
315
316 virtual bool IsKnockout() const { return m_isKnockout; }
317 virtual void SetIsKnockout( bool aKnockout ) { m_isKnockout = aKnockout; }
318
319 bool IsLocked() const override;
320 void SetLocked( bool aLocked ) override { m_isLocked = aLocked; }
321
322 virtual void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings ) { }
323
327 void DeleteStructure();
328
334 virtual void Move( const VECTOR2I& aMoveVector )
335 {
336 wxFAIL_MSG( wxT( "virtual BOARD_ITEM::Move called for " ) + GetClass() );
337 }
338
344 virtual void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle );
345
352 virtual void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection );
353
360 virtual void Mirror( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection );
361
365 virtual void Normalize() {}
366
372 virtual void NormalizeForCompare() { Normalize(); }
373
377 virtual const BOARD* GetBoard() const;
378 virtual BOARD* GetBoard();
379
384 wxString GetParentAsString() const;
385
391 wxString GetLayerName() const;
392
393 virtual std::vector<int> ViewGetLayers() const override;
394
405 virtual void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer,
406 int aClearance, int aError, ERROR_LOC aErrorLoc,
407 bool ignoreLineWidth = false ) const;
408
421 int aClearance, int aError, ERROR_LOC aErrorLoc ) const
422 {
423 TransformShapeToPolygon( aBuffer, aLayer, aClearance, aError, aErrorLoc );
424 }
425
426 enum COMPARE_FLAGS : int
427 {
428 DRC = 0x01
429 };
430
431 struct ptr_cmp
432 {
433 bool operator() ( const BOARD_ITEM* a, const BOARD_ITEM* b ) const;
434 };
435
436protected:
440 virtual wxString layerMaskDescribe() const;
441
442 virtual void swapData( BOARD_ITEM* aImage );
443
444protected:
447
449};
450
451#ifndef SWIG
453#endif
454
455
462{
463public:
465 BOARD_ITEM( nullptr, NOT_USED )
466 {}
467
468 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override
469 {
470 return _( "(Deleted Item)" );
471 }
472
473 wxString GetClass() const override
474 {
475 return wxT( "DELETED_BOARD_ITEM" );
476 }
477
478 // pure virtuals:
479 void SetPosition( const VECTOR2I& ) override {}
480 VECTOR2I GetPosition() const override { return VECTOR2I( 0, 0 ); }
481
483 {
484 static DELETED_BOARD_ITEM* item = nullptr;
485
486 if( !item )
487 item = new DELETED_BOARD_ITEM();
488
489 return item;
490 }
491
492 double Similarity( const BOARD_ITEM& aItem ) const override
493 {
494 return ( this == &aItem ) ? 1.0 : 0.0;
495 }
496
497 bool operator==( const BOARD_ITEM& aBoardItem ) const override
498 {
499 return ( this == &aBoardItem );
500 }
501
502 bool operator==( const DELETED_BOARD_ITEM& aOther ) const
503 {
504 return ( this == &aOther );
505 }
506
507#if defined(DEBUG)
508 void Show( int , std::ostream& ) const override {}
509#endif
510};
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
ZONE_LAYER_OVERRIDE
Conditionally flashed vias and pads that interact with zones of different priority can be very squirr...
Definition: board_item.h:66
@ ZLO_NONE
Definition: board_item.h:67
@ ZLO_FORCE_NO_ZONE_CONNECTION
Definition: board_item.h:69
@ ZLO_FORCE_FLASHED
Definition: board_item.h:68
Container for design settings for a BOARD object.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:78
BOARD_ITEM(BOARD_ITEM *aParent, KICAD_T idtype, PCB_LAYER_ID aLayer=F_Cu)
Definition: board_item.h:80
virtual void Mirror(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection)
Mirror this object relative to a given horizontal axis the layer is not changed.
Definition: board_item.cpp:368
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:229
virtual void StyleFromSettings(const BOARD_DESIGN_SETTINGS &settings)
Definition: board_item.h:322
int GetY() const
Definition: board_item.h:98
virtual void NormalizeForCompare()
Perform any normalization required to compare 2 graphics, especially if the can be rotated and/or fli...
Definition: board_item.h:372
void DeleteStructure()
Delete this object after removing from its parent if it has one.
Definition: board_item.cpp:210
void SwapItemData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
Definition: board_item.cpp:226
virtual void TransformShapeToPolySet(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc) const
Convert the item shape to a polyset.
Definition: board_item.h:420
void SetLocked(bool aLocked) override
Definition: board_item.h:320
virtual STROKE_PARAMS GetStroke() const
Definition: board_item.cpp:87
virtual bool IsConnected() const
Returns information if the object is derived from BOARD_CONNECTED_ITEM.
Definition: board_item.h:131
bool m_isKnockout
Definition: board_item.h:446
virtual int BoardLayerCount() const
Return the total number of layers for the board that this item resides on.
Definition: board_item.cpp:107
virtual void SetStroke(const STROKE_PARAMS &aStroke)
Definition: board_item.cpp:95
PCB_LAYER_ID m_layer
Definition: board_item.h:445
virtual void SetLayerSet(const LSET &aLayers)
Definition: board_item.h:257
bool m_isLocked
Definition: board_item.h:448
wxString GetParentAsString() const
For "parent" property.
Definition: board_item.cpp:374
virtual bool IsKnockout() const
Definition: board_item.h:316
int GetX() const
Definition: board_item.h:92
bool IsLocked() const override
Definition: board_item.cpp:76
virtual void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
Convert the item shape to a closed polygon.
Definition: board_item.cpp:256
virtual void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle)
Rotate this object.
Definition: board_item.cpp:356
void SetX(int aX)
Definition: board_item.h:114
virtual BOARD_ITEM * Duplicate() const
Create a copy of this BOARD_ITEM.
Definition: board_item.cpp:244
void SetY(int aY)
Definition: board_item.h:120
virtual VECTOR2I GetCenter() const
This defaults to the center of the bounding box if not overridden.
Definition: board_item.h:109
virtual void Move(const VECTOR2I &aMoveVector)
Move this object.
Definition: board_item.h:334
virtual bool IsOnLayer(PCB_LAYER_ID aLayer) const
Test to see if this object is on the given layer.
Definition: board_item.h:311
virtual void SetIsKnockout(bool aKnockout)
Definition: board_item.h:317
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:280
virtual std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
Definition: board_item.cpp:200
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: board_item.cpp:279
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:48
FOOTPRINT * GetParentFootprint() const
Definition: board_item.cpp:299
VECTOR2I GetFPRelativePosition() const
Definition: board_item.cpp:328
virtual LSET BoardLayerSet() const
Return the LSET for the board that this item resides on.
Definition: board_item.cpp:129
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition: board_item.h:249
virtual bool IsTented(PCB_LAYER_ID aLayer) const
Checks if the given object is tented (its copper shape is covered by solder mask) on a given side of ...
Definition: board_item.h:170
virtual void swapData(BOARD_ITEM *aImage)
Definition: board_item.cpp:221
const KIFONT::METRICS & GetFontMetrics() const
Definition: board_item.cpp:101
void SetFPRelativePosition(const VECTOR2I &aPos)
Definition: board_item.cpp:342
static VECTOR2I ZeroOffset
A value of wxPoint(0,0) which can be passed to the Draw() functions.
Definition: board_item.h:178
virtual void CopyFrom(const BOARD_ITEM *aOther)
Definition: board_item.cpp:41
virtual bool operator==(const BOARD_ITEM &aItem) const =0
virtual void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction, RECURSE_MODE aMode) const
Invoke a function on all children.
Definition: board_item.h:205
virtual bool HasDrilledHole() const
Definition: board_item.h:158
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:207
bool IsSideSpecific() const
Definition: board_item.cpp:150
virtual int BoardCopperLayerCount() const
Return the total number of copper layers for the board that this item resides on.
Definition: board_item.cpp:118
virtual bool IsOnCopperLayer() const
Definition: board_item.h:148
virtual bool HasLineStroke() const
Check if this item has line stoke properties.
Definition: board_item.h:219
virtual void Normalize()
Perform any normalization required after a user rotate and/or flip.
Definition: board_item.h:365
virtual wxString layerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
Definition: board_item.cpp:167
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:140
virtual double Similarity(const BOARD_ITEM &aItem) const =0
Return a measure of how likely the other object is to represent the same object.
virtual std::shared_ptr< SHAPE_SEGMENT > GetEffectiveHoleShape() const
Definition: board_item.cpp:289
virtual void Flip(const VECTOR2I &aCentre, FLIP_DIRECTION aFlipDirection)
Flip this object, i.e.
Definition: board_item.cpp:362
virtual bool HasHole() const
Definition: board_item.h:153
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:297
constexpr const Vec GetCenter() const
Definition: box2.h:230
A singleton item of this class is returned for a weak reference that no longer exists.
Definition: board_item.h:462
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: board_item.h:468
static DELETED_BOARD_ITEM * GetInstance()
Definition: board_item.h:482
wxString GetClass() const override
Return the class name.
Definition: board_item.h:473
double Similarity(const BOARD_ITEM &aItem) const override
Return a measure of how likely the other object is to represent the same object.
Definition: board_item.h:492
VECTOR2I GetPosition() const override
Definition: board_item.h:480
void SetPosition(const VECTOR2I &) override
Definition: board_item.h:479
bool operator==(const BOARD_ITEM &aBoardItem) const override
Definition: board_item.h:497
bool operator==(const DELETED_BOARD_ITEM &aOther) const
Definition: board_item.h:502
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:96
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:256
virtual void SetPosition(const VECTOR2I &aPos)
Definition: eda_item.h:257
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:84
virtual wxString GetClass() const =0
Return the class name.
EDA_ITEM * m_parent
Linked list: Link (parent struct).
Definition: eda_item.h:514
LSET is a set of PCB_LAYER_IDs.
Definition: lset.h:37
LSEQ Seq(const LSEQ &aSequence) const
Return an LSEQ from the union of this LSET and a desired sequence.
Definition: lset.cpp:297
Base PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:53
Represent a set of closed polygons.
An abstract shape on 2D plane.
Definition: shape.h:126
Simple container to manage line stroke parameters.
Definition: stroke_params.h:94
#define _(s)
RECURSE_MODE
Definition: eda_item.h:49
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:184
bool IsCopperLayer(int aLayerId)
Test whether a layer is a copper layer.
Definition: layer_ids.h:663
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:60
@ UNDEFINED_LAYER
Definition: layer_ids.h:61
@ F_Cu
Definition: layer_ids.h:64
FLIP_DIRECTION
Definition: mirror.h:27
#define DECLARE_ENUM_TO_WXANY(type)
Definition: property.h:747
bool operator()(const BOARD_ITEM *a, const BOARD_ITEM *b) const
Definition: board_item.cpp:264
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ NOT_USED
the 3d code uses this value
Definition: typeinfo.h:79
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:695