KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_line.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) 2009 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 1992-2023 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#ifndef _SCH_LINE_H_
26#define _SCH_LINE_H_
27
28#include <sch_item.h>
29#include <wx/pen.h> // for wxPenStyle
30#include <list> // for std::list
31
32class NETLIST_OBJECT_LIST;
33
34
39class SCH_LINE : public SCH_ITEM
40{
41public:
42 static const enum wxPenStyle PenStyle[];
43
44 SCH_LINE( const VECTOR2I& pos = VECTOR2I( 0, 0 ), int layer = LAYER_NOTES );
45
46 SCH_LINE( const VECTOR2D& pos, int layer = LAYER_NOTES ) :
47 SCH_LINE( VECTOR2I( pos.x, pos.y ), layer )
48 {}
49
50 SCH_LINE( const SCH_LINE& aLine );
51
53
54 static inline bool ClassOf( const EDA_ITEM* aItem )
55 {
56 return aItem && SCH_LINE_T == aItem->Type();
57 }
58
59 wxString GetClass() const override
60 {
61 return wxT( "SCH_LINE" );
62 }
63
64 wxString GetFriendlyName() const override;
65
72 wxString GetNetname(const SCH_SHEET_PATH &aSheet);
73
74 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
75 {
76 if( SCH_ITEM::IsType( aScanTypes ) )
77 return true;
78
79 for( KICAD_T scanType : aScanTypes )
80 {
81 if( scanType == SCH_ITEM_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
82 return true;
83
84 if ( scanType == SCH_ITEM_LOCATE_BUS_T && m_layer == LAYER_BUS )
85 return true;
86
88 return true;
89 }
90
91 return false;
92 }
93
94 bool IsEndPoint( const VECTOR2I& aPoint ) const
95 {
96 return aPoint == m_start || aPoint == m_end;
97 }
98
99 int GetAngleFrom( const VECTOR2I& aPoint ) const;
100 int GetReverseAngleFrom( const VECTOR2I& aPoint ) const;
101
107 inline EDA_ANGLE Angle() const
108 {
109 return ( EDA_ANGLE( (VECTOR2I) m_end - (VECTOR2I) m_start ) );
110 }
111
116 inline void StoreAngle()
117 {
118 if( !IsNull() )
120 }
121
122 inline void StoreAngle( const EDA_ANGLE& aAngle ) { m_storedAngle = aAngle; }
123
129 inline EDA_ANGLE GetStoredAngle() const { return m_storedAngle; }
130
136 inline bool IsOrthogonal() const { return Angle().IsCardinal(); }
137
138 bool IsNull() const { return m_start == m_end; }
139
140 VECTOR2I GetStartPoint() const { return m_start; }
141 void SetStartPoint( const VECTOR2I& aPosition ) { m_start = aPosition; }
142
143 VECTOR2I GetMidPoint() const { return ( m_start + m_end ) / 2; }
144
145 VECTOR2I GetEndPoint() const { return m_end; }
146 void SetEndPoint( const VECTOR2I& aPosition ) { m_end = aPosition; }
147
148 void SetLastResolvedState( const SCH_ITEM* aItem ) override
149 {
150 const SCH_LINE* aLine = dynamic_cast<const SCH_LINE*>( aItem );
151
152 if( aLine )
153 {
154 m_stroke = aLine->GetStroke();
158 }
159 }
160
161 void SetLineStyle( const LINE_STYLE aStyle );
162 void SetLineStyle( const int aStyleId );
163 LINE_STYLE GetLineStyle() const;
164
168
169 void SetLineColor( const COLOR4D& aColor );
170
171 void SetLineColor( const double r, const double g, const double b, const double a );
172
174 COLOR4D GetLineColor() const;
175
176 void SetLineWidth( const int aSize );
177 int GetLineWidth() const { return m_stroke.GetWidth(); }
178
179 virtual bool HasLineStroke() const override { return true; }
180 virtual STROKE_PARAMS GetStroke() const override { return m_stroke; }
181 virtual void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }
182
183 bool IsStrokeEquivalent( const SCH_LINE* aLine )
184 {
185 if( m_stroke.GetWidth() != aLine->GetStroke().GetWidth() )
186 return false;
187
188 if( m_stroke.GetColor() != aLine->GetStroke().GetColor() )
189 return false;
190
191 LINE_STYLE style_a = m_stroke.GetLineStyle();
192 LINE_STYLE style_b = aLine->GetStroke().GetLineStyle();
193
194 return style_a == style_b
195 || ( style_a == LINE_STYLE::DEFAULT && style_b == LINE_STYLE::SOLID )
196 || ( style_a == LINE_STYLE::SOLID && style_b == LINE_STYLE::DEFAULT );
197 }
198
199 void ViewGetLayers( int aLayers[], int& aCount ) const override;
200
201 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
202
203 const BOX2I GetBoundingBox() const override;
204
208 double GetLength() const;
209
210 void Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset ) override;
211
212 int GetPenWidth() const override;
213
214 void Move( const VECTOR2I& aMoveVector ) override;
215 void MoveStart( const VECTOR2I& aMoveVector );
216 void MoveEnd( const VECTOR2I& aMoveVector );
217
218 void MirrorVertically( int aCenter ) override;
219 void MirrorHorizontally( int aCenter ) override;
220 void Rotate( const VECTOR2I& aCenter ) override;
221 void RotateStart( const VECTOR2I& aCenter );
222 void RotateEnd( const VECTOR2I& aCenter );
223
237 SCH_LINE* MergeOverlap( SCH_SCREEN* aScreen, SCH_LINE* aLine, bool aCheckJunctions );
238
251 SCH_LINE* BreakAt( const VECTOR2I& aPoint );
252
253 bool IsParallel( const SCH_LINE* aLine ) const;
254
255 void GetEndPoints( std::vector<DANGLING_END_ITEM>& aItemList ) override;
256
257 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemList,
258 const SCH_SHEET_PATH* aPath = nullptr ) override;
259
260 bool IsStartDangling() const { return m_startIsDangling; }
261 bool IsEndDangling() const { return m_endIsDangling; }
262 bool IsDangling() const override { return m_startIsDangling || m_endIsDangling; }
263
264 bool IsConnectable() const override;
265
266 std::vector<VECTOR2I> GetConnectionPoints() const override;
267
268 bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const override;
269
270 void GetSelectedPoints( std::vector<VECTOR2I>& aPoints ) const;
271
272 bool CanConnect( const SCH_ITEM* aItem ) const override;
273
274 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
275
276 BITMAPS GetMenuImage() const override;
277
278 bool operator <( const SCH_ITEM& aItem ) const override;
279
280 VECTOR2I GetPosition() const override { return m_start; }
281 void SetPosition( const VECTOR2I& aPosition ) override;
282 VECTOR2I GetSortPosition() const override { return GetMidPoint(); }
283
284 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
285 {
286 return ( GetStartPoint() == aPos && IsStartDangling() )
287 || ( GetEndPoint() == aPos && IsEndDangling() );
288 }
289
290 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
291 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
292
293 void Plot( PLOTTER* aPlotter, bool aBackground,
294 const SCH_PLOT_SETTINGS& aPlotSettings ) const override;
295
296 EDA_ITEM* Clone() const override;
297
298 void SwapData( SCH_ITEM* aItem ) override;
299
300 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
301
302 const wxString& GetOperatingPoint() const { return m_operatingPoint; }
303 void SetOperatingPoint( const wxString& aText ) { m_operatingPoint = aText; }
304
305#if defined(DEBUG)
306 void Show( int nestLevel, std::ostream& os ) const override;
307#endif
308
314 bool IsGraphicLine() const;
315
321 bool IsWire() const;
322
328 bool IsBus() const;
329
330 double Similarity( const SCH_ITEM& aOther ) const override;
331
332 bool operator==( const SCH_ITEM& aOther ) const override;
333
334private:
344 wxString FindWireSegmentNetNameRecursive( SCH_LINE *line, std::list<const SCH_LINE*>& checkedLines,
345 const SCH_SHEET_PATH &aSheet ) const;
346 bool doIsConnected( const VECTOR2I& aPosition ) const override;
347
348private:
355
356 // If real-time connectivity gets disabled (due to being too slow on a particular
357 // design), we can no longer rely on getting the NetClass to find netclass-specific
358 // linestyles, linewidths and colors.
362
364};
365
366
367#endif // _SCH_LINE_H_
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
bool IsCardinal() const
Definition: eda_angle.cpp:49
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
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:68
Base plotter engine class.
Definition: plotter.h:104
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:151
SCH_LAYER_ID m_layer
Definition: sch_item.h:521
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: sch_item.h:166
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:40
int GetPenWidth() const override
Definition: sch_line.cpp:322
void Rotate(const VECTOR2I &aCenter) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
Definition: sch_line.cpp:406
bool doIsConnected(const VECTOR2I &aPosition) const override
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_line.cpp:854
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
Definition: sch_line.cpp:603
void SetStartPoint(const VECTOR2I &aPosition)
Definition: sch_line.h:141
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: sch_line.cpp:144
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: sch_line.cpp:772
void SetOperatingPoint(const wxString &aText)
Definition: sch_line.h:303
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:349
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
Definition: sch_line.cpp:806
bool IsPointClickableAnchor(const VECTOR2I &aPos) const override
Definition: sch_line.h:284
void SetPosition(const VECTOR2I &aPosition) override
Definition: sch_line.cpp:922
void StoreAngle()
Saves the current line angle.
Definition: sch_line.h:116
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Definition: sch_line.cpp:706
int GetReverseAngleFrom(const VECTOR2I &aPoint) const
Definition: sch_line.cpp:444
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: sch_line.cpp:196
virtual bool HasLineStroke() const override
Check if this schematic item has line stoke properties.
Definition: sch_line.h:179
bool IsWire() const
Return true if the line is a wire.
Definition: sch_line.cpp:973
bool IsStartDangling() const
Definition: sch_line.h:260
SCH_LINE(const VECTOR2D &pos, int layer=LAYER_NOTES)
Definition: sch_line.h:46
void RotateEnd(const VECTOR2I &aCenter)
Definition: sch_line.cpp:425
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: sch_line.cpp:221
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the layers the item is drawn on (which may be more than its "home" layer)
Definition: sch_line.cpp:186
void SetLineColor(const COLOR4D &aColor)
Definition: sch_line.cpp:243
bool CanConnect(const SCH_ITEM *aItem) const override
Definition: sch_line.cpp:663
EDA_ANGLE GetStoredAngle() const
Returns the angle stored by StoreAngle()
Definition: sch_line.h:129
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
Definition: sch_line.cpp:735
bool IsParallel(const SCH_LINE *aLine) const
Definition: sch_line.cpp:457
void SetLineWidth(const int aSize)
Definition: sch_line.cpp:315
void RotateStart(const VECTOR2I &aCenter)
Definition: sch_line.cpp:419
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
Definition: sch_line.cpp:396
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_line.h:180
int GetAngleFrom(const VECTOR2I &aPoint) const
Definition: sch_line.cpp:431
void GetSelectedPoints(std::vector< VECTOR2I > &aPoints) const
Definition: sch_line.cpp:725
COLOR4D m_lastResolvedColor
Definition: sch_line.h:361
LINE_STYLE GetEffectiveLineStyle() const
Definition: sch_line.cpp:302
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_line.cpp:929
EDA_ANGLE Angle() const
Gets the angle between the start and end lines.
Definition: sch_line.h:107
wxString m_operatingPoint
Definition: sch_line.h:363
wxString GetClass() const override
Return the class name.
Definition: sch_line.h:59
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_line.h:54
VECTOR2I GetMidPoint() const
Definition: sch_line.h:143
VECTOR2I GetEndPoint() const
Definition: sch_line.h:145
VECTOR2I GetStartPoint() const
Definition: sch_line.h:140
bool ConnectionPropagatesTo(const EDA_ITEM *aItem) const override
Return true if this item should propagate connection info to aItem.
Definition: sch_line.cpp:712
LINE_STYLE m_lastResolvedLineStyle
Definition: sch_line.h:359
VECTOR2I GetPosition() const override
Definition: sch_line.h:280
bool IsEndDangling() const
Definition: sch_line.h:261
SCH_LINE * MergeOverlap(SCH_SCREEN *aScreen, SCH_LINE *aLine, bool aCheckJunctions)
Check line against aLine to see if it overlaps and merge if it does.
Definition: sch_line.cpp:470
VECTOR2I m_start
Line start point.
Definition: sch_line.h:351
bool IsBus() const
Return true if the line is a bus.
Definition: sch_line.cpp:979
int m_lastResolvedWidth
Definition: sch_line.h:360
void StoreAngle(const EDA_ANGLE &aAngle)
Definition: sch_line.h:122
void SetLineStyle(const LINE_STYLE aStyle)
Definition: sch_line.cpp:286
VECTOR2I m_end
Line end point.
Definition: sch_line.h:352
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_line.cpp:150
bool UpdateDanglingState(std::vector< DANGLING_END_ITEM > &aItemList, const SCH_SHEET_PATH *aPath=nullptr) override
Test the schematic item to aItemList to check if it's dangling state has changed.
Definition: sch_line.cpp:613
LINE_STYLE GetLineStyle() const
Definition: sch_line.cpp:293
bool IsNull() const
Definition: sch_line.h:138
void MoveEnd(const VECTOR2I &aMoveVector)
Definition: sch_line.cpp:163
VECTOR2I GetSortPosition() const override
Return the coordinates that should be used for sorting this element visually compared to other elemen...
Definition: sch_line.h:282
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:354
EDA_ANGLE m_storedAngle
Stored angle.
Definition: sch_line.h:353
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:350
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition: sch_line.cpp:838
bool IsConnectable() const override
Definition: sch_line.cpp:654
wxString GetFriendlyName() const override
Definition: sch_line.cpp:93
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
Definition: sch_line.cpp:386
bool operator==(const SCH_ITEM &aOther) const override
Definition: sch_line.cpp:985
bool operator<(const SCH_ITEM &aItem) const override
Definition: sch_line.cpp:783
virtual void SetStroke(const STROKE_PARAMS &aStroke) override
Definition: sch_line.h:181
void Print(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset) override
Print a schematic item.
Definition: sch_line.cpp:356
wxString GetNetname(const SCH_SHEET_PATH &aSheet)
This function travel though all the connected wire segments to look for connected labels.
Definition: sch_line.cpp:104
bool IsEndPoint(const VECTOR2I &aPoint) const
Definition: sch_line.h:94
bool IsStrokeEquivalent(const SCH_LINE *aLine)
Definition: sch_line.h:183
void SetLastResolvedState(const SCH_ITEM *aItem) override
Definition: sch_line.h:148
bool IsGraphicLine() const
Return if the line is a graphic (non electrical line)
Definition: sch_line.cpp:967
void Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_SETTINGS &aPlotSettings) const override
Plot the schematic item to aPlotter.
Definition: sch_line.cpp:863
static enum wxPenStyle PenStyle[]
Definition: sch_line.h:42
int GetLineWidth() const
Definition: sch_line.h:177
COLOR4D GetLineColor() const
Returns COLOR4D::UNSPECIFIED if a custom color hasn't been set for this line.
Definition: sch_line.cpp:267
void MoveStart(const VECTOR2I &aMoveVector)
Definition: sch_line.cpp:157
double GetLength() const
Definition: sch_line.cpp:237
SCH_LINE * BreakAt(const VECTOR2I &aPoint)
Break this segment into two at the specified point.
Definition: sch_line.cpp:591
~SCH_LINE()
Definition: sch_line.h:52
bool IsOrthogonal() const
Checks if line is orthogonal (to the grid).
Definition: sch_line.h:136
wxString FindWireSegmentNetNameRecursive(SCH_LINE *line, std::list< const SCH_LINE * > &checkedLines, const SCH_SHEET_PATH &aSheet) const
Recursively called function to travel through the connected wires and find a connected net name label...
Definition: sch_line.cpp:112
void SetEndPoint(const VECTOR2I &aPosition)
Definition: sch_line.h:146
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: sch_line.h:74
bool IsDangling() const override
Definition: sch_line.h:262
const wxString & GetOperatingPoint() const
Definition: sch_line.h:302
double Similarity(const SCH_ITEM &aOther) const override
Return a measure of how likely the other object is to represent the same object.
Definition: sch_line.cpp:1014
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.
Definition: stroke_params.h:81
int GetWidth() const
Definition: stroke_params.h:91
LINE_STYLE GetLineStyle() const
Definition: stroke_params.h:94
KIGFX::COLOR4D GetColor() const
Definition: stroke_params.h:97
@ LAYER_WIRE
Definition: layer_ids.h:349
@ LAYER_NOTES
Definition: layer_ids.h:363
@ LAYER_BUS
Definition: layer_ids.h:350
LINE_STYLE
Dashed line types.
Definition: stroke_params.h:48
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ SCH_LINE_T
Definition: typeinfo.h:146
@ SCH_ITEM_LOCATE_WIRE_T
Definition: typeinfo.h:170
@ SCH_ITEM_LOCATE_BUS_T
Definition: typeinfo.h:171
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition: typeinfo.h:172
VECTOR2< int > VECTOR2I
Definition: vector2d.h:588