KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_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) 2004 Jean-Pierre Charras, [email protected]
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#include <unordered_map>
28#include <unordered_set>
29#include <map>
30#include <set>
31
32#include <eda_item.h>
33#include <sch_sheet_path.h>
34#include <netclass.h>
35#include <stroke_params.h>
36#include <layer_ids.h>
37#include <sch_render_settings.h>
38#include <plotters/plotter.h>
39
41class SCH_CONNECTION;
42class SCH_SHEET_PATH;
43class SCHEMATIC;
44class SCH_COMMIT;
45class SYMBOL;
46class LINE_READER;
47class SCH_EDIT_FRAME;
48class SCH_RULE_AREA;
49struct SCH_PLOT_OPTS;
50
51namespace KIFONT
52{
53class METRICS;
54}
55
56
57enum BODY_STYLE : int
58{
59 BASE = 1,
61};
62
63
64#define MINIMUM_SELECTION_DISTANCE 2 // Minimum selection distance in mils
65
66
68{
69 AUTOPLACE_NONE, // No autoplacement
70 AUTOPLACE_AUTO, // A minimalist placement algorithm.
71 AUTOPLACE_MANUAL // A more involved routine that can be annoying if done from the get go.
72 // Initiated by a hotkey or menu item.
73};
74
75
89
90
96{
97public:
98 DANGLING_END_ITEM( DANGLING_END_T aType, EDA_ITEM* aItem, const VECTOR2I& aPosition )
99 {
100 m_item = aItem;
101 m_type = aType;
102 m_pos = aPosition;
103 m_parent = aItem;
104 }
105
106 DANGLING_END_ITEM( DANGLING_END_T aType, EDA_ITEM* aItem, const VECTOR2I& aPosition,
107 const EDA_ITEM* aParent )
108 {
109 m_item = aItem;
110 m_type = aType;
111 m_pos = aPosition;
112 m_parent = aParent;
113 }
114
115 bool operator==( const DANGLING_END_ITEM& aB ) const
116 {
117 return GetItem() == aB.GetItem()
118 && GetPosition() == aB.GetPosition()
119 && GetType() == aB.GetType()
120 && GetParent() == aB.GetParent();
121 }
122
123 bool operator<( const DANGLING_END_ITEM& rhs ) const
124 {
125 return( m_pos.x < rhs.m_pos.x || ( m_pos.x == rhs.m_pos.x && m_pos.y < rhs.m_pos.y )
126 || ( m_pos == rhs.m_pos && m_item < rhs.m_item ) );
127 }
128
129 VECTOR2I GetPosition() const { return m_pos; }
130 EDA_ITEM* GetItem() const { return m_item; }
131 const EDA_ITEM* GetParent() const { return m_parent; }
132 DANGLING_END_T GetType() const { return m_type; }
133
134private:
139};
140
141
143{
144public:
145 static std::vector<DANGLING_END_ITEM>::iterator
146 get_lower_pos( std::vector<DANGLING_END_ITEM>& aItemListByPos, const VECTOR2I& aPos );
147
148 static std::vector<DANGLING_END_ITEM>::iterator
149 get_lower_type( std::vector<DANGLING_END_ITEM>& aItemListByType, const DANGLING_END_T& aType );
150
152 static void sort_dangling_end_items( std::vector<DANGLING_END_ITEM>& aItemListByType,
153 std::vector<DANGLING_END_ITEM>& aItemListByPos );
154};
155
156typedef std::vector<SCH_ITEM*> SCH_ITEM_VEC;
157
158
166class SCH_ITEM : public EDA_ITEM
167{
168public:
169 SCH_ITEM( EDA_ITEM* aParent, KICAD_T aType, int aUnit = 0, int aBodyStyle = 0 );
170
171 SCH_ITEM( const SCH_ITEM& aItem );
172
173 SCH_ITEM& operator=( const SCH_ITEM& aPin );
174
175 virtual ~SCH_ITEM();
176
177 wxString GetClass() const override
178 {
179 return wxT( "SCH_ITEM" );
180 }
181
182 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
183 {
184 if( EDA_ITEM::IsType( aScanTypes ) )
185 return true;
186
187 for( KICAD_T scanType : aScanTypes )
188 {
189 if( scanType == SCH_ITEM_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
190 return true;
191
192 if ( scanType == SCH_ITEM_LOCATE_BUS_T && m_layer == LAYER_BUS )
193 return true;
194
195 if ( scanType == SCH_ITEM_LOCATE_GRAPHIC_LINE_T
196 && Type() == SCH_LINE_T && m_layer == LAYER_NOTES )
197 {
198 return true;
199 }
200 }
201
202 return false;
203 }
204
205 bool IsGroupableType() const;
206
217 void SwapItemData( SCH_ITEM* aImage );
218
222 void SwapFlags( SCH_ITEM* aItem );
223
235 SCH_ITEM* Duplicate( bool addToParentGroup, SCH_COMMIT* aCommit = nullptr, bool doClone = false ) const;
236
237 virtual void SetUnit( int aUnit ) { m_unit = aUnit; }
238 int GetUnit() const { return m_unit; }
239
240 virtual wxString GetUnitDisplayName( int aUnit, bool aLabel ) const;
241 virtual wxString GetBodyStyleDescription( int aBodyStyle, bool aLabel ) const;
242
243 virtual void SetBodyStyle( int aBodyStyle ) { m_bodyStyle = aBodyStyle; }
244 int GetBodyStyle() const { return m_bodyStyle; }
245
246 virtual void SetBodyStyleProp( const wxString& aBodyStyle );
247 virtual wxString GetBodyStyleProp() const;
248
249 void SetPrivate( bool aPrivate ) { m_private = aPrivate; }
250 bool IsPrivate() const { return m_private; }
251
252 virtual void SetExcludedFromSim( bool aExclude ) { }
253 virtual bool GetExcludedFromSim() const { return false; }
254 bool ResolveExcludedFromSim() const;
255
256 virtual void SetExcludedFromBOM( bool aExcludeFromBOM ) { }
257 virtual bool GetExcludedFromBOM() const { return false; }
258 bool ResolveExcludedFromBOM() const;
259
260 virtual void SetExcludedFromBoard( bool aExcludeFromBoard ) { }
261 virtual bool GetExcludedFromBoard() const { return false; }
262 bool ResolveExcludedFromBoard() const;
263
264 virtual void SetDNP( bool aDNP ) { }
265 virtual bool GetDNP() const { return false; }
266 bool ResolveDNP() const;
267
277 virtual bool IsMovableFromAnchorPoint() const { return true; }
278
280 void SetStoredPos( const VECTOR2I& aPos ) { m_storedPos = aPos; }
281
294 SCHEMATIC* Schematic() const;
295
296 const SYMBOL* GetParentSymbol() const;
298
302 virtual bool IsHypertext() const { return false; }
303
304 virtual void DoHypertextAction( EDA_DRAW_FRAME* aFrame ) const { }
305
309 SCH_LAYER_ID GetLayer() const { return m_layer; }
310 void SetLayer( SCH_LAYER_ID aLayer ) { m_layer = aLayer; }
311
315 std::vector<int> ViewGetLayers() const override;
316
320 virtual int GetPenWidth() const { return 0; }
321
322 int GetEffectivePenWidth( const SCH_RENDER_SETTINGS* aSettings ) const;
323
324 const wxString& GetDefaultFont( const RENDER_SETTINGS* aSettings ) const;
325
326 const KIFONT::METRICS& GetFontMetrics() const;
327
328 bool RenderAsBitmap( double aWorldScale ) const override;
329
336 virtual double Similarity( const SCH_ITEM& aItem ) const
337 {
338 wxCHECK_MSG( false, 0.0, wxT( "Similarity not implemented in " ) + GetClass() );
339 }
340
346 double SimilarityBase( const SCH_ITEM& aItem ) const
347 {
348 double similarity = 1.0;
349
350 if( m_unit != aItem.m_unit )
351 similarity *= 0.9;
352
353 if( m_bodyStyle != aItem.m_bodyStyle )
354 similarity *= 0.9;
355
356 if( m_private != aItem.m_private )
357 similarity *= 0.9;
358
359 return similarity;
360 }
361
365 virtual void Move( const VECTOR2I& aMoveVector )
366 {
367 wxCHECK_MSG( false, /*void*/, wxT( "Move not implemented in " ) + GetClass() );
368 }
369
373 virtual void MirrorHorizontally( int aCenter )
374 {
375 wxCHECK_MSG( false, /*void*/, wxT( "MirrorHorizontally not implemented in " ) + GetClass() );
376 }
377
381 virtual void MirrorVertically( int aCenter )
382 {
383 wxCHECK_MSG( false, /*void*/, wxT( "MirrorVertically not implemented in " ) + GetClass() );
384 }
385
389 virtual void Rotate( const VECTOR2I& aCenter, bool aRotateCCW )
390 {
391 wxCHECK_MSG( false, /*void*/, wxT( "Rotate not implemented in " ) + GetClass() );
392 }
393
403 virtual void BeginEdit( const VECTOR2I& aPosition ) {}
404
415 virtual bool ContinueEdit( const VECTOR2I& aPosition ) { return false; }
416
422 virtual void EndEdit( bool aClosed = false ) {}
423
433 virtual void CalcEdit( const VECTOR2I& aPosition ) {}
434
445 virtual void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) {}
446
465 virtual bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
466 std::vector<DANGLING_END_ITEM>& aItemListByPos,
467 const SCH_SHEET_PATH* aSheet = nullptr )
468 {
469 return false;
470 }
471
484 virtual bool IsEndPoint( const VECTOR2I& aPt ) const { return false; }
485
486 virtual bool IsDangling() const { return false; }
487
488 virtual bool CanConnect( const SCH_ITEM* aItem ) const { return m_layer == aItem->GetLayer(); }
489
493 virtual bool IsConnectable() const { return false; }
494
499 virtual bool IsPointClickableAnchor( const VECTOR2I& aPos ) const { return false; }
500
508 virtual std::vector<VECTOR2I> GetConnectionPoints() const { return {}; }
509
516 bool IsConnected( const VECTOR2I& aPoint ) const;
517
523 SCH_CONNECTION* Connection( const SCH_SHEET_PATH* aSheet = nullptr ) const;
524
528 const SCH_ITEM_VEC& ConnectedItems( const SCH_SHEET_PATH& aPath );
529
533 void AddConnectionTo( const SCH_SHEET_PATH& aPath, SCH_ITEM* aItem );
534
538 void ClearConnectedItems( const SCH_SHEET_PATH& aPath );
539
546
548
552 virtual bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const { return true; }
553
555
556 void SetConnectivityDirty( bool aDirty = true ) { m_connectivity_dirty = aDirty; }
557
573 virtual bool HasConnectivityChanges( const SCH_ITEM* aItem,
574 const SCH_SHEET_PATH* aInstance = nullptr ) const
575 {
576 return false;
577 }
578
580 void SetConnectionGraph( CONNECTION_GRAPH* aGraph );
581
582 virtual bool HasCachedDriverName() const { return false; }
583 virtual const wxString& GetCachedDriverName() const;
584
585 virtual void SetLastResolvedState( const SCH_ITEM* aItem ) { }
586
587 std::shared_ptr<NETCLASS> GetEffectiveNetClass( const SCH_SHEET_PATH* aSheet = nullptr ) const;
588
594
595 virtual void AutoplaceFields( SCH_SCREEN* aScreen, AUTOPLACE_ALGO aAlgo ) { }
596
597 virtual void RunOnChildren( const std::function<void( SCH_ITEM* )>& aFunction, RECURSE_MODE aMode ) { }
598
599 virtual void ClearCaches();
600
608 virtual bool HasLineStroke() const { return false; }
609
610 virtual STROKE_PARAMS GetStroke() const { wxCHECK( false, STROKE_PARAMS() ); }
611
612 virtual void SetStroke( const STROKE_PARAMS& aStroke ) { wxCHECK( false, /* void */ ); }
613
614 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
615
626 virtual void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
627 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed)
628 {
629 wxCHECK_MSG( false, /*void*/, wxT( "Plot not implemented in " ) + GetClass() );
630 }
631
636
640 void AddRuleAreaToCache( SCH_RULE_AREA* aRuleArea ) { m_rule_areas_cache.insert( aRuleArea ); }
641
645 const std::unordered_set<SCH_RULE_AREA*>& GetRuleAreaCache() const
646 {
647 return m_rule_areas_cache;
648 }
649
650 const std::vector<wxString>* GetEmbeddedFonts() override;
651
666 enum COMPARE_FLAGS : int
667 {
668 UNIT = 0x01,
669 EQUALITY = 0x02,
670 ERC = 0x04,
672 };
673
674 virtual bool operator==( const SCH_ITEM& aOther ) const;
675
676 virtual bool operator<( const SCH_ITEM& aItem ) const;
677
678protected:
686 virtual void swapData( SCH_ITEM* aItem );
687
689 {
690 return static_cast<SCH_RENDER_SETTINGS*>( aPlotter->RenderSettings() );
691 }
692
694 {
695 bool operator()( const SCH_ITEM* aFirst, const SCH_ITEM* aSecond ) const;
696 };
697
718 virtual int compare( const SCH_ITEM& aOther, int aCompareFlags = 0 ) const;
719
720private:
721 friend class CONNECTION_GRAPH;
722
736 virtual bool doIsConnected( const VECTOR2I& aPosition ) const { return false; }
737
738protected:
740 int m_unit; // set to 0 if common to all units
741 int m_bodyStyle; // set to 0 if common to all body styles
742 bool m_private; // only shown in Symbol Editor
743 AUTOPLACE_ALGO m_fieldsAutoplaced; // indicates status of field autoplacement
744 VECTOR2I m_storedPos; // temp variable used in some move commands to store
745 // an initial position of the item or mouse cursor
746
748 std::map<SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMP> m_connected_items;
749
751 std::unordered_map<SCH_SHEET_PATH, SCH_CONNECTION*> m_connection_map;
752
754
756 std::unordered_set<SCH_RULE_AREA*> m_rule_areas_cache;
757
758private:
759 friend class LIB_SYMBOL;
760};
761
762#ifndef SWIG
764#endif
Calculate the connectivity of a schematic and generates netlists.
static std::vector< DANGLING_END_ITEM >::iterator get_lower_type(std::vector< DANGLING_END_ITEM > &aItemListByType, const DANGLING_END_T &aType)
Definition sch_item.cpp:786
static std::vector< DANGLING_END_ITEM >::iterator get_lower_pos(std::vector< DANGLING_END_ITEM > &aItemListByPos, const VECTOR2I &aPos)
Definition sch_item.cpp:775
static void sort_dangling_end_items(std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos)
Both contain the same information.
Definition sch_item.cpp:796
const EDA_ITEM * m_parent
A pointer to the parent object (in the case of pins).
Definition sch_item.h:138
bool operator==(const DANGLING_END_ITEM &aB) const
Definition sch_item.h:115
DANGLING_END_T m_type
The type of connection of m_item.
Definition sch_item.h:137
DANGLING_END_ITEM(DANGLING_END_T aType, EDA_ITEM *aItem, const VECTOR2I &aPosition)
Definition sch_item.h:98
DANGLING_END_T GetType() const
Definition sch_item.h:132
bool operator<(const DANGLING_END_ITEM &rhs) const
Definition sch_item.h:123
DANGLING_END_ITEM(DANGLING_END_T aType, EDA_ITEM *aItem, const VECTOR2I &aPosition, const EDA_ITEM *aParent)
Definition sch_item.h:106
VECTOR2I m_pos
The position of the connection point.
Definition sch_item.h:136
const EDA_ITEM * GetParent() const
Definition sch_item.h:131
EDA_ITEM * GetItem() const
Definition sch_item.h:130
EDA_ITEM * m_item
A pointer to the connectable object.
Definition sch_item.h:135
VECTOR2I GetPosition() const
Definition sch_item.h:129
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:98
KICAD_T Type() const
Returns the type of object.
Definition eda_item.h:110
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
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:39
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition richio.h:93
Base plotter engine class.
Definition plotter.h:121
RENDER_SETTINGS * RenderSettings()
Definition plotter.h:152
Holds all the data relating to one schematic.
Definition schematic.h:88
Each graphical item can have a SCH_CONNECTION describing its logical connection (to a bus or net).
Schematic editor (Eeschema) main window.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition sch_item.h:167
virtual bool GetExcludedFromSim() const
Definition sch_item.h:253
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 sch_item.cpp:637
void SetStoredPos(const VECTOR2I &aPos)
Definition sch_item.h:280
friend class CONNECTION_GRAPH
Definition sch_item.h:721
VECTOR2I m_storedPos
Definition sch_item.h:744
SCH_ITEM * Duplicate(bool addToParentGroup, SCH_COMMIT *aCommit=nullptr, bool doClone=false) const
Routine to create a new copy of given item.
Definition sch_item.cpp:137
virtual void SetBodyStyle(int aBodyStyle)
Definition sch_item.h:243
virtual bool CanConnect(const SCH_ITEM *aItem) const
Definition sch_item.h:488
virtual bool IsEndPoint(const VECTOR2I &aPt) const
Test if aPt is an end point of this schematic object.
Definition sch_item.h:484
virtual bool IsConnectable() const
Definition sch_item.h:493
virtual void AutoplaceFields(SCH_SCREEN *aScreen, AUTOPLACE_ALGO aAlgo)
Definition sch_item.h:595
int m_unit
Definition sch_item.h:740
virtual int GetPenWidth() const
Definition sch_item.h:320
const SCH_ITEM_VEC & ConnectedItems(const SCH_SHEET_PATH &aPath)
Retrieve the set of items connected to this item on the given sheet.
Definition sch_item.cpp:382
SCH_ITEM & operator=(const SCH_ITEM &aPin)
Definition sch_item.cpp:75
void ClearConnectedItems(const SCH_SHEET_PATH &aPath)
Clear all connections to this item.
Definition sch_item.cpp:373
virtual bool doIsConnected(const VECTOR2I &aPosition) const
Provide the object specific test to see if it is connected to aPosition.
Definition sch_item.h:736
virtual void RunOnChildren(const std::function< void(SCH_ITEM *)> &aFunction, RECURSE_MODE aMode)
Definition sch_item.h:597
int m_bodyStyle
Definition sch_item.h:741
virtual void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList)
Add the schematic item end points to aItemList if the item has end points.
Definition sch_item.h:445
virtual void SetExcludedFromBoard(bool aExcludeFromBoard)
Definition sch_item.h:260
const std::vector< wxString > * GetEmbeddedFonts() override
Definition sch_item.cpp:655
SCH_RENDER_SETTINGS * getRenderSettings(PLOTTER *aPlotter) const
Definition sch_item.h:688
virtual bool UpdateDanglingState(std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos, const SCH_SHEET_PATH *aSheet=nullptr)
Test the schematic item to aItemList to check if it's dangling state has changed.
Definition sch_item.h:465
virtual ~SCH_ITEM()
Definition sch_item.cpp:88
const SYMBOL * GetParentSymbol() const
Definition sch_item.cpp:223
virtual wxString GetBodyStyleDescription(int aBodyStyle, bool aLabel) const
Definition sch_item.cpp:179
void SetPrivate(bool aPrivate)
Definition sch_item.h:249
virtual void swapData(SCH_ITEM *aItem)
Swap the internal data structures aItem with the schematic item.
Definition sch_item.cpp:450
virtual const wxString & GetCachedDriverName() const
Definition sch_item.cpp:443
SCHEMATIC * Schematic() const
Search the item hierarchy to find a SCHEMATIC.
Definition sch_item.cpp:217
virtual void SetLastResolvedState(const SCH_ITEM *aItem)
Definition sch_item.h:585
int GetBodyStyle() const
Definition sch_item.h:244
virtual double Similarity(const SCH_ITEM &aItem) const
Return a measure of how likely the other object is to represent the same object.
Definition sch_item.h:336
virtual bool IsDangling() const
Definition sch_item.h:486
virtual bool IsPointClickableAnchor(const VECTOR2I &aPos) const
Definition sch_item.h:499
std::vector< int > ViewGetLayers() const override
Return the layers the item is drawn on (which may be more than its "home" layer)
Definition sch_item.cpp:307
virtual bool ContinueEdit(const VECTOR2I &aPosition)
Continue an edit in progress at aPosition.
Definition sch_item.h:415
virtual void MirrorHorizontally(int aCenter)
Mirror item horizontally about aCenter.
Definition sch_item.h:373
bool ResolveExcludedFromBOM() const
Definition sch_item.cpp:262
const std::unordered_set< SCH_RULE_AREA * > & GetRuleAreaCache() const
Get the cache of rule areas enclosing this item.
Definition sch_item.h:645
SCH_CONNECTION * InitializeConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Create a new connection object associated with this object.
Definition sch_item.cpp:404
virtual wxString GetUnitDisplayName(int aUnit, bool aLabel) const
Definition sch_item.cpp:168
void AddConnectionTo(const SCH_SHEET_PATH &aPath, SCH_ITEM *aItem)
Add a connection link between this item and another.
Definition sch_item.cpp:388
friend class LIB_SYMBOL
Definition sch_item.h:759
virtual void Move(const VECTOR2I &aMoveVector)
Move the item by aMoveVector to a new position.
Definition sch_item.h:365
COMPARE_FLAGS
The list of flags used by the compare function.
Definition sch_item.h:667
@ SKIP_TST_POS
Definition sch_item.h:671
int GetUnit() const
Definition sch_item.h:238
std::shared_ptr< NETCLASS > GetEffectiveNetClass(const SCH_SHEET_PATH *aSheet=nullptr) const
Definition sch_item.cpp:352
bool ResolveExcludedFromBoard() const
Definition sch_item.cpp:277
virtual void CalcEdit(const VECTOR2I &aPosition)
Calculate the attributes of an item at aPosition when it is being edited.
Definition sch_item.h:433
virtual bool GetDNP() const
Definition sch_item.h:265
virtual bool operator==(const SCH_ITEM &aOther) const
Definition sch_item.cpp:517
bool m_connectivity_dirty
Definition sch_item.h:753
virtual bool GetExcludedFromBOM() const
Definition sch_item.h:257
bool IsPrivate() const
Definition sch_item.h:250
virtual void ClearCaches()
Definition sch_item.cpp:497
void SetLayer(SCH_LAYER_ID aLayer)
Definition sch_item.h:310
void AddRuleAreaToCache(SCH_RULE_AREA *aRuleArea)
Add a rule area to the item's cache.
Definition sch_item.h:640
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition sch_item.h:309
void ClearRuleAreasCache()
Reset the cache of rule areas (called prior to schematic connectivity computation)
Definition sch_item.h:635
virtual bool GetExcludedFromBoard() const
Definition sch_item.h:261
virtual void SetStroke(const STROKE_PARAMS &aStroke)
Definition sch_item.h:612
virtual void SetBodyStyleProp(const wxString &aBodyStyle)
Definition sch_item.cpp:189
void SetConnectivityDirty(bool aDirty=true)
Definition sch_item.h:556
virtual int compare(const SCH_ITEM &aOther, int aCompareFlags=0) const
Provide the draw object specific comparison called by the == and < operators.
Definition sch_item.cpp:541
virtual wxString GetBodyStyleProp() const
Definition sch_item.cpp:211
void SetFieldsAutoplaced(AUTOPLACE_ALGO aAlgo)
Definition sch_item.h:593
bool RenderAsBitmap(double aWorldScale) const override
Definition sch_item.cpp:625
virtual void Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed)
Plot the item to aPlotter.
Definition sch_item.h:626
virtual void Rotate(const VECTOR2I &aCenter, bool aRotateCCW)
Rotate the item around aCenter 90 degrees in the clockwise direction.
Definition sch_item.h:389
const wxString & GetDefaultFont(const RENDER_SETTINGS *aSettings) const
Definition sch_item.cpp:580
bool IsConnectivityDirty() const
Definition sch_item.h:554
virtual void SetExcludedFromSim(bool aExclude)
Definition sch_item.h:252
virtual void SetExcludedFromBOM(bool aExcludeFromBOM)
Definition sch_item.h:256
void SetConnectionGraph(CONNECTION_GRAPH *aGraph)
Update the connection graph for all connections in this item.
Definition sch_item.cpp:340
virtual void SetUnit(int aUnit)
Definition sch_item.h:237
AUTOPLACE_ALGO m_fieldsAutoplaced
Definition sch_item.h:743
std::unordered_set< SCH_RULE_AREA * > m_rule_areas_cache
Store pointers to rule areas which this item is contained within.
Definition sch_item.h:756
void SwapFlags(SCH_ITEM *aItem)
Swap the non-temp and non-edit flags.
Definition sch_item.cpp:476
bool IsConnected(const VECTOR2I &aPoint) const
Test the item to see if it is connected to aPoint.
Definition sch_item.cpp:314
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
Definition sch_item.cpp:51
std::unordered_map< SCH_SHEET_PATH, SCH_CONNECTION * > m_connection_map
Store connectivity information, per sheet.
Definition sch_item.h:751
virtual bool HasCachedDriverName() const
Definition sch_item.h:582
virtual bool operator<(const SCH_ITEM &aItem) const
Definition sch_item.cpp:526
bool m_private
Definition sch_item.h:742
virtual bool IsHypertext() const
Allow items to support hypertext actions when hovered/clicked.
Definition sch_item.h:302
SCH_CONNECTION * GetOrInitConnection(const SCH_SHEET_PATH &aPath, CONNECTION_GRAPH *aGraph)
Definition sch_item.cpp:428
virtual bool IsMovableFromAnchorPoint() const
Check if object is movable from the anchor point.
Definition sch_item.h:277
virtual bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const
Check if aItem has connectivity changes against this object.
Definition sch_item.h:573
AUTOPLACE_ALGO GetFieldsAutoplaced() const
Return whether the fields have been automatically placed.
Definition sch_item.h:592
SCH_CONNECTION * Connection(const SCH_SHEET_PATH *aSheet=nullptr) const
Retrieve the connection associated with this object in the given sheet.
Definition sch_item.cpp:323
virtual void DoHypertextAction(EDA_DRAW_FRAME *aFrame) const
Definition sch_item.h:304
wxString GetClass() const override
Return the class name.
Definition sch_item.h:177
VECTOR2I & GetStoredPos()
Definition sch_item.h:279
bool ResolveExcludedFromSim() const
Definition sch_item.cpp:247
virtual void EndEdit(bool aClosed=false)
End an object editing action.
Definition sch_item.h:422
const KIFONT::METRICS & GetFontMetrics() const
Definition sch_item.cpp:593
std::map< SCH_SHEET_PATH, SCH_ITEM_VEC, SHEET_PATH_CMP > m_connected_items
Store pointers to other items that are connected to this one, per sheet.
Definition sch_item.h:748
int GetEffectivePenWidth(const SCH_RENDER_SETTINGS *aSettings) const
Definition sch_item.cpp:602
virtual STROKE_PARAMS GetStroke() const
Definition sch_item.h:610
virtual void BeginEdit(const VECTOR2I &aPosition)
Begin drawing a symbol library draw item at aPosition.
Definition sch_item.h:403
virtual void SetDNP(bool aDNP)
Definition sch_item.h:264
bool IsGroupableType() const
Definition sch_item.cpp:105
void SwapItemData(SCH_ITEM *aImage)
Swap data between aItem and aImage.
Definition sch_item.cpp:456
SCH_LAYER_ID m_layer
Definition sch_item.h:739
virtual bool HasLineStroke() const
Check if this schematic item has line stoke properties.
Definition sch_item.h:608
virtual bool ConnectionPropagatesTo(const EDA_ITEM *aItem) const
Return true if this item should propagate connection info to aItem.
Definition sch_item.h:552
virtual std::vector< VECTOR2I > GetConnectionPoints() const
Add all the connection points for this item to aPoints.
Definition sch_item.h:508
double SimilarityBase(const SCH_ITEM &aItem) const
Calculate the boilerplate similarity for all LIB_ITEMs without preventing the use above of a pure vir...
Definition sch_item.h:346
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition sch_item.h:182
virtual void MirrorVertically(int aCenter)
Mirror item vertically about aCenter.
Definition sch_item.h:381
bool ResolveDNP() const
Definition sch_item.cpp:292
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Simple container to manage line stroke parameters.
A base class for LIB_SYMBOL and SCH_SYMBOL.
Definition symbol.h:63
RECURSE_MODE
Definition eda_item.h:50
SCH_LAYER_ID
Eeschema drawing layers.
Definition layer_ids.h:448
@ LAYER_WIRE
Definition layer_ids.h:451
@ LAYER_NOTES
Definition layer_ids.h:466
@ LAYER_BUS
Definition layer_ids.h:452
#define DECLARE_ENUM_TO_WXANY(type)
Definition property.h:765
AUTOPLACE_ALGO
Definition sch_item.h:68
@ AUTOPLACE_MANUAL
Definition sch_item.h:71
@ AUTOPLACE_NONE
Definition sch_item.h:69
@ AUTOPLACE_AUTO
Definition sch_item.h:70
DANGLING_END_T
Definition sch_item.h:77
@ NO_CONNECT_END
Definition sch_item.h:87
@ SHEET_LABEL_END
Definition sch_item.h:86
@ LABEL_END
Definition sch_item.h:83
@ JUNCTION_END
Definition sch_item.h:81
@ BUS_END
Definition sch_item.h:80
@ PIN_END
Definition sch_item.h:82
@ BUS_ENTRY_END
Definition sch_item.h:84
@ WIRE_END
Definition sch_item.h:79
@ WIRE_ENTRY_END
Definition sch_item.h:85
@ DANGLING_END_UNKNOWN
Definition sch_item.h:78
std::vector< SCH_ITEM * > SCH_ITEM_VEC
Definition sch_item.h:156
BODY_STYLE
Definition sch_item.h:58
@ BASE
Definition sch_item.h:59
@ DEMORGAN
Definition sch_item.h:60
Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
bool operator()(const SCH_ITEM *aFirst, const SCH_ITEM *aSecond) const
Definition sch_item.cpp:535
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition typeinfo.h:78
@ SCH_LINE_T
Definition typeinfo.h:165
@ SCH_ITEM_LOCATE_WIRE_T
Definition typeinfo.h:188
@ SCH_ITEM_LOCATE_BUS_T
Definition typeinfo.h:189
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition typeinfo.h:190
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695