gerber_draw_item.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 1992-2016 <Jean-Pierre Charras>
 * Copyright (C) 1992-2023 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 GERBER_DRAW_ITEM_H
#define GERBER_DRAW_ITEM_H
 
#include <eda_item.h>
#include <layer_ids.h>
#include <gr_basic.h>
#include <gbr_netlist_metadata.h>
#include <dcode.h>
#include <geometry/shape_poly_set.h>
#include <geometry/eda_angle.h>
 
class GERBER_FILE_IMAGE;
class GBR_LAYOUT;
class D_CODE;
class MSG_PANEL_ITEM;
class GBR_DISPLAY_OPTIONS;
class PCB_BASE_FRAME;
 
namespace KIGFX
{
    class VIEW;
}
 
 
/* Shapes id for basic shapes ( .m_ShapeType member ) */
enum GBR_BASIC_SHAPE_TYPE
{
    GBR_SEGMENT = 0,        // usual segment : line with rounded ends
    GBR_ARC,                // Arcs (with rounded ends)
    GBR_CIRCLE,             // ring
    GBR_POLYGON,            // polygonal shape
    GBR_SPOT_CIRCLE,        // flashed shape: round shape (can have hole)
    GBR_SPOT_RECT,          // flashed shape: rectangular shape can have hole)
    GBR_SPOT_OVAL,          // flashed shape: oval shape
    GBR_SPOT_POLY,          // flashed shape: regular polygon, 3 to 12 edges
    GBR_SPOT_MACRO          // complex shape described by a macro
};
 
class GERBER_DRAW_ITEM : public EDA_ITEM
{
public:
    GERBER_DRAW_ITEM( GERBER_FILE_IMAGE* aGerberparams );
    ~GERBER_DRAW_ITEM();
 
    void SetNetAttributes( const GBR_NETLIST_METADATA& aNetAttributes );
    const GBR_NETLIST_METADATA& GetNetAttributes() const { return m_netAttributes; }
 
    int GetLayer() const;
 
    bool GetLayerPolarity() const { return m_LayerNegative; }
 
    bool GetTextD_CodePrms( int& aSize, VECTOR2I& aPos, EDA_ANGLE& aOrientation );
 
    bool HasNegativeItems();
 
    void SetLayerParameters();
 
    void SetLayerPolarity( bool aNegative) { m_LayerNegative = aNegative; }
 
    void MoveXY( const VECTOR2I& aMoveVector );
 
    VECTOR2I GetPosition() const override { return m_Start; }
    void     SetPosition( const VECTOR2I& aPos ) override { m_Start = aPos; }
 
    VECTOR2I GetABPosition( const VECTOR2I& aXYPosition ) const;
 
    VECTOR2I GetXYPosition( const VECTOR2I& aABPosition ) const;
 
    D_CODE* GetDcodeDescr() const;
 
    const BOX2I GetBoundingBox() const override;
 
    void Print( wxDC* aDC, const VECTOR2I& aOffset, GBR_DISPLAY_OPTIONS* aOptions );
 
    void ConvertSegmentToPolygon();
    void ConvertSegmentToPolygon( SHAPE_POLY_SET* aPolygon ) const;
 
    void PrintGerberPoly( wxDC* aDC, const COLOR4D& aColor, const VECTOR2I& aOffset,
                          bool aFilledShape );
 
    GBR_BASIC_SHAPE_TYPE ShapeType() const { return m_ShapeType; }
 
    void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList ) override;
 
    wxString ShowGBRShape() const;
 
    bool HitTest( const VECTOR2I& aRefPos, int aAccuracy = 0 ) const override;
 
    bool HitTest( const BOX2I& aRefArea, bool aContained, int aAccuracy = 0 ) const override;
 
    wxString GetClass() const override
    {
        return wxT( "GERBER_DRAW_ITEM" );
    }
 
#if defined(DEBUG)
    void Show( int nestLevel, std::ostream& os ) const override;
#endif
 
    virtual std::vector<int> ViewGetLayers() const override;
 
    virtual const BOX2I ViewBBox() const override;
 
    double ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
 
    INSPECT_RESULT Visit( INSPECTOR inspector, void* testData,
                          const std::vector<KICAD_T>& aScanTypes ) override;
 
    virtual wxString GetItemDescription( UNITS_PROVIDER* aUnitsProvider, bool aFull ) const override;
 
    BITMAPS GetMenuImage() const override;
 
public:
    bool               m_UnitsMetric;       // store here the gerber units (inch/mm).  Used
                                            // only to calculate aperture macros shapes sizes
    GBR_BASIC_SHAPE_TYPE m_ShapeType;       // Shape type of this gerber item
    VECTOR2I           m_Start;             // Line or arc start point or position of the shape
                                            // for flashed items
    VECTOR2I           m_End;               // Line or arc end point
    VECTOR2I           m_ArcCentre;         // for arcs only: Center of arc
    SHAPE_POLY_SET     m_ShapeAsPolygon;    // Polygon shape data from G36 to G37 coordinates
                                            // or for complex shapes which are converted to polygon
    VECTOR2I           m_Size;              // Flashed shapes: size of the shape
                                            // Lines : m_Size.x = m_Size.y = line width
    bool               m_Flashed;           // True for flashed items
    int                m_DCode;             // DCode used to draw this item.
                                            // Allowed values are >= 10. 0 when unknown
                                            // values 0 to 9 can be used for special purposes
                                            // Regions (polygons) do not use DCode,
                                            // so it is set to 0
    wxString           m_AperFunction;      // the aperture function set by a %TA.AperFunction, xxx
                                            // (stores the xxx value). Used for regions that do
                                            // not have a attached DCode, but
                                            // have a TA.AperFunction defined
    GERBER_FILE_IMAGE* m_GerberImageFile;   /* Gerber file image source of this item
                                             * Note: some params stored in this class are common
                                             * to the whole gerber file (i.e) the whole graphic
                                             * layer and some can change when reading the file,
                                             * so they are stored inside this item if there is no
                                             * redundancy for these parameters
                                             */
 
    // This polygon is to draw this item (mainly GBR_POLYGON), according to layer parameters
    SHAPE_POLY_SET   m_AbsolutePolygon;     // the polygon to draw, in absolute coordinates
 
private:
    // These values are used to draw this item, according to gerber layers parameters
    // Because they can change inside a gerber image, they are stored here
    // for each item
    bool        m_LayerNegative;            // true = item in negative Layer
    bool        m_swapAxis;                 // false if A = X, B = Y; true if A =Y, B = Y
    bool        m_mirrorA;                  // true: mirror / axis A
    bool        m_mirrorB;                  // true: mirror / ax's B
    VECTOR2I    m_drawScale;                // A and B scaling factor
    VECTOR2I    m_layerOffset;              // Offset for A and B axis, from OF parameter
    double      m_lyrRotation;              // Fine rotation, from OR parameter, in degrees
    GBR_NETLIST_METADATA m_netAttributes;   
};
 
 
#endif /* GERBER_DRAW_ITEM_H */