KiCad PCB EDA Suite
sch_no_connect.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 
29 #ifndef _SCH_NO_CONNECT_H_
30 #define _SCH_NO_CONNECT_H_
31 
32 
33 #include <sch_item.h>
34 #include <math/util.h> // for KiROUND
35 
36 
37 class NETLIST_OBJECT_LIST;
38 
39 class SCH_NO_CONNECT : public SCH_ITEM
40 {
42  int m_size;
43 
44 public:
45  SCH_NO_CONNECT( const wxPoint& pos = wxPoint( 0, 0 ) );
46 
47  // Do not create a copy constructor. The one generated by the compiler is adequate.
48 
50 
51  static inline bool ClassOf( const EDA_ITEM* aItem )
52  {
53  return aItem && SCH_NO_CONNECT_T == aItem->Type();
54  }
55 
56  wxString GetClass() const override
57  {
58  return wxT( "SCH_NO_CONNECT" );
59  }
60 
61  int GetSize() const
62  {
63  return m_size;
64  }
65 
66  int GetPenWidth() const override;
67 
68  void SwapData( SCH_ITEM* aItem ) override;
69 
70  void ViewGetLayers( int aLayers[], int& aCount ) const override;
71 
72  void Print( RENDER_SETTINGS* aSettings, const wxPoint& aOffset ) override;
73 
74  void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
75 
76  const EDA_RECT GetBoundingBox() const override;
77 
78  // Geometric transforms (used in block operations):
79 
80  void Move( const wxPoint& aMoveVector ) override
81  {
82  m_pos += aMoveVector;
83  }
84 
85  void MirrorY( int aYaxis_position ) override;
86  void MirrorX( int aXaxis_position ) override;
87  void Rotate( wxPoint aPosition ) override;
88 
89  bool IsConnectable() const override { return true; }
90 
91  bool CanConnect( const SCH_ITEM* aItem ) const override
92  {
93  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
94  aItem->Type() == SCH_COMPONENT_T;
95  }
96 
97  std::vector<wxPoint> GetConnectionPoints() const override;
98 
99  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override
100  {
101  return wxString( _( "No Connect" ) );
102  }
103 
104  BITMAP_DEF GetMenuImage() const override;
105 
106  wxPoint GetPosition() const override { return m_pos; }
107  void SetPosition( const wxPoint& aPosition ) override { m_pos = aPosition; }
108 
109  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
110  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
111 
112  void Plot( PLOTTER* aPlotter ) override;
113 
114  EDA_ITEM* Clone() const override;
115 
116 #if defined(DEBUG)
117  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
118 #endif
119 
120 private:
121  bool doIsConnected( const wxPoint& aPosition ) const override;
122 };
123 
124 
125 #endif // _SCH_NO_CONNECT_H_
EDA_UNITS
Definition: common.h:198
std::vector< wxPoint > GetConnectionPoints() const override
Add all the connection points for this item to aPoints.
void MirrorY(int aYaxis_position) override
Mirror item relative to the Y axis about aYaxis_position.
int GetPenWidth() const override
PNG memory record (file in memory).
Definition: bitmap_def.h:29
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
RENDER_SETTINGS Contains all the knowledge about how graphical objects are drawn on any output surfac...
wxPoint GetPosition() const override
wxPoint m_pos
Position of the no connect object.
void MirrorX(int aXaxis_position) override
Mirror item relative to the X axis about aXaxis_position.
wxString GetClass() const override
Function GetClass returns the class name.
void GetEndPoints(std::vector< DANGLING_END_ITEM > &aItemList) override
Add the schematic item end points to aItemList if the item has end points.
SCH_NO_CONNECT(const wxPoint &pos=wxPoint(0, 0))
void SwapData(SCH_ITEM *aItem) override
Swap the internal data structures aItem with the schematic item.
void Print(RENDER_SETTINGS *aSettings, const wxPoint &aOffset) override
Print a schematic item.
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.
void SetPosition(const wxPoint &aPosition) override
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
bool IsConnectable() const override
int GetSize() const
bool CanConnect(const SCH_ITEM *aItem) const override
void Move(const wxPoint &aMoveVector) override
Move the item by aMoveVector to a new position.
void Plot(PLOTTER *aPlotter) override
Plot the schematic item to aPlotter.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes.
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
#define _(s)
Definition: 3d_actions.cpp:33
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:159
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the layers the item is drawn on (which may be more than its "home" layer)
void Rotate(wxPoint aPosition) override
Rotate the item around aPosition 90 degrees in the clockwise direction.
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
Base class for any item which can be embedded within the SCHEMATIC container class,...
Definition: sch_item.h:194
static bool ClassOf(const EDA_ITEM *aItem)
bool doIsConnected(const wxPoint &aPosition) const override
Provide the object specific test to see if it is connected to aPosition.
int m_size
Size of the no connect object.
KICAD_T Type() const
Function Type()
Definition: base_struct.h:193