KiCad PCB EDA Suite
lib_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, jaen-pierre.charras@gipsa-lab.inpg.com
5  * Copyright (C) 2004-2020 KiCad Developers, see change_log.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 LIB_TEXT_H
26 #define LIB_TEXT_H
27 
28 #include <eda_text.h>
29 #include <lib_item.h>
30 
31 
40 class LIB_TEXT : public LIB_ITEM, public EDA_TEXT
41 {
42  void print( const RENDER_SETTINGS* aSettings, const wxPoint& aOffset, void* aData,
43  const TRANSFORM& aTransform ) override;
44 
45 public:
46  LIB_TEXT( LIB_PART* aParent );
47 
48  // Do not create a copy constructor. The one generated by the compiler is adequate.
49 
50  ~LIB_TEXT() { }
51 
52  wxString GetClass() const override
53  {
54  return wxT( "LIB_TEXT" );
55  }
56 
57  wxString GetTypeName() const override
58  {
59  return _( "Text" );
60  }
61 
62  void ViewGetLayers( int aLayers[], int& aCount ) const override;
63 
64  bool HitTest( const wxPoint& aPosition, int aAccuracy = 0 ) const override;
65 
66  bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override
67  {
69  return false;
70 
71  EDA_RECT rect = aRect;
72 
73  rect.Inflate( aAccuracy );
74 
75  EDA_RECT textBox = GetTextBox();
76  textBox.RevertYAxis();
77 
78  if( aContained )
79  return rect.Contains( textBox );
80 
81  return rect.Intersects( textBox, GetTextAngle() );
82  }
83 
84  int GetPenWidth() const override;
85 
86  void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
87 
88  const EDA_RECT GetBoundingBox() const override;
89 
90  void BeginEdit( const wxPoint aStartPoint ) override;
91  void CalcEdit( const wxPoint& aPosition ) override;
92 
93  void Offset( const wxPoint& aOffset ) override;
94 
95  void MoveTo( const wxPoint& aPosition ) override;
96 
97  wxPoint GetPosition() const override { return EDA_TEXT::GetTextPos(); }
98 
99  void MirrorHorizontal( const wxPoint& aCenter ) override;
100  void MirrorVertical( const wxPoint& aCenter ) override;
101  void Rotate( const wxPoint& aCenter, bool aRotateCCW = true ) override;
102 
103  void NormalizeJustification( bool inverse );
104 
105  void Plot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
106  const TRANSFORM& aTransform ) override;
107 
108  int GetWidth() const override { return GetTextThickness(); }
109  void SetWidth( int aWidth ) override { SetTextThickness( aWidth ); }
110 
111  wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
112 
113  BITMAP_DEF GetMenuImage() const override;
114 
115  EDA_ITEM* Clone() const override;
116 
117 private:
118 
129  int compare( const LIB_ITEM& aOther,
130  LIB_ITEM::COMPARE_FLAGS aCompareFlags = LIB_ITEM::COMPARE_FLAGS::NORMAL ) const override;
131 };
132 
133 
134 #endif // LIB_TEXT_H
void MoveTo(const wxPoint &aPosition) override
Move a draw object to aPosition.
Definition: lib_text.cpp:130
bool HitTest(const EDA_RECT &aRect, bool aContained, int aAccuracy=0) const override
Test if aRect intersects or is contained within the bounding box of an item.
Definition: lib_text.h:66
void Plot(PLOTTER *aPlotter, const wxPoint &aOffset, bool aFill, const TRANSFORM &aTransform) override
Plot the draw item using the plot object.
Definition: lib_text.cpp:265
PNG memory record (file in memory).
Definition: bitmap_def.h:29
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
Define a symbol library graphical text item.
Definition: lib_text.h:40
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_text.cpp:347
void NormalizeJustification(bool inverse)
Definition: lib_text.cpp:136
void CalcEdit(const wxPoint &aPosition) override
Calculates the attributes of an item at aPosition when it is being edited.
Definition: lib_text.cpp:399
void MirrorHorizontal(const wxPoint &aCenter) override
Mirror the draw object along the horizontal (X) axis about aCenter point.
Definition: lib_text.cpp:173
wxPoint GetPosition() const override
Definition: lib_text.h:97
EDA_RECT GetTextBox(int aLine=-1, bool aInvertY=false) const
Useful in multiline texts to calculate the full text or a line area (for zones filling,...
Definition: eda_text.cpp:223
int compare(const LIB_ITEM &aOther, LIB_ITEM::COMPARE_FLAGS aCompareFlags=LIB_ITEM::COMPARE_FLAGS::NORMAL) const override
Provide the draw object specific comparison called by the == and < operators.
Definition: lib_text.cpp:92
double GetTextAngle() const
Definition: eda_text.h:181
int GetTextThickness() const
Definition: eda_text.h:167
The base class for create windows for drawing purpose.
void RevertYAxis()
Mirror the rectangle from the X axis (negate Y pos and size).
Definition: eda_rect.h:203
void BeginEdit(const wxPoint aStartPoint) override
Begin drawing a component library draw item at aPosition.
Definition: lib_text.cpp:393
void print(const RENDER_SETTINGS *aSettings, const wxPoint &aOffset, void *aData, const TRANSFORM &aTransform) override
Print the item to aDC.
Definition: lib_text.cpp:304
bool Contains(const wxPoint &aPoint) const
Definition: eda_rect.cpp:57
~LIB_TEXT()
Definition: lib_text.h:50
The base class for drawable items used by schematic library components.
Definition: lib_item.h:62
void ViewGetLayers(int aLayers[], int &aCount) const override
Return the all the layers within the VIEW the object is painted on.
Definition: lib_text.cpp:53
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_text.cpp:61
A mix-in class (via multiple inheritance) that handles texts such as labels, parts,...
Definition: eda_text.h:119
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:84
void Rotate(const wxPoint &aCenter, bool aRotateCCW=true) override
Rotate the object about aCenter point.
Definition: lib_text.cpp:231
wxString GetTypeName() const override
Provide a user-consumable name of the object type.
Definition: lib_text.h:57
Define a library symbol object.
Definition: lib_symbol.h:93
int GetWidth() const override
Definition: lib_text.h:108
#define STRUCT_DELETED
flag indication structures to be erased
Definition: eda_item.h:115
void MirrorVertical(const wxPoint &aCenter) override
Mirror the draw object along the MirrorVertical (Y) axis about aCenter point.
Definition: lib_text.cpp:202
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: lib_text.cpp:381
EDA_UNITS
Definition: eda_units.h:38
Base plotter engine class.
Definition: plotter.h:121
void Offset(const wxPoint &aOffset) override
Set the drawing object by aOffset from the current position.
Definition: lib_text.cpp:124
BITMAP_DEF GetMenuImage() const override
Return a pointer to an image to be used in menus.
Definition: lib_text.cpp:387
const EDA_RECT GetBoundingBox() const override
Definition: lib_text.cpp:356
#define _(s)
Definition: 3d_actions.cpp:33
wxString GetClass() const override
Return the class name.
Definition: lib_text.h:52
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:149
int GetPenWidth() const override
Definition: lib_text.cpp:298
bool Intersects(const EDA_RECT &aRect) const
Test for a common area between rectangles.
Definition: eda_rect.cpp:150
const wxPoint & GetTextPos() const
Definition: eda_text.h:254
void SetTextThickness(int aWidth)
The TextThickness is that set by the user.
Definition: eda_text.h:166
EDA_ITEM * Clone() const override
Create a duplicate of this item with linked list members set to NULL.
Definition: lib_text.cpp:77
#define SKIP_STRUCT
flag indicating that the structure should be ignored
Definition: eda_item.h:117
STATUS_FLAGS m_flags
Definition: eda_item.h:530
void SetWidth(int aWidth) override
Definition: lib_text.h:109
LIB_TEXT(LIB_PART *aParent)
Definition: lib_text.cpp:45
EDA_RECT & Inflate(wxCoord dx, wxCoord dy)
Inflate the rectangle horizontally by dx and vertically by dy.
Definition: eda_rect.cpp:363