plotter.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2016 Jean-Pierre Charras, jp.charras at wanadoo.fr
 * Copyright (C) 2016-2021 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 PLOT_COMMON_H_
#define PLOT_COMMON_H_

#include <eda_shape.h>
#include <vector>
#include <math/box2.h>
#include <gr_text.h>
#include <page_info.h>
#include <outline_mode.h>
#include <gal/color4d.h>
#include <render_settings.h>

class COLOR_SETTINGS;
class SHAPE_ARC;
class SHAPE_POLY_SET;
class SHAPE_LINE_CHAIN;
class GBR_NETLIST_METADATA;
class PROJECT;

using KIGFX::RENDER_SETTINGS;


// Must be in the same order as the drop-down list in the plot dialog inside pcbnew
// Units (inch/mm for DXF plotter
enum class DXF_UNITS
{
 INCHES = 0,
 MILLIMETERS = 1
};


enum class PLOT_FORMAT
{
 UNDEFINED = -1,
 FIRST_FORMAT = 0,
 HPGL = FIRST_FORMAT,
 GERBER,
 POST,
 DXF,
 PDF,
 SVG,
 LAST_FORMAT = SVG
};

enum class PLOT_TEXT_MODE
{
 STROKE,
 NATIVE,
 PHANTOM,
 DEFAULT
};

enum class PLOT_DASH_TYPE
{
 DEFAULT = -1,
 SOLID = 0,
 FIRST_TYPE = SOLID,
 DASH,
 DOT,
 DASHDOT,
 LAST_TYPE = DASHDOT
};

class PLOTTER
{
public:
 // These values are used as flag for pen or aperture selection
 static const int DO_NOT_SET_LINE_WIDTH = -2; // Skip selection
 static const int USE_DEFAULT_LINE_WIDTH = -1; // use the default pen

 PLOTTER();

 virtual ~PLOTTER();

 virtual PLOT_FORMAT GetPlotterType() const = 0;

 virtual bool StartPlot() = 0;
 virtual bool EndPlot() = 0;

 virtual void SetNegative( bool aNegative )
 {
 m_negativeMode = aNegative;
 }

 virtual void SetColorMode( bool aColorMode ) { m_colorMode = aColorMode; }
 bool GetColorMode() const { return m_colorMode; }

 void SetRenderSettings( RENDER_SETTINGS* aSettings ) { m_renderSettings = aSettings; }
 RENDER_SETTINGS* RenderSettings() { return m_renderSettings; }

 virtual void SetPageSettings( const PAGE_INFO& aPageSettings ) { m_pageInfo = aPageSettings; }
 PAGE_INFO& PageSettings() { return m_pageInfo; }

 virtual void SetCurrentLineWidth( int width, void* aData = nullptr ) = 0;
 virtual int GetCurrentLineWidth() const { return m_currentPenWidth; }

 virtual void SetColor( const COLOR4D& color ) = 0;

 virtual void SetDash( PLOT_DASH_TYPE dashed ) = 0;

 virtual void SetCreator( const wxString& aCreator ) { m_creator = aCreator; }

 virtual void SetTitle( const wxString& aTitle ) { m_title = aTitle; }

 void AddLineToHeader( const wxString& aExtraString )
 {
 m_headerExtraLines.Add( aExtraString );
 }

 void ClearHeaderLinesList()
 {
 m_headerExtraLines.Clear();
 }

 virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
 double aScale, bool aMirror ) = 0;

 virtual bool OpenFile( const wxString& aFullFilename );

 double GetIUsPerDecimil() const { return m_IUsPerDecimil; }

 int GetPlotterArcLowDef() const { return m_IUsPerDecimil * 8; }
 int GetPlotterArcHighDef() const { return m_IUsPerDecimil * 2; }

 // Low level primitives
 virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) = 0;
 virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
 int width = USE_DEFAULT_LINE_WIDTH ) = 0;

 virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle, int rayon,
 FILL_T fill, int width = USE_DEFAULT_LINE_WIDTH );
 virtual void Arc( const SHAPE_ARC& aArc );

 virtual void BezierCurve( const wxPoint& aStart, const wxPoint& aControl1,
 const wxPoint& aControl2, const wxPoint& aEnd,
 int aTolerance, int aLineThickness = USE_DEFAULT_LINE_WIDTH );

 virtual void PenTo( const wxPoint& pos, char plume ) = 0;

 // Convenience functions for PenTo
 void MoveTo( const wxPoint& pos )
 {
 PenTo( pos, 'U' );
 }

 void LineTo( const wxPoint& pos )
 {
 PenTo( pos, 'D' );
 }

 void FinishTo( const wxPoint& pos )
 {
 PenTo( pos, 'D' );
 PenTo( pos, 'Z' );
 }

 void PenFinish()
 {
 // The point is not important with Z motion
 PenTo( wxPoint( 0, 0 ), 'Z' );
 }

 virtual void PlotPoly( const std::vector< wxPoint >& aCornerList, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr ) = 0;

 virtual void PlotPoly( const SHAPE_LINE_CHAIN& aCornerList, FILL_T aFill,
 int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr );

 virtual void PlotImage( const wxImage& aImage, const wxPoint& aPos, double aScaleFactor );

 // Higher level primitives -- can be drawn as line, sketch or 'filled'
 virtual void ThickSegment( const wxPoint& start, const wxPoint& end, int width,
 OUTLINE_MODE tracemode, void* aData );
 virtual void ThickArc( const wxPoint& centre, double StAngle, double EndAngle,
 int rayon, int width, OUTLINE_MODE tracemode, void* aData );
 virtual void ThickRect( const wxPoint& p1, const wxPoint& p2, int width,
 OUTLINE_MODE tracemode, void* aData );
 virtual void ThickCircle( const wxPoint& pos, int diametre, int width,
 OUTLINE_MODE tracemode, void* aData );
 virtual void FilledCircle( const wxPoint& pos, int diametre,
 OUTLINE_MODE tracemode, void* aData );


 // Flash primitives

 virtual void FlashPadCircle( const wxPoint& aPadPos, int aDiameter,
 OUTLINE_MODE aTraceMode, void* aData ) = 0;

 virtual void FlashPadOval( const wxPoint& aPadPos, const wxSize& aSize, double aPadOrient,
 OUTLINE_MODE aTraceMode, void* aData ) = 0;

 virtual void FlashPadRect( const wxPoint& aPadPos, const wxSize& aSize,
 double aPadOrient, OUTLINE_MODE aTraceMode, void* aData ) = 0;

 virtual void FlashPadRoundRect( const wxPoint& aPadPos, const wxSize& aSize,
 int aCornerRadius, double aOrient,
 OUTLINE_MODE aTraceMode, void* aData ) = 0;

 virtual void FlashPadCustom( const wxPoint& aPadPos, const wxSize& aSize,
 double aPadOrient, SHAPE_POLY_SET* aPolygons,
 OUTLINE_MODE aTraceMode, void* aData ) = 0;

 virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
 double aPadOrient, OUTLINE_MODE aTraceMode,
 void* aData ) = 0;

 virtual void FlashRegularPolygon( const wxPoint& aShapePos, int aDiameter, int aCornerCount,
 double aOrient, OUTLINE_MODE aTraceMode, void* aData ) = 0 ;

 virtual void Text( const wxPoint& aPos,
 const COLOR4D& aColor,
 const wxString& aText,
 double aOrient,
 const wxSize& aSize,
 enum EDA_TEXT_HJUSTIFY_T aH_justify,
 enum EDA_TEXT_VJUSTIFY_T aV_justify,
 int aWidth,
 bool aItalic,
 bool aBold,
 bool aMultilineAllowed = false,
 void* aData = nullptr );

 static const unsigned MARKER_COUNT = 58;

 void Marker( const wxPoint& position, int diametre, unsigned aShapeId );

 virtual void SetLayerPolarity( bool aPositive )
 {
 // NOP for most plotters
 }

 virtual void SetTextMode( PLOT_TEXT_MODE mode )
 {
 // NOP for most plotters.
 }

 virtual void SetGerberCoordinatesFormat( int aResolution, bool aUseInches = false )
 {
 // NOP for most plotters. Only for Gerber plotter
 }

 virtual void SetSvgCoordinatesFormat( unsigned aResolution, bool aUseInches = false )
 {
 // NOP for most plotters. Only for SVG plotter
 }

 virtual void StartBlock( void* aData ) {}

 virtual void EndBlock( void* aData ) {}


protected:
 // These are marker subcomponents
 void markerCircle( const wxPoint& pos, int radius );

 void markerHBar( const wxPoint& pos, int radius );

 void markerSlash( const wxPoint& pos, int radius );

 void markerBackSlash( const wxPoint& pos, int radius );

 void markerVBar( const wxPoint& pos, int radius );

 void markerSquare( const wxPoint& position, int radius );

 void markerLozenge( const wxPoint& position, int radius );

 // Helper function for sketched filler segment

 void segmentAsOval( const wxPoint& start, const wxPoint& end, int width,
 OUTLINE_MODE tracemode );

 void sketchOval( const wxPoint& pos, const wxSize& size, double orient, int width );

 // Coordinate and scaling conversion functions

 virtual DPOINT userToDeviceCoordinates( const wxPoint& aCoordinate );

 virtual DPOINT userToDeviceSize( const wxSize& size );

 virtual double userToDeviceSize( double size ) const;

 double GetDotMarkLenIU() const;

 double GetDashMarkLenIU() const;

 double GetDashGapLenIU() const;

protected: // variables used in most of plotters:
 double m_plotScale;

 /* Caller scale (how many IUs in a decimil - always); it's a double
 * because in Eeschema there are 0.1 IUs in a decimil (Eeschema
 * always works in mils internally) while PcbNew can work in decimil
 * or nanometers, so this value would be >= 1 */
 double m_IUsPerDecimil;

 double m_iuPerDeviceUnit; // Device scale (from IUs to plotter device units;
 // usually decimils)
 wxPoint m_plotOffset; // Plot offset (in IUs)
 bool m_plotMirror; // X axis orientation (SVG)
 // and plot mirrored (only for PS, PDF HPGL and SVG)
 bool m_mirrorIsHorizontal; // true to mirror horizontally (else vertically)
 bool m_yaxisReversed; // true if the Y axis is top to bottom (SVG)

 FILE* m_outputFile;

 // Pen handling
 bool m_colorMode; // true to plot in color, otherwise black & white
 bool m_negativeMode; // true to generate a negative image (PS mode mainly)
 int m_currentPenWidth;
 char m_penState; // current pen state: 'U', 'D' or 'Z' (see PenTo)
 wxPoint m_penLastpos; // last pen position; -1,-1 when pen is at rest

 wxString m_creator;
 wxString m_filename;
 wxString m_title;
 PAGE_INFO m_pageInfo;
 wxSize m_paperSize; // Paper size in IU - not in mils

 wxArrayString m_headerExtraLines; // a set of string to print in header file

 RENDER_SETTINGS* m_renderSettings;
};


class TITLE_BLOCK;

void PlotDrawingSheet( PLOTTER* plotter, const PROJECT* aProject, const TITLE_BLOCK& aTitleBlock,
 const PAGE_INFO& aPageInfo, const wxString& aSheetNumber, int aSheetCount,
 const wxString& aSheetDesc, const wxString& aFilename,
 COLOR4D aColor = COLOR4D::UNSPECIFIED, bool aIsFirstPage = true );

wxString GetDefaultPlotExtension( PLOT_FORMAT aFormat );


#endif // PLOT_COMMON_H_