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 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#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 IsStartDangling() const { return m_isStartDangling; }
44 bool IsEndDangling() const { return m_isEndDangling; }
45
46 void SetEndDangling( bool aDanglingState ) { m_isEndDangling = 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
84 void SetLineStyle( LINE_STYLE aStyle );
86
87 // Special Getter/Setters for properties panel. Required because it uses WIRE_STYLE instead
88 // of LINE_STYLE. (The two enums are identical, but we expose "default" in the WIRE_STYLE
89 // property while we don't with the LINE_STYLE property.)
90 void SetWireStyle( WIRE_STYLE aStyle ) { SetLineStyle( (LINE_STYLE) aStyle ); }
92
94 void SetBusEntryColor( const COLOR4D& aColor );
95
96 void swapData( SCH_ITEM* aItem ) override;
97
98 std::vector<int> ViewGetLayers() const override;
99
100 const BOX2I GetBoundingBox() const override;
101
102 void Move( const VECTOR2I& aMoveVector ) override
103 {
104 m_pos += aMoveVector;
105 }
106
107 void MirrorHorizontally( int aCenter ) override;
108 void MirrorVertically( int aCenter ) override;
109 void Rotate( const VECTOR2I& aCenter, bool aRotateCCW ) override;
110
111 bool IsDangling() const override;
112
113 bool IsConnectable() const override { return true; }
114
115 bool HasConnectivityChanges( const SCH_ITEM* aItem,
116 const SCH_SHEET_PATH* aInstance = nullptr ) const override;
117
118 std::vector<VECTOR2I> GetConnectionPoints() const override;
119
120 VECTOR2I GetPosition() const override { return m_pos; }
121 void SetPosition( const VECTOR2I& aPosition ) override { m_pos = aPosition; }
122
123 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
124 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
125 {
126 return ( GetPosition() == aPos && IsStartDangling() )
127 || ( GetEnd() == aPos && IsEndDangling() );
128 }
129
130 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
131 bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const override;
132
133 void Plot( PLOTTER* aPlotter, bool aBackground, const SCH_PLOT_OPTS& aPlotOpts,
134 int aUnit, int aBodyStyle, const VECTOR2I& aOffset, bool aDimmed ) override;
135
136 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
137
138 bool operator <( const SCH_ITEM& aItem ) const override;
139
140 double Similarity( const SCH_ITEM& aItem ) const override;
141
142 bool operator==( const SCH_ITEM& aItem ) const override;
143
144#if defined(DEBUG)
145 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
146#endif
147
148private:
149 bool doIsConnected( const VECTOR2I& aPosition ) const override;
150
151protected:
157
158 // If real-time connectivity gets disabled (due to being too slow on a particular
159 // design), we can no longer rely on getting the NetClass to find netclass-specific
160 // linestyles, linewidths and colors.
164};
165
170{
171public:
172 SCH_BUS_WIRE_ENTRY( const VECTOR2I& pos = VECTOR2I( 0, 0 ), bool aFlipY = false );
173
174 SCH_BUS_WIRE_ENTRY( const VECTOR2I& pos, int aQuadrant );
175
177
178 static inline bool ClassOf( const EDA_ITEM* aItem )
179 {
180 return aItem && SCH_BUS_WIRE_ENTRY_T == aItem->Type();
181 }
182
183 wxString GetClass() const override
184 {
185 return wxT( "SCH_BUS_WIRE_ENTRY" );
186 }
187
188 int GetPenWidth() const override;
189
190 void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
191
192 bool CanConnect( const SCH_ITEM* aItem ) const override
193 {
194 return aItem->Type() == SCH_LINE_T &&
195 ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
196 }
197
198 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
199
200 EDA_ITEM* Clone() const override;
201
202 virtual bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const override;
203
204 BITMAPS GetMenuImage() const override;
205
206 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
207 std::vector<DANGLING_END_ITEM>& aItemListByPos,
208 const SCH_SHEET_PATH* aPath = nullptr ) override;
209
215};
216
221{
222public:
223 SCH_BUS_BUS_ENTRY( const VECTOR2I& pos = VECTOR2I( 0, 0 ), bool aFlipY = false );
224
226
227 static inline bool ClassOf( const EDA_ITEM* aItem )
228 {
229 return aItem && SCH_BUS_BUS_ENTRY_T == aItem->Type();
230 }
231
232 wxString GetClass() const override
233 {
234 return wxT( "SCH_BUS_BUS_ENTRY" );
235 }
236
237 int GetPenWidth() const override;
238
239 void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
240
241 bool CanConnect( const SCH_ITEM* aItem ) const override
242 {
243 return aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS;
244 }
245
246 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
247
248 EDA_ITEM* Clone() const override;
249
250 BITMAPS GetMenuImage() const override;
251
252 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
253 std::vector<DANGLING_END_ITEM>& aItemListByPos,
254 const SCH_SHEET_PATH* aPath = nullptr ) override;
255
261};
262
263#endif // _SCH_BUS_ENTRY_H_
BITMAPS
A list of all bitmap identifiers.
BOX2< VECTOR2I > BOX2I
Definition box2.h:922
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
EDA_ITEM(EDA_ITEM *parent, KICAD_T idType, bool isSCH_ITEM=false, bool isBOARD_ITEM=false)
Definition eda_item.cpp:39
A color representation with 4 components: red, green, blue, alpha.
Definition color4d.h:104
Base plotter engine class.
Definition plotter.h:121
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.
SCH_BUS_BUS_ENTRY(const VECTOR2I &pos=VECTOR2I(0, 0), bool aFlipY=false)
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...
VECTOR2I GetSize() const
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
VECTOR2I m_pos
virtual bool HasLineStroke() const override
Check if this schematic item has line stoke properties.
LINE_STYLE m_lastResolvedLineStyle
COLOR4D GetBusEntryColor() const
void SetSize(const VECTOR2I &aSize)
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
void SetBusEntryColor(const COLOR4D &aColor)
std::vector< int > ViewGetLayers() const override
Return the all the layers within the VIEW the object is painted on.
bool IsStartDangling() const
VECTOR2I GetPosition() const override
bool m_isEndDangling
bool IsEndDangling() const
virtual STROKE_PARAMS GetStroke() const override
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...
void SetWireStyle(WIRE_STYLE aStyle)
void swapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
~SCH_BUS_ENTRY_BASE()
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)
int GetPenWidth() const override
WIRE_STYLE GetWireStyle() const
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.
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.
SCH_BUS_ENTRY_BASE(KICAD_T aType, const VECTOR2I &pos=VECTOR2I(0, 0), bool aFlipY=false)
LINE_STYLE GetEffectiveLineStyle() const
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 m_isStartDangling
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.
wxString GetClass() const override
Return the class name.
SCH_BUS_WIRE_ENTRY(const VECTOR2I &pos=VECTOR2I(0, 0), bool aFlipY=false)
~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:167
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition sch_item.h:309
SCH_ITEM(EDA_ITEM *aParent, KICAD_T aType, int aUnit=0, int aBodyStyle=0)
Definition sch_item.cpp:51
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
Represent a polyline containing arcs as well as line segments: A chain of connected line and/or arc s...
Simple container to manage line stroke parameters.
LINE_STYLE GetLineStyle() const
@ LAYER_WIRE
Definition layer_ids.h:451
@ LAYER_BUS
Definition layer_ids.h:452
LINE_STYLE
Dashed line types.
WIRE_STYLE
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_BUS_BUS_ENTRY_T
Definition typeinfo.h:164
@ SCH_BUS_WIRE_ENTRY_T
Definition typeinfo.h:163
VECTOR2< int32_t > VECTOR2I
Definition vector2d.h:695