KiCad PCB EDA Suite
Loading...
Searching...
No Matches
pcb_text.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) 2004 Jean-Pierre Charras, [email protected]
5 * Copyright (C) 1992-2023 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 PCB_TEXT_H
26#define PCB_TEXT_H
27
28#include <eda_text.h>
29#include <board_item.h>
30
31
32class LINE_READER;
33class MSG_PANEL_ITEM;
34class FOOTPRINT;
35
36
37class PCB_TEXT : public BOARD_ITEM, public EDA_TEXT
38{
39public:
40 PCB_TEXT( BOARD_ITEM* parent, KICAD_T idtype = PCB_TEXT_T );
41
49 {
53 };
54
55 PCB_TEXT( FOOTPRINT* aParent, TEXT_TYPE text_type );
56
57 // Do not create a copy constructor & operator=.
58 // The ones generated by the compiler are adequate.
59
60 ~PCB_TEXT();
61
62 static inline bool ClassOf( const EDA_ITEM* aItem )
63 {
64 return aItem && PCB_TEXT_T == aItem->Type();
65 }
66
67 bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
68 {
69 if( BOARD_ITEM::IsType( aScanTypes ) )
70 return true;
71
72 for( KICAD_T scanType : aScanTypes )
73 {
74 if( scanType == PCB_LOCATE_TEXT_T )
75 return true;
76 }
77
78 return false;
79 }
80
84 void KeepUpright( const EDA_ANGLE& aOldOrientation, const EDA_ANGLE& aNewOrientation );
85
86 wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const override;
87
88 void SetType( TEXT_TYPE aType ) { m_type = aType; }
89 TEXT_TYPE GetType() const { return m_type; }
90
91 bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
92
93 virtual VECTOR2I GetPosition() const override
94 {
95 return EDA_TEXT::GetTextPos();
96 }
97
98 virtual void SetPosition( const VECTOR2I& aPos ) override
99 {
100 EDA_TEXT::SetTextPos( aPos );
101 }
102
103 void Move( const VECTOR2I& aMoveVector ) override
104 {
105 EDA_TEXT::Offset( aMoveVector );
106 }
107
108 void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
109
110 void Mirror( const VECTOR2I& aCentre, bool aMirrorAroundXAxis );
111
112 void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
113
114 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
115
116 bool TextHitTest( const VECTOR2I& aPoint, int aAccuracy = 0 ) const override;
117 bool TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy = 0 ) const override;
118
119 bool HitTest( const VECTOR2I& aPosition, int aAccuracy ) const override
120 {
121 return TextHitTest( aPosition, aAccuracy );
122 }
123
124 bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override
125 {
126 return TextHitTest( aRect, aContained, aAccuracy );
127 }
128
129 wxString GetClass() const override
130 {
131 return wxT( "PCB_TEXT" );
132 }
133
142 void TransformTextToPolySet( SHAPE_POLY_SET& aBuffer, int aClearance, int aMaxError,
143 ERROR_LOC aErrorLoc ) const;
144
145 void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
146 int aMaxError, ERROR_LOC aErrorLoc,
147 bool aIgnoreLineWidth = false ) const override;
148
149 // @copydoc BOARD_ITEM::GetEffectiveShape
150 virtual std::shared_ptr<SHAPE>
152 FLASHING aFlash = FLASHING::DEFAULT ) const override;
153
154 wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
155
156 BITMAPS GetMenuImage() const override;
157
162 EDA_ANGLE GetDrawRotation() const override;
163
164 const BOX2I ViewBBox() const override;
165
166 void ViewGetLayers( int aLayers[], int& aCount ) const override;
167
169 double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
170
171 // Virtual function
172 const BOX2I GetBoundingBox() const override;
173
174 EDA_ITEM* Clone() const override;
175
176#if defined(DEBUG)
177 virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
178#endif
179
180protected:
185 void buildBoundingHull( SHAPE_POLY_SET* aBuffer, const SHAPE_POLY_SET& aRenderedText,
186 int aClearance ) const;
187
188 virtual void swapData( BOARD_ITEM* aImage ) override;
189
190 int getKnockoutMargin() const;
191
192private:
194};
195
196#endif // #define PCB_TEXT_H
BITMAPS
A list of all bitmap identifiers.
Definition: bitmaps_list.h:33
A base class for any item which can be embedded within the BOARD container class, and therefore insta...
Definition: board_item.h:71
The base class for create windows for drawing purpose.
A base class for most all the KiCad significant classes used in schematics and boards.
Definition: eda_item.h:85
KICAD_T Type() const
Returns the type of object.
Definition: eda_item.h:97
virtual bool IsType(const std::vector< KICAD_T > &aScanTypes) const
Check whether the item is one of the listed types.
Definition: eda_item.h:165
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:72
const VECTOR2I & GetTextPos() const
Definition: eda_text.h:211
void SetTextPos(const VECTOR2I &aPoint)
Definition: eda_text.cpp:383
void Offset(const VECTOR2I &aOffset)
Definition: eda_text.cpp:401
Hold a (potentially large) number of VIEW_ITEMs and renders them on a graphics device provided by the...
Definition: view.h:69
An abstract class from which implementation specific LINE_READERs may be derived to read single lines...
Definition: richio.h:93
EDA_MSG_PANEL items for displaying messages.
Definition: msgpanel.h:54
void SetType(TEXT_TYPE aType)
Definition: pcb_text.h:88
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:214
void TransformShapeToPolygon(SHAPE_POLY_SET &aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc, bool aIgnoreLineWidth=false) const override
Convert the item shape to a closed polygon.
Definition: pcb_text.cpp:527
void KeepUpright(const EDA_ANGLE &aOldOrientation, const EDA_ANGLE &aNewOrientation)
Called when rotating the parent footprint.
Definition: pcb_text.cpp:262
const BOX2I ViewBBox() const override
Return the bounding box of the item covering all its layers.
Definition: pcb_text.cpp:143
virtual void swapData(BOARD_ITEM *aImage) override
Definition: pcb_text.cpp:417
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:425
bool HitTest(const VECTOR2I &aPosition, int aAccuracy) const override
Test if aPosition is inside or on the boundary of this item.
Definition: pcb_text.h:119
bool Matches(const EDA_SEARCH_DATA &aSearchData, void *aAuxData) const override
Compare the item against the search criteria in aSearchData.
Definition: pcb_text.cpp:115
TEXT_TYPE m_type
Definition: pcb_text.h:193
TEXT_TYPE
Footprint text type: there must be only one (and only one) for each of the reference value texts in o...
Definition: pcb_text.h:49
@ TEXT_is_DIVERS
Definition: pcb_text.h:52
@ TEXT_is_REFERENCE
Definition: pcb_text.h:50
@ TEXT_is_VALUE
Definition: pcb_text.h:51
bool HitTest(const BOX2I &aRect, bool aContained, int aAccuracy=0) const override
Test if aRect intersects this item.
Definition: pcb_text.h:124
wxString GetShownText(bool aAllowExtraText, int aDepth=0) const override
Return the string actually shown after processing of the base text.
Definition: pcb_text.cpp:80
void Flip(const VECTOR2I &aCentre, bool aFlipLeftRight) override
Flip this object, i.e.
Definition: pcb_text.cpp:352
static bool ClassOf(const EDA_ITEM *aItem)
Definition: pcb_text.h:62
~PCB_TEXT()
Definition: pcb_text.cpp:75
virtual VECTOR2I GetPosition() const override
Definition: pcb_text.h:93
wxString GetItemDescription(UNITS_PROVIDER *aUnitsProvider) const override
Return a user-visible description string of this item.
Definition: pcb_text.cpp:372
bool IsType(const std::vector< KICAD_T > &aScanTypes) const override
Check whether the item is one of the listed types.
Definition: pcb_text.h:67
double ViewGetLOD(int aLayer, KIGFX::VIEW *aView) const override
Return the level of detail (LOD) of the item.
Definition: pcb_text.cpp:160
int getKnockoutMargin() const
Definition: pcb_text.cpp:256
void Mirror(const VECTOR2I &aCentre, bool aMirrorAroundXAxis)
Definition: pcb_text.cpp:331
void TransformTextToPolySet(SHAPE_POLY_SET &aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc) const
Function TransformTextToPolySet Convert the text to a polygonSet describing the actual character stro...
Definition: pcb_text.cpp:469
const BOX2I GetBoundingBox() const override
Return the orthogonal bounding box of this object for display purposes.
Definition: pcb_text.cpp:280
void buildBoundingHull(SHAPE_POLY_SET *aBuffer, const SHAPE_POLY_SET &aRenderedText, int aClearance) const
Build a nominally rectangular bounding box for the rendered text.
Definition: pcb_text.cpp:440
bool TextHitTest(const VECTOR2I &aPoint, int aAccuracy=0) const override
Test if aPoint is within the bounds of this object.
Definition: pcb_text.cpp:295
virtual void SetPosition(const VECTOR2I &aPos) override
Definition: pcb_text.h:98
wxString GetClass() const override
Return the class name.
Definition: pcb_text.h:129
void Move(const VECTOR2I &aMoveVector) override
Move this object.
Definition: pcb_text.h:103
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: pcb_text.cpp:411
EDA_ANGLE GetDrawRotation() const override
Definition: pcb_text.cpp:121
void ViewGetLayers(int aLayers[], int &aCount) const override
Definition: pcb_text.cpp:149
TEXT_TYPE GetType() const
Definition: pcb_text.h:89
void Rotate(const VECTOR2I &aRotCentre, const EDA_ANGLE &aAngle) override
Rotate this object.
Definition: pcb_text.cpp:319
BITMAPS GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: pcb_text.cpp:405
Represent a set of closed polygons.
ERROR_LOC
When approximating an arc or circle, should the error be placed on the outside or inside of the curve...
FLASHING
Enum used during connectivity building to ensure we do not query connectivity while building the data...
Definition: layer_ids.h:147
PCB_LAYER_ID
A quick note on layer IDs:
Definition: layer_ids.h:59
@ UNDEFINED_LAYER
Definition: layer_ids.h:60
KICAD_T
The set of class identification values stored in EDA_ITEM::m_structType.
Definition: typeinfo.h:78
@ PCB_TEXT_T
class PCB_TEXT, text on a layer
Definition: typeinfo.h:90
@ PCB_LOCATE_TEXT_T
Definition: typeinfo.h:114