KiCad PCB EDA Suite
Loading...
Searching...
No Matches
sch_bus_entry.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 (C) 2004-2024 KiCad Developers, see change_log.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_BUS_ENTRY_H_
26#define _SCH_BUS_ENTRY_H_
27
28#include <gal/color4d.h>
29#include <sch_item.h>
30
31#define TARGET_BUSENTRY_RADIUS schIUScale.MilsToIU( 12 ) // Circle diameter drawn at the ends
32
33
38{
39public:
40 SCH_BUS_ENTRY_BASE( KICAD_T aType, const VECTOR2I& pos = VECTOR2I( 0, 0 ),
41 bool aFlipY = false );
42
43 bool IsDanglingStart() const { return m_isDanglingStart; }
44 bool IsDanglingEnd() const { return m_isDanglingEnd; }
45
46 void SetEndDangling( bool aDanglingState ) { m_isDanglingEnd = aDanglingState; }
47
48 // Do not create a copy constructor. The one generated by the compiler is adequate.
49
51
52 void SetLastResolvedState( const SCH_ITEM* aItem ) override
53 {
54 const SCH_BUS_ENTRY_BASE* aEntry = dynamic_cast<const SCH_BUS_ENTRY_BASE*>( aItem );
55
56 if( aEntry )
57 {
61 }
62 }
63
69 bool IsMovableFromAnchorPoint() const override { return false; }
70
71 VECTOR2I GetEnd() const;
72
73 VECTOR2I GetSize() const { return m_size; }
74 void SetSize( const VECTOR2I& aSize ) { m_size = aSize; }
75
76 // Base class getter unused; necessary for property to compile
77 int GetPenWidth() const override;
78 void SetPenWidth( int aWidth );
79
80 virtual bool HasLineStroke() const override { return true; }
81 virtual STROKE_PARAMS GetStroke() const override { return m_stroke; }
82 virtual void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }
83
85 void SetLineStyle( LINE_STYLE aStyle );
86
88 void SetBusEntryColor( const COLOR4D& aColor );
89
90 void SwapData( SCH_ITEM* aItem ) override;
91
92 void ViewGetLayers( int aLayers[], int& aCount ) const override;
93
94 const BOX2I GetBoundingBox() const override;
95
96 void Move( const VECTOR2I& aMoveVector ) override
97 {
98 m_pos += aMoveVector;
99 }
100
101 void MirrorHorizontally( int aCenter ) override;
102 void MirrorVertically( int aCenter ) override;
103 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
104
105 bool IsDangling() const override;
106
107 bool IsConnectable() const override { return true; }
108
109 bool HasConnectivityChanges( const SCH_ITEM* aItem,
110 const SCH_SHEET_PATH* aInstance = nullptr ) const override;
111
112 std::vector<VECTOR2I> GetConnectionPoints() const override;
113
114 VECTOR2I GetPosition() const override { return m_pos; }
115 void SetPosition( const VECTOR2I& aPosition ) override { m_pos = aPosition; }
116
117 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
118 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
119 {
120 return ( GetPosition() == aPos && IsDanglingStart() )
121 || ( GetEnd() == aPos && IsDanglingEnd() );
122 }
123
124 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
125
126 void Print( const SCH_RENDER_SETTINGS* aSettings, int aUnit, int aBodyStyle,
127 const VECTOR2I& aOffset, bool aForceNoFill, bool aDimmed ) override;
128
129 void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
130 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
131
132 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
133
134 bool operator <( const SCH_ITEM& aItem ) const override;
135
136 double Similarity( const SCH_ITEM& aItem ) const override;
137
138 bool operator==( const SCH_ITEM& aItem ) const override;
139
140#if defined(DEBUG)
141 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
142#endif
143
144private:
145 bool doIsConnected( const VECTOR2I& aPosition ) const override;
146
147protected:
153
154 // If real-time connectivity gets disabled (due to being too slow on a particular
155 // design), we can no longer rely on getting the NetClass to find netclass-specific
156 // linestyles, linewidths and colors.
160};
161
166{
167public:
168 SCH_BUS_WIRE_ENTRY( const VECTOR2I& pos = VECTOR2I( 0, 0 ), bool aFlipY = false );
169
170 SCH_BUS_WIRE_ENTRY( const VECTOR2I& pos, int aQuadrant );
171
173
174 static inline bool ClassOf( const EDA_ITEM* aItem )
175 {
176 return aItem && SCH_BUS_WIRE_ENTRY_T == aItem->Type();
177 }
178
179 wxString GetClass() const override
180 {
181 return wxT( "SCH_BUS_WIRE_ENTRY" );
182 }
183
184 int GetPenWidth() const override;
185
186 void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
187
188 bool CanConnect( const SCH_ITEM* aItem ) const override
189 {
190 return aItem->Type() == SCH_LINE_T &&
191 ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
192 }
193
194 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
195
196 EDA_ITEM* Clone() const override;
197
198 virtual bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const override;
199
200 BITMAPS GetMenuImage() const override;
201
202 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
203 std::vector<DANGLING_END_ITEM>& aItemListByPos,
204 const SCH_SHEET_PATH* aPath = nullptr ) override;
205
211};
212
217{
218public:
219 SCH_BUS_BUS_ENTRY( const VECTOR2I& pos = VECTOR2I( 0, 0 ), bool aFlipY = false );
220
222
223 static inline bool ClassOf( const EDA_ITEM* aItem )
224 {
225 return aItem && SCH_BUS_BUS_ENTRY_T == aItem->Type();
226 }
227
228 wxString GetClass() const override
229 {
230 return wxT( "SCH_BUS_BUS_ENTRY" );
231 }
232
233 int GetPenWidth() const override;
234
235 void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
236
237 bool CanConnect( const SCH_ITEM* aItem ) const override
238 {
239 return aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS;
240 }
241
242 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
243
244 EDA_ITEM* Clone() const override;
245
246 BITMAPS GetMenuImage() const override;
247
248 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
249 std::vector<DANGLING_END_ITEM>& aItemListByPos,
250 const SCH_SHEET_PATH* aPath = nullptr ) override;
251
257};
258
259#endif // _SCH_BUS_ENTRY_H_
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
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:88
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:100
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Base plotter engine class.
Definition: plotter.h:105
Class for a bus to bus entry.
int GetPenWidth() const override
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
static bool ClassOf(const EDA_ITEM *aItem)
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
bool CanConnect(const SCH_ITEM *aItem) const override
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
~SCH_BUS_BUS_ENTRY()
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
wxString GetClass() const override
Return the class name.
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.
SCH_ITEM * m_connected_bus_items[2]
Pointer to the bus items (usually bus wires) connected to this bus-bus entry (either or both may be n...
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:38
VECTOR2I GetSize() const
Definition: sch_bus_entry.h:73
bool HasConnectivityChanges(const SCH_ITEM *aItem, const SCH_SHEET_PATH *aInstance=nullptr) const override
Check if aItem has connectivity changes against this object.
double Similarity(const SCH_ITEM &aItem) const override
Return a measure of how likely the other object is to represent the same object.
void SetLastResolvedState(const SCH_ITEM *aItem) override
Definition: sch_bus_entry.h:52
VECTOR2I m_pos
virtual bool HasLineStroke() const override
Check if this schematic item has line stoke properties.
Definition: sch_bus_entry.h:80
bool m_isDanglingStart
LINE_STYLE m_lastResolvedLineStyle
COLOR4D GetBusEntryColor() const
void SetSize(const VECTOR2I &aSize)
Definition: sch_bus_entry.h:74
bool m_isDanglingEnd
bool HitTest(const VECTOR2I &aPosition, int aAccuracy=0) const override
Test if aPosition is inside or on the boundary of this item.
virtual void SetStroke(const STROKE_PARAMS &aStroke) override
Definition: sch_bus_entry.h:82
LINE_STYLE GetLineStyle() const
void SetBusEntryColor(const COLOR4D &aColor)
VECTOR2I GetPosition() const override
bool IsDanglingStart() const
Definition: sch_bus_entry.h:43
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_bus_entry.h:81
void Print(const SCH_RENDER_SETTINGS *aSettings, int aUnit, int aBodyStyle, const VECTOR2I &aOffset, bool aForceNoFill, bool aDimmed) override
Print an item.
void SetPosition(const VECTOR2I &aPosition) override
void SetPenWidth(int aWidth)
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.
bool IsMovableFromAnchorPoint() const override
Return true for items which are moved with the anchor point at mouse cursor and false for items moved...
Definition: sch_bus_entry.h:69
~SCH_BUS_ENTRY_BASE()
Definition: sch_bus_entry.h:50
bool IsDanglingEnd() const
Definition: sch_bus_entry.h:44
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
bool operator==(const SCH_ITEM &aItem) const override
int m_lastResolvedWidth
std::vector< VECTOR2I > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
void SetLineStyle(LINE_STYLE aStyle)
bool IsConnectable() const override
void SetEndDangling(bool aDanglingState)
Definition: sch_bus_entry.h:46
int GetPenWidth() const override
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.
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
VECTOR2I GetEnd() const
bool IsDangling() const override
COLOR4D m_lastResolvedColor
STROKE_PARAMS m_stroke
bool IsPointClickableAnchor(const VECTOR2I &aPos) const override
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
VECTOR2I m_size
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_bus_entry.h:96
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void Rotate(const VECTOR2I &aCenter, bool aRotateCCW) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
bool operator<(const SCH_ITEM &aItem) const override
bool doIsConnected(const VECTOR2I &aPosition) const override
Provide the object specific test to see if it is connected to aPosition.
Class for a wire to bus entry.
wxString GetClass() const override
Return the class name.
~SCH_BUS_WIRE_ENTRY()
bool CanConnect(const SCH_ITEM *aItem) const override
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider, bool aFull) const override
Return a user-visible description string of this item.
static bool ClassOf(const EDA_ITEM *aItem)
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
int GetPenWidth() const override
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.
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
virtual bool ConnectionPropagatesTo(const EDA_ITEM *aItem) const override
Return true if this item should propagate connection info to aItem.
SCH_ITEM * m_connected_bus_item
Pointer to the bus item (usually a bus wire) connected to this bus-wire entry, if it is connected to ...
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:166
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:281
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
@ LAYER_WIRE
Definition: layer_ids.h:357
@ 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_BUS_BUS_ENTRY_T
Definition: typeinfo.h:162
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:161
VECTOR2< int32_t > VECTOR2I
Definition: vector2d.h:673