KiCad PCB EDA Suite
pcb_group.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) 2020 Joshua Redstone redstone at gmail.com
5 * Copyright (C) 1992-2022 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
30#ifndef CLASS_PCB_GROUP_H_
31#define CLASS_PCB_GROUP_H_
32
33#include <board_commit.h>
34#include <board_item.h>
35#include <unordered_set>
36
37namespace KIGFX
38{
39class VIEW;
40}
41
50class PCB_GROUP : public BOARD_ITEM
51{
52public:
53 PCB_GROUP( BOARD_ITEM* aParent );
54
55 static inline bool ClassOf( const EDA_ITEM* aItem )
56 {
57 return aItem && PCB_GROUP_T == aItem->Type();
58 }
59
60 wxString GetClass() const override
61 {
62 return wxT( "PCB_GROUP" );
63 }
64
65 wxString GetName() const { return m_name; }
66 void SetName( const wxString& aName ) { m_name = aName; }
67
68 std::unordered_set<BOARD_ITEM*>& GetItems()
69 {
70 return m_items;
71 }
72
73 const std::unordered_set<BOARD_ITEM*>& GetItems() const
74 {
75 return m_items;
76 }
77
83 bool AddItem( BOARD_ITEM* aItem );
84
90 bool RemoveItem( BOARD_ITEM* aItem );
91
92 void RemoveAll();
93
94 /*
95 * Search for highest level group inside of aScope, containing item.
96 *
97 * @param aScope restricts the search to groups within the group scope.
98 * @param isFootprintEditor true if we should stop promoting at the footprint level
99 * @return group inside of aScope, containing item, if exists, otherwise, nullptr
100 */
101 static PCB_GROUP* TopLevelGroup( BOARD_ITEM* aItem, PCB_GROUP* aScope, bool isFootprintEditor );
102
103 static bool WithinScope( BOARD_ITEM* aItem, PCB_GROUP* aScope, bool isFootprintEditor );
104
105#if defined( DEBUG )
106 void Show( int nestLevel, std::ostream& os ) const override
107 {
108 ShowDummy( os );
109 }
110#endif
111
113 VECTOR2I GetPosition() const override;
114
116 void SetPosition( const VECTOR2I& aNewpos ) override;
117
119 LSET GetLayerSet() const override;
120
122 void SetLayer( PCB_LAYER_ID aLayer ) override
123 {
124 wxFAIL_MSG( wxT( "groups don't support layer SetLayer" ) );
125 }
126
131 void SetLayerRecursive( PCB_LAYER_ID aLayer, int aDepth );
132
133 void SetLocked( bool aLocked ) override;
134
136 EDA_ITEM* Clone() const override;
137
138 /*
139 * Clone() this and all descendants
140 */
141 PCB_GROUP* DeepClone() const;
142
143 /*
144 * Duplicate() this and all descendants
145 */
146 PCB_GROUP* DeepDuplicate() const;
147
149 bool IsOnLayer( PCB_LAYER_ID aLayer ) const override;
150
152 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
153
155 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
156
158 const BOX2I GetBoundingBox() const override;
159
160 // @copydoc BOARD_ITEM::GetEffectiveShape
161 std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
162 FLASHING aFlash = FLASHING::DEFAULT ) const override;
163
165 INSPECT_RESULT Visit( INSPECTOR aInspector, void* aTestData,
166 const std::vector<KICAD_T>& aScanTypes ) override;
167
169 void ViewGetLayers( int aLayers[], int& aCount ) const override;
170
172 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
173
175 void Move( const VECTOR2I& aMoveVector ) override;
176
178 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
179
181 void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
182
184 wxString GetSelectMenuText( UNITS_PROVIDER* aUnitsProvider ) const override;
185
187 BITMAPS GetMenuImage() const override;
188
189
197 {
198 RunOnChildren( [&]( BOARD_ITEM* bItem )
199 {
200 aCommit.Add( bItem );
201 } );
202 }
203
204
206 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
207
215 void RunOnChildren( const std::function<void ( BOARD_ITEM* )>& aFunction ) const;
216
223 void RunOnDescendants( const std::function<void( BOARD_ITEM* )>& aFunction ) const;
224
230 static bool IsGroupableType( KICAD_T aType );
231
232protected:
234 void swapData( BOARD_ITEM* aImage ) override;
235
236private:
237 std::unordered_set<BOARD_ITEM*> m_items; // Members of the group
238 wxString m_name; // Optional group name
239};
240
241#endif // CLASS_PCB_GROUP_H_
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:58
COMMIT & Add(EDA_ITEM *aItem)
Notify observers that aItem has been added.
Definition: commit.h:78
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:85
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:69
LSET is a set of PCB_LAYER_IDs.
Definition: layer_ids.h:530
A set of BOARD_ITEMs (i.e., without duplicates).
Definition: pcb_group.h:51
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_group.cpp:276
std::unordered_set< BOARD_ITEM * > m_items
Definition: pcb_group.h:237
static bool WithinScope(BOARD_ITEM *aItem, PCB_GROUP *aScope, bool isFootprintEditor)
Definition: pcb_group.cpp:156
PCB_GROUP * DeepClone() const
Definition: pcb_group.cpp:219
static PCB_GROUP * TopLevelGroup(BOARD_ITEM *aItem, PCB_GROUP *aScope, bool isFootprintEditor)
Definition: pcb_group.cpp:150
void SetLayer(PCB_LAYER_ID aLayer) override
Set the layer this item is on.
Definition: pcb_group.h:122
std::unordered_set< BOARD_ITEM * > & GetItems()
Definition: pcb_group.h:68
static bool IsGroupableType(KICAD_T aType)
Check if the proposed type can be added to a group.
Definition: pcb_group.cpp:43
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Flip this object, i.e.
Definition: pcb_group.cpp:368
void SetLayerRecursive(PCB_LAYER_ID aLayer, int aDepth)
Set layer for all items within the group.
Definition: pcb_group.cpp:183
void RunOnChildren(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invoke a function on all members of the group.
Definition: pcb_group.cpp:407
wxString GetSelectMenuText(UNITS_PROVIDER *aUnitsProvider) const override
Return a pointer to an image to be used in menus.
Definition: pcb_group.cpp:382
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Move this object.
Definition: pcb_group.cpp:352
void RemoveAll()
Definition: pcb_group.cpp:108
bool IsOnLayer(PCB_LAYER_ID aLayer) const override
Test if aPosition is inside or on the boundary of this item.
Definition: pcb_group.cpp:332
PCB_GROUP * DeepDuplicate() const
Test to see if this object is on the given layer.
Definition: pcb_group.cpp:237
static bool ClassOf(const EDA_ITEM *aItem)
Definition: pcb_group.h:55
LSET GetLayerSet() const override
Set the layer this item is on.
Definition: pcb_group.cpp:321
void SetName(const wxString &aName)
Definition: pcb_group.h:66
void SetPosition(const VECTOR2I &aNewpos) override
Return a std::bitset of all layers on which the item physically resides.
Definition: pcb_group.cpp:175
void Move(const VECTOR2I &aMoveVector) override
Rotate this object.
Definition: pcb_group.cpp:361
wxString GetClass() const override
Return the class name.
Definition: pcb_group.h:60
INSPECT_RESULT Visit(INSPECTOR aInspector, void *aTestData, const std::vector< KICAD_T > &aScanTypes) override
Definition: pcb_group.cpp:305
bool RemoveItem(BOARD_ITEM *aItem)
Remove item from group.
Definition: pcb_group.cpp:95
std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: pcb_group.cpp:294
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: pcb_group.cpp:375
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_group.cpp:397
VECTOR2I GetPosition() const override
Definition: pcb_group.cpp:169
bool AddItem(BOARD_ITEM *aItem)
Add item to group.
Definition: pcb_group.cpp:80
void ViewGetLayers(int aLayers[], int &aCount) const override
Definition: pcb_group.cpp:345
const std::unordered_set< BOARD_ITEM * > & GetItems() const
Definition: pcb_group.h:73
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition: pcb_group.cpp:262
wxString GetName() const
Definition: pcb_group.h:65
void RunOnDescendants(const std::function< void(BOARD_ITEM *)> &aFunction) const
Invoke a function on all descendants of the group.
Definition: pcb_group.cpp:421
wxString m_name
Definition: pcb_group.h:238
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_group.cpp:211
PCB_GROUP(BOARD_ITEM *aParent)
Definition: pcb_group.cpp:37
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: pcb_group.cpp:391
void swapData(BOARD_ITEM *aImage) override
<
Definition: pcb_group.cpp:254
void AddChildrenToCommit(BOARD_COMMIT &aCommit)
Add all the immediate children of this group to the board commit.
Definition: pcb_group.h:196
void SetLocked(bool aLocked) override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_group.cpp:199
INSPECT_RESULT
Definition: eda_item.h:42
const INSPECTOR_FUNC & INSPECTOR
Definition: eda_item.h:78
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:59
@ UNDEFINED_LAYER
Definition: layer_ids.h:60
The Cairo implementation of the graphics abstraction layer.
Definition: color4d.cpp:266
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_GROUP_T
class PCB_GROUP, a set of BOARD_ITEMs
Definition: typeinfo.h:115