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
|
2023-03-04 23:15:43 +00:00
|
|
|
* Copyright (C) 1992-2023 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 PCB_TEXT_H
|
|
|
|
#define PCB_TEXT_H
|
2007-06-05 12:10:51 +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;
|
2013-01-12 17:32:24 +00:00
|
|
|
class MSG_PANEL_ITEM;
|
2023-03-30 11:49:23 +00:00
|
|
|
class FOOTPRINT;
|
2007-06-05 12:10:51 +00:00
|
|
|
|
2011-08-01 15:29:27 +00:00
|
|
|
|
2020-10-04 23:34:59 +00:00
|
|
|
class PCB_TEXT : public BOARD_ITEM, public EDA_TEXT
|
2007-06-05 12:10:51 +00:00
|
|
|
{
|
|
|
|
public:
|
2023-03-04 23:15:43 +00:00
|
|
|
PCB_TEXT( BOARD_ITEM* parent, KICAD_T idtype = PCB_TEXT_T );
|
2012-01-14 19:50:32 +00:00
|
|
|
|
2023-06-06 17:30:03 +00:00
|
|
|
PCB_TEXT( FOOTPRINT* aParent );
|
2023-03-30 11:49:23 +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
|
|
|
~PCB_TEXT();
|
2008-04-01 05:21:50 +00:00
|
|
|
|
2015-02-18 16:53:46 +00:00
|
|
|
static inline bool ClassOf( const EDA_ITEM* aItem )
|
2015-02-17 23:53:57 +00:00
|
|
|
{
|
|
|
|
return aItem && PCB_TEXT_T == aItem->Type();
|
|
|
|
}
|
|
|
|
|
2022-08-21 19:54:07 +00:00
|
|
|
bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
|
2020-05-15 23:25:33 +00:00
|
|
|
{
|
|
|
|
if( BOARD_ITEM::IsType( aScanTypes ) )
|
|
|
|
return true;
|
|
|
|
|
2022-08-20 09:27:35 +00:00
|
|
|
for( KICAD_T scanType : aScanTypes )
|
2020-05-15 23:25:33 +00:00
|
|
|
{
|
2022-08-20 09:27:35 +00:00
|
|
|
if( scanType == PCB_LOCATE_TEXT_T )
|
2020-05-15 23:25:33 +00:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
2023-07-09 11:19:43 +00:00
|
|
|
void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings ) override;
|
|
|
|
|
2023-03-30 11:49:23 +00:00
|
|
|
/**
|
|
|
|
* Called when rotating the parent footprint.
|
|
|
|
*/
|
|
|
|
void KeepUpright( const EDA_ANGLE& aOldOrientation, const EDA_ANGLE& aNewOrientation );
|
|
|
|
|
2023-05-05 13:21:56 +00:00
|
|
|
wxString GetShownText( bool aAllowExtraText, int aDepth = 0 ) const override;
|
2020-03-26 11:02:59 +00:00
|
|
|
|
2023-05-05 13:21:56 +00:00
|
|
|
bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
|
2019-07-26 23:52:17 +00:00
|
|
|
|
2022-01-01 06:04:08 +00:00
|
|
|
virtual VECTOR2I GetPosition() const override
|
2013-08-29 10:06:06 +00:00
|
|
|
{
|
2022-01-01 06:04:08 +00:00
|
|
|
return EDA_TEXT::GetTextPos();
|
2013-08-29 10:06:06 +00:00
|
|
|
}
|
|
|
|
|
2022-01-01 06:04:08 +00:00
|
|
|
virtual void SetPosition( const VECTOR2I& aPos ) override
|
2013-08-29 10:06:06 +00:00
|
|
|
{
|
2017-01-23 20:30:11 +00:00
|
|
|
EDA_TEXT::SetTextPos( aPos );
|
2013-08-29 10:06:06 +00:00
|
|
|
}
|
|
|
|
|
2022-01-01 06:04:08 +00:00
|
|
|
void Move( const VECTOR2I& aMoveVector ) override
|
2009-08-01 19:26:05 +00:00
|
|
|
{
|
2017-01-23 20:30:11 +00:00
|
|
|
EDA_TEXT::Offset( aMoveVector );
|
2009-08-01 19:26:05 +00:00
|
|
|
}
|
|
|
|
|
2022-01-13 19:32:00 +00:00
|
|
|
void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
|
2009-08-01 19:26:05 +00:00
|
|
|
|
2022-09-22 14:05:06 +00:00
|
|
|
void Mirror( const VECTOR2I& aCentre, bool aMirrorAroundXAxis );
|
|
|
|
|
2022-01-01 06:04:08 +00:00
|
|
|
void Flip( const VECTOR2I& aCentre, bool aFlipLeftRight ) override;
|
2009-08-01 19:26:05 +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-22 05:11:01 +00:00
|
|
|
|
2022-01-01 06:04:08 +00:00
|
|
|
bool TextHitTest( const VECTOR2I& aPoint, int aAccuracy = 0 ) const override;
|
2022-08-31 09:33:46 +00:00
|
|
|
bool TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy = 0 ) const override;
|
2021-05-06 16:48:23 +00:00
|
|
|
|
2022-01-01 06:04:08 +00:00
|
|
|
bool HitTest( const VECTOR2I& aPosition, int aAccuracy ) const override
|
2007-08-22 05:11:01 +00:00
|
|
|
{
|
2019-05-05 10:33:34 +00:00
|
|
|
return TextHitTest( aPosition, aAccuracy );
|
2007-08-22 05:11:01 +00:00
|
|
|
}
|
2008-04-01 05:21:50 +00:00
|
|
|
|
2022-08-31 09:33:46 +00:00
|
|
|
bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override
|
2008-01-06 12:43:57 +00:00
|
|
|
{
|
2013-09-21 18:09:41 +00:00
|
|
|
return TextHitTest( aRect, aContained, aAccuracy );
|
2008-01-06 12:43:57 +00:00
|
|
|
}
|
2008-04-01 05:21:50 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
wxString GetClass() const override
|
2007-08-07 06:21:19 +00:00
|
|
|
{
|
2022-01-30 10:52:52 +00:00
|
|
|
return wxT( "PCB_TEXT" );
|
2007-08-07 06:21:19 +00:00
|
|
|
}
|
|
|
|
|
2013-05-01 19:01:14 +00:00
|
|
|
/**
|
2022-10-21 12:48:45 +00:00
|
|
|
* Function TransformTextToPolySet
|
2020-11-29 14:00:39 +00:00
|
|
|
* Convert the text to a polygonSet describing the actual character strokes (one per segment).
|
2023-01-25 18:33:31 +00:00
|
|
|
* Circles and arcs are approximated by segments.
|
2023-03-24 13:02:13 +00:00
|
|
|
* @param aBuffer SHAPE_POLY_SET to store the polygon corners
|
|
|
|
* @param aClearance the clearance around the text
|
2023-05-29 14:28:48 +00:00
|
|
|
* @param aMaxError the maximum error to allow when approximating curves
|
2009-11-16 08:13:40 +00:00
|
|
|
*/
|
2023-05-29 14:28:48 +00:00
|
|
|
void TransformTextToPolySet( SHAPE_POLY_SET& aBuffer, int aClearance, int aMaxError,
|
2023-05-28 16:20:11 +00:00
|
|
|
ERROR_LOC aErrorLoc ) const;
|
2020-11-29 14:00:39 +00:00
|
|
|
|
2022-10-21 12:48:45 +00:00
|
|
|
void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
|
2023-05-29 14:28:48 +00:00
|
|
|
int aMaxError, ERROR_LOC aErrorLoc,
|
2022-10-21 12:48:45 +00:00
|
|
|
bool aIgnoreLineWidth = false ) const override;
|
2011-07-14 15:42:44 +00:00
|
|
|
|
2020-08-08 22:37:41 +00:00
|
|
|
// @copydoc BOARD_ITEM::GetEffectiveShape
|
2022-10-21 12:48:45 +00:00
|
|
|
virtual std::shared_ptr<SHAPE>
|
|
|
|
GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
|
|
|
|
FLASHING aFlash = FLASHING::DEFAULT ) const override;
|
2020-08-08 22:37:41 +00:00
|
|
|
|
2023-06-06 17:30:03 +00:00
|
|
|
virtual wxString GetTextTypeDescription() const;
|
|
|
|
|
2023-01-12 03:27:44 +00:00
|
|
|
wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider ) const override;
|
2009-11-16 08:13:40 +00:00
|
|
|
|
2021-03-08 02:59:07 +00:00
|
|
|
BITMAPS GetMenuImage() const override;
|
2011-08-01 15:29:27 +00:00
|
|
|
|
2023-03-30 11:49:23 +00:00
|
|
|
/**
|
|
|
|
* @return the text rotation for drawings and plotting the footprint rotation is taken
|
|
|
|
* in account.
|
|
|
|
*/
|
|
|
|
EDA_ANGLE GetDrawRotation() const override;
|
|
|
|
|
|
|
|
const BOX2I ViewBBox() const override;
|
|
|
|
|
|
|
|
void ViewGetLayers( int aLayers[], int& aCount ) const override;
|
|
|
|
|
2022-03-07 17:03:06 +00:00
|
|
|
///< @copydoc VIEW_ITEM::ViewGetLOD
|
|
|
|
double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
|
|
|
|
|
2013-11-24 17:48:14 +00:00
|
|
|
// Virtual function
|
2022-08-31 09:15:42 +00:00
|
|
|
const BOX2I GetBoundingBox() const override;
|
2011-09-01 21:39:38 +00:00
|
|
|
|
2016-09-24 18:53:15 +00:00
|
|
|
EDA_ITEM* Clone() const override;
|
2012-03-17 14:39:27 +00:00
|
|
|
|
2007-09-13 11:28:58 +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-07 06:21:19 +00:00
|
|
|
#endif
|
2022-08-05 22:57:37 +00:00
|
|
|
|
|
|
|
protected:
|
2023-05-28 16:20:11 +00:00
|
|
|
/**
|
|
|
|
* Build a nominally rectangular bounding box for the rendered text. (It's not a BOX2I
|
|
|
|
* because it will be a diamond shape for non-cardinally rotated text.)
|
|
|
|
*/
|
|
|
|
void buildBoundingHull( SHAPE_POLY_SET* aBuffer, const SHAPE_POLY_SET& aRenderedText,
|
|
|
|
int aClearance ) const;
|
|
|
|
|
2022-11-11 17:09:25 +00:00
|
|
|
virtual void swapData( BOARD_ITEM* aImage ) override;
|
|
|
|
|
2022-08-05 22:57:37 +00:00
|
|
|
int getKnockoutMargin() const;
|
2007-06-05 12:10:51 +00:00
|
|
|
};
|
|
|
|
|
2020-10-04 23:34:59 +00:00
|
|
|
#endif // #define PCB_TEXT_H
|