kicad/pcbnew/class_pcb_text.h

165 lines
5.4 KiB
C
Raw Normal View History

/*
* 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
* Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors.
*
* 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
*/
/**
* @file class_pcb_text.h
* @brief TEXTE_PCB class definition.
*/
#ifndef CLASS_PCB_TEXT_H
#define CLASS_PCB_TEXT_H
2018-04-06 10:38:18 +00:00
#include <mutex>
#include <eda_text.h>
#include <class_board_item.h>
#include <PolyLine.h>
class LINE_READER;
class EDA_DRAW_PANEL;
class MSG_PANEL_ITEM;
// A mutex which is unique to each instance it appears in (ie: a new std::mutex is allocated
// on copy or assignment).
class UNIQUE_MUTEX : public std::mutex
{
public:
UNIQUE_MUTEX() : std::mutex() {}
UNIQUE_MUTEX( const UNIQUE_MUTEX& ) : std::mutex() {}
UNIQUE_MUTEX& operator= (const UNIQUE_MUTEX& ) { return *this; }
};
class TEXTE_PCB : public BOARD_ITEM, public EDA_TEXT
{
public:
2008-04-01 05:21:50 +00:00
TEXTE_PCB( BOARD_ITEM* parent );
// Do not create a copy constructor & operator=.
// The ones generated by the compiler are adequate.
2008-04-01 05:21:50 +00:00
~TEXTE_PCB();
2015-02-18 16:53:46 +00:00
static inline bool ClassOf( const EDA_ITEM* aItem )
{
return aItem && PCB_TEXT_T == aItem->Type();
}
virtual const wxPoint GetPosition() const override
{
return EDA_TEXT::GetTextPos();
}
2016-09-24 18:53:15 +00:00
virtual void SetPosition( const wxPoint& aPos ) override
{
EDA_TEXT::SetTextPos( aPos );
}
2016-09-24 18:53:15 +00:00
void Move( const wxPoint& aMoveVector ) override
2009-08-01 19:26:05 +00:00
{
EDA_TEXT::Offset( aMoveVector );
2009-08-01 19:26:05 +00:00
}
void SetTextAngle( double aAngle );
2016-09-24 18:53:15 +00:00
void Rotate( const wxPoint& aRotCentre, double aAngle ) override;
2009-08-01 19:26:05 +00:00
2016-09-24 18:53:15 +00:00
void Flip( const wxPoint& aCentre ) override;
2009-08-01 19:26:05 +00:00
void Draw( EDA_DRAW_PANEL* panel, wxDC* DC,
2016-09-24 18:53:15 +00:00
GR_DRAWMODE aDrawMode, const wxPoint& offset = ZeroOffset ) override;
2008-04-01 05:21:50 +00:00
void GetMsgPanelInfo( EDA_UNITS_T aUnits, std::vector< MSG_PANEL_ITEM >& aList ) override;
2007-08-22 05:11:01 +00:00
virtual bool HitTest( const wxPoint& aPosition ) const override
2007-08-22 05:11:01 +00:00
{
return TextHitTest( aPosition );
2007-08-22 05:11:01 +00:00
}
2008-04-01 05:21:50 +00:00
/** @copydoc BOARD_ITEM::HitTest(const EDA_RECT& aRect,
* bool aContained = true, int aAccuracy ) const
*/
virtual bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override
2008-01-06 12:43:57 +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
{
return wxT( "PTEXT" );
}
2010-11-12 15:17:10 +00:00
/**
* Function TransformBoundingBoxWithClearanceToPolygon
* Convert the text bounding box to a rectangular polygon
* depending on the text orientation, the bounding box
* is not always horizontal or vertical
* Used in filling zones calculations
* Circles and arcs are approximated by segments
* @param aCornerBuffer = a buffer to store the polygon
* @param aClearanceValue = the clearance around the text bounding box
* to the real clearance value (usually near from 1.0)
*/
void TransformBoundingBoxWithClearanceToPolygon(
SHAPE_POLY_SET& aCornerBuffer,
int aClearanceValue ) const;
/**
* Function TransformShapeWithClearanceToPolygonSet
* Convert the text shape to a set of polygons (one by segment)
* Used in 3D viewer
* Circles and arcs are approximated by segments
* @param aCornerBuffer = a buffer to store the polygon
* @param aClearanceValue = the clearance around the text
* @param aCircleToSegmentsCount = the number of segments to approximate a circle
* @param aCorrectionFactor = the correction to apply to circles radius to keep
* clearance when the circle is approximated by segment bigger or equal
* to the real clearance value (usually near from 1.0)
*/
void TransformShapeWithClearanceToPolygonSet( SHAPE_POLY_SET& aCornerBuffer,
int aClearanceValue,
int aCircleToSegmentsCount,
double aCorrectionFactor ) const;
wxString GetSelectMenuText( EDA_UNITS_T aUnits ) const override;
BITMAP_DEF GetMenuImage() const override;
// Virtual function
2016-09-24 18:53:15 +00:00
const EDA_RECT GetBoundingBox() const override;
2016-09-24 18:53:15 +00:00
EDA_ITEM* Clone() const override;
virtual void SwapData( BOARD_ITEM* aImage ) override;
mutable UNIQUE_MUTEX m_mutex;
#if defined(DEBUG)
2016-09-24 18:53:15 +00:00
virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
};
#endif // #define CLASS_PCB_TEXT_H