KiCad PCB EDA Suite
sch_junction.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) 2009 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
5  * Copyright (C) 1992-2019 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_JUNCTION_H_
26 #define _SCH_JUNCTION_H_
27 
28 
29 #include <sch_item.h>
31 
32 class SCH_JUNCTION : public SCH_ITEM
33 {
34  wxPoint m_pos; // Position of the junction.
35  static int m_symbolSize; // diameter of the junction graphic symbol
36 
37 public:
38  SCH_JUNCTION( const wxPoint& pos = wxPoint( 0, 0 ) );
39 
40  // Do not create a copy constructor. The one generated by the compiler is adequate.
41 
43 
44  static inline bool ClassOf( const EDA_ITEM* aItem )
45  {
46  return aItem && SCH_JUNCTION_T == aItem->Type();
47  }
48 
49  wxString GetClass() const override
50  {
51  return wxT( "SCH_JUNCTION" );
52  }
53 
54  static int GetSymbolSize() { return m_symbolSize; }
55  static void SetSymbolSize( int aSize ) { m_symbolSize = aSize; }
56 
57  // Return the size the symbol should be drawn at. This is GetSymbolSize() clamped to be
58  // no less than the current wire width.
59  static int GetEffectiveSymbolSize();
60 
61  void SwapData( SCH_ITEM* aItem ) override;
62 
63  void ViewGetLayers( int aLayers[], int& aCount ) const override;
64 
65  const EDA_RECT GetBoundingBox() const override;
66 
67  void Print( wxDC* aDC, const wxPoint& aOffset ) override;
68 
69  void Move( const wxPoint& aMoveVector ) override
70  {
71  m_pos += aMoveVector;
72  }
73 
74  void MirrorY( int aYaxis_position ) override;
75  void MirrorX( int aXaxis_position ) override;
76  void Rotate( wxPoint aPosition ) override;
77 
78  void GetEndPoints( std::vector <DANGLING_END_ITEM>& aItemList ) override;
79 
80  bool IsConnectable() const override { return true; }
81 
82  void GetConnectionPoints( std::vector< wxPoint >& aPoints ) const override;
83 
84  bool CanConnect( const SCH_ITEM* aItem ) const override
85  {
86  return ( aItem->Type() == SCH_LINE_T &&
87  ( aItem->GetLayer() == LAYER_WIRE || aItem->GetLayer() == LAYER_BUS ) ) ||
88  aItem->Type() == SCH_COMPONENT_T;
89  }
90 
91  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override
92  {
93  return wxString( _( "Junction" ) );
94  }
95 
96  BITMAP_DEF GetMenuImage() const override;
97 
98  void GetNetListItem( NETLIST_OBJECT_LIST& aNetListItems, SCH_SHEET_PATH* aSheetPath ) override;
99 
100  wxPoint GetPosition() const override { return m_pos; }
101  void SetPosition( const wxPoint& aPosition ) override { m_pos = aPosition; }
102 
103  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
104  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
105 
106  void Plot( PLOTTER* aPlotter ) override;
107 
108  EDA_ITEM* Clone() const override;
109 
110 #if defined(DEBUG)
111  void Show( int nestLevel, std::ostream& os ) const override;
112 #endif
113 
114 private:
115  bool doIsConnected( const wxPoint& aPosition ) const override;
116 };
117 
118 
119 #endif // _SCH_JUNCTION_H_
EDA_UNITS
Definition: common.h:72
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
Definition: sch_junction.h:69
wxString GetClass() const override
Function GetClass returns the class name.
Definition: sch_junction.h:49
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
PNG memory record (file in memory).
Definition: bitmap_def.h:29
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
void GetConnectionPoints(std::vector< wxPoint > &aPoints) const override
Function GetConnectionPoints add all the connection points for this item to aPoints.
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
void SwapData(SCH_ITEM *aItem) override
Function SwapData swap the internal data structures aItem with the schematic item.
static bool ClassOf(const EDA_ITEM *aItem)
Definition: sch_junction.h:44
bool doIsConnected(const wxPoint &aPosition) const override
Function doIsConnected provides the object specific test to see if it is connected to aPosition.
static void SetSymbolSize(int aSize)
Definition: sch_junction.h:55
static int m_symbolSize
Definition: sch_junction.h:35
NETLIST_OBJECT_LIST is a container holding and owning NETLIST_OBJECTs, which are connected items in a...
void GetNetListItem(NETLIST_OBJECT_LIST &aNetListItems, SCH_SHEET_PATH *aSheetPath) override
Function GetNetListItem creates a new NETLIST_OBJECT for the schematic object and adds it to aNetList...
wxPoint GetPosition() const override
Function GetPosition.
Definition: sch_junction.h:100
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
Definition: sch_junction.h:101
bool CanConnect(const SCH_ITEM *aItem) const override
Definition: sch_junction.h:84
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_SHEET_PATH.
void ViewGetLayers(int aLayers[], int &aCount) const override
Function ViewGetLayers returns the layers the item is drawn on (which may be more than its "home" lay...
wxPoint m_pos
Definition: sch_junction.h:34
bool IsConnectable() const override
Function IsConnectable returns true if the schematic item can connect to another schematic item.
Definition: sch_junction.h:80
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
Definition: sch_item.h:212
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Function GetEndPoints adds the schematic item end points to aItemList if the item has end points.
Base plotter engine class.
Definition: plotter.h:103
SCH_JUNCTION(const wxPoint &pos=wxPoint(0, 0))
#define _(s)
Definition: 3d_actions.cpp:31
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Definition: sch_junction.h:91
static int GetSymbolSize()
Definition: sch_junction.h:54
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:163
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
void Print(wxDC *aDC, const wxPoint &aOffset) override
Function Print Print a schematic item.
static int GetEffectiveSymbolSize()
SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:136
void Plot(PLOTTER *aPlotter) override
Function Plot plots the schematic item to aPlotter.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207