KiCad PCB EDA Suite
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, [email protected]
5  * Copyright (C) 1992-2011 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
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  *
20  * or you may search the 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  */
25 #ifndef PCB_TEXT_H
26 #define PCB_TEXT_H
28 #include <eda_text.h>
29 #include <board_item.h>
32 class LINE_READER;
33 class MSG_PANEL_ITEM;
36 class PCB_TEXT : public BOARD_ITEM, public EDA_TEXT
37 {
38 public:
39  PCB_TEXT( BOARD_ITEM* parent );
41  // Do not create a copy constructor & operator=.
42  // The ones generated by the compiler are adequate.
44  ~PCB_TEXT();
46  static inline bool ClassOf( const EDA_ITEM* aItem )
47  {
48  return aItem && PCB_TEXT_T == aItem->Type();
49  }
51  bool IsType( const KICAD_T aScanTypes[] ) const override
52  {
53  if( BOARD_ITEM::IsType( aScanTypes ) )
54  return true;
56  for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
57  {
58  if( *p == PCB_LOCATE_TEXT_T )
59  return true;
60  }
62  return false;
63  }
65  wxString GetShownText( int aDepth = 0 ) const override;
68  void SetVisible( bool aVisible ) override { /* do nothing */}
69  bool IsVisible() const override { return true; }
71  bool Matches( const wxFindReplaceData& aSearchData, void* aAuxData ) const override
72  {
73  return BOARD_ITEM::Matches( GetShownText(), aSearchData );
74  }
76  virtual wxPoint GetPosition() const override
77  {
78  return EDA_TEXT::GetTextPos();
79  }
81  virtual void SetPosition( const wxPoint& aPos ) override
82  {
83  EDA_TEXT::SetTextPos( aPos );
84  }
86  void Move( const wxPoint& aMoveVector ) override
87  {
88  EDA_TEXT::Offset( aMoveVector );
89  }
91  void SetTextAngle( double aAngle ) override;
93  void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
95  void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;
97  void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
99  bool TextHitTest( const wxPoint& aPoint, int aAccuracy = 0 ) const override;
100  bool TextHitTest( const EDA_RECT& aRect, bool aContains, int aAccuracy = 0 ) const override;
102  bool HitTest( const wxPoint& aPosition, int aAccuracy ) const override
103  {
104  return TextHitTest( aPosition, aAccuracy );
105  }
110  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override
111  {
112  return TextHitTest( aRect, aContained, aAccuracy );
113  }
115  wxString GetClass() const override
116  {
117  return wxT( "PTEXT" );
118  }
130  PCB_LAYER_ID aLayer, int aClearanceValue,
131  int aError, ERROR_LOC aErrorLoc ) const;
134  int aClearanceValue, int aError, ERROR_LOC aErrorLoc,
135  bool aIgnoreLineWidth = false ) const override;
137  // @copydoc BOARD_ITEM::GetEffectiveShape
138  virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
139  FLASHING aFlash = FLASHING::DEFAULT ) const override;
141  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
143  BITMAPS GetMenuImage() const override;
145  // Virtual function
146  const EDA_RECT GetBoundingBox() const override;
148  EDA_ITEM* Clone() const override;
150  virtual void SwapData( BOARD_ITEM* aImage ) override;
152 #if defined(DEBUG)
153  virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
154 #endif
155 };
157 #endif // #define PCB_TEXT_H
void Offset(const wxPoint &aOffset)
Definition: eda_text.h:273
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:80
virtual bool Matches(const wxFindReplaceData &aSearchData, void *aAuxData) const
Compare the item against the search criteria in aSearchData.
Definition: eda_item.h:364
bool TextHitTest(const wxPoint &aPoint, int aAccuracy=0) const override
Test if aPoint is within the bounds of this object.
Definition: pcb_text.cpp:143
virtual void SetPosition(const wxPoint &aPos) override
Definition: pcb_text.h:81
virtual void SwapData(BOARD_ITEM *aImage) override
Swap data between aItem and aImage.
Definition: pcb_text.cpp:208
void Flip(const wxPoint &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: pcb_text.cpp:172
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: pcb_text.cpp:196
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:49
void TransformTextShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc) const
Function TransformTextShapeWithClearanceToPolygon Convert the text to a polygonSet describing the act...
Definition: pcb_text.cpp:222
void SetTextAngle(double aAngle) override
Definition: pcb_text.cpp:104
wxString GetClass() const override
Return the class name.
Definition: pcb_text.h:115
void TransformShapeWithClearanceToPolygon(SHAPE_POLY_SET &aCornerBuffer, PCB_LAYER_ID aLayer, int aClearanceValue, int aError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=false) const override
Convert the item shape to a closed polygon.
Definition: pcb_text.cpp:245
void SetTextPos(const wxPoint &aPoint)
Definition: eda_text.h:267
class PCB_TEXT, text on a layer
Definition: typeinfo.h:91
void GetMsgPanelInfo(EDA_DRAW_FRAME *aFrame, std::vector< MSG_PANEL_ITEM > &aList) override
Populate aList of MSG_PANEL_ITEM objects with it's internal state for display purposes.
Definition: pcb_text.cpp:110
The base class for create windows for drawing purpose.
Definition: pcb_text.cpp:43
search types array terminator (End Of Types)
Definition: typeinfo.h:81
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:77
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
bool IsVisible() const override
Definition: pcb_text.h:69
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:140
wxString GetShownText(int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: pcb_text.cpp:56
Definition: pcb_text.cpp:51
virtual wxPoint GetPosition() const override
Definition: pcb_text.h:76
Represent a set of closed polygons.
bool IsType(const KICAD_T aScanTypes[]) const override
Check whether the item is one of the listed types.
Definition: pcb_text.h:51
virtual bool IsType(const KICAD_T aScanTypes[]) const
Check whether the item is one of the listed types.
Definition: eda_item.h:182
static bool ClassOf(const EDA_ITEM *aItem)
Definition: pcb_text.h:46
wxString GetSelectMenuText(EDA_UNITS aUnits) const override
Return the text to display to be used in the selection clarification context menu when multiple items...
Definition: pcb_text.cpp:190
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:153
bool HitTest(const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
Definition: pcb_text.h:110
Definition: eda_units.h:38
void Move(const wxPoint &aMoveVector) override
Move this object.
Definition: pcb_text.h:86
A list of all bitmap identifiers.
Definition: bitmaps_list.h:32
A quick note on layer IDs:
Definition: layer_ids.h:65
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:99
virtual std::shared_ptr< SHAPE > GetEffectiveShape(PCB_LAYER_ID aLayer=UNDEFINED_LAYER, FLASHING aFlash=FLASHING::DEFAULT) const override
Some pad shapes can be complex (rounded/chamfered rectangle), even without considering custom shapes.
Definition: pcb_text.cpp:216
bool HitTest(const wxPoint &aPosition, int aAccuracy) const override
Test if aPosition is inside or on the boundary of this item.
Definition: pcb_text.h:102
void Rotate(const wxPoint &aRotCentre, double aAngle) override
Rotate this object.
Definition: pcb_text.cpp:162
const wxPoint & GetTextPos() const
Definition: eda_text.h:268
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_text.cpp:202
void SetVisible(bool aVisible) override
PCB_TEXTs are always visible:
Definition: pcb_text.h:68
bool Matches(const wxFindReplaceData &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: pcb_text.h:71
const EDA_RECT GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_text.cpp:132
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:53
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:112