KiCad PCB EDA Suite
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, jaen-pierre.charras@gipsa-lab.inpg.com
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 
30 #ifndef _SCH_BUS_ENTRY_H_
31 #define _SCH_BUS_ENTRY_H_
32 
33 #include <gal/color4d.h>
34 #include <sch_item.h>
35 
36 #define TARGET_BUSENTRY_RADIUS Mils2iu( 12 ) // Circle diameter drawn at the ends
37 
38 
43 {
44 public:
45  SCH_BUS_ENTRY_BASE( KICAD_T aType, const wxPoint& pos = wxPoint( 0, 0 ), bool aFlipY = false );
46 
47  bool IsDanglingStart() const { return m_isDanglingStart; }
48  bool IsDanglingEnd() const { return m_isDanglingEnd; }
49 
50  // Do not create a copy constructor. The one generated by the compiler is adequate.
51 
53 
59  bool IsMovableFromAnchorPoint() const override { return false; }
60 
61  wxPoint GetEnd() const;
62 
63  wxSize GetSize() const { return m_size; }
64  void SetSize( const wxSize& aSize ) { m_size = aSize; }
65 
66  void SetPenWidth( int aWidth ) { m_stroke.SetWidth( aWidth ); }
67 
68  virtual bool HasLineStroke() const override { return true; }
69  virtual STROKE_PARAMS GetStroke() const override { return m_stroke; }
70  virtual void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }
71 
73  void SetStrokeStyle( PLOT_DASH_TYPE aStyle ) { m_stroke.SetPlotStyle( aStyle ); }
74 
75  COLOR4D GetStrokeColor() const;
76  void SetStrokeColor( const COLOR4D& aColor ) { m_stroke.SetColor( aColor ); }
77 
78  void SwapData( SCH_ITEM* aItem ) override;
79 
80  void ViewGetLayers( int aLayers[], int& aCount ) const override;
81 
82  void Print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override;
83 
84  const EDA_RECT GetBoundingBox() const override;
85 
86  void Move( const wxPoint& aMoveVector ) override
87  {
88  m_pos += aMoveVector;
89  }
90 
91  void MirrorHorizontally( int aCenter ) override;
92  void MirrorVertically( int aCenter ) override;
93  void Rotate( const wxPoint& aCenter ) override;
94 
95  bool IsDangling() const override;
96 
97  bool IsConnectable() const override { return true; }
98 
99  std::vector<wxPoint> GetConnectionPoints() const override;
100 
101  wxPoint GetPosition() const override { return m_pos; }
102  void SetPosition( const wxPoint& aPosition ) override { m_pos = aPosition; }
103 
104  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
105  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
106 
107  void Plot( PLOTTER* aPlotter ) const override;
108 
109  void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
110 
111  bool operator <( const SCH_ITEM& aItem ) const override;
112 
113 #if defined(DEBUG)
114  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
115 #endif
116 
117 private:
118  bool doIsConnected( const wxPoint& aPosition ) const override;
119 
120 protected:
121  wxPoint m_pos;
122  wxSize m_size;
126 };
127 
132 {
133 public:
134  SCH_BUS_WIRE_ENTRY( const wxPoint& pos = wxPoint( 0, 0 ), bool aFlipY = false );
135 
136  SCH_BUS_WIRE_ENTRY( const wxPoint& pos, int aQuadrant );
137 
139 
140  static inline bool ClassOf( const EDA_ITEM* aItem )
141  {
142  return aItem && SCH_BUS_WIRE_ENTRY_T == aItem->Type();
143  }
144 
145  wxString GetClass() const override
146  {
147  return wxT( "SCH_BUS_WIRE_ENTRY" );
148  }
149 
150  int GetPenWidth() const override;
151 
152  void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
153 
154  bool CanConnect( const SCH_ITEM* aItem ) const override
155  {
156  return aItem->Type() == SCH_LINE_T &&
157  ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS );
158  }
159 
160  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
161 
162  EDA_ITEM* Clone() const override;
163 
164  virtual bool ConnectionPropagatesTo( const EDA_ITEM* aItem ) const override;
165 
166  BITMAPS GetMenuImage() const override;
167 
168  bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemList,
169  const SCH_SHEET_PATH* aPath = nullptr ) override;
170 
176 };
177 
182 {
183 public:
184  SCH_BUS_BUS_ENTRY( const wxPoint& pos = wxPoint( 0, 0 ), bool aFlipY = false );
185 
187 
188  static inline bool ClassOf( const EDA_ITEM* aItem )
189  {
190  return aItem && SCH_BUS_BUS_ENTRY_T == aItem->Type();
191  }
192 
193  wxString GetClass() const override
194  {
195  return wxT( "SCH_BUS_BUS_ENTRY" );
196  }
197 
198  int GetPenWidth() const override;
199 
200  void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
201 
202  bool CanConnect( const SCH_ITEM* aItem ) const override
203  {
204  return aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_BUS;
205  }
206 
207  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
208 
209  EDA_ITEM* Clone() const override;
210 
211  BITMAPS GetMenuImage() const override;
212 
213  bool UpdateDanglingState( std::vector<DANGLING_END_ITEM>& aItemList,
214  const SCH_SHEET_PATH* aPath = nullptr ) override;
215 
221 };
222 
223 #endif // _SCH_BUS_ENTRY_H_
Class for a bus to bus entry.
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.
void SetWidth(int aWidth)
Definition: sch_item.h:168
void MirrorVertically(int aCenter) override
Mirror item vertically about aCenter.
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_bus_entry.h:86
bool doIsConnected(const wxPoint &aPosition) const override
Provide the object specific test to see if it is connected to aPosition.
virtual bool HasLineStroke() const override
Check if this schematic item has line stoke properties.
Definition: sch_bus_entry.h:68
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
void SetSize(const wxSize &aSize)
Definition: sch_bus_entry.h:64
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 ...
void Print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
Print a schematic item.
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...
bool CanConnect(const SCH_ITEM *aItem) const override
void SetPenWidth(int aWidth)
Definition: sch_bus_entry.h:66
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_bus_entry.h:69
~SCH_BUS_BUS_ENTRY()
SCH_BUS_BUS_ENTRY(const wxPoint &pos=wxPoint(0, 0), bool aFlipY=false)
bool IsConnectable() const override
Definition: sch_bus_entry.h:97
SCH_BUS_ENTRY_BASE(KICAD_T aType, const wxPoint &pos=wxPoint(0, 0), bool aFlipY=false)
void Rotate(const wxPoint &aCenter) override
Rotate the item around aCenter 90 degrees in the clockwise direction.
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
void SetPosition(const wxPoint &aPosition) override
SCH_BUS_WIRE_ENTRY(const wxPoint &pos=wxPoint(0, 0), bool aFlipY=false)
wxString GetClass() const override
Return the class name.
void SetPlotStyle(PLOT_DASH_TYPE aPlotStyle)
Definition: sch_item.h:171
wxPoint m_pos
bool CanConnect(const SCH_ITEM *aItem) const override
void MirrorHorizontally(int aCenter) override
Mirror item horizontally about aCenter.
wxSize m_size
The base class for create windows for drawing purpose.
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
bool IsDanglingEnd() const
Definition: sch_bus_entry.h:48
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:42
virtual bool ConnectionPropagatesTo(const EDA_ITEM *aItem) const override
Return true if this item should propagate connection info to aItem.
PLOT_DASH_TYPE GetStrokeStyle() const
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
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:59
void SetStrokeColor(const COLOR4D &aColor)
Definition: sch_bus_entry.h:76
virtual void SetStroke(const STROKE_PARAMS &aStroke) override
Definition: sch_bus_entry.h:70
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
bool IsDangling() const override
bool IsDanglingStart() const
Definition: sch_bus_entry.h:47
std::vector< wxPoint > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
wxString GetClass() const override
Return the class name.
void Plot(PLOTTER *aPlotter) const override
Plot the schematic item to aPlotter.
void SetStrokeStyle(PLOT_DASH_TYPE aStyle)
Definition: sch_bus_entry.h:73
bool m_isDanglingStart
static bool ClassOf(const EDA_ITEM *aItem)
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
Handle access to a stack of flattened SCH_SHEET objects by way of a path for creating a flattened sch...
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.
STROKE_PARAMS m_stroke
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
PLOT_DASH_TYPE
Dashed line types.
Definition: plotter.h:104
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:272
EDA_UNITS
Definition: eda_units.h:38
Base plotter engine class.
Definition: plotter.h:121
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
wxSize GetSize() const
Definition: sch_bus_entry.h:63
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:32
int GetPenWidth() const override
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
Simple container to manage line stroke parameters.
Definition: sch_item.h:155
Handle the component boundary box.
Definition: eda_rect.h:42
bool m_isDanglingEnd
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
Class for a wire to bus entry.
void SetColor(const COLOR4D &aColor)
Definition: sch_item.h:174
COLOR4D GetStrokeColor() const
bool operator<(const SCH_ITEM &aItem) const override
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.
~SCH_BUS_ENTRY_BASE()
Definition: sch_bus_entry.h:52
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Test if aPosition is contained within or on the bounding box of an item.
~SCH_BUS_WIRE_ENTRY()
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:197
int GetPenWidth() const override
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:113
wxPoint GetEnd() const
static bool ClassOf(const EDA_ITEM *aItem)
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:103
wxPoint GetPosition() const override