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-2020 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 <plotter.h>
35 #include <sch_item.h>
36 
37 #define TARGET_BUSENTRY_RADIUS Mils2iu( 12 ) // Circle diameter drawn at the ends
38 
39 
44 {
45 protected:
47  wxSize m_size;
51 
52 public:
53  SCH_BUS_ENTRY_BASE( KICAD_T aType, const wxPoint& pos = wxPoint( 0, 0 ), bool aFlipY = false );
54 
55  bool IsDanglingStart() const { return m_isDanglingStart; }
56  bool IsDanglingEnd() const { return m_isDanglingEnd; }
57 
58  // Do not create a copy constructor. The one generated by the compiler is adequate.
59 
61 
67  bool IsMovableFromAnchorPoint() override { return false; }
68 
69  wxPoint GetEnd() const;
70 
71  wxSize GetSize() const { return m_size; }
72 
73  void SetSize( const wxSize& aSize ) { m_size = aSize; }
74 
75  void SetPenWidth( int aWidth ) { m_stroke.SetWidth( aWidth ); }
76 
77  virtual bool HasLineStroke() const override { return true; }
78  virtual STROKE_PARAMS GetStroke() const override { return m_stroke; }
79  virtual void SetStroke( const STROKE_PARAMS& aStroke ) override { m_stroke = aStroke; }
80 
82  void SetStrokeStyle( PLOT_DASH_TYPE aStyle ) { m_stroke.SetType( aStyle ); }
83 
84  COLOR4D GetStrokeColor() const;
85  void SetStrokeColor( const COLOR4D& aColor ) { m_stroke.SetColor( aColor ); }
86 
87  void SwapData( SCH_ITEM* aItem ) override;
88 
89  void ViewGetLayers( int aLayers[], int& aCount ) const override;
90 
91  void Print( RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override;
92 
93  const EDA_RECT GetBoundingBox() const override;
94 
95  void Move( const wxPoint& aMoveVector ) override
96  {
97  m_pos += aMoveVector;
98  }
99 
100  void MirrorY( int aYaxis_position ) override;
101  void MirrorX( int aXaxis_position ) override;
102  void Rotate( wxPoint aPosition ) override;
103 
104  bool IsDangling() const override;
105 
106  bool IsConnectable() const override { return true; }
107 
108  std::vector<wxPoint> GetConnectionPoints() const override;
109 
110  wxPoint GetPosition() const override { return m_pos; }
111  void SetPosition( const wxPoint& aPosition ) override { m_pos = aPosition; }
112 
113  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
114  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
115 
116  void Plot( PLOTTER* aPlotter ) override;
117 
118  void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
119 
120  bool operator <( const SCH_ITEM& aItem ) const override;
121 
122 #if defined(DEBUG)
123  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
124 #endif
125 
126 private:
127  bool doIsConnected( const wxPoint& aPosition ) const override;
128 };
129 
134 {
135 public:
136  SCH_BUS_WIRE_ENTRY( const wxPoint& pos = wxPoint( 0, 0 ), bool aFlipY = false );
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  BITMAP_DEF 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  BITMAP_DEF 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_
EDA_UNITS
Definition: common.h:198
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:170
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
Definition: sch_bus_entry.h:95
bool doIsConnected(const wxPoint &aPosition) const override
Provide the object specific test to see if it is connected to aPosition.
PNG memory record (file in memory).
Definition: bitmap_def.h:29
virtual bool HasLineStroke() const override
Check if this schematic item has line stoke properties.
Definition: sch_bus_entry.h:77
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
void SetSize(const wxSize &aSize)
Definition: sch_bus_entry.h:73
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 ...
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:75
virtual STROKE_PARAMS GetStroke() const override
Definition: sch_bus_entry.h:78
~SCH_BUS_BUS_ENTRY()
SCH_BUS_BUS_ENTRY(const wxPoint &pos=wxPoint(0, 0), bool aFlipY=false)
bool IsConnectable() const override
SCH_BUS_ENTRY_BASE(KICAD_T aType, const wxPoint &pos=wxPoint(0, 0), bool aFlipY=false)
void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers() Returns the all the layers within the VIEW the object is painted on.
void SetType(PLOT_DASH_TYPE aType)
Definition: sch_item.h:173
void SetPosition(const wxPoint &aPosition) override
SCH_BUS_WIRE_ENTRY(const wxPoint &pos=wxPoint(0, 0), bool aFlipY=false)
void Rotate(wxPoint aPosition) override
Rotate the item around aPosition 90 degrees in the clockwise direction.
wxString GetClass() const override
Function GetClass returns the class name.
wxPoint m_pos
Definition: sch_bus_entry.h:46
bool CanConnect(const SCH_ITEM *aItem) const override
wxSize m_size
Definition: sch_bus_entry.h:47
The base class for create windows for drawing purpose.
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
KICAD_T
Enum KICAD_T is the set of class identification values, stored in EDA_ITEM::m_StructType.
Definition: typeinfo.h:78
bool IsDanglingEnd() const
Definition: sch_bus_entry.h:56
void Print(RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
Print a schematic item.
Base class for a bus or wire entry.
Definition: sch_bus_entry.h:43
virtual bool ConnectionPropagatesTo(const EDA_ITEM *aItem) const override
Returns true if this item should propagate connection info to aItem.
PLOT_DASH_TYPE GetStrokeStyle() const
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
void SetStrokeColor(const COLOR4D &aColor)
Definition: sch_bus_entry.h:85
virtual void SetStroke(const STROKE_PARAMS &aStroke) override
Definition: sch_bus_entry.h:79
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
bool IsDangling() const override
bool IsDanglingStart() const
Definition: sch_bus_entry.h:55
std::vector< wxPoint > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
wxString GetClass() const override
Function GetClass returns the class name.
void SetStrokeStyle(PLOT_DASH_TYPE aStyle)
Definition: sch_bus_entry.h:82
bool IsMovableFromAnchorPoint() 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:67
bool m_isDanglingStart
Definition: sch_bus_entry.h:48
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.
SCH_SHEET_PATH.
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
Definition: sch_bus_entry.h:50
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
PLOT_DASH_TYPE
Enum for choosing dashed line type.
Definition: plotter.h:87
SCH_LAYER_ID GetLayer() const
Return the layer this item is on.
Definition: sch_item.h:279
Base plotter engine class.
Definition: plotter.h:114
wxSize GetSize() const
Definition: sch_bus_entry.h:71
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
int GetPenWidth() const override
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Simple container to manage line stroke parameters.
Definition: sch_item.h:153
void MirrorX(int aXaxis_position) override
Mirror item relative to the X axis about aXaxis_position.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
bool m_isDanglingEnd
Definition: sch_bus_entry.h:49
void Plot(PLOTTER *aPlotter) override
Plot the schematic item to aPlotter.
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:159
Class for a wire to bus entry.
void SetColor(const COLOR4D &aColor)
Definition: sch_item.h:176
COLOR4D GetStrokeColor() const
bool operator<(const SCH_ITEM &aItem) const override
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Function GetMsgPanelInfo populates aList of MSG_PANEL_ITEM objects with it's internal state for displ...
~SCH_BUS_ENTRY_BASE()
Definition: sch_bus_entry.h:60
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item.
~SCH_BUS_WIRE_ENTRY()
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
void MirrorY(int aYaxis_position) override
Mirror item relative to the Y axis about aYaxis_position.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
int GetPenWidth() const override
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193
wxPoint GetEnd() const
static bool ClassOf(const EDA_ITEM *aItem)
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:99
wxPoint GetPosition() const override