2012-01-14 19:50:32 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KiCad, a free EDA CAD application.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
|
2021-01-27 22:15:38 +00:00
|
|
|
* Copyright (C) 1992-2021 KiCad Developers, see AUTHORS.txt for contributors.
|
2012-01-14 19:50:32 +00:00
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or
|
|
|
|
* modify it under the terms of the GNU General Public License
|
|
|
|
* as published by the Free Software Foundation; either version 2
|
|
|
|
* of the License, or (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, you may find one here:
|
|
|
|
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
|
|
|
|
* or you may search the http://www.gnu.org website for the version 2 license,
|
|
|
|
* or you may write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
|
|
|
*/
|
|
|
|
|
2020-10-04 23:34:59 +00:00
|
|
|
#ifndef FP_TEXT_H
|
|
|
|
#define FP_TEXT_H
|
2007-08-14 19:24:48 +00:00
|
|
|
|
2012-04-12 21:31:31 +00:00
|
|
|
#include <eda_text.h>
|
2020-11-14 18:11:28 +00:00
|
|
|
#include <board_item.h>
|
2011-09-23 13:57:12 +00:00
|
|
|
|
|
|
|
class LINE_READER;
|
|
|
|
class EDA_RECT;
|
2020-11-13 15:15:52 +00:00
|
|
|
class FOOTPRINT;
|
2013-01-12 17:32:24 +00:00
|
|
|
class MSG_PANEL_ITEM;
|
2019-05-31 12:15:25 +00:00
|
|
|
class PCB_BASE_FRAME;
|
2020-08-08 22:37:41 +00:00
|
|
|
class SHAPE;
|
2007-08-14 19:24:48 +00:00
|
|
|
|
2011-08-01 15:29:27 +00:00
|
|
|
|
2020-10-04 23:34:59 +00:00
|
|
|
class FP_TEXT : public BOARD_ITEM, public EDA_TEXT
|
2007-06-05 12:10:51 +00:00
|
|
|
{
|
2013-04-07 11:55:18 +00:00
|
|
|
public:
|
2020-11-13 02:57:11 +00:00
|
|
|
/**
|
|
|
|
* Footprint text type: there must be only one (and only one) for each of the reference
|
|
|
|
* value texts in one footprint; others could be added for the user (DIVERS is French for
|
|
|
|
* 'others'). Reference and value always live on silkscreen (on the footprint side); other
|
|
|
|
* texts are planned to go on whatever layer the user wants.
|
|
|
|
*/
|
2013-04-07 11:55:18 +00:00
|
|
|
enum TEXT_TYPE
|
|
|
|
{
|
|
|
|
TEXT_is_REFERENCE = 0,
|
2020-12-20 18:50:45 +00:00
|
|
|
TEXT_is_VALUE = 1,
|
|
|
|
TEXT_is_DIVERS = 2
|
2013-04-07 11:55:18 +00:00
|
|
|
};
|
|
|
|
|
2020-11-13 15:15:52 +00:00
|
|
|
FP_TEXT( FOOTPRINT* aParentFootprint, TEXT_TYPE text_type = TEXT_is_DIVERS );
|
2011-09-23 13:57:12 +00:00
|
|
|
|
2016-05-31 08:27:52 +00:00
|
|
|
// Do not create a copy constructor & operator=.
|
|
|
|
// The ones generated by the compiler are adequate.
|
2012-01-14 19:50:32 +00:00
|
|
|
|
2020-10-04 23:34:59 +00:00
|
|
|
~FP_TEXT();
|
2007-08-04 20:05:54 +00:00
|
|
|
|
2014-06-06 09:44:21 +00:00
|
|
|
static inline bool ClassOf( const EDA_ITEM* aItem )
|
|
|
|
{
|
2020-10-04 14:19:33 +00:00
|
|
|
return aItem && aItem->Type() == PCB_FP_TEXT_T;
|
2014-06-06 09:44:21 +00:00
|
|
|
}
|
|
|
|
|
2020-05-15 23:25:33 +00:00
|
|
|
bool IsType( const KICAD_T aScanTypes[] ) const override
|
|
|
|
{
|
|
|
|
if( BOARD_ITEM::IsType( aScanTypes ) )
|
|
|
|
return true;
|
|
|
|
|
|
|
|
for( const KICAD_T* p = aScanTypes; *p != EOT; ++p )
|
|
|
|
{
|
|
|
|
if( *p == PCB_LOCATE_TEXT_T )
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2021-02-19 21:06:28 +00:00
|
|
|
wxString GetParentAsString() const { return m_parent->m_Uuid.AsString(); }
|
|
|
|
|
2020-12-20 18:27:51 +00:00
|
|
|
bool Matches( const wxFindReplaceData& aSearchData, void* aAuxData ) const override
|
2019-07-26 23:52:17 +00:00
|
|
|
{
|
|
|
|
return BOARD_ITEM::Matches( GetShownText(), aSearchData );
|
|
|
|
}
|
|
|
|
|
2020-02-02 17:52:19 +00:00
|
|
|
virtual wxPoint GetPosition() const override
|
2013-08-29 10:06:06 +00:00
|
|
|
{
|
2017-01-23 20:30:11 +00:00
|
|
|
return EDA_TEXT::GetTextPos();
|
2013-08-29 10:06:06 +00:00
|
|
|
}
|
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual void SetPosition( const wxPoint& aPos ) override
|
2013-08-29 10:06:06 +00:00
|
|
|
{
|
2017-01-23 20:30:11 +00:00
|
|
|
EDA_TEXT::SetTextPos( aPos );
|
2014-04-04 07:01:17 +00:00
|
|
|
SetLocalCoord();
|
2013-08-29 10:06:06 +00:00
|
|
|
}
|
|
|
|
|
2020-04-14 12:25:00 +00:00
|
|
|
void SetTextAngle( double aAngle ) override;
|
2021-12-28 22:13:54 +00:00
|
|
|
void SetTextAngle( const EDA_ANGLE& aAngle );
|
2017-01-23 20:30:11 +00:00
|
|
|
|
2019-04-07 21:09:50 +00:00
|
|
|
/**
|
|
|
|
* Called when rotating the parent footprint.
|
|
|
|
*/
|
|
|
|
void KeepUpright( double aOldOrientation, double aNewOrientation );
|
|
|
|
|
2019-02-28 10:02:23 +00:00
|
|
|
/**
|
2021-01-27 22:15:38 +00:00
|
|
|
* @return force the text rotation to be always between -90 .. 90 deg. Otherwise the text
|
|
|
|
* is not easy to read if false, the text rotation is free.
|
2019-02-28 10:02:23 +00:00
|
|
|
*/
|
2021-12-26 00:36:12 +00:00
|
|
|
bool IsKeepUpright() const { return m_keepUpright; }
|
|
|
|
void SetKeepUpright( bool aKeepUpright ) { m_keepUpright = aKeepUpright; }
|
2017-11-25 19:55:32 +00:00
|
|
|
|
2015-07-31 19:04:30 +00:00
|
|
|
/// Rotate text, in footprint editor
|
|
|
|
/// (for instance in footprint rotation transform)
|
2016-09-24 18:53:15 +00:00
|
|
|
void Rotate( const wxPoint& aOffset, double aAngle ) override;
|
2014-09-10 15:18:42 +00:00
|
|
|
|
2020-11-13 02:57:11 +00:00
|
|
|
/// Flip entity during footprint flip
|
2019-07-12 21:02:10 +00:00
|
|
|
void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;
|
2014-09-10 15:18:42 +00:00
|
|
|
|
2018-02-17 18:03:22 +00:00
|
|
|
bool IsParentFlipped() const;
|
|
|
|
|
2018-06-22 13:05:11 +00:00
|
|
|
/// Mirror text position in footprint editing
|
2015-07-31 19:04:30 +00:00
|
|
|
/// the text itself is not mirrored, and the layer not modified,
|
|
|
|
/// only position is mirrored.
|
|
|
|
/// (use Flip to change layer to its paired and mirror the text in fp editor).
|
|
|
|
void Mirror( const wxPoint& aCentre, bool aMirrorAroundXAxis );
|
2014-09-27 16:39:18 +00:00
|
|
|
|
2015-07-31 19:04:30 +00:00
|
|
|
/// move text in move transform, in footprint editor
|
2016-09-24 18:53:15 +00:00
|
|
|
void Move( const wxPoint& aMoveVector ) override;
|
2014-09-10 15:18:42 +00:00
|
|
|
|
2013-04-07 11:55:18 +00:00
|
|
|
/// @deprecated it seems (but the type is used to 'protect'
|
2014-09-27 16:39:18 +00:00
|
|
|
// reference and value from deletion, and for identification)
|
2013-04-07 11:55:18 +00:00
|
|
|
void SetType( TEXT_TYPE aType ) { m_Type = aType; }
|
|
|
|
TEXT_TYPE GetType() const { return m_Type; }
|
2009-11-12 15:43:38 +00:00
|
|
|
|
2021-01-27 22:15:38 +00:00
|
|
|
// The Pos0 accessors are for footprint-relative coordinates.
|
2014-04-04 07:01:17 +00:00
|
|
|
void SetPos0( const wxPoint& aPos ) { m_Pos0 = aPos; SetDrawCoord(); }
|
2012-05-22 17:51:18 +00:00
|
|
|
const wxPoint& GetPos0() const { return m_Pos0; }
|
2011-12-02 21:56:47 +00:00
|
|
|
|
2013-04-07 11:55:18 +00:00
|
|
|
int GetLength() const; // text length
|
2010-12-10 19:47:44 +00:00
|
|
|
|
2010-11-12 15:17:10 +00:00
|
|
|
/**
|
2021-01-27 22:15:38 +00:00
|
|
|
* @return the text rotation for drawings and plotting the footprint rotation is taken
|
|
|
|
* in account.
|
2008-04-01 05:21:50 +00:00
|
|
|
*/
|
2021-12-28 22:13:54 +00:00
|
|
|
virtual EDA_ANGLE GetDrawRotation() const override;
|
2007-06-05 12:10:51 +00:00
|
|
|
|
2013-11-24 17:48:14 +00:00
|
|
|
// Virtual function
|
2016-09-24 18:53:15 +00:00
|
|
|
const EDA_RECT GetBoundingBox() const override;
|
2008-03-15 10:24:32 +00:00
|
|
|
|
2021-01-27 22:15:38 +00:00
|
|
|
///< Set absolute coordinates.
|
2014-07-09 09:59:24 +00:00
|
|
|
void SetDrawCoord();
|
2008-08-09 08:05:42 +00:00
|
|
|
|
2021-01-27 22:15:38 +00:00
|
|
|
///< Set relative coordinates.
|
2014-07-09 09:59:24 +00:00
|
|
|
void SetLocalCoord();
|
2007-08-04 20:05:54 +00:00
|
|
|
|
2020-04-24 13:36:10 +00:00
|
|
|
void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
|
2007-08-20 19:33:15 +00:00
|
|
|
|
2019-05-05 10:33:34 +00:00
|
|
|
bool TextHitTest( const wxPoint& aPoint, int aAccuracy = 0 ) const override;
|
|
|
|
bool TextHitTest( const EDA_RECT& aRect, bool aContains, int aAccuracy = 0 ) const override;
|
2017-05-02 06:44:41 +00:00
|
|
|
|
2019-05-05 10:33:34 +00:00
|
|
|
bool HitTest( const wxPoint& aPosition, int aAccuracy ) const override
|
2017-04-26 12:38:41 +00:00
|
|
|
{
|
2019-05-05 10:33:34 +00:00
|
|
|
return TextHitTest( aPosition, aAccuracy );
|
2017-04-26 12:38:41 +00:00
|
|
|
}
|
|
|
|
|
2019-05-05 10:33:34 +00:00
|
|
|
bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override
|
2017-04-26 12:38:41 +00:00
|
|
|
{
|
|
|
|
return TextHitTest( aRect, aContained, aAccuracy );
|
|
|
|
}
|
2008-04-01 05:21:50 +00:00
|
|
|
|
2020-11-29 14:00:39 +00:00
|
|
|
void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer, PCB_LAYER_ID aLayer,
|
|
|
|
int aClearance, int aError, ERROR_LOC aErrorLoc,
|
|
|
|
bool aIgnoreLineWidth ) const override;
|
|
|
|
|
2020-11-27 18:04:30 +00:00
|
|
|
void TransformTextShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
|
|
|
|
PCB_LAYER_ID aLayer, int aClearanceValue,
|
|
|
|
int aError, ERROR_LOC aErrorLoc ) const;
|
|
|
|
|
2020-08-08 22:37:41 +00:00
|
|
|
// @copydoc BOARD_ITEM::GetEffectiveShape
|
2021-12-26 00:36:12 +00:00
|
|
|
std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER ) const override;
|
2020-08-08 22:37:41 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
wxString GetClass() const override
|
2007-08-07 06:21:19 +00:00
|
|
|
{
|
|
|
|
return wxT( "MTEXT" );
|
|
|
|
}
|
|
|
|
|
2019-12-20 14:11:39 +00:00
|
|
|
wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;
|
2011-07-14 15:42:44 +00:00
|
|
|
|
2021-03-08 02:59:07 +00:00
|
|
|
BITMAPS GetMenuImage() const override;
|
2011-08-01 15:29:27 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
EDA_ITEM* Clone() const override;
|
2012-03-17 14:39:27 +00:00
|
|
|
|
2020-04-06 13:06:57 +00:00
|
|
|
virtual wxString GetShownText( int aDepth = 0 ) const override;
|
2014-10-04 15:15:38 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual const BOX2I ViewBBox() const override;
|
2014-01-07 13:09:27 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
|
Introduction of Graphics Abstraction Layer based rendering for pcbnew.
New classes:
- VIEW - represents view that is seen by user, takes care of layer ordering & visibility and how it is displayed (which location, how much zoomed, etc.)
- VIEW_ITEM - Base class for every item that can be displayed on VIEW (the biggest change is that now it may be necessary to override ViewBBox & ViewGetLayers method for derived classes).
- EDA_DRAW_PANEL_GAL - Inherits after EDA_DRAW_PANEL, displays VIEW output, right now it is not editable (in opposite to usual EDA_DRAW_PANEL).
- GAL/OPENGL_GAL/CAIRO_GAL - Base Graphics Abstraction Layer class + two different flavours (Cairo is not fully supported yet), that offers methods to draw primitives using different libraries.
- WX_VIEW_CONTROLS - Controller for VIEW, handles user events, allows zooming, panning, etc.
- PAINTER/PCB_PAINTER - Classes that uses GAL interface to draw items (as you may have already guessed - PCB_PAINTER is a class for drawing PCB specific object, PAINTER is an abstract class). Its methods are invoked by VIEW, when an item has to be drawn. To display a new type of item - you need to implement draw(ITEM_TYPE*) method that draws it using GAL methods.
- STROKE_FONT - Implements stroke font drawing using GAL methods.
Most important changes to Kicad original code:
* EDA_ITEM now inherits from VIEW_ITEM, which is a base class for all drawable objects.
* EDA_DRAW_FRAME contains both usual EDA_DRAW_PANEL and new EDA_DRAW_PANEL_GAL, that can be switched anytime.
* There are some new layers for displaying multilayer pads, vias & pads holes (these are not shown yet on the right sidebar in pcbnew)
* Display order of layers is different than in previous versions (if you are curious - you may check m_galLayerOrder@pcbnew/basepcbframe.cpp). Preserving usual order would result in not very natural display, such as showing silkscreen texts on the bottom.
* Introduced new hotkey (Alt+F12) and new menu option (View->Switch canvas) for switching canvas during runtime.
* Some of classes (mostly derived from BOARD_ITEM) now includes ViewBBox & ViewGetLayers methods.
* Removed tools/class_painter.h, as now it is extended and included in source code.
Build changes:
* GAL-based rendering option is turned on by a new compilation CMake option KICAD_GAL.
* When compiling with CMake option KICAD_GAL=ON, GLEW and Cairo libraries are required.
* GAL-related code is compiled into a static library (common/libgal).
* Build with KICAD_GAL=OFF should not need any new libraries and should come out as a standard version of Kicad
Currently most of items in pcbnew can be displayed using OpenGL (to be done are DIMENSIONS and MARKERS).
More details about GAL can be found in: http://www.ohwr.org/attachments/1884/view-spec.pdf
2013-04-02 06:54:03 +00:00
|
|
|
|
2020-09-21 15:03:08 +00:00
|
|
|
double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
|
2015-06-16 15:03:36 +00:00
|
|
|
|
2009-11-12 15:43:38 +00:00
|
|
|
#if defined(DEBUG)
|
2016-09-24 18:53:15 +00:00
|
|
|
virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
|
2007-08-06 20:26:59 +00:00
|
|
|
#endif
|
2014-06-06 09:44:21 +00:00
|
|
|
|
|
|
|
private:
|
2021-12-26 00:36:12 +00:00
|
|
|
TEXT_TYPE m_Type; ///< 0=ref, 1=val, etc.
|
2014-06-06 09:44:21 +00:00
|
|
|
|
2021-12-26 00:36:12 +00:00
|
|
|
wxPoint m_Pos0; ///< text coordinates relative to the footprint anchor, orient 0.
|
|
|
|
///< text coordinate ref point is the text center
|
2017-11-25 19:55:32 +00:00
|
|
|
|
2019-02-28 10:02:23 +00:00
|
|
|
bool m_keepUpright; ///< if true, keep rotation angle between -90 .. 90 deg.
|
|
|
|
///< to keep the text more easy to read
|
2007-08-04 20:05:54 +00:00
|
|
|
};
|
2007-08-14 19:24:48 +00:00
|
|
|
|
2020-10-04 23:34:59 +00:00
|
|
|
#endif // FP_TEXT_H
|