KiCad PCB EDA Suite
lib_item.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) 2015 Jean-Pierre Charras, jaen-pierre.charras at wanadoo.fr
5  * Copyright (C) 2015 Wayne Stambaugh <stambaughw@gmail.com>
6  * Copyright (C) 2004-2021 KiCad Developers, see AUTHORS.txt for contributors.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, you may find one here:
20  * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
21  * or you may search the http://www.gnu.org website for the version 2 license,
22  * or you may write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
24  */
25 
26 #ifndef _LIB_ITEM_H_
27 #define _LIB_ITEM_H_
28 
29 #include <eda_item.h>
30 #include <eda_rect.h>
31 #include <fill_type.h>
32 #include <transform.h>
33 #include <render_settings.h>
34 
35 class LINE_READER;
36 class OUTPUTFORMATTER;
37 class LIB_SYMBOL;
38 class PLOTTER;
39 class LIB_PIN;
40 class MSG_PANEL_ITEM;
41 
43 
44 extern const int fill_tab[];
45 
46 
47 #define MINIMUM_SELECTION_DISTANCE 2 // Minimum selection distance in internal units
48 
49 
55 typedef std::vector< LIB_PIN* > LIB_PINS;
56 
57 
61 class LIB_ITEM : public EDA_ITEM
62 {
63 public:
64  LIB_ITEM( KICAD_T aType, LIB_SYMBOL* aSymbol = nullptr, int aUnit = 0, int aConvert = 0,
65  FILL_TYPE aFillType = FILL_TYPE::NO_FILL );
66 
67  // Do not create a copy constructor. The one generated by the compiler is adequate.
68 
69  virtual ~LIB_ITEM() { }
70 
71  // Define the enums for basic
72  enum LIB_CONVERT : int { BASE = 1, DEMORGAN = 2 };
73 
81  enum COMPARE_FLAGS : int { NORMAL = 0x00, UNIT = 0x01 };
82 
87  virtual wxString GetTypeName() const = 0;
88 
98  virtual void BeginEdit( const wxPoint& aPosition ) {}
99 
110  virtual bool ContinueEdit( const wxPoint& aPosition ) { return false; }
111 
117  virtual void EndEdit() {}
118 
128  virtual void CalcEdit( const wxPoint& aPosition ) {}
129 
141  virtual void Print( const RENDER_SETTINGS* aSettings, const wxPoint &aOffset,
142  void* aData, const TRANSFORM& aTransform );
143 
144  virtual int GetPenWidth() const = 0;
145 
147  {
148  return (LIB_SYMBOL*) m_parent;
149  }
150 
151  void ViewGetLayers( int aLayers[], int& aCount ) const override;
152 
153  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override
154  {
155  // This is just here to prevent annoying compiler warnings about hidden overloaded
156  // virtual functions
157  return EDA_ITEM::HitTest( aPosition, aAccuracy );
158  }
159 
160  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override;
161 
165  const EDA_RECT GetBoundingBox() const override { return EDA_ITEM::GetBoundingBox(); }
166 
176  void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
177 
184  bool operator==( const LIB_ITEM& aOther ) const;
185  bool operator==( const LIB_ITEM* aOther ) const
186  {
187  return *this == *aOther;
188  }
189 
196  bool operator<( const LIB_ITEM& aOther) const;
197 
203  virtual void Offset( const wxPoint& aOffset ) = 0;
204 
210  virtual void MoveTo( const wxPoint& aPosition ) = 0;
211 
212  void SetPosition( const wxPoint& aPosition ) override { MoveTo( aPosition ); }
213 
219  virtual void MirrorHorizontal( const wxPoint& aCenter ) = 0;
220 
226  virtual void MirrorVertical( const wxPoint& aCenter ) = 0;
227 
234  virtual void Rotate( const wxPoint& aCenter, bool aRotateCCW = true ) = 0;
235 
244  virtual void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
245  const TRANSFORM& aTransform ) const = 0;
246 
247  virtual int GetWidth() const = 0;
248  virtual void SetWidth( int aWidth ) = 0;
249 
256  bool IsFillable() const { return m_isFillable; }
257 
258  void SetUnit( int aUnit ) { m_unit = aUnit; }
259  int GetUnit() const { return m_unit; }
260 
261  void SetConvert( int aConvert ) { m_convert = aConvert; }
262  int GetConvert() const { return m_convert; }
263 
264  void SetFillMode( FILL_TYPE aFillMode ) { m_fill = aFillMode; }
265  FILL_TYPE GetFillMode() const { return m_fill; }
266 
267 #if defined(DEBUG)
268  void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
269 #endif
270 
271 protected:
292  virtual int compare( const LIB_ITEM& aOther,
293  LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const;
294 
303  virtual void print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset, void* aData,
304  const TRANSFORM& aTransform ) = 0;
305 
306 private:
307  friend class LIB_SYMBOL;
308 
309 protected:
314  int m_unit;
315 
321 
328 };
329 
330 
331 #endif // _LIB_ITEM_H_
const EDA_RECT GetBoundingBox() const override
Definition: lib_item.h:165
virtual int GetPenWidth() const =0
EDA_ITEM * m_parent
Linked list: Link (parent struct)
Definition: eda_item.h:479
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:80
FILL_TYPE
The set of fill types used in plotting or drawing enclosed areas.
Definition: fill_type.h:28
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
virtual void SetWidth(int aWidth)=0
std::vector< LIB_PIN * > LIB_PINS
Helper for defining a list of pin object pointers.
Definition: lib_item.h:55
void SetFillMode(FILL_TYPE aFillMode)
Definition: lib_item.h:264
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:306
virtual void MirrorHorizontal(const wxPoint &aCenter)=0
Mirror the draw object along the horizontal (X) axis about aCenter point.
virtual void CalcEdit(const wxPoint &aPosition)
Calculate the attributes of an item at aPosition when it is being edited.
Definition: lib_item.h:128
The base class for create windows for drawing purpose.
Define a library symbol object.
Definition: lib_symbol.h:96
FILL_TYPE m_fill
The body fill type.
Definition: lib_item.h:326
bool operator==(const LIB_ITEM *aOther) const
Definition: lib_item.h:185
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
The base class for drawable items used by schematic library symbols.
Definition: lib_item.h:61
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
Definition: lib_item.cpp:129
virtual void Offset(const wxPoint &aOffset)=0
Set the drawing object by aOffset from the current position.
virtual bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const
Test if aPosition is contained within or on the bounding box of an item.
Definition: eda_item.h:225
virtual wxString GetTypeName() const =0
Provide a user-consumable name of the object type.
virtual void Plot(PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform) const =0
Plot the draw item using the plot object.
FILL_TYPE GetFillMode() const
Definition: lib_item.h:265
int m_unit
Unit identification for multiple parts per package.
Definition: lib_item.h:314
int GetUnit() const
Definition: lib_item.h:259
bool operator==(const LIB_ITEM &aOther) const
Test LIB_ITEM objects for equivalence.
Definition: lib_item.cpp:93
virtual ~LIB_ITEM()
Definition: lib_item.h:69
for transforming drawing coordinates for a wxDC device context.
Definition: transform.h:45
COMPARE_FLAGS
The list of flags used by the compare function.
Definition: lib_item.h:81
int m_convert
Shape identification for alternate body styles.
Definition: lib_item.h:320
bool operator<(const LIB_ITEM &aOther) const
Test if another draw item is less than this draw object.
Definition: lib_item.cpp:99
virtual void Rotate(const wxPoint &aCenter, bool aRotateCCW=true)=0
Rotate the object about aCenter point.
bool m_isFillable
Definition: lib_item.h:327
virtual void MirrorVertical(const wxPoint &aCenter)=0
Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.
int GetConvert() const
Definition: lib_item.h:262
LIB_CONVERT
Definition: lib_item.h:72
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Display basic info (type, part and convert) about the current item in message panel.
Definition: lib_item.cpp:50
virtual void MoveTo(const wxPoint &aPosition)=0
Move a draw object to aPosition.
void SetConvert(int aConvert)
Definition: lib_item.h:261
LIB_ITEM(KICAD_T aType, LIB_SYMBOL *aSymbol=nullptr, int aUnit=0, int aConvert=0, FILL_TYPE aFillType=FILL_TYPE::NO_FILL)
Definition: lib_item.cpp:35
virtual int GetWidth() const =0
LIB_SYMBOL * GetParent() const
Definition: lib_item.h:146
void SetUnit(int aUnit)
Definition: lib_item.h:258
Base plotter engine class.
Definition: plotter.h:121
virtual bool ContinueEdit(const wxPoint &aPosition)
Continue an edit in progress at aPosition.
Definition: lib_item.h:110
const int fill_tab[]
Definition: lib_item.cpp:32
virtual void Print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)
Draw an item.
Definition: lib_item.cpp:122
bool HitTest(const wxPoint &aPosition, int aAccuracy=0) const override
Test if aPosition is contained within or on the bounding box of an item.
Definition: lib_item.h:153
virtual void BeginEdit(const wxPoint &aPosition)
Begin drawing a symbol library draw item at aPosition.
Definition: lib_item.h:98
Handle the component boundary box.
Definition: eda_rect.h:42
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:100
void SetPosition(const wxPoint &aPosition) override
Definition: lib_item.h:212
bool IsFillable() const
Check if draw object can be filled.
Definition: lib_item.h:256
virtual const EDA_RECT GetBoundingBox() const
Return the orthogonal bounding box of this object for display purposes.
Definition: eda_item.cpp:75
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:53
virtual int compare(const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) const
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_item.cpp:74
virtual void print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform)=0
Print the item to aDC.
virtual void EndEdit()
End an object editing action.
Definition: lib_item.h:117