pcb_barcode.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2020 Thomas Pointhuber <[email protected]>
 * Copyright (C) 2020 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 BARCODE_H_
#define BARCODE_H_
 
 
#include <board_item.h>
#include <geometry/shape_poly_set.h>
#include <pcb_text.h>
#include <memory>
 
class LINE_READER;
class MSG_PANEL_ITEM;
 
 
enum class BARCODE_T : int
{
    CODE_39 = 0,
    CODE_128 = 1,
    DATA_MATRIX = 2,
    QR_CODE = 3,
    MICRO_QR_CODE = 4
};
 
enum class BARCODE_ECC_T : int
{
    L = 1, // Low
    M = 2, // Medium
    Q = 3, // Quartile
    H = 4  // High
};
 
DECLARE_ENUM_TO_WXANY( BARCODE_T );
DECLARE_ENUM_TO_WXANY( BARCODE_ECC_T );
 
 
struct PCB_BARCODE_CACHE
{
    size_t keyHash = 0; 
 
    // Geometry
    SHAPE_POLY_SET poly;
    SHAPE_POLY_SET symbolPoly;
    SHAPE_POLY_SET textPoly;
    BOX2I          bbox;
    wxString       lastError;
};
 
 
class PCB_BARCODE : public BOARD_ITEM
{
public:
    PCB_BARCODE( BOARD_ITEM* aParent );

    PCB_BARCODE( const PCB_BARCODE& aOther );

    PCB_BARCODE& operator=( const PCB_BARCODE& aOther );

    ~PCB_BARCODE();

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

    VECTOR2I GetPosition() const override;
    void SetPosition( const VECTOR2I& aPos ) override;

    void SetTextSize( int aTextSize );
 
    int  GetTextSize() const;

    void SetLayer( PCB_LAYER_ID aLayer ) override;
 
    void Serialize( google::protobuf::Any& aContainer ) const override;
    bool Deserialize( const google::protobuf::Any& aContainer ) override;

    int  GetWidth() const { return m_width; }
    void SetWidth( int aWidth ) { m_width = aWidth; }

    int  GetHeight() const { return m_height; }
    void SetHeight( int aHeight ) { m_height = aHeight; }

    const VECTOR2I& GetMargin() const { return m_margin; }
    void SetMargin( const VECTOR2I& aMargin ) { m_margin = aMargin; }

    const SHAPE_POLY_SET& GetPolyShape() const
    {
        AssembleBarcode();
        return m_cache->poly;
    }

    const SHAPE_POLY_SET& GetSymbolPoly() const
    {
        AssembleBarcode();
        return m_cache->symbolPoly;
    }

    const SHAPE_POLY_SET& GetTextPoly() const
    {
        AssembleBarcode();
        return m_cache->textPoly;
    }

    void TransformShapeToPolygon( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                                  int aMaxError, ERROR_LOC aErrorLoc = ERROR_INSIDE,
                                  bool ignoreLineWidth = 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;
 
    /*
     * Add two rectangular polygons separately bounding the barcode's symbol and the barcode's text.
     */
    void GetBoundingHull( SHAPE_POLY_SET& aBuffer, PCB_LAYER_ID aLayer, int aClearance,
                          int aMaxError, ERROR_LOC aErrorLoc = ERROR_INSIDE ) const;

    void ComputeBarcode() const;

    void ComputeTextPoly() const;

    void AssembleBarcode() const;

    void     SetText( const wxString& aText );
    wxString GetText() const;
    wxString GetShownText() const;

    const std::vector<TEXT_VAR_REF_KEY>& GetTextVarReferences() const { return m_text.GetTextVarReferences(); }

    void Move( const VECTOR2I& offset ) override;

    void Rotate( const VECTOR2I& aRotCentre, const EDA_ANGLE& aAngle ) override;

    void Flip( const VECTOR2I& aCentre, FLIP_DIRECTION aFlipLeftRight ) override;
 
    void StyleFromSettings( const BOARD_DESIGN_SETTINGS& settings, bool aCheckSide ) override;

    VECTOR2I GetCenter() const override { return GetPosition(); }

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

    bool HitTest( const VECTOR2I& aPosition, int aAccuracy ) const override;

    bool HitTest( const BOX2I& aRect, bool aContained, int aAccuracy = 0 ) const override;

    wxString GetClass() const override { return wxT( "BARCODE" ); }
 
    // Virtual function
    const BOX2I GetBoundingBox() const override;

    wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;

    BITMAPS GetMenuImage() const override;

    EDA_ITEM* Clone() const override;
 
    void swapData( BOARD_ITEM* aImage ) override;

    virtual const BOX2I ViewBBox() const override;

    double Similarity( const BOARD_ITEM& aItem ) const override;
 
    static int Compare( const PCB_BARCODE* aBarcode, const PCB_BARCODE* aOther );

    bool operator==( const BOARD_ITEM& aItem ) const override;
 
    bool operator==( const PCB_BARCODE& aBarcode ) const;

    BARCODE_T GetKind() const { return m_kind; }
    void SetKind( BARCODE_T aKind );
    void SetBarcodeKind( BARCODE_T aKind ); // Includes re-compute
 
    bool KeepSquare() const
    {
        return m_kind == BARCODE_T::QR_CODE
                || m_kind == BARCODE_T::MICRO_QR_CODE
                || m_kind == BARCODE_T::DATA_MATRIX;
    }

    void SetErrorCorrection( BARCODE_ECC_T aErrorCorrection );
    BARCODE_ECC_T GetErrorCorrection() const { return m_errorCorrection; }
    void SetBarcodeErrorCorrection( BARCODE_ECC_T aErrorCorrection );  // Includes re-compute
 
    void SetBarcodeText( const wxString& aText ) { SetText( aText ); AssembleBarcode(); }
    void SetShowText( bool aShow ) { m_text.SetVisible( aShow ); AssembleBarcode(); }
    bool GetShowText() const { return m_text.IsVisible(); }
 
    void SetBarcodeWidth( int aWidth );
    void SetBarcodeHeight( int aHeight );
 
    EDA_ANGLE GetAngle() const { return m_angle; }
    double GetOrientation() const { return m_angle.AsDegrees(); }
    void   SetOrientation( double aDegrees )
    {
        EDA_ANGLE newAngle( aDegrees, DEGREES_T );
        EDA_ANGLE oldAngle = m_angle;
 
        if( newAngle != oldAngle )
        {
            Rotate( GetPosition(), newAngle - oldAngle );
        }
    }
 
    int  GetMarginX() const { return m_margin.x; }
    int  GetMarginY() const { return m_margin.y; }
 
    void SetMarginX( int aX )
    {
        aX = std::max( pcbIUScale.mmToIU( 1 ), aX );
        m_margin.x = aX;
        AssembleBarcode();
    }
 
    void SetMarginY( int aY )
    {
        aY = std::max( pcbIUScale.mmToIU( 1 ), aY );
        m_margin.y = aY;
        AssembleBarcode();
    }
 
    bool IsKnockout() const override { return BOARD_ITEM::IsKnockout(); }
    void SetIsKnockout( bool aEnable ) override
    {
        BOARD_ITEM::SetIsKnockout( aEnable );
        AssembleBarcode();
    }
 
    const wxString& GetLastError() const
    {
        AssembleBarcode();
        return m_cache->lastError;
    }
 
private:
    int            m_width;      
    int            m_height;     
    VECTOR2I       m_pos;        
    VECTOR2I       m_margin;     
    PCB_TEXT       m_text;
    BARCODE_T      m_kind;
    EDA_ANGLE      m_angle;
    BARCODE_ECC_T  m_errorCorrection; 
 
    mutable std::unique_ptr<PCB_BARCODE_CACHE> m_cache;

    size_t computeCacheKey() const;

    void rescaleSymbolPoly( const VECTOR2I& aTopLeft, const VECTOR2I& aBotRight ) const;
};
 
#endif // DIMENSION_H_