KiCad PCB EDA Suite
board_item.cpp
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) 2012 Jean-Pierre Charras, [email protected]
5  * Copyright (C) 2012 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6  * Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #include <pybind11/pybind11.h>
27 
28 #include <wx/debug.h>
29 #include <wx/msgdlg.h>
30 #include <i18n_utility.h>
31 #include <macros.h>
32 #include <board.h>
33 #include <pcb_group.h>
34 
35 
37 {
38  if( Type() == PCB_T )
39  return static_cast<const BOARD*>( this );
40 
41  BOARD_ITEM* parent = GetParent();
42 
43  if( parent )
44  return parent->GetBoard();
45 
46  return nullptr;
47 }
48 
49 
51 {
52  if( Type() == PCB_T )
53  return static_cast<BOARD*>( this );
54 
55  BOARD_ITEM* parent = GetParent();
56 
57  if( parent )
58  return parent->GetBoard();
59 
60  return nullptr;
61 }
62 
63 
65 {
66  if( GetParentGroup() )
67  return GetParentGroup()->IsLocked();
68 
69  return GetState( LOCKED );
70 }
71 
72 
73 wxString BOARD_ITEM::GetLayerName() const
74 {
75  const BOARD* board = GetBoard();
76 
77  if( board )
78  return board->GetLayerName( m_layer );
79 
80  // If no parent, return standard name
82 }
83 
84 
86 {
87  const BOARD* board = GetBoard();
88  LSET layers = GetLayerSet();
89 
90  // Try to be smart and useful. Check all copper first.
91  if( layers[F_Cu] && layers[B_Cu] )
92  return _( "all copper layers" );
93 
94  LSET copperLayers = layers & board->GetEnabledLayers().AllCuMask();
95  LSET techLayers = layers & board->GetEnabledLayers().AllTechMask();
96 
97  for( LSET testLayers : { copperLayers, techLayers, layers } )
98  {
99  for( int bit = PCBNEW_LAYER_ID_START; bit < PCB_LAYER_ID_COUNT; ++bit )
100  {
101  if( testLayers[ bit ] )
102  {
103  wxString layerInfo = board->GetLayerName( static_cast<PCB_LAYER_ID>( bit ) );
104 
105  if( testLayers.count() > 1 )
106  layerInfo << wxS( " " ) + _( "and others" );
107 
108  return layerInfo;
109  }
110  }
111  }
112 
113  // No copper, no technicals: no layer
114  return _( "no layers" );
115 }
116 
117 
118 void BOARD_ITEM::ViewGetLayers( int aLayers[], int& aCount ) const
119 {
120  // Basic fallback
121  aCount = 1;
122  aLayers[0] = m_layer;
123 }
124 
125 
127 {
128  BOARD_ITEM_CONTAINER* parent = GetParent();
129 
130  if( parent )
131  parent->Remove( this );
132 
133  delete this;
134 }
135 
136 
138 {
139 }
140 
141 
143  PCB_LAYER_ID aLayer, int aClearanceValue,
144  int aError, ERROR_LOC aErrorLoc,
145  bool ignoreLineWidth ) const
146 {
147  wxASSERT_MSG( false,
148  "Called TransformShapeWithClearanceToPolygon() on unsupported BOARD_ITEM." );
149 };
150 
151 
153 {
154  if( a->Type() != b->Type() )
155  return a->Type() < b->Type();
156 
157  if( a->GetLayer() != b->GetLayer() )
158  return a->GetLayer() < b->GetLayer();
159 
160  if( a->m_Uuid != b->m_Uuid ) // should be always the case for valid boards
161  return a->m_Uuid < b->m_Uuid;
162 
163  return a < b;
164 }
165 
166 
167 std::shared_ptr<SHAPE> BOARD_ITEM::GetEffectiveShape( PCB_LAYER_ID aLayer ) const
168 {
169  std::shared_ptr<SHAPE> shape;
170 
172 
173  return shape;
174 }
175 
176 
177 void BOARD_ITEM::Rotate( const wxPoint& aRotCentre, double aAngle )
178 {
179  wxMessageBox( wxT( "virtual BOARD_ITEM::Rotate used, should not occur" ), GetClass() );
180 }
181 
182 
183 void BOARD_ITEM::Flip( const wxPoint& aCentre, bool aFlipLeftRight )
184 {
185  wxMessageBox( wxT( "virtual BOARD_ITEM::Flip used, should not occur" ), GetClass() );
186 }
187 
188 
189 static struct BOARD_ITEM_DESC
190 {
192  {
194 
195  if( layerEnum.Choices().GetCount() == 0 )
196  {
197  layerEnum.Undefined( UNDEFINED_LAYER );
198 
199  for( LSEQ seq = LSET::AllLayersMask().Seq(); seq; ++seq )
200  layerEnum.Map( *seq, LSET::Name( *seq ) );
201  }
202 
206 
207  propMgr.AddProperty( new PROPERTY<BOARD_ITEM, int>( _HKI( "Position X" ),
209  propMgr.AddProperty( new PROPERTY<BOARD_ITEM, int>( _HKI( "Position Y" ),
213  propMgr.AddProperty( new PROPERTY<BOARD_ITEM, bool>( _HKI( "Locked" ),
215  }
217 
static LSET AllCuMask(int aCuLayerCount=MAX_CU_LAYERS)
Return a mask holding the requested number of Cu PCB_LAYER_IDs.
Definition: lset.cpp:750
PCB_GROUP * GetParentGroup() const
Definition: board_item.h:60
static PROPERTY_MANAGER & Instance()
Definition: property_mgr.h:65
#define TYPE_HASH(x)
Definition: property.h:59
#define IMPLEMENT_ENUM_TO_WXANY(type)
Definition: property.h:610
Definition: typeinfo.h:84
const wxString GetLayerName(PCB_LAYER_ID aLayer) const
Return the name of a aLayer.
Definition: board.cpp:362
virtual void SetLayer(PCB_LAYER_ID aLayer)
Set the layer this item is on.
Definition: board_item.h:161
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:49
virtual void Rotate(const wxPoint &aRotCentre, double aAngle)
Rotate this object.
Definition: board_item.cpp:177
ENUM_MAP & Undefined(T aValue)
Definition: property.h:523
virtual void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
Definition: board_item.cpp:118
static ENUM_MAP< T > & Instance()
Definition: property.h:510
void DeleteStructure()
Delete this object after removing from its parent if it has one.
Definition: board_item.cpp:126
LSET GetEnabledLayers() const
A proxy function that calls the corresponding function in m_BoardSettings.
Definition: board.cpp:467
virtual void SetLocked(bool aLocked)
Modify the 'lock' status for of the item.
Definition: board_item.h:221
wxPGChoices & Choices()
Definition: property.h:559
static LSET AllTechMask()
Return a mask holding all technical layers (no CU layer) on both side.
Definition: lset.cpp:820
static struct BOARD_ITEM_DESC _BOARD_ITEM_DESC
virtual bool IsLocked() const
Definition: board_item.cpp:64
#define REGISTER_TYPE(x)
Definition: property_mgr.h:248
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
This file contains miscellaneous commonly used macros and functions.
virtual void SwapData(BOARD_ITEM *aImage)
Swap data between aItem and aImage.
Definition: board_item.cpp:137
virtual wxString layerMaskDescribe() const
Return a string (to be shown to the user) describing a layer mask.
Definition: board_item.cpp:85
virtual void Flip(const wxPoint &aCentre, bool aFlipLeftRight)
Flip this object, i.e.
Definition: board_item.cpp:183
Display value expressed in distance units (mm/inch)
Definition: property.h:53
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:504
int GetY() const
Definition: board_item.h:70
static const wxChar * Name(PCB_LAYER_ID aLayerId)
Return the fixed name association with aLayerId.
Definition: lset.cpp:82
Represent a set of closed polygons.
void InheritsAfter(TYPE_ID aDerived, TYPE_ID aBase)
Declare an inheritance relationship between types.
#define UNIMPLEMENTED_FOR(type)
Definition: macros.h:120
#define LOCKED
Pcbnew: locked from movement and deletion.
void SetY(int aY)
Definition: board_item.h:92
#define _(s)
static LSET AllLayersMask()
Definition: lset.cpp:787
int GetState(EDA_ITEM_FLAGS type) const
Definition: eda_item.h:137
void SetX(int aX)
Definition: board_item.h:86
LSEQ is a sequence (and therefore also a set) of PCB_LAYER_IDs.
Definition: layer_ids.h:465
const KIID m_Uuid
Definition: eda_item.h:475
Some functions to handle hotkeys in KiCad.
virtual wxString GetClass() const =0
Return the class name.
int GetX() const
Definition: board_item.h:64
Information pertinent to a Pcbnew printed circuit board.
Definition: board.h:190
bool operator()(const BOARD_ITEM *a, const BOARD_ITEM *b) const
Definition: board_item.cpp:152
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:65
Definition: layer_ids.h:71
void AddProperty(PROPERTY_BASE *aProperty)
Register a property.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
PCB_LAYER_ID m_layer
Definition: board_item.h:316
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER) const
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: board_item.cpp:167
virtual const BOARD * GetBoard() const
Return the BOARD in which this BOARD_ITEM resides, or NULL if none.
Definition: board_item.cpp:36
Provide class metadata.Helper macro to map type hashes to names.
Definition: property_mgr.h:62
virtual void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool ignoreLineWidth=false) const
Convert the item shape to a closed polygon.
Definition: board_item.cpp:142
virtual void Remove(BOARD_ITEM *aItem, REMOVE_MODE aMode=REMOVE_MODE::NORMAL)=0
Removes an item from the container.
Abstract interface for BOARD_ITEMs capable of storing other items inside.
ENUM_MAP & Map(T aValue, const wxString &aName)
Definition: property.h:516
BOARD_ITEM_CONTAINER * GetParent() const
Definition: board_item.h:135
wxString GetLayerName() const
Return the name of the PCB layer on which the item resides.
Definition: board_item.cpp:73
#define _HKI(x)
virtual PCB_LAYER_ID GetLayer() const
Return the primary layer this item is on.
Definition: board_item.h:140
virtual LSET GetLayerSet() const
Return a std::bitset of all layers on which the item physically resides.
Definition: board_item.h:145
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113
static wxString GetStandardLayerName(PCB_LAYER_ID aLayerId)
Return an "English Standard" name of a PCB layer when given aLayerNumber.
Definition: board.h:605