pcb_text.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2004 Jean-Pierre Charras, [email protected]
 * 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
 */

#ifndef PCB_TEXT_H
#define PCB_TEXT_H

#include <eda_text.h>
#include <board_item.h>


class LINE_READER;
class MSG_PANEL_ITEM;


class PCB_TEXT : public BOARD_ITEM, public EDA_TEXT
{
public:
 PCB_TEXT( BOARD_ITEM* parent );

 // Do not create a copy constructor & operator=.
 // The ones generated by the compiler are adequate.

 ~PCB_TEXT();

 static inline bool ClassOf( const EDA_ITEM* aItem )
 {
 return aItem && PCB_TEXT_T == aItem->Type();
 }

 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;
 }

 wxString GetShownText( int aDepth = 0 ) const override;

 void SetVisible( bool aVisible ) override { /* do nothing */}
 bool IsVisible() const override { return true; }

 bool Matches( const wxFindReplaceData& aSearchData, void* aAuxData ) const override
 {
 return BOARD_ITEM::Matches( GetShownText(), aSearchData );
 }

 virtual wxPoint GetPosition() const override
 {
 return EDA_TEXT::GetTextPos();
 }

 virtual void SetPosition( const wxPoint& aPos ) override
 {
 EDA_TEXT::SetTextPos( aPos );
 }

 void Move( const wxPoint& aMoveVector ) override
 {
 EDA_TEXT::Offset( aMoveVector );
 }

 void SetTextAngle( double aAngle ) override;

 void Rotate( const wxPoint& aRotCentre, double aAngle ) override;

 void Flip( const wxPoint& aCentre, bool aFlipLeftRight ) override;

 void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;

 bool TextHitTest( const wxPoint& aPoint, int aAccuracy = 0 ) const override;
 bool TextHitTest( const EDA_RECT& aRect, bool aContains, int aAccuracy = 0 ) const override;

 bool HitTest( const wxPoint& aPosition, int aAccuracy ) const override
 {
 return TextHitTest( aPosition, aAccuracy );
 }

 bool HitTest( const EDA_RECT& aRect, bool aContained, int aAccuracy = 0 ) const override
 {
 return TextHitTest( aRect, aContained, aAccuracy );
 }

 wxString GetClass() const override
 {
 return wxT( "PTEXT" );
 }

 void TransformTextShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer,
 PCB_LAYER_ID aLayer, int aClearanceValue,
 int aError, ERROR_LOC aErrorLoc ) const;

 void TransformShapeWithClearanceToPolygon( SHAPE_POLY_SET& aCornerBuffer, PCB_LAYER_ID aLayer,
 int aClearanceValue, int aError, ERROR_LOC aErrorLoc,
 bool aIgnoreLineWidth = false ) const override;

 // @copydoc BOARD_ITEM::GetEffectiveShape
 virtual std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
 FLASHING aFlash = FLASHING::DEFAULT ) const override;

 wxString GetSelectMenuText( EDA_UNITS aUnits ) const override;

 BITMAPS GetMenuImage() const override;

 // Virtual function
 const EDA_RECT GetBoundingBox() const override;

 EDA_ITEM* Clone() const override;

 virtual void SwapData( BOARD_ITEM* aImage ) override;

#if defined(DEBUG)
 virtual void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
};

#endif // #define PCB_TEXT_H