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 The 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <memory>
 
#include <eda_text.h>
#include <board_item.h>
 
 
class LINE_READER;
class MSG_PANEL_ITEM;
class FOOTPRINT;
class HTML_MESSAGE_BOX;
 
namespace kiapi::board::types
{
    class BoardText;
}
 
 
struct PCB_TEXT_KNOCKOUT_CACHE_DATA
{
    wxString        text;
    TEXT_ATTRIBUTES text_attrs;
    EDA_ANGLE       angle;
    VECTOR2I        pos;
    SHAPE_POLY_SET  cache;
};
 
 
class PCB_TEXT : public BOARD_ITEM, public EDA_TEXT
{
public:
    PCB_TEXT( BOARD_ITEM* parent, KICAD_T idtype = PCB_TEXT_T );
 
    PCB_TEXT( FOOTPRINT* aParent, KICAD_T idtype = PCB_TEXT_T );
 
    PCB_TEXT( const PCB_TEXT& aOther );
    PCB_TEXT& operator=( const PCB_TEXT& aOther );
 
    PCB_TEXT( PCB_TEXT&& ) noexcept = default;
    PCB_TEXT& operator=( PCB_TEXT&& ) noexcept = default;
 
    ~PCB_TEXT();
 
    void CopyFrom( const BOARD_ITEM* aOther ) override;
 
    static bool ClassOf( const EDA_ITEM* aItem ) { return aItem && PCB_TEXT_T == aItem->Type(); }
 
    bool IsType( const std::vector<KICAD_T>& aScanTypes ) const override
    {
        if( BOARD_ITEM::IsType( aScanTypes ) )
            return true;
 
        for( KICAD_T scanType : aScanTypes )
        {
            if( scanType == PCB_LOCATE_TEXT_T )
                return true;
        }
 
        return false;
    }
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;
 
    void Serialize( kiapi::board::types::BoardText& aOutput ) const;
    bool Deserialize( const kiapi::board::types::BoardText& aInput );
 
    void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings, bool aCheckSide ) override;

    void KeepUpright();
 
    wxString GetShownText( RESOLUTION_CONTEXT aContext, int aDepth = 0 ) const override;
 
    bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 
    VECTOR2I GetPosition() const override { return GetTextPos(); }
 
    void SetPosition( const VECTOR2I& aPos ) override { SetTextPos( aPos ); }
 
    void Move( const VECTOR2I& aMoveVector ) override { Offset( aMoveVector ); }
 
    VECTOR2I GetTextPos() const override;
    void     Offset( const VECTOR2I& aOffset ) override;
 
    // Lib-frame setters for the parser (board-frame setters bake the parent scale).
    void SetLibTextPos( const VECTOR2I& aPos );
    void SetLibTextSize( const VECTOR2I& aSize );
    void SetLibTextThickness( int aWidth );
 
    VECTOR2I GetTextSize() const override;
    void     SetTextSize( VECTOR2I aNewSize, bool aEnforceMinTextSize = true ) override;
 
    int  GetTextThickness() const override;
    void SetTextThickness( int aWidth ) override;
 
    EDA_ANGLE GetTextAngle() const override;
    void      SetTextAngle( const EDA_ANGLE& aAngle ) override;

    EDA_ANGLE GetLibTextAngle() const { return m_libTextAngle.GetAngle(); }
 
    void SetLibTextAngle( const EDA_ANGLE& aAngle ) { m_libTextAngle = aAngle; }
 
    void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;
 
    void Mirror( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection ) override;
 
    void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipDirection ) override;
 
    void OnFootprintRescaled( double aRatioX, double aRatioY, double aLinearFactor, const VECTOR2I& aAnchor,
                              const EDA_ANGLE& aParentRotate ) override;
 
    void OnFootprintTransformed() override;
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
    bool TextHitTest( const VECTOR2I& aPoint, int aAccuracy = 0 ) const override;
    bool TextHitTest( const BOX2I& aRect, bool aContains, int aAccuracy = 0 ) const override;
    bool TextHitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const;
 
    bool HitTest( const VECTOR2I& aPosition, int aAccuracy ) const override
    {
        return TextHitTest( aPosition, aAccuracy );
    }
 
    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override
    {
        return TextHitTest( aRect, aContained, aAccuracy );
    }
 
    bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const override
    {
        return TextHitTest( aPoly, aContained );
    }
 
    wxString GetClass() const override { return wxT( "PCB_TEXT" ); }

    void TransformTextToPolySet( SHAPE_POLY_SET& aBuffer, int aClearance, int aMaxError, ERROR_LOC aErrorLoc ) const;
 
    double GetCoverageArea( int aTextMargin ) const override;
 
    void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance, int aMaxError,
                                  ERROR_LOC aErrorLoc, bool aIgnoreLineWidth = false ) const override;
 
    // @copydoc BOARD_ITEM::GetEffectiveShape
    std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
                                              FLASHING aFlash = FLASHING::DEFAULT,
                                              DRC_CONSTRAINT_T aUsage = NULL_CONSTRAINT ) const override;
 
    const SHAPE_POLY_SET& GetKnockoutCache( const KIFONT::FONT* aFont, const wxString& forResolvedText,
                                            int aMaxError ) const;
 
    virtual wxString GetTextTypeDescription() const;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    BITMAPS GetMenuImage() const override;

    static HTML_MESSAGE_BOX* ShowSyntaxHelp( wxWindow* aParentWindow );

    EDA_ANGLE GetDrawRotation() const override;
 
    const BOX2I ViewBBox() const override;
 
    std::vector<int> ViewGetLayers() const override;
 
    double ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const override;
 
    const BOX2I GetBoundingBox() const override;
 
    EDA_ITEM* Clone() const override;
 
    double Similarity( const BOARD_ITEM& aBoardItem ) const override;
 
    bool operator==( const PCB_TEXT& aOther ) const;
    bool operator==( const BOARD_ITEM& aBoardItem ) const override;
 
#if defined( DEBUG )
    void Show( int nestLevel, std::ostream& os ) const override { ShowDummy( os ); }
#endif
 
protected:
    void buildBoundingHull( SHAPE_POLY_SET* aBuffer, const SHAPE_POLY_SET& aRenderedText, int aClearance ) const;
 
    void swapData( BOARD_ITEM* aImage ) override;
 
    int getKnockoutMargin() const;
 
    const KIFONT::METRICS& getFontMetrics() const override { return GetFontMetrics(); }
 
private:
    mutable std::unique_ptr<PCB_TEXT_KNOCKOUT_CACHE_DATA> m_knockout_cache;
 
    EDA_ORIENTATION m_libTextAngle; // Text angle in parent footprint's lib frame
};