KiCad PCB EDA Suite
Loading...
Searching...
No Matches
eda_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) 2013-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 2008-2015 SoftPLC Corporation, Dick Hollenbeck <[email protected]>
6 * Copyright (C) 2008 Wayne Stambaugh <[email protected]>
7 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
8 *
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License
11 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, you may find one here:
21 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
22 * or you may search the http://www.gnu.org website for the version 2 license,
23 * or you may write to the Free Software Foundation, Inc.,
24 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
25 */
26
27#ifndef EDA_ITEM_H
28#define EDA_ITEM_H
29
30#include <deque>
31
33#include <api/serializable.h>
34#include <core/typeinfo.h>
35#include <eda_item_flags.h>
36#include <eda_search_data.h>
37#include <view/view_item.h>
38#include <kiid.h>
39
40enum class BITMAPS : unsigned int;
41
42
44{
45 QUIT,
47};
48
50{
53};
54
55#define IGNORE_PARENT_GROUP false
56
60class UNITS_PROVIDER;
61class EDA_DRAW_FRAME;
62class EDA_GROUP;
63class MSG_PANEL_ITEM;
64class EMBEDDED_FILES;
65
66namespace google { namespace protobuf { class Any; } }
67
68
88typedef std::function< INSPECT_RESULT ( EDA_ITEM* aItem, void* aTestData ) > INSPECTOR_FUNC;
89
92
93
98{
99public:
100 virtual ~EDA_ITEM() = default;
101
110 inline KICAD_T Type() const { return m_structType; }
111
112 EDA_ITEM* GetParent() const { return m_parent; }
113 virtual void SetParent( EDA_ITEM* aParent ) { m_parent = aParent; }
114
115 virtual void SetParentGroup( EDA_GROUP* aGroup ) { m_group = aGroup; }
116 virtual EDA_GROUP* GetParentGroup() const { return m_group; }
117
118 KIID GetParentGroupId() const;
119
120 virtual bool IsLocked() const { return false; }
121 virtual void SetLocked( bool aLocked ) {}
122
123 inline bool IsModified() const { return m_flags & IS_CHANGED; }
124 inline bool IsNew() const { return m_flags & IS_NEW; }
125 inline bool IsMoving() const { return m_flags & IS_MOVING; }
126
127 inline bool IsSelected() const { return m_flags & SELECTED; }
128 inline bool IsEntered() const { return m_flags & ENTERED; }
129 inline bool IsBrightened() const { return m_flags & BRIGHTENED; }
130
131 inline bool IsRollover() const { return m_isRollover; }
132 inline void SetIsRollover( bool aIsRollover ) { m_isRollover = aIsRollover; }
133
134 inline void SetSelected() { SetFlags( SELECTED ); }
135 inline void SetBrightened() { SetFlags( BRIGHTENED ); }
136
137 inline void ClearSelected() { ClearFlags( SELECTED ); }
139
140 void SetModified();
141
142 void SetFlags( EDA_ITEM_FLAGS aMask ) { m_flags |= aMask; }
143 void XorFlags( EDA_ITEM_FLAGS aMask ) { m_flags ^= aMask; }
145 EDA_ITEM_FLAGS GetFlags() const { return m_flags; }
146 bool HasFlag( EDA_ITEM_FLAGS aFlag ) const { return ( m_flags & aFlag ) == aFlag; }
147
149 {
150 constexpr int mask =
152
153 return m_flags & mask;
154 }
155
156 virtual void ClearEditFlags()
157 {
159 }
160
162 {
165
166 return m_flags & mask;
167 }
168
169 virtual void ClearTempFlags()
170 {
172 }
173
174 virtual bool RenderAsBitmap( double aWorldScale ) const { return false; }
175
176 void SetIsShownAsBitmap( bool aBitmap )
177 {
178 if( aBitmap )
180 else
182 }
183
184 inline bool IsShownAsBitmap() const { return m_flags & IS_SHOWN_AS_BITMAP; }
185
192 virtual bool IsType( const std::vector<KICAD_T>& aScanTypes ) const
193 {
194 for( KICAD_T scanType : aScanTypes )
195 {
196 if( scanType == SCH_LOCATE_ANY_T || scanType == m_structType )
197 return true;
198 }
199
200 return false;
201 }
202
210 void SetForceVisible( bool aEnable ) { m_forceVisible = aEnable; }
211 bool IsForceVisible() const { return m_forceVisible; }
212
220 virtual void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
221 {
222 }
223
224 virtual wxString GetFriendlyName() const;
225
233 virtual bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const
234 {
235 return false; // derived classes should override this function
236 }
237
246 virtual bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const
247 {
248 return false; // derived classes should override this function
249 }
250
258 virtual bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const
259 {
260 return false; // derived classes should override this function
261 }
262
270 virtual const BOX2I GetBoundingBox() const;
271
272 virtual VECTOR2I GetPosition() const { return VECTOR2I(); }
273 virtual void SetPosition( const VECTOR2I& aPos ){};
274
279 virtual const VECTOR2I GetFocusPosition() const { return GetPosition(); }
280
288 virtual VECTOR2I GetSortPosition() const { return GetPosition(); }
289
302 virtual EDA_ITEM* Clone() const;
303
318 virtual INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
319 const std::vector<KICAD_T>& aScanTypes );
320
324 template< class T >
325 static INSPECT_RESULT IterateForward( std::deque<T>& aList, INSPECTOR inspector, void* testData,
326 const std::vector<KICAD_T>& scanTypes )
327 {
328 for( const auto& it : aList )
329 {
330 EDA_ITEM* item = static_cast<EDA_ITEM*>( it );
331
332 if( item && item->Visit( inspector, testData, scanTypes ) == INSPECT_RESULT::QUIT )
333 {
334 return INSPECT_RESULT::QUIT;
335 }
336 }
337
338 return INSPECT_RESULT::CONTINUE;
339 }
340
344 template <class T>
345 static INSPECT_RESULT IterateForward( std::vector<T>& aList, INSPECTOR inspector,
346 void* testData, const std::vector<KICAD_T>& scanTypes )
347 {
348 for( const auto& it : aList )
349 {
350 EDA_ITEM* item = static_cast<EDA_ITEM*>( it );
351
352 if( item && item->Visit( inspector, testData, scanTypes ) == INSPECT_RESULT::QUIT )
353 {
354 return INSPECT_RESULT::QUIT;
355 }
356 }
357
358 return INSPECT_RESULT::CONTINUE;
359 }
360
365 wxString GetTypeDesc() const;
366
378 virtual wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const;
379
388 virtual BITMAPS GetMenuImage() const;
389
401 virtual bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const
402 {
403 return false;
404 }
405
415 static bool Replace( const EDA_SEARCH_DATA& aSearchData, wxString& aText );
416
428 virtual bool Replace( const EDA_SEARCH_DATA& aSearchData, void* aAuxData = nullptr )
429 {
430 return false;
431 }
432
439 virtual bool IsReplaceable() const { return false; }
440
447 bool operator<( const EDA_ITEM& aItem ) const;
448
457 static bool Sort( const EDA_ITEM* aLeft, const EDA_ITEM* aRight ) { return *aLeft < *aRight; }
458
462 EDA_ITEM& operator=( const EDA_ITEM& aItem );
463
464 virtual const BOX2I ViewBBox() const override;
465
466 virtual std::vector<int> ViewGetLayers() const override;
467
468 virtual EMBEDDED_FILES* GetEmbeddedFiles() { return nullptr; }
469 virtual const std::vector<wxString>* GetEmbeddedFonts() { return nullptr; }
470
471#if defined(DEBUG)
472
482 virtual void Show( int nestLevel, std::ostream& os ) const { ShowDummy( os ); };
483
484 void ShowDummy( std::ostream& os ) const;
485
493 static std::ostream& NestedSpace( int nestLevel, std::ostream& os );
494
495#endif
496
497protected:
498 EDA_ITEM( EDA_ITEM* parent, KICAD_T idType, bool isSCH_ITEM = false, bool isBOARD_ITEM = false );
499 EDA_ITEM( KICAD_T idType, bool isSCH_ITEM = false, bool isBOARD_ITEM = false );
500 EDA_ITEM( const EDA_ITEM& base );
501
511 bool Matches( const wxString& aText, const EDA_SEARCH_DATA& aSearchData ) const;
512
513 EDA_ITEM* findParent( KICAD_T aType ) const;
514
515public:
517
518private:
525
526protected:
532};
533
534
541inline EDA_ITEM* new_clone( const EDA_ITEM& aItem ) { return aItem.Clone(); }
542
547{
548 bool operator()(const EDA_ITEM* item1, const EDA_ITEM* item2) const
549 {
550 assert( item1 != nullptr && item2 != nullptr );
551
552 if( item1->m_Uuid == item2->m_Uuid )
553 return item1 < item2;
554
555 return item1->m_Uuid < item2->m_Uuid;
556 }
557};
558
559
566typedef std::vector< EDA_ITEM* > EDA_ITEMS;
567
568typedef std::set< EDA_ITEM*, CompareByUuid > EDA_ITEM_SET;
569
570#endif // EDA_ITEM_H
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
The base class for create windows for drawing purpose.
A set of EDA_ITEMs (i.e., without duplicates).
Definition: eda_group.h:46
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:98
virtual bool HitTest(const BOX2I &aRect, bool aContained, int aAccuracy=0) const
Test if aRect intersects this item.
Definition: eda_item.h:246
virtual VECTOR2I GetPosition() const
Definition: eda_item.h:272
virtual void ClearEditFlags()
Definition: eda_item.h:156
EDA_ITEM & operator=(const EDA_ITEM &aItem)
Assign the members of aItem to another object.
Definition: eda_item.cpp:329
virtual const VECTOR2I GetFocusPosition() const
Similar to GetPosition() but allows items to return their visual center rather than their anchor.
Definition: eda_item.h:279
virtual void SetPosition(const VECTOR2I &aPos)
Definition: eda_item.h:273
virtual void SetLocked(bool aLocked)
Definition: eda_item.h:121
virtual const BOX2I GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:110
wxString GetTypeDesc() const
Return a translated description of the type for this EDA_ITEM for display in user facing messages.
Definition: eda_item.cpp:393
static bool Sort(const EDA_ITEM *aLeft, const EDA_ITEM *aRight)
Helper function to be used by the C++ STL sort algorithm for sorting a STL container of EDA_ITEM poin...
Definition: eda_item.h:457
EDA_ITEM_FLAGS GetEditFlags() const
Definition: eda_item.h:148
void SetFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:142
virtual wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const
Return a user-visible description string of this item.
Definition: eda_item.cpp:144
void SetModified()
Definition: eda_item.cpp:100
const KIID m_Uuid
Definition: eda_item.h:516
bool m_forceVisible
Definition: eda_item.h:530
virtual EDA_GROUP * GetParentGroup() const
Definition: eda_item.h:116
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:110
bool IsEntered() const
Definition: eda_item.h:128
void ClearSelected()
Definition: eda_item.h:137
virtual const std::vector< wxString > * GetEmbeddedFonts()
Definition: eda_item.h:469
bool operator<(const EDA_ITEM &aItem) const
Test if another item is less than this object.
Definition: eda_item.cpp:320
void SetForceVisible(bool aEnable)
Set and clear force visible flag used to force the item to be drawn even if it's draw attribute is se...
Definition: eda_item.h:210
void ClearFlags(EDA_ITEM_FLAGS aMask=EDA_ITEM_ALL_FLAGS)
Definition: eda_item.h:144
void SetIsRollover(bool aIsRollover)
Definition: eda_item.h:132
virtual bool Replace(const EDA_SEARCH_DATA &aSearchData, void *aAuxData=nullptr)
Perform a text replace using the find and replace criteria in aSearchData on items that support text ...
Definition: eda_item.h:428
EDA_ITEM_FLAGS m_flags
Definition: eda_item.h:527
void SetIsShownAsBitmap(bool aBitmap)
Definition: eda_item.h:176
virtual std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
Definition: eda_item.cpp:353
EDA_ITEM_FLAGS GetTempFlags() const
Definition: eda_item.h:161
virtual bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:401
EDA_GROUP * m_group
The group this item belongs to, if any. No ownership implied.
Definition: eda_item.h:529
virtual void SetParentGroup(EDA_GROUP *aGroup)
Definition: eda_item.h:115
static INSPECT_RESULT IterateForward(std::deque< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
This changes first parameter to avoid the DList and use the main queue instead.
Definition: eda_item.h:325
bool IsSelected() const
Definition: eda_item.h:127
virtual void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList)
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: eda_item.h:220
KIID GetParentGroupId() const
Definition: eda_item.cpp:91
void SetSelected()
Definition: eda_item.h:134
virtual bool IsType(const std::vector< KICAD_T > &aScanTypes) const
Check whether the item is one of the listed types.
Definition: eda_item.h:192
virtual INSPECT_RESULT Visit(INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &aScanTypes)
May be re-implemented for each derived class in order to handle all the types given by its member dat...
Definition: eda_item.cpp:127
virtual void SetParent(EDA_ITEM *aParent)
Definition: eda_item.h:113
bool IsModified() const
Definition: eda_item.h:123
bool IsShownAsBitmap() const
Definition: eda_item.h:184
void ClearBrightened()
Definition: eda_item.h:138
void SetBrightened()
Definition: eda_item.h:135
virtual bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const
Test if aPosition is inside or on the boundary of this item.
Definition: eda_item.h:233
virtual wxString GetFriendlyName() const
Definition: eda_item.cpp:402
EDA_ITEM * GetParent() const
Definition: eda_item.h:112
bool m_isRollover
Definition: eda_item.h:531
bool IsRollover() const
Definition: eda_item.h:131
virtual ~EDA_ITEM()=default
virtual EDA_ITEM * Clone() const
Create a duplicate of this item with linked list members set to NULL.
Definition: eda_item.cpp:118
bool HasFlag(EDA_ITEM_FLAGS aFlag) const
Definition: eda_item.h:146
virtual EMBEDDED_FILES * GetEmbeddedFiles()
Definition: eda_item.h:468
bool IsBrightened() const
Definition: eda_item.h:129
virtual VECTOR2I GetSortPosition() const
Return the coordinates that should be used for sorting this element visually compared to other elemen...
Definition: eda_item.h:288
void XorFlags(EDA_ITEM_FLAGS aMask)
Definition: eda_item.h:143
virtual const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: eda_item.cpp:346
virtual bool RenderAsBitmap(double aWorldScale) const
Definition: eda_item.h:174
virtual bool IsLocked() const
Definition: eda_item.h:120
static INSPECT_RESULT IterateForward(std::vector< T > &aList, INSPECTOR inspector, void *testData, const std::vector< KICAD_T > &scanTypes)
Change first parameter to avoid the DList and use std::vector instead.
Definition: eda_item.h:345
EDA_ITEM * m_parent
Owner.
Definition: eda_item.h:528
bool IsForceVisible() const
Definition: eda_item.h:211
virtual bool HitTest(const SHAPE_LINE_CHAIN &aPoly, bool aContained) const
Test if aPoly intersects this item.
Definition: eda_item.h:258
EDA_ITEM_FLAGS GetFlags() const
Definition: eda_item.h:145
static bool Replace(const EDA_SEARCH_DATA &aSearchData, wxString &aText)
Perform a text replace on aText using the find and replace criteria in aSearchData on items that supp...
Definition: eda_item.cpp:237
bool IsMoving() const
Definition: eda_item.h:125
KICAD_T m_structType
Run time identification, keep private so it can never be changed after a ctor sets it.
Definition: eda_item.h:524
bool IsNew() const
Definition: eda_item.h:124
virtual bool IsReplaceable() const
Override this method in any derived object that supports test find and replace.
Definition: eda_item.h:439
virtual void ClearTempFlags()
Definition: eda_item.h:169
EDA_ITEM * findParent(KICAD_T aType) const
Definition: eda_item.cpp:75
virtual BITMAPS GetMenuImage() const
Return a pointer to an image to be used in menus.
Definition: eda_item.cpp:361
An abstract base class for deriving all objects that can be added to a VIEW.
Definition: view_item.h:86
Definition: kiid.h:49
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
Interface for objects that can be serialized to Protobuf messages.
Definition: serializable.h:37
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
EDA_ITEM * new_clone(const EDA_ITEM &aItem)
Provide cloning capabilities for all Boost pointer containers of EDA_ITEM pointers.
Definition: eda_item.h:541
RECURSE_MODE
Definition: eda_item.h:50
@ RECURSE
Definition: eda_item.h:51
@ NO_RECURSE
Definition: eda_item.h:52
INSPECT_RESULT
Definition: eda_item.h:44
std::vector< EDA_ITEM * > EDA_ITEMS
Define list of drawing items for screens.
Definition: eda_item.h:566
std::set< EDA_ITEM *, CompareByUuid > EDA_ITEM_SET
Definition: eda_item.h:568
const INSPECTOR_FUNC & INSPECTOR
std::function passed to nested users by ref, avoids copying std::function.
Definition: eda_item.h:91
std::function< INSPECT_RESULT(EDA_ITEM *aItem, void *aTestData) > INSPECTOR_FUNC
Used to inspect and possibly collect the (search) results of iterating over a list or tree of KICAD_T...
Definition: eda_item.h:88
#define IS_PASTED
Modifier on IS_NEW which indicates it came from clipboard.
#define IS_CHANGED
Item was edited, and modified.
#define BRIGHTENED
item is drawn with a bright contour
#define IS_SHOWN_AS_BITMAP
#define IS_NEW
New item, just created.
#define IS_LINKED
Used in calculation to mark linked items (temporary use)
#define SELECTED
Item was manually selected by the user.
#define SELECTED_BY_DRAG
Item was algorithmically selected as a dragged item.
#define SELECTION_CANDIDATE
indicates an item is a candidate for selection
#define CONNECTIVITY_CANDIDATE
flag indicating that the structure is connected for connectivity
#define EDA_ITEM_ALL_FLAGS
#define IS_BROKEN
Is a segment just broken by BreakSegment.
#define ENTERED
indicates a group has been entered
#define STRUCT_DELETED
flag indication structures to be erased
#define SKIP_STRUCT
flag indicating that the structure should be ignored
std::uint32_t EDA_ITEM_FLAGS
#define CANDIDATE
flag indicating that the structure is connected
#define IS_MOVING
Item being moved.
Comparison functor for sorting EDA_ITEM pointers by their UUID.
Definition: eda_item.h:547
bool operator()(const EDA_ITEM *item1, const EDA_ITEM *item2) const
Definition: eda_item.h:548
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ SCH_LOCATE_ANY_T
Definition: typeinfo.h:200
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:695