plotter_gerber.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 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2016-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 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 <http://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include "plotter.h"
#include "gbr_plotter_apertures.h"
 
class SHAPE_ARC;
class GBR_METADATA;
 
class GERBER_PLOTTER : public PLOTTER
{
public:
 GERBER_PLOTTER();
 
 virtual PLOT_FORMAT GetPlotterType() const override
 {
 return PLOT_FORMAT::GERBER;
 }
 
 static wxString GetDefaultFileExtension()
 {
 return wxString( wxT( "gbr" ) );
 }
 
 virtual bool StartPlot( const wxString& pageNumber ) override;
 virtual bool EndPlot() override;
 virtual void SetCurrentLineWidth( int aLineWidth, void* aData = nullptr ) override;
 
 // RS274X has no dashing, nor colors
 virtual void SetDash( int aLineWidth, LINE_STYLE aLineStyle ) override
 {
 }
 
 virtual void SetColor( const COLOR4D& aColor ) override {}
 
 // Currently, aScale and aMirror are not used in gerber plotter
 virtual void SetViewport( const VECTOR2I& aOffset, double aIusPerDecimil,
 double aScale, bool aMirror ) override;
 
 // Basic plot primitives
 virtual void Rect( const VECTOR2I& p1, const VECTOR2I& p2, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;
 virtual void Circle( const VECTOR2I& pos, int diametre, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) override;
 virtual void Arc( const VECTOR2D& aCenter, const EDA_ANGLE& aStartAngle,
 const EDA_ANGLE& aAngle, double aRadius, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH ) override;
 
 // These functions plot an item and manage X2 gerber attributes
 virtual void ThickSegment( const VECTOR2I& start, const VECTOR2I& end, int width,
 OUTLINE_MODE tracemode, void* aData ) override;
 
 virtual void ThickRect( const VECTOR2I& p1, const VECTOR2I& p2, int width,
 OUTLINE_MODE tracemode, void* aData ) override;
 
 virtual void ThickCircle( const VECTOR2I& pos, int diametre, int width,
 OUTLINE_MODE tracemode, void* aData ) override;
 
 virtual void FilledCircle( const VECTOR2I& pos, int diametre,
 OUTLINE_MODE tracemode, void* aData ) override;
 
 virtual void PlotPoly( const std::vector<VECTOR2I>& aCornerList, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr ) override;
 
 virtual void PlotPoly( const SHAPE_LINE_CHAIN& aCornerList, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr ) override;
 
 void PlotPolyAsRegion( const SHAPE_LINE_CHAIN& aPoly, FILL_T aFill,
 int aWidth, GBR_METADATA* aGbrMetadata );
 
 virtual void PenTo( const VECTOR2I& pos, char plume ) override;
 
 virtual void Text( const VECTOR2I& aPos,
 const COLOR4D& aColor,
 const wxString& aText,
 const EDA_ANGLE& aOrient,
 const VECTOR2I& aSize,
 enum GR_TEXT_H_ALIGN_T aH_justify,
 enum GR_TEXT_V_ALIGN_T aV_justify,
 int aWidth,
 bool aItalic,
 bool aBold,
 bool aMultilineAllowed,
 KIFONT::FONT* aFont,
 const KIFONT::METRICS& aFontMetrics,
 void* aData = nullptr ) override;
 
 
 virtual void PlotText( const VECTOR2I& aPos,
 const COLOR4D& aColor,
 const wxString& aText,
 const TEXT_ATTRIBUTES& aAttributes,
 KIFONT::FONT* aFont,
 const KIFONT::METRICS& aFontMetrics,
 void* aData = nullptr ) override;
 
 virtual void FlashPadCircle( const VECTOR2I& pos, int diametre,
 OUTLINE_MODE trace_mode, void* aData ) override;
 
 virtual void FlashPadOval( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
 const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
 void* aData ) override;
 
 virtual void FlashPadRect( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
 const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
 void* aData ) override;
 
 virtual void FlashPadRoundRect( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
 int aCornerRadius, const EDA_ANGLE& aOrient,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 virtual void FlashPadCustom( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
 const EDA_ANGLE& aPadOrient, SHAPE_POLY_SET* aPolygons,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 
 virtual void FlashPadTrapez( const VECTOR2I& aPadPos, const VECTOR2I* aCorners,
 const EDA_ANGLE& aPadOrient, OUTLINE_MODE aTraceMode,
 void* aData ) override;
 
 virtual void FlashRegularPolygon( const VECTOR2I& aShapePos, int aDiameter, int aCornerCount,
 const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
 void* aData ) override;
 
 void FlashPadChamferRoundRect( const VECTOR2I& aShapePos, const VECTOR2I& aPadSize,
 int aCornerRadius, double aChamferRatio,
 int aChamferPositions, const EDA_ANGLE& aPadOrient,
 OUTLINE_MODE aPlotMode, void* aData );
 
 void PlotGerberRegion( const std::vector<VECTOR2I>& aCornerList, GBR_METADATA* aGbrMetadata );
 
 void PlotGerberRegion( const SHAPE_LINE_CHAIN& aPoly, GBR_METADATA* aGbrMetadata );
 
 virtual void SetLayerPolarity( bool aPositive ) override;
 
 virtual void SetGerberCoordinatesFormat( int aResolution, bool aUseInches = false ) override;
 
 void UseX2format( bool aEnable ) { m_useX2format = aEnable; }
 void UseX2NetAttributes( bool aEnable ) { m_useNetAttributes = aEnable; }
 
 void DisableApertMacros( bool aDisable ) { m_gerberDisableApertMacros = aDisable; }
 
 virtual void StartBlock( void* aData ) override;
 
 virtual void EndBlock( void* aData ) override;
 
 void ClearAllAttributes();
 
 int GetOrCreateAperture( const VECTOR2I& aSize, int aRadius, const EDA_ANGLE& aRotation,
 APERTURE::APERTURE_TYPE aType, int aApertureAttribute );
 
 int GetOrCreateAperture( const std::vector<VECTOR2I>& aCorners, const EDA_ANGLE& aRotation,
 APERTURE::APERTURE_TYPE aType, int aApertureAttribute );
 
protected:
 virtual void ThickArc( const VECTOR2D& aCentre, const EDA_ANGLE& aStartAngle,
 const EDA_ANGLE& aAngle, double aRadius, int aWidth,
 OUTLINE_MODE aTraceMode, void* aData ) override;
 
 void plotRoundRectAsRegion( const VECTOR2I& aRectCenter, const VECTOR2I& aSize,
 int aCornerRadius, const EDA_ANGLE& aOrient );
 void plotArc( const VECTOR2I& aCenter, const EDA_ANGLE& aStartAngle, const EDA_ANGLE& aEndAngle,
 double aRadius, bool aPlotInRegion );
 void plotArc( const SHAPE_ARC& aArc, bool aPlotInRegion );
 
 void selectAperture( const VECTOR2I& aSize, int aRadius, const EDA_ANGLE& aRotation,
 APERTURE::APERTURE_TYPE aType, int aApertureAttribute );
 void selectAperture( const std::vector<VECTOR2I>& aCorners, const EDA_ANGLE& aPolygonRotation,
 APERTURE::APERTURE_TYPE aType, int aApertureAttribute );
 
 void selectAperture( int aDiameter, const EDA_ANGLE& aRotation,
 APERTURE::APERTURE_TYPE aType, int aApertureAttribute );
 
 void emitDcode( const VECTOR2D& pt, int dcode );
 
 void formatNetAttribute( GBR_NETLIST_METADATA* aData );
 
 void clearNetAttribute();
 
 // the attributes dictionary created/modified by %TO, attached to objects, when they are created
 // by D01, D03, G36/G37 commands
 // standard attributes are .P, .C and .N
 // this is used by gerber readers when creating a new object. Cleared by %TD command
 // Note: m_objectAttributesDictionary can store more than one attribute
 // the string stores the line(s) actually written to the gerber file
 // it can store a .P, .C or .N attribute, or 2 or 3 attributes, separated by a \n char (EOL)
 std::string m_objectAttributesDictionary;
 
 // The last aperture attribute generated (only one aperture attribute can be set)
 int m_apertureAttribute;
 
 FILE* workFile;
 FILE* finalFile;
 wxString m_workFilename;
 
 void writeApertureList();
 
 std::vector<APERTURE> m_apertures; // The list of available apertures
 int m_currentApertureIdx; // The index of the current aperture in m_apertures
 bool m_hasApertureRoundRect; // true is at least one round rect aperture is in use
 bool m_hasApertureRotOval; // true is at least one oval rotated aperture is in use
 bool m_hasApertureRotRect; // true is at least one rect. rotated aperture is in use
 bool m_hasApertureOutline4P; // true is at least one 4 corners outline (free polygon
 // with 4 corners) aperture is in use
 bool m_hasApertureChamferedRect; // true is at least one chamfered rect is in use
 // (with no rounded corner)
 
 bool m_gerberUnitInch; // true if the gerber units are inches, false for mm
 int m_gerberUnitFmt; // number of digits in mantissa.
 // usually 6 in Inches and 5 or 6 in mm
 bool m_gerberDisableApertMacros; // True to disable Aperture Macro (AM) command,
 // for broken Gerber Readers
 // Regions will be used instead of AM shapes
 bool m_useX2format; // Add X2 file header attributes. If false, attributes
 // will be added as comments.
 bool m_useNetAttributes; // In recent gerber files, netlist info can be added.
 // It will be added if this param is true, using X2 or
 // X1 format
 
 // A list of aperture macros defined "on the fly" because the number of parameters is not
 // defined: this is the case of the macro using the primitive 4 to create a polygon.
 // The number of vertices is not known for free polygonal shapes, and an aperture macro
 // must be created for each specific polygon
 APER_MACRO_FREEPOLY_LIST m_am_freepoly_list;
};