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-2021 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 void Print( const RENDER_SETTINGS* aSettings, const VECTOR2I& aOffset ) override;
95
96 const BOX2I GetBoundingBox() const override;
97
98 void Move( const VECTOR2I& aMoveVector ) override
99 {
100 m_pos += aMoveVector;
101 }
102
103 void MirrorHorizontally( int aCenter ) override;
104 void MirrorVertically( int aCenter ) override;
105 void Rotate( const VECTOR2I& aCenter ) override;
106
107 bool IsDangling() const override;
108
109 bool IsConnectable() const override { return true; }
110
111 std::vector<VECTOR2I> GetConnectionPoints() const override;
112
113 VECTOR2I GetPosition() const override { return m_pos; }
114 void SetPosition( const VECTOR2I& aPosition ) override { m_pos = aPosition; }
115
116 bool HitTest( const VECTOR2I& aPosition, int aAccuracy = 0 ) const override;
117 bool IsPointClickableAnchor( const VECTOR2I& aPos ) const override
118 {
119 return ( GetPosition() == aPos && IsDanglingStart() )
120 || ( GetEnd() == aPos && IsDanglingEnd() );
121 }
122
123 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
124
125 void Plot( PLOTTER* aPlotter, bool aBackground,
126 const SCH_PLOT_SETTINGS& aPlotSettings ) const override;
127
128 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
129
130 bool operator <( const SCH_ITEM& aItem ) const override;
131
132 double Similarity( const SCH_ITEM& aItem ) const override;
133
134 bool operator==( const SCH_ITEM& aItem ) const override;
135
136#if defined(DEBUG)
137 void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
138#endif
139
140private:
141 bool doIsConnected( const VECTOR2I& aPosition ) const override;
142
143protected:
149
150 // If real-time connectivity gets disabled (due to being too slow on a particular
151 // design), we can no longer rely on getting the NetClass to find netclass-specific
152 // linestyles, linewidths and colors.
156};
157
162{
163public:
164 SCH_BUS_WIRE_ENTRY( const VECTOR2I& pos = VECTOR2I( 0, 0 ), bool aFlipY = false );
165
166 SCH_BUS_WIRE_ENTRY( const VECTOR2I& pos, int aQuadrant );
167
169
170 static inline bool ClassOf( const EDA_ITEM* aItem )
171 {
172 return aItem && SCH_BUS_WIRE_ENTRY_T == aItem->Type();
173 }
174
175 wxString GetClass() const override
176 {
177 return wxT( "SCH_BUS_WIRE_ENTRY" );
178 }
179
180 int GetPenWidth() const override;
181
182 void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
183
184 bool CanConnect( const SCH_ITEM* aItem ) const override
185 {
186 return aItem->Type() == SCH_LINE_T &&
187 ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
188 }
189
190 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
191
192 EDA_ITEM* Clone() const override;
193
194 virtual bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const override;
195
196 BITMAPS GetMenuImage() const override;
197
198 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
199 std::vector<DANGLING_END_ITEM>& aItemListByPos,
200 const SCH_SHEET_PATH* aPath = nullptr ) override;
201
207};
208
213{
214public:
215 SCH_BUS_BUS_ENTRY( const VECTOR2I& pos = VECTOR2I( 0, 0 ), bool aFlipY = false );
216
218
219 static inline bool ClassOf( const EDA_ITEM* aItem )
220 {
221 return aItem && SCH_BUS_BUS_ENTRY_T == aItem->Type();
222 }
223
224 wxString GetClass() const override
225 {
226 return wxT( "SCH_BUS_BUS_ENTRY" );
227 }
228
229 int GetPenWidth() const override;
230
231 void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
232
233 bool CanConnect( const SCH_ITEM* aItem ) const override
234 {
235 return aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS;
236 }
237
238 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
239
240 EDA_ITEM* Clone() const override;
241
242 BITMAPS GetMenuImage() const override;
243
244 bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemListByType,
245 std::vector<DANGLING_END_ITEM>& aItemListByPos,
246 const SCH_SHEET_PATH* aPath = nullptr ) override;
247
253};
254
255#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: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.
Base plotter engine class.
Definition: plotter.h:104
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
~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...
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:38
VECTOR2I GetSize() const
Definition: sch_bus_entry.h:73
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)
void Print(const RENDER_SETTINGS *aSettings, const VECTOR2I &aOffset) override
Print a schematic item.
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 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 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 Plot(PLOTTER *aPlotter, bool aBackground, const SCH_PLOT_SETTINGS &aPlotSettings) const override
Plot the schematic item to aPlotter.
void Move(const VECTOR2I &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_bus_entry.h:98
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
void Rotate(const VECTOR2I &aCenter) 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
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.
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
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:165
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
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:355
@ LAYER_BUS
Definition: layer_ids.h:356
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:148
@ SCH_BUS_BUS_ENTRY_T
Definition: typeinfo.h:147
@ SCH_BUS_WIRE_ENTRY_T
Definition: typeinfo.h:146
VECTOR2< int > VECTOR2I
Definition: vector2d.h:588