pcb_textbox.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/>.
 */
 
#ifndef PCB_TEXTBOX_H
#define PCB_TEXTBOX_H
 
#include <eda_text.h>
#include <pcb_shape.h>
 
 
class LINE_READER;
class MSG_PANEL_ITEM;
 
namespace kiapi::board::types
{
    class BoardTextBox;
}
 
 
class PCB_TEXTBOX : public PCB_SHAPE, public EDA_TEXT
{
public:
    PCB_TEXTBOX( BOARD_ITEM* aParent, KICAD_T aType = PCB_TEXTBOX_T );
 
    // Do not create a copy constructor & operator=.
    // The ones generated by the compiler are adequate.
 
    ~PCB_TEXTBOX();
 
    void CopyFrom( const BOARD_ITEM* aOther ) override;
 
    static inline bool ClassOf( const EDA_ITEM* aItem )
    {
        return aItem && PCB_TEXTBOX_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::BoardTextBox& aOutput ) const;
    bool Deserialize( const kiapi::board::types::BoardTextBox& aInput );
 
    wxString GetFriendlyName() const override { return _( "Text Box" ); }
 
    VECTOR2I GetTopLeft() const override;
    VECTOR2I GetBotRight() const override;
 
    std::vector<VECTOR2I> GetCorners() const override;
 
    /*
     * @return a PCB_SHAPE type POLYGON of the box of the TEXTBOX, according to the box shape
     * and the textbox rotation
     * The base PCB_SHAPE of a textbox is a RECTANGLE, so creating some issues when orientation
     * is not 0 is some draw functions
     */
    PCB_SHAPE GetPolygonalBoxShape() const;
 
    std::vector<VECTOR2I> GetCornersInSequence( EDA_ANGLE angle ) const override;
 
    // Keep the lib shape as RECTANGLE even if a runtime polygon conversion happens.
    void SetShape( SHAPE_T aShape ) override;

    VECTOR2I GetMinSize() const;
 
    void SetTop( int aVal ) override;
    void SetLeft( int aVal ) override;
    void SetRight( int aVal ) override;
    void SetBottom( int aVal ) override;
 
    void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings, bool aCheckSide ) override;
 
    int GetLegacyTextMargin() const;
 
    void SetMarginLeft( int aLeft )     { m_marginLeft = aLeft; }
    void SetMarginTop( int aTop )       { m_marginTop = aTop; }
    void SetMarginRight( int aRight )   { m_marginRight = aRight; }
    void SetMarginBottom( int aBottom ) { m_marginBottom = aBottom; }
 
    int GetMarginLeft() const           { return m_marginLeft; }
    int GetMarginTop() const            { return m_marginTop; }
    int GetMarginRight() const          { return m_marginRight; }
    int GetMarginBottom() const         { return m_marginBottom; }
 
    VECTOR2I GetDrawPos() const override;
    VECTOR2I GetDrawPos( bool aIsFlipped ) const;
 
    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; }
 
    wxString GetShownText( RESOLUTION_CONTEXT aContext, int aDepth = 0 ) const override;
 
    bool Matches( const EDA_SEARCH_DATA& aSearchData, void* aAuxData ) const override;
 
    void Move( const VECTOR2I& aMoveVector ) override;
 
    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 OnFootprintTransformed() override;
 
    void OnFootprintRescaled( double aRatioX, double aRatioY, double aLinearFactor, const VECTOR2I& aAnchor,
                              const EDA_ANGLE& aParentRotate ) override;
 
    VECTOR2I GetTextSize() const override;
    void     SetTextSize( VECTOR2I aNewSize, bool aEnforceMinTextSize = true ) override;
 
    int  GetTextThickness() const override;
    void SetTextThickness( int aWidth ) override;
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
    const BOX2I GetBoundingBox() const override;
 
    bool HitTest( const VECTOR2I& aPosition, int aAccuracy ) const override;
 
    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;
 
    bool HitTest( const SHAPE_LINE_CHAIN& aPoly, bool aContained ) const override;
 
    wxString GetClass() const override
    {
        return wxT( "PCB_TEXTBOX" );
    }

    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;

    std::shared_ptr<SHAPE> GetEffectiveShape( PCB_LAYER_ID aLayer = UNDEFINED_LAYER,
                                              FLASHING aFlash = FLASHING::DEFAULT,
                                              DRC_CONSTRAINT_T aUsage = NULL_CONSTRAINT ) const override;
 
    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    BITMAPS GetMenuImage() const override;
 
    double ViewGetLOD( int aLayer, const KIGFX::VIEW* aView ) const override;
 
    std::vector<int> ViewGetLayers() const override;
 
    EDA_ITEM* Clone() const override;

    bool IsBorderEnabled() const;

    void SetBorderEnabled( bool enabled );
 
    void SetBorderWidth( const int aSize );
    int  GetBorderWidth() const { return m_stroke.GetWidth(); }
 
    double Similarity( const BOARD_ITEM& aBoardItem ) const override;
 
    bool operator==( const PCB_TEXTBOX& aOther ) const;
    bool operator==( const BOARD_ITEM& aBoardItem ) const override;
 
protected:
    EDA_ANGLE getDrawRotation() const override { return GetDrawRotation(); }
 
    virtual void swapData( BOARD_ITEM* aImage ) override;
 
    // Inverse of OnFootprintTransformed (move center, scale half-extents, keep
    // the box axis-aligned). A true inverse at any angle.
    void syncLibCoords() override;
 
    const KIFONT::METRICS& getFontMetrics() const override { return GetFontMetrics(); }
 
protected:
    bool m_borderEnabled; 
 
private:
    int             m_marginLeft;
    int             m_marginTop;
    int             m_marginRight;
    int             m_marginBottom;
    EDA_ORIENTATION m_libTextAngle; // Text angle in parent footprint's lib frame
};
 
#endif  // #define PCB_TEXTBOX_H