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-2017 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_struct.h>
34 
36 
37 class SCH_NO_CONNECT : public SCH_ITEM
38 {
40  int m_size;
41 
42 public:
43  SCH_NO_CONNECT( const wxPoint& pos = wxPoint( 0, 0 ) );
44 
45  // Do not create a copy constructor. The one generated by the compiler is adequate.
46 
48 
49  wxString GetClass() const override
50  {
51  return wxT( "SCH_NO_CONNECT" );
52  }
53 
54  int GetSize() const
55  {
56  return std::max( m_size, KiROUND( GetDefaultLineThickness() * 3 ) );
57  }
58 
59  int GetPenSize() const override;
60 
61  void SwapData( SCH_ITEM* aItem ) override;
62 
63  void ViewGetLayers( int aLayers[], int& aCount ) const override;
64 
65  void Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, const wxPoint& aOffset,
66  GR_DRAWMODE aDrawMode, COLOR4D aColor = COLOR4D::UNSPECIFIED ) override;
67 
68  void GetEndPoints( std::vector< DANGLING_END_ITEM >& aItemList ) override;
69 
70  const EDA_RECT GetBoundingBox() const override;
71 
72  // Geometric transforms (used in block operations):
73 
74  void Move( const wxPoint& aMoveVector ) override
75  {
76  m_pos += aMoveVector;
77  }
78 
79  void MirrorY( int aYaxis_position ) override;
80 
81  void MirrorX( int aXaxis_position ) override;
82 
83  void Rotate( wxPoint aPosition ) override;
84 
85  bool IsSelectStateChanged( const wxRect& aRect ) override;
86 
87  bool IsConnectable() const override { return true; }
88 
89  bool CanConnect( const SCH_ITEM* aItem ) const override
90  {
91  return ( aItem->Type() == SCH_LINE_T && aItem->GetLayer() == LAYER_WIRE ) ||
92  aItem->Type() == SCH_COMPONENT_T;
93  }
94 
95  void GetConnectionPoints( std::vector< wxPoint >& aPoints ) const override;
96 
97  wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override
98  {
99  return wxString( _( "No Connect" ) );
100  }
101 
102  BITMAP_DEF GetMenuImage() const override;
103 
104  void GetNetListItem( NETLIST_OBJECT_LIST& aNetListItems, SCH_SHEET_PATH* aSheetPath ) override;
105 
106  wxPoint GetPosition() const override { return m_pos; }
107 
108  void SetPosition( const wxPoint& aPosition ) override { m_pos = aPosition; }
109 
110  bool HitTest( const wxPoint& aPosition, int aAccuracy ) const override;
111 
112  bool HitTest( const EDA_RECT& aRect, bool aContained = false, int aAccuracy = 0 ) const override;
113 
114  void Plot( PLOTTER* aPlotter ) override;
115 
116  EDA_ITEM* Clone() const override;
117 
118 #if defined(DEBUG)
119  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
120 #endif
121 
122 private:
123  bool doIsConnected( const wxPoint& aPosition ) const override;
124 };
125 
126 
127 #endif // _SCH_NO_CONNECT_H_
KICAD_T Type() const
Function Type()
Definition: base_struct.h:201
void MirrorY(int aYaxis_position) override
Function MirrorY mirrors item relative to the Y axis about aYaxis_position.
bool HitTest(const wxPoint &aPosition, int aAccuracy) const override
Function HitTest tests if aPosition is contained within or on the bounding box of an item...
PNG memory record (file in memory).
Definition: bitmap_types.h:43
BITMAP_DEF GetMenuImage() const override
Function GetMenuImage returns a pointer to an image to be used in menus.
static int KiROUND(double v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: common.h:120
Base schematic object class definition.
wxPoint GetPosition() const override
Function GetPosition.
wxPoint m_pos
Position of the no connect object.
int GetDefaultLineThickness()
Default line thickness used to draw/plot items having a default thickness line value (i...
void MirrorX(int aXaxis_position) override
Function MirrorX mirrors item relative to the X axis about aXaxis_position.
wxString GetClass() const override
Function GetClass returns the class name.
void GetConnectionPoints(std::vector< wxPoint > &aPoints) const override
Function GetConnectionPoints add all the connection points for this item to aPoints.
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...
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...
SCH_LAYER_ID GetLayer() const
Function GetLayer returns the layer this item is on.
SCH_NO_CONNECT(const wxPoint &pos=wxPoint(0, 0))
void SwapData(SCH_ITEM *aItem) override
Function SwapData swap the internal data structures aItem with the schematic item.
wxString GetSelectMenuText(EDA_UNITS_T aUnits) const override
Function GetSelectMenuText returns the text to display to be used in the selection clarification cont...
Class NETLIST_OBJECT_LIST is a container holding and owning NETLIST_OBJECTs, which are connected item...
void SetPosition(const wxPoint &aPosition) override
Function SetPosition set the schematic item position to aPosition.
GR_DRAWMODE
Drawmode. Compositing mode plus a flag or two.
Definition: gr_basic.h:37
bool IsConnectable() const override
Function IsConnectable returns true if the schematic item can connect to another schematic item...
bool CanConnect(const SCH_ITEM *aItem) const override
Class SCH_SHEET_PATH.
void Move(const wxPoint &aMoveVector) override
Function Move moves the item by aMoveVector to a new position.
void Plot(PLOTTER *aPlotter) override
Function Plot plots the schematic item to aPlotter.
const EDA_RECT GetBoundingBox() const override
Function GetBoundingBox returns the orthogonal, bounding box of this object for display purposes...
Base plotter engine class.
Definition: plotter.h:97
#define max(a, b)
Definition: auxiliary.h:86
void Draw(EDA_DRAW_PANEL *aPanel, wxDC *aDC, const wxPoint &aOffset, GR_DRAWMODE aDrawMode, COLOR4D aColor=COLOR4D::UNSPECIFIED) override
Function Draw Draw a schematic item.
Class EDA_RECT handles the component boundary box.
Definition: eda_rect.h:44
Class EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boa...
Definition: base_struct.h:154
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...
void Rotate(wxPoint aPosition) override
Function Rotate rotates the item around aPosition 90 degrees in the clockwise direction.
int GetPenSize() const override
Function GetPenSize virtual pure.
int GetSize() const
EDA_ITEM * Clone() const override
Function Clone creates a duplicate of this item with linked list members set to NULL.
bool IsSelectStateChanged(const wxRect &aRect) override
Function IsSelectStateChanged checks if the selection state of an item inside aRect has changed...
Class SCH_ITEM is a base class for any item which can be embedded within the SCHEMATIC container clas...
EDA_UNITS_T
Definition: common.h:159
bool doIsConnected(const wxPoint &aPosition) const override
Function doIsConnected provides the object specific test to see if it is connected to aPosition...
int m_size
Size of the no connect object.
Class COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39