pin_layout_cache.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers
 *
 * 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 3
 * 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 <font/text_attributes.h>
#include <optional>
 
#include <geometry/circle.h>
#include <geometry/seg.h>
#include <math/box2.h>
#include <sch_pin.h>
 
 
class SCHEMATIC_SETTINGS;

class PIN_LAYOUT_CACHE
{
public:
    PIN_LAYOUT_CACHE( const SCH_PIN& aPin );
 
    enum DIRTY_FLAGS
    {
        NAME = 1,
        NUMBER = 2,
        ELEC_TYPE = 4,
 
        ALL = NAME | NUMBER | ELEC_TYPE,
    };

    void MarkDirty( int aFlags );
 
    void SetRenderParameters( int aNameThickness, int aNumberThickness, bool aShowElectricalType,
                              bool aShowAltIcons );

    BOX2I GetPinBoundingBox( bool aIncludeLabelsOnInvisiblePins, bool aIncludeNameAndNumber,
                             bool aIncludeElectricalType );

    OPT_BOX2I GetPinNameBBox();

    OPT_BOX2I GetPinNumberBBox();

    OPT_BOX2I GetAltIconBBox();

    CIRCLE GetDanglingIndicator() const;
 
    struct TEXT_INFO
    {
        wxString          m_Text;
        int               m_TextSize;
        int               m_Thickness;
        VECTOR2I          m_TextPosition;
        GR_TEXT_H_ALIGN_T m_HAlign;
        GR_TEXT_V_ALIGN_T m_VAlign;
        EDA_ANGLE         m_Angle;
    };

    std::optional<TEXT_INFO> GetPinNameInfo( int aShadowWidth );
    std::optional<TEXT_INFO> GetPinNumberInfo( int aShadowWidth );
    std::optional<TEXT_INFO> GetPinElectricalTypeInfo( int aShadowWidth );
 
private:
 
    bool isDirty( int aMask ) const
    {
        return m_dirtyFlags & aMask;
    }
 
    void setClean( int aMask )
    {
        m_dirtyFlags &= ~aMask;
    }

    struct TEXT_EXTENTS_CACHE
    {
        KIFONT::FONT* m_Font = nullptr;
        int           m_FontSize = 0;
        wxString      m_Text;
        VECTOR2I      m_Extents;
    };
 
    static void recomputeExtentsCache( bool aDefinitelyDirty, KIFONT::FONT* aFont, int aSize,
                                       const wxString& aText, const KIFONT::METRICS& aFontMetrics,
                                       TEXT_EXTENTS_CACHE& aCache );

    void recomputeCaches();

    void transformBoxForPin( BOX2I& aBox ) const;

    void transformTextForPin( TEXT_INFO& aTextInfo ) const;

    int getPinTextOffset() const;

    int getNumberBlockOffset() const;

    OPT_BOX2I getUntransformedPinNameBox() const;
    OPT_BOX2I getUntransformedPinNumberBox() const;
    OPT_BOX2I getUntransformedPinTypeBox() const;
    OPT_BOX2I getUntransformedAltIconBox() const;

    OPT_BOX2I getUntransformedDecorationBox() const;

    const SCH_PIN& m_pin;
 
    // The schematic settings if there are any
    const SCHEMATIC_SETTINGS* m_schSettings;
 
    int m_dirtyFlags;
 
    // Cached render parameters
    float m_shadowOffsetAdjust = 1.0f;
    int   m_nameThickness = 0;
    int   m_numberThickness = 0;
    bool  m_showElectricalType = false;
    bool  m_showAltIcons = false;
 
    // Inputs the stacked-number formatting depends on, so a repeat call can skip it
    wxString m_numSource;
    int      m_numSourceLength = -1;
 
    // Various cache members
    TEXT_EXTENTS_CACHE m_numExtentsCache;
    TEXT_EXTENTS_CACHE m_nameExtentsCache;
    TEXT_EXTENTS_CACHE m_typeExtentsCache;
};