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-2024 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#include <geometry/seg.h>
32
33class NETLIST_OBJECT_LIST;
34
35
40class SCH_LINE : public SCH_ITEM
41{
42public:
43 static const enum wxPenStyle PenStyle[];
44
45 SCH_LINE( const VECTOR2I& pos = VECTOR2I( 0, 0 ), int layer = LAYER_NOTES );
46
47 SCH_LINE( const VECTOR2D& pos, int layer = LAYER_NOTES ) :
48 SCH_LINE( VECTOR2I( pos.x, pos.y ), layer )
49 {}
50
51 SCH_LINE( const SCH_LINE& aLine );
52
54
55 void Serialize( google::protobuf::Any &aContainer ) const override;
56 bool Deserialize( const google::protobuf::Any &aContainer ) override;
57
58 static inline bool ClassOf( const EDA_ITEM* aItem )
59 {
60 return aItem && SCH_LINE_T == aItem->Type();
61 }
62
63 wxString GetClass() const override
64 {
65 return wxT( "SCH_LINE" );
66 }
67
68 wxString GetFriendlyName() const override;
69
70 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
71 {
72 if( SCH_ITEM::IsType( aScanTypes ) )
73 return true;
74
75 for( KICAD_T scanType : aScanTypes )
76 {
77 if( scanType == SCH_ITEM_LOCATE_WIRE_T && m_layer == LAYER_WIRE )
78 return true;
79
80 if ( scanType == SCH_ITEM_LOCATE_BUS_T && m_layer == LAYER_BUS )
81 return true;
82
84 return true;
85 }
86
87 return false;
88 }
89
90 bool IsEndPoint( const VECTOR2I& aPoint ) const
91 {
92 return aPoint == m_start || aPoint == m_end;
93 }
94
95 int GetAngleFrom( const VECTOR2I& aPoint ) const;
96 int GetReverseAngleFrom( const VECTOR2I& aPoint ) const;
97
103 inline EDA_ANGLE Angle() const
104 {
105 return ( EDA_ANGLE( (VECTOR2I) m_end - (VECTOR2I) m_start ) );
106 }
107
112 inline void StoreAngle()
113 {
114 if( !IsNull() )
116 }
117
118 inline void StoreAngle( const EDA_ANGLE& aAngle ) { m_storedAngle = aAngle; }
119
125 inline EDA_ANGLE GetStoredAngle() const { return m_storedAngle; }
126
132 inline bool IsOrthogonal() const { return Angle().IsCardinal(); }
133
134 bool IsNull() const { return m_start == m_end; }
135
136 VECTOR2I GetStartPoint() const { return m_start; }
137 void SetStartPoint( const VECTOR2I& aPosition ) { m_start = aPosition; }
138
139 VECTOR2I GetMidPoint() const { return ( m_start + m_end ) / 2; }
140
141 VECTOR2I GetEndPoint() const { return m_end; }
142 void SetEndPoint( const VECTOR2I& aPosition ) { m_end = aPosition; }
143
147 SEG GetSeg() const
148 {
149 return SEG{ m_start, m_end };
150 }
151
152 void SetLastResolvedState( const SCH_ITEM* aItem ) override
153 {
154 const SCH_LINE* aLine = dynamic_cast<const SCH_LINE*>( aItem );
155
156 if( aLine )
157 {
158 m_stroke = aLine->GetStroke();
162 }
163 }
164
165 void SetLineStyle( const LINE_STYLE aStyle );
166 void SetLineStyle( const int aStyleId );
167 LINE_STYLE GetLineStyle() const;
168
172
173 void SetLineColor( const COLOR4D& aColor );
174
175 void SetLineColor( const double r, const double g, const double b, const double a );
176
178 COLOR4D GetLineColor() const;
179
180 void SetLineWidth( const int aSize );
181 int GetLineWidth() const { return m_stroke.GetWidth(); }
182
183 virtual bool HasLineStroke() const override { return true; }
184 virtual STROKE_PARAMS GetStroke() const override { return m_stroke; }
185 virtual void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }
186
187 bool IsStrokeEquivalent( const SCH_LINE* aLine )
188 {
189 if( m_stroke.GetWidth() != aLine->GetStroke().GetWidth() )
190 return false;
191
192 if( m_stroke.GetColor() != aLine->GetStroke().GetColor() )
193 return false;
194
195 LINE_STYLE style_a = m_stroke.GetLineStyle();
196 LINE_STYLE style_b = aLine->GetStroke().GetLineStyle();
197
198 return style_a == style_b
199 || ( style_a == LINE_STYLE::DEFAULT && style_b == LINE_STYLE::SOLID )
200 || ( style_a == LINE_STYLE::SOLID && style_b == LINE_STYLE::DEFAULT );
201 }
202
203 void ViewGetLayers( int aLayers[], int& aCount ) const override;
204
205 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
206
207 const BOX2I GetBoundingBox() const override;
208
212 double GetLength() const;
213
214 int GetPenWidth() const override;
215
216 void Move( const VECTOR2I& aMoveVector ) override;
217 void MoveStart( const VECTOR2I& aMoveVector );
218 void MoveEnd( const VECTOR2I& aMoveVector );
219
220 void MirrorVertically( int aCenter ) override;
221 void MirrorHorizontally( int aCenter ) override;
222 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
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>& aItemListByType,
258 std::vector<DANGLING_END_ITEM>& aItemListByPos,
259 const SCH_SHEET_PATH* aPath = nullptr ) override;
260
261 bool IsStartDangling() const { return m_startIsDangling; }
262 bool IsEndDangling() const { return m_endIsDangling; }
263 bool IsDangling() const override { return m_startIsDangling || m_endIsDangling; }
264
265 bool IsConnectable() const override;
266
267 bool HasConnectivityChanges( const SCH_ITEM* aItem,
268 const SCH_SHEET_PATH* aInstance = nullptr ) const override;
269
270 std::vector<VECTOR2I> GetConnectionPoints() const override;
271
272 bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const override;
273
274 void GetSelectedPoints( std::vector<VECTOR2I>& aPoints ) const;
275
276 bool CanConnect( const SCH_ITEM* aItem ) const override;
277
278 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
279
280 BITMAPS GetMenuImage() const override;
281
282 bool operator <( const SCH_ITEM& aItem ) const override;
283
284 VECTOR2I GetPosition() const override { return m_start; }
285 void SetPosition( const VECTOR2I& aPosition ) override;
286 VECTOR2I GetSortPosition() const override { return GetMidPoint(); }
287
288 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
289 {
290 return ( GetStartPoint() == aPos && IsStartDangling() )
291 || ( GetEndPoint() == aPos && IsEndDangling() );
292 }
293
294 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
295 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
296
297 void Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
298 const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed ) override;
299
300 void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
301 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
302
303 EDA_ITEM* Clone() const override;
304
305 void SwapData( SCH_ITEM* aItem ) override;
306
307 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
308
309 const wxString& GetOperatingPoint() const { return m_operatingPoint; }
310 void SetOperatingPoint( const wxString& aText ) { m_operatingPoint = aText; }
311
312#if defined(DEBUG)
313 void Show( int nestLevel, std::ostream& os ) const override;
314#endif
315
321 bool IsGraphicLine() const;
322
328 bool IsWire() const;
329
335 bool IsBus() const;
336
337 double Similarity( const SCH_ITEM& aOther ) const override;
338
339 bool operator==( const SCH_ITEM& aOther ) const override;
340
341private:
342 bool doIsConnected( const VECTOR2I& aPosition ) const override;
343
344private:
351
352 // If real-time connectivity gets disabled (due to being too slow on a particular
353 // design), we can no longer rely on getting the NetClass to find netclass-specific
354 // linestyles, linewidths and colors.
358
360};
361
362
363#endif // _SCH_LINE_H_
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
bool IsCardinal() const
Definition: eda_angle.cpp:40
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:89
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:101
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
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:105
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
SCH_LAYER_ID m_layer
Definition: sch_item.h:723
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: sch_item.h:181
Segment description base class to describe items which have 2 end points (track, wire,...
Definition: sch_line.h:41
int GetPenWidth() const override
Definition: sch_line.cpp:327
bool doIsConnected(const VECTOR2I &aPosition) const override
Provide the object specific test to see if it is connected to aPosition.
Definition: sch_line.cpp:857
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:594
void SetStartPoint(const VECTOR2I &aPosition)
Definition: sch_line.h:137
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: sch_line.cpp:149
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: sch_line.cpp:775
bool UpdateDanglingState(std::vector< DANGLING_END_ITEM > &aItemListByType, std::vector< DANGLING_END_ITEM > &aItemListByPos, 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:604
void SetOperatingPoint(const wxString &aText)
Definition: sch_line.h:310
bool m_startIsDangling
True if start point is not connected.
Definition: sch_line.h:345
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:809
bool IsPointClickableAnchor(const VECTOR2I &aPos) const override
Definition: sch_line.h:288
void SetPosition(const VECTOR2I &aPosition) override
Definition: sch_line.cpp:925
void StoreAngle()
Saves the current line angle.
Definition: sch_line.h:112
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
Definition: sch_line.cpp:709
int GetReverseAngleFrom(const VECTOR2I &aPoint) const
Definition: sch_line.cpp:435
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: sch_line.cpp:201
virtual bool HasLineStroke() const override
Check if this schematic item has line stoke properties.
Definition: sch_line.h:183
bool IsWire() const
Return true if the line is a wire.
Definition: sch_line.cpp:976
bool IsStartDangling() const
Definition: sch_line.h:261
SCH_LINE(const VECTOR2D &pos, int layer=LAYER_NOTES)
Definition: sch_line.h:47
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: sch_line.cpp:226
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:191
void SetLineColor(const COLOR4D &aColor)
Definition: sch_line.cpp:248
bool CanConnect(const SCH_ITEM *aItem) const override
Definition: sch_line.cpp:666
EDA_ANGLE GetStoredAngle() const
Returns the angle stored by StoreAngle()
Definition: sch_line.h:125
bool IsParallel(const SCH_LINE *aLine) const
Definition: sch_line.cpp:448
void SetLineWidth(const int aSize)
Definition: sch_line.cpp:320
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
Definition: sch_line.cpp:402
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_line.h:184
int GetAngleFrom(const VECTOR2I &aPoint) const
Definition: sch_line.cpp:422
void GetSelectedPoints(std::vector< VECTOR2I > &aPoints) const
Definition: sch_line.cpp:728
COLOR4D m_lastResolvedColor
Definition: sch_line.h:357
LINE_STYLE GetEffectiveLineStyle() const
Definition: sch_line.cpp:307
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:932
EDA_ANGLE Angle() const
Gets the angle between the start and end lines.
Definition: sch_line.h:103
void Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_OPTS &aPlotOpts, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aDimmed) override
Plot the item to aPlotter.
Definition: sch_line.cpp:866
wxString m_operatingPoint
Definition: sch_line.h:359
wxString GetClass() const override
Return the class name.
Definition: sch_line.h:63
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_line.h:58
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
Definition: sch_line.cpp:412
VECTOR2I GetMidPoint() const
Definition: sch_line.h:139
VECTOR2I GetEndPoint() const
Definition: sch_line.h:141
VECTOR2I GetStartPoint() const
Definition: sch_line.h:136
bool ConnectionPropagatesTo(const EDA_ITEM *aItem) const override
Return true if this item should propagate connection info to aItem.
Definition: sch_line.cpp:715
LINE_STYLE m_lastResolvedLineStyle
Definition: sch_line.h:355
VECTOR2I GetPosition() const override
Definition: sch_line.h:284
SEG GetSeg() const
Get the geometric aspect of the wire as a SEG.
Definition: sch_line.h:147
bool IsEndDangling() const
Definition: sch_line.h:262
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:461
VECTOR2I m_start
Line start point.
Definition: sch_line.h:347
bool IsBus() const
Return true if the line is a bus.
Definition: sch_line.cpp:982
int m_lastResolvedWidth
Definition: sch_line.h:356
void Print(const SCH_RENDER_SETTINGS *aSettings, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aForceNoFill, bool aDimmed) override
Print an item.
Definition: sch_line.cpp:361
void StoreAngle(const EDA_ANGLE &aAngle)
Definition: sch_line.h:118
bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const override
Check if aItem has connectivity changes against this object.
Definition: sch_line.cpp:690
void Serialize(google::protobuf::Any &aContainer) const override
Serializes this object to the given Any message.
Definition: sch_line.cpp:95
void SetLineStyle(const LINE_STYLE aStyle)
Definition: sch_line.cpp:291
VECTOR2I m_end
Line end point.
Definition: sch_line.h:348
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_line.cpp:155
LINE_STYLE GetLineStyle() const
Definition: sch_line.cpp:298
bool IsNull() const
Definition: sch_line.h:134
void MoveEnd(const VECTOR2I &aMoveVector)
Definition: sch_line.cpp:168
VECTOR2I GetSortPosition() const override
Return the coordinates that should be used for sorting this element visually compared to other elemen...
Definition: sch_line.h:286
STROKE_PARAMS m_stroke
Line stroke properties.
Definition: sch_line.h:350
EDA_ANGLE m_storedAngle
Stored angle.
Definition: sch_line.h:349
bool m_endIsDangling
True if end point is not connected.
Definition: sch_line.h:346
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
Definition: sch_line.cpp:841
bool IsConnectable() const override
Definition: sch_line.cpp:657
wxString GetFriendlyName() const override
Definition: sch_line.cpp:138
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
Definition: sch_line.cpp:392
bool operator==(const SCH_ITEM &aOther) const override
Definition: sch_line.cpp:988
bool operator<(const SCH_ITEM &aItem) const override
Definition: sch_line.cpp:786
virtual void SetStroke(const STROKE_PARAMS &aStroke) override
Definition: sch_line.h:185
bool IsEndPoint(const VECTOR2I &aPoint) const
Definition: sch_line.h:90
bool IsStrokeEquivalent(const SCH_LINE *aLine)
Definition: sch_line.h:187
void SetLastResolvedState(const SCH_ITEM *aItem) override
Definition: sch_line.h:152
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
Definition: sch_line.cpp:738
bool IsGraphicLine() const
Return if the line is a graphic (non electrical line)
Definition: sch_line.cpp:970
static enum wxPenStyle PenStyle[]
Definition: sch_line.h:43
int GetLineWidth() const
Definition: sch_line.h:181
COLOR4D GetLineColor() const
Returns COLOR4D::UNSPECIFIED if a custom color hasn't been set for this line.
Definition: sch_line.cpp:272
void MoveStart(const VECTOR2I &aMoveVector)
Definition: sch_line.cpp:162
bool Deserialize(const google::protobuf::Any &aContainer) override
Deserializes the given protobuf message into this object.
Definition: sch_line.cpp:109
double GetLength() const
Definition: sch_line.cpp:242
SCH_LINE * BreakAt(const VECTOR2I &aPoint)
Break this segment into two at the specified point.
Definition: sch_line.cpp:582
~SCH_LINE()
Definition: sch_line.h:53
bool IsOrthogonal() const
Checks if line is orthogonal (to the grid).
Definition: sch_line.h:132
void SetEndPoint(const VECTOR2I &aPosition)
Definition: sch_line.h:142
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: sch_line.h:70
bool IsDangling() const override
Definition: sch_line.h:263
const wxString & GetOperatingPoint() const
Definition: sch_line.h:309
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:1017
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Definition: seg.h:42
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:357
@ LAYER_NOTES
Definition: layer_ids.h:372
@ LAYER_BUS
Definition: layer_ids.h:358
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:163
@ SCH_ITEM_LOCATE_WIRE_T
Definition: typeinfo.h:185
@ SCH_ITEM_LOCATE_BUS_T
Definition: typeinfo.h:186
@ SCH_ITEM_LOCATE_GRAPHIC_LINE_T
Definition: typeinfo.h:187
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:673