mirror of
https://gitlab.com/kicad/code/kicad.git
synced 2025-09-14 10:13:19 +02:00
d00c83cde9
The plan goes like this: - eeschema still uses int in decidegrees - all the other things internally use double in decidegrees (or radians in temporaries) - in pcbnew UI the unit is *still* int in decidegrees The idea is to have better precision everywhere while keeping the user with int i angles. Hopefully, if a fractional angle doesn't come in from the outside, everything should *look* like an integer angle (unless I forgot something and it broke) When the time comes, simply updating the UI for allowing doubles from the user should be enough to get arbitrary angles in pcbnew.
921 lines
33 KiB
C++
921 lines
33 KiB
C++
/**
|
|
* Common plot library \n
|
|
* Plot settings, and plotting engines (Postscript, Gerber, HPGL and DXF)
|
|
*
|
|
* @file plot_common.h
|
|
*/
|
|
|
|
#ifndef PLOT_COMMON_H_
|
|
#define PLOT_COMMON_H_
|
|
|
|
#include <vector>
|
|
#include <vector2d.h>
|
|
#include <drawtxt.h>
|
|
#include <common.h> // PAGE_INFO
|
|
#include <eda_text.h> // FILL_T
|
|
|
|
/**
|
|
* Enum PlotFormat
|
|
* is the set of supported output plot formats. They should be kept in order
|
|
* of the radio buttons in the plot panel/windows.
|
|
*/
|
|
enum PlotFormat {
|
|
PLOT_FIRST_FORMAT = 0,
|
|
PLOT_FORMAT_HPGL = PLOT_FIRST_FORMAT,
|
|
PLOT_FORMAT_GERBER,
|
|
PLOT_FORMAT_POST,
|
|
PLOT_FORMAT_DXF,
|
|
PLOT_FORMAT_PDF,
|
|
PLOT_FORMAT_SVG,
|
|
PLOT_LAST_FORMAT = PLOT_FORMAT_SVG
|
|
};
|
|
|
|
/**
|
|
* Enum for choosing which kind of text to output with the PSLIKE
|
|
* plotters. You can:
|
|
* 1) only use the internal vector font
|
|
* 2) only use native postscript fonts
|
|
* 3) use the internal vector font and add 'phantom' text to aid
|
|
* searching
|
|
* 4) keep the default for the plot driver
|
|
*
|
|
* This is recognized by the DXF driver too, where NATIVE emits
|
|
* TEXT entities instead of stroking the text
|
|
*/
|
|
enum PlotTextMode {
|
|
PLOTTEXTMODE_STROKE,
|
|
PLOTTEXTMODE_NATIVE,
|
|
PLOTTEXTMODE_PHANTOM,
|
|
PLOTTEXTMODE_DEFAULT
|
|
};
|
|
|
|
|
|
/**
|
|
* Base plotter engine class. General rule: all the interface with the caller
|
|
* is done in IU, the IU size is specified with SetViewport. Internal and
|
|
* output processing is usually done in decimils (or whatever unit the
|
|
* effective engine class need to use)
|
|
*/
|
|
class PLOTTER
|
|
{
|
|
public:
|
|
static const int DEFAULT_LINE_WIDTH = -1;
|
|
|
|
PLOTTER();
|
|
|
|
virtual ~PLOTTER();
|
|
|
|
/**
|
|
* Returns the effective plot engine in use. It's not very OO but for
|
|
* now is required since some things are only done with some output devices
|
|
* (like drill marks, emitted only for postscript
|
|
*/
|
|
virtual PlotFormat GetPlotterType() const = 0;
|
|
|
|
virtual bool StartPlot() = 0;
|
|
virtual bool EndPlot() = 0;
|
|
|
|
virtual void SetNegative( bool _negative )
|
|
{
|
|
negativeMode = _negative;
|
|
}
|
|
|
|
virtual void SetColorMode( bool _color_mode )
|
|
{
|
|
colorMode = _color_mode;
|
|
}
|
|
|
|
bool GetColorMode() const
|
|
{
|
|
return colorMode;
|
|
}
|
|
|
|
virtual void SetPageSettings( const PAGE_INFO& aPageSettings );
|
|
|
|
/**
|
|
* Set the line width for the next drawing.
|
|
* @param width is specified in IUs
|
|
*/
|
|
virtual void SetCurrentLineWidth( int width ) = 0;
|
|
|
|
/**
|
|
* Set the default line width. Used at the beginning and when a width
|
|
* of -1 (DEFAULT_LINE_WIDTH) is requested.
|
|
* @param width is specified in IUs
|
|
*/
|
|
virtual void SetDefaultLineWidth( int width ) = 0;
|
|
|
|
virtual int GetCurrentLineWidth() const
|
|
{
|
|
return currentPenWidth;
|
|
}
|
|
|
|
virtual void SetColor( EDA_COLOR_T color ) = 0;
|
|
|
|
virtual void SetDash( bool dashed ) = 0;
|
|
|
|
virtual void SetCreator( const wxString& _creator )
|
|
{
|
|
creator = _creator;
|
|
}
|
|
|
|
/**
|
|
* Set the plot offset and scaling for the current plot
|
|
* @param aOffset is the plot offset
|
|
* @param aIusPerDecimil gives the scaling factor from IUs to device units
|
|
* @param aScale is the user set plot scaling factor (either explicitly
|
|
* or using 'fit to A4')
|
|
* @param aMirror flips the plot in the Y direction (useful for toner
|
|
* transfers or some kind of film)
|
|
*/
|
|
virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
|
|
double aScale, bool aMirror ) = 0;
|
|
|
|
/**
|
|
* Open or create the plot file aFullFilename
|
|
* @param aFullFilename = the full file name of the file to create
|
|
* @return true if success, false if the file cannot be created/opened
|
|
*
|
|
* Virtual because some plotters use ascii files, some others binary files (PDF)
|
|
* The base class open the file in text mode
|
|
*/
|
|
virtual bool OpenFile( const wxString& aFullFilename );
|
|
|
|
/**
|
|
* The IUs per decimil are an essential scaling factor when
|
|
* plotting; they are set and saved when establishing the viewport.
|
|
* Here they can be get back again
|
|
*/
|
|
double GetIUsPerDecimil() const { return m_IUsPerDecimil; }
|
|
|
|
// Low level primitives
|
|
virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH ) = 0;
|
|
virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH ) = 0;
|
|
virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle,
|
|
int rayon, FILL_T fill, int width = DEFAULT_LINE_WIDTH );
|
|
|
|
/**
|
|
* moveto/lineto primitive, moves the 'pen' to the specified direction
|
|
* @param pos is the target position
|
|
* @param plume specifies the kind of motion: 'U' only moves the pen,
|
|
* 'D' draw a line from the current position and 'Z' finish
|
|
* the drawing and returns the 'pen' to rest (flushes the trace)
|
|
*/
|
|
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' );
|
|
}
|
|
|
|
/**
|
|
* Function PlotPoly
|
|
* @brief Draw a polygon ( filled or not )
|
|
* @param aCornerList = corners list
|
|
* @param aFill = type of fill
|
|
* @param aWidth = line width
|
|
*/
|
|
virtual void PlotPoly( const std::vector< wxPoint >& aCornerList, FILL_T aFill,
|
|
int aWidth = DEFAULT_LINE_WIDTH ) = 0;
|
|
|
|
/**
|
|
* Function PlotImage
|
|
* Only Postscript plotters can plot bitmaps
|
|
* for plotters that cannot plot a bitmap, a rectangle is plotted
|
|
* @brief Draw an image bitmap
|
|
* @param aImage = the bitmap
|
|
* @param aPos = position of the center of the bitmap
|
|
* @param aScaleFactor = the scale factor to apply to the bitmap size
|
|
* (this is not the plot scale factor)
|
|
*/
|
|
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,
|
|
EDA_DRAW_MODE_T tracemode );
|
|
virtual void ThickArc( const wxPoint& centre, double StAngle, double EndAngle,
|
|
int rayon, int width, EDA_DRAW_MODE_T tracemode );
|
|
virtual void ThickRect( const wxPoint& p1, const wxPoint& p2, int width,
|
|
EDA_DRAW_MODE_T tracemode );
|
|
virtual void ThickCircle( const wxPoint& pos, int diametre, int width,
|
|
EDA_DRAW_MODE_T tracemode );
|
|
|
|
// Flash primitives
|
|
virtual void FlashPadCircle( const wxPoint& pos, int diametre,
|
|
EDA_DRAW_MODE_T trace_mode ) = 0;
|
|
virtual void FlashPadOval( const wxPoint& pos, const wxSize& size, double orient,
|
|
EDA_DRAW_MODE_T trace_mode ) = 0;
|
|
virtual void FlashPadRect( const wxPoint& pos, const wxSize& size,
|
|
double orient, EDA_DRAW_MODE_T trace_mode ) = 0;
|
|
|
|
/** virtual function FlashPadTrapez
|
|
* flash a trapezoidal pad
|
|
* @param aPadPos = the position of the shape
|
|
* @param aCorners = the list of 4 corners positions,
|
|
* relative to the shape position, pad orientation 0
|
|
* @param aPadOrient = the rotation of the shape
|
|
* @param aTrace_Mode = FILLED or SKETCH
|
|
*/
|
|
virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
|
|
double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode ) = 0;
|
|
|
|
|
|
/**
|
|
* Draws text with the plotter. For convenience it accept the color to use
|
|
*/
|
|
virtual void Text( const wxPoint& aPos,
|
|
enum EDA_COLOR_T 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 );
|
|
|
|
/**
|
|
* Draw a marker (used for the drill map)
|
|
*/
|
|
static const unsigned MARKER_COUNT = 58;
|
|
void Marker( const wxPoint& position, int diametre, unsigned aShapeId );
|
|
|
|
/**
|
|
* Function SetLayerPolarity
|
|
* sets current Gerber layer polarity to positive or negative
|
|
* by writing \%LPD*\% or \%LPC*\% to the Gerber file, respectively.
|
|
* (obviously starts a new Gerber layer, too)
|
|
* @param aPositive is the layer polarity and true for positive.
|
|
* It's not useful with most other plotter since they can't 'scratch'
|
|
* the film like photoplotter imagers do
|
|
*/
|
|
virtual void SetLayerPolarity( bool aPositive )
|
|
{
|
|
// NOP for most plotters
|
|
}
|
|
|
|
/**
|
|
* Change the current text mode. See the PlotTextMode
|
|
* explanation at the beginning of the file
|
|
*/
|
|
virtual void SetTextMode( PlotTextMode mode )
|
|
{
|
|
// NOP for most plotters
|
|
}
|
|
|
|
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,
|
|
EDA_DRAW_MODE_T tracemode );
|
|
void sketchOval( const wxPoint& pos, const wxSize& size, double orient,
|
|
int width );
|
|
|
|
// Coordinate and scaling conversion functions
|
|
virtual DPOINT userToDeviceCoordinates( const wxPoint& pos );
|
|
virtual DPOINT userToDeviceSize( const wxSize& size );
|
|
virtual double userToDeviceSize( double size );
|
|
|
|
/// Plot scale - chosen by the user (even implicitly with 'fit in a4')
|
|
double plotScale;
|
|
|
|
/* Device 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;
|
|
|
|
/// Device scale (from IUs to device units - usually decimils)
|
|
double iuPerDeviceUnit;
|
|
|
|
/// Plot offset (in IUs)
|
|
wxPoint plotOffset;
|
|
|
|
/// Output file
|
|
FILE* outputFile;
|
|
|
|
// Pen handling
|
|
bool colorMode; /// true to plot in color, false to plot in black and white
|
|
bool negativeMode; /// true to generate a negative image (PS mode mainly)
|
|
int defaultPenWidth;
|
|
int currentPenWidth;
|
|
/// Current pen state: 'U', 'D' or 'Z' (see PenTo)
|
|
char penState;
|
|
/// Last pen positions; set to -1,-1 when the pen is at rest
|
|
wxPoint penLastpos;
|
|
bool plotMirror;
|
|
wxString creator;
|
|
wxString filename;
|
|
PAGE_INFO pageInfo;
|
|
/// Paper size in IU - not in mils
|
|
wxSize paperSize;
|
|
};
|
|
|
|
|
|
class HPGL_PLOTTER : public PLOTTER
|
|
{
|
|
public:
|
|
HPGL_PLOTTER();
|
|
|
|
virtual PlotFormat GetPlotterType() const
|
|
{
|
|
return PLOT_FORMAT_HPGL;
|
|
}
|
|
|
|
static wxString GetDefaultFileExtension()
|
|
{
|
|
return wxString( wxT( "plt" ) );
|
|
}
|
|
|
|
virtual bool StartPlot();
|
|
virtual bool EndPlot();
|
|
|
|
/// HPGL doesn't handle line thickness or color
|
|
virtual void SetCurrentLineWidth( int width )
|
|
{
|
|
// This is the truth
|
|
currentPenWidth = userToDeviceSize( penDiameter );
|
|
}
|
|
|
|
virtual void SetDefaultLineWidth( int width ) {};
|
|
virtual void SetDash( bool dashed );
|
|
|
|
virtual void SetColor( EDA_COLOR_T color ) {};
|
|
|
|
virtual void SetPenSpeed( int speed )
|
|
{
|
|
penSpeed = speed;
|
|
}
|
|
|
|
virtual void SetPenNumber( int number )
|
|
{
|
|
penNumber = number;
|
|
}
|
|
|
|
virtual void SetPenDiameter( double diameter )
|
|
{
|
|
penDiameter = diameter;
|
|
}
|
|
|
|
virtual void SetPenOverlap( double overlap )
|
|
{
|
|
penOverlap = overlap;
|
|
}
|
|
|
|
virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
|
|
double aScale, bool aMirror );
|
|
virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void PlotPoly( const std::vector< wxPoint >& aCornerList,
|
|
FILL_T aFill, int aWidth = DEFAULT_LINE_WIDTH);
|
|
|
|
virtual void ThickSegment( const wxPoint& start, const wxPoint& end, int width,
|
|
EDA_DRAW_MODE_T tracemode );
|
|
virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle,
|
|
int rayon, FILL_T fill, int width = DEFAULT_LINE_WIDTH );
|
|
virtual void PenTo( const wxPoint& pos, char plume );
|
|
virtual void FlashPadCircle( const wxPoint& pos, int diametre,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadOval( const wxPoint& pos, const wxSize& size, double orient,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadRect( const wxPoint& pos, const wxSize& size,
|
|
double orient, EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
|
|
double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode );
|
|
|
|
protected:
|
|
void penControl( char plume );
|
|
|
|
int penSpeed;
|
|
int penNumber;
|
|
double penDiameter;
|
|
double penOverlap;
|
|
};
|
|
|
|
/**
|
|
* The PSLIKE_PLOTTER class is an intermediate class to handle common
|
|
* routines for engines working more or less with the postscript imaging
|
|
* model
|
|
*/
|
|
class PSLIKE_PLOTTER : public PLOTTER
|
|
{
|
|
public:
|
|
PSLIKE_PLOTTER() : plotScaleAdjX( 1 ), plotScaleAdjY( 1 ),
|
|
m_textMode( PLOTTEXTMODE_PHANTOM )
|
|
{
|
|
}
|
|
|
|
/**
|
|
* PS and PDF fully implement native text (for the Latin-1 subset)
|
|
*/
|
|
virtual void SetTextMode( PlotTextMode mode )
|
|
{
|
|
if( mode != PLOTTEXTMODE_DEFAULT )
|
|
m_textMode = mode;
|
|
}
|
|
|
|
virtual void SetDefaultLineWidth( int width );
|
|
|
|
/**
|
|
* Set the 'fine' scaling for the postscript engine
|
|
*/
|
|
void SetScaleAdjust( double scaleX, double scaleY )
|
|
{
|
|
plotScaleAdjX = scaleX;
|
|
plotScaleAdjY = scaleY;
|
|
}
|
|
|
|
// Pad routines are handled with lower level primitives
|
|
virtual void FlashPadCircle( const wxPoint& pos, int diametre,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadOval( const wxPoint& pos, const wxSize& size, double orient,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadRect( const wxPoint& pos, const wxSize& size,
|
|
double orient, EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
|
|
double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode );
|
|
|
|
/** The SetColor implementation is split with the subclasses:
|
|
* The PSLIKE computes the rgb values, the subclass emits the
|
|
* operator to actually do it
|
|
*/
|
|
virtual void SetColor( EDA_COLOR_T color );
|
|
|
|
protected:
|
|
void computeTextParameters( const wxPoint& aPos,
|
|
const wxString& aText,
|
|
int aOrient,
|
|
const wxSize& aSize,
|
|
enum EDA_TEXT_HJUSTIFY_T aH_justify,
|
|
enum EDA_TEXT_VJUSTIFY_T aV_justify,
|
|
int aWidth,
|
|
bool aItalic,
|
|
bool aBold,
|
|
double *wideningFactor,
|
|
double *ctm_a,
|
|
double *ctm_b,
|
|
double *ctm_c,
|
|
double *ctm_d,
|
|
double *ctm_e,
|
|
double *ctm_f,
|
|
double *heightFactor );
|
|
void postscriptOverlinePositions( const wxString& aText, int aXSize,
|
|
bool aItalic, bool aBold,
|
|
std::vector<int> *pos_pairs );
|
|
void fputsPostscriptString(FILE *fout, const wxString& txt);
|
|
|
|
/// Virtual primitive for emitting the setrgbcolor operator
|
|
virtual void emitSetRGBColor( double r, double g, double b ) = 0;
|
|
|
|
/// Height of the postscript font (from the AFM)
|
|
static const double postscriptTextAscent; // = 0.718;
|
|
|
|
int returnPostscriptTextWidth( const wxString& aText, int aXSize,
|
|
bool aItalic, bool aBold );
|
|
|
|
/// Fine user scale adjust ( = 1.0 if no correction)
|
|
double plotScaleAdjX, plotScaleAdjY;
|
|
|
|
/// How to draw text
|
|
PlotTextMode m_textMode;
|
|
};
|
|
|
|
|
|
class PS_PLOTTER : public PSLIKE_PLOTTER
|
|
{
|
|
public:
|
|
PS_PLOTTER()
|
|
{
|
|
// The phantom plot in postscript is an hack and reportedly
|
|
// crashes Adobe's own postscript interpreter!
|
|
m_textMode = PLOTTEXTMODE_STROKE;
|
|
}
|
|
|
|
static wxString GetDefaultFileExtension()
|
|
{
|
|
return wxString( wxT( "ps" ) );
|
|
}
|
|
|
|
virtual PlotFormat GetPlotterType() const
|
|
{
|
|
return PLOT_FORMAT_POST;
|
|
}
|
|
|
|
virtual bool StartPlot();
|
|
virtual bool EndPlot();
|
|
virtual void SetCurrentLineWidth( int width );
|
|
virtual void SetDash( bool dashed );
|
|
|
|
virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
|
|
double aScale, bool aMirror );
|
|
virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle,
|
|
int rayon, FILL_T fill, int width = DEFAULT_LINE_WIDTH );
|
|
|
|
virtual void PlotPoly( const std::vector< wxPoint >& aCornerList,
|
|
FILL_T aFill, int aWidth = DEFAULT_LINE_WIDTH );
|
|
|
|
virtual void PlotImage( const wxImage& aImage, const wxPoint& aPos,
|
|
double aScaleFactor );
|
|
|
|
virtual void PenTo( const wxPoint& pos, char plume );
|
|
virtual void Text( const wxPoint& aPos,
|
|
enum EDA_COLOR_T 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 );
|
|
protected:
|
|
virtual void emitSetRGBColor( double r, double g, double b );
|
|
};
|
|
|
|
class PDF_PLOTTER : public PSLIKE_PLOTTER
|
|
{
|
|
public:
|
|
PDF_PLOTTER() : pageStreamHandle( 0 ), workFile( NULL )
|
|
{
|
|
}
|
|
|
|
virtual PlotFormat GetPlotterType() const
|
|
{
|
|
return PLOT_FORMAT_PDF;
|
|
}
|
|
|
|
static wxString GetDefaultFileExtension()
|
|
{
|
|
return wxString( wxT( "pdf" ) );
|
|
}
|
|
|
|
/**
|
|
* Open or create the plot file aFullFilename
|
|
* @param aFullFilename = the full file name of the file to create
|
|
* @return true if success, false if the file cannot be created/opened
|
|
*
|
|
* The base class open the file in text mode, so we should have this
|
|
* function overlaid for PDF files, which are binary files
|
|
*/
|
|
virtual bool OpenFile( const wxString& aFullFilename );
|
|
|
|
virtual bool StartPlot();
|
|
virtual bool EndPlot();
|
|
virtual void StartPage();
|
|
virtual void ClosePage();
|
|
virtual void SetCurrentLineWidth( int width );
|
|
virtual void SetDash( bool dashed );
|
|
|
|
/** PDF can have multiple pages, so SetPageSettings can be called
|
|
* with the outputFile open (but not inside a page stream!) */
|
|
virtual void SetPageSettings( const PAGE_INFO& aPageSettings );
|
|
virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
|
|
double aScale, bool aMirror );
|
|
virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle,
|
|
int rayon, FILL_T fill, int width = DEFAULT_LINE_WIDTH );
|
|
|
|
virtual void PlotPoly( const std::vector< wxPoint >& aCornerList,
|
|
FILL_T aFill, int aWidth = DEFAULT_LINE_WIDTH);
|
|
|
|
virtual void PenTo( const wxPoint& pos, char plume );
|
|
|
|
virtual void Text( const wxPoint& aPos,
|
|
enum EDA_COLOR_T 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 );
|
|
|
|
virtual void PlotImage( const wxImage& aImage, const wxPoint& aPos,
|
|
double aScaleFactor );
|
|
|
|
|
|
protected:
|
|
virtual void emitSetRGBColor( double r, double g, double b );
|
|
int allocPdfObject();
|
|
int startPdfObject(int handle = -1);
|
|
void closePdfObject();
|
|
int startPdfStream(int handle = -1);
|
|
void closePdfStream();
|
|
int pageTreeHandle; /// Handle to the root of the page tree object
|
|
int fontResDictHandle; /// Font resource dictionary
|
|
std::vector<int> pageHandles;/// Handles to the page objects
|
|
int pageStreamHandle; /// Handle of the page content object
|
|
int streamLengthHandle; /// Handle to the deferred stream length
|
|
wxString workFilename;
|
|
FILE* workFile; /// Temporary file to costruct the stream before zipping
|
|
std::vector<long> xrefTable; /// The PDF xref offset table
|
|
};
|
|
|
|
class SVG_PLOTTER : public PSLIKE_PLOTTER
|
|
{
|
|
public:
|
|
SVG_PLOTTER();
|
|
|
|
static wxString GetDefaultFileExtension()
|
|
{
|
|
return wxString( wxT( "svg" ) );
|
|
}
|
|
|
|
virtual PlotFormat GetPlotterType() const
|
|
{
|
|
return PLOT_FORMAT_SVG;
|
|
}
|
|
|
|
virtual void SetColor( EDA_COLOR_T color );
|
|
virtual bool StartPlot();
|
|
virtual bool EndPlot();
|
|
virtual void SetCurrentLineWidth( int width );
|
|
virtual void SetDash( bool dashed );
|
|
|
|
virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
|
|
double aScale, bool aMirror );
|
|
virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle,
|
|
int rayon, FILL_T fill, int width = DEFAULT_LINE_WIDTH );
|
|
|
|
virtual void PlotPoly( const std::vector< wxPoint >& aCornerList,
|
|
FILL_T aFill, int aWidth = DEFAULT_LINE_WIDTH );
|
|
|
|
virtual void PlotImage( const wxImage& aImage, const wxPoint& aPos,
|
|
double aScaleFactor );
|
|
|
|
virtual void PenTo( const wxPoint& pos, char plume );
|
|
virtual void Text( const wxPoint& aPos,
|
|
enum EDA_COLOR_T 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 );
|
|
|
|
protected:
|
|
FILL_T m_fillMode; // true if the current contour
|
|
// rect, arc, circle, polygon must be filled
|
|
long m_pen_rgb_color; // current rgb color value: each color has
|
|
// a value 0 ... 255, and the 3 colors are
|
|
// grouped in a 3x8 bits value
|
|
// (written in hex to svg files)
|
|
long m_brush_rgb_color; // same as m_pen_rgb_color, used to fill
|
|
// some contours.
|
|
bool m_graphics_changed; // true if a pen/brush parameter is modified
|
|
// color, pen size, fil mode ...
|
|
// the new SVG stype must be output on file
|
|
|
|
/**
|
|
* function emitSetRGBColor()
|
|
* initialize m_pen_rgb_color from reduced values r, g ,b
|
|
* ( reduced values are 0.0 to 1.0 )
|
|
*/
|
|
virtual void emitSetRGBColor( double r, double g, double b );
|
|
|
|
/**
|
|
* function setSVGPlotStyle()
|
|
* output the string which define pen and brush color, shape, transparence
|
|
*/
|
|
void setSVGPlotStyle();
|
|
|
|
/**
|
|
* function setFillMode()
|
|
* prepare parameters for setSVGPlotStyle()
|
|
*/
|
|
void setFillMode( FILL_T fill );
|
|
};
|
|
|
|
/* Class to handle a D_CODE when plotting a board : */
|
|
#define FIRST_DCODE_VALUE 10 // D_CODE < 10 is a command, D_CODE >= 10 is a tool
|
|
|
|
struct APERTURE
|
|
{
|
|
enum APERTURE_TYPE {
|
|
Circle = 1,
|
|
Rect = 2,
|
|
Plotting = 3,
|
|
Oval = 4
|
|
};
|
|
|
|
wxSize Size; // horiz and Vert size
|
|
APERTURE_TYPE Type; // Type ( Line, rect , circulaire , ovale .. )
|
|
int DCode; // code number ( >= 10 );
|
|
|
|
/* Trivia question: WHY Gerber decided to use D instead of the usual T for
|
|
* tool change? */
|
|
};
|
|
|
|
|
|
class GERBER_PLOTTER : public PLOTTER
|
|
{
|
|
public:
|
|
GERBER_PLOTTER()
|
|
{
|
|
workFile = 0;
|
|
finalFile = 0;
|
|
currentAperture = apertures.end();
|
|
}
|
|
|
|
virtual PlotFormat GetPlotterType() const
|
|
{
|
|
return PLOT_FORMAT_GERBER;
|
|
}
|
|
|
|
static wxString GetDefaultFileExtension()
|
|
{
|
|
return wxString( wxT( "pho" ) );
|
|
}
|
|
|
|
virtual bool StartPlot();
|
|
virtual bool EndPlot();
|
|
virtual void SetCurrentLineWidth( int width );
|
|
virtual void SetDefaultLineWidth( int width );
|
|
|
|
// RS274X has no dashing, nor colours
|
|
virtual void SetDash( bool dashed ) {};
|
|
virtual void SetColor( EDA_COLOR_T color ) {};
|
|
virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
|
|
double aScale, bool aMirror );
|
|
virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Arc( const wxPoint& aCenter, double aStAngle, double aEndAngle,
|
|
int aRadius, FILL_T aFill, int aWidth = DEFAULT_LINE_WIDTH );
|
|
virtual void PlotPoly( const std::vector< wxPoint >& aCornerList,
|
|
FILL_T aFill, int aWidth = DEFAULT_LINE_WIDTH );
|
|
|
|
virtual void PenTo( const wxPoint& pos, char plume );
|
|
virtual void FlashPadCircle( const wxPoint& pos, int diametre,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadOval( const wxPoint& pos, const wxSize& size, double orient,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadRect( const wxPoint& pos, const wxSize& size,
|
|
double orient, EDA_DRAW_MODE_T trace_mode );
|
|
|
|
virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
|
|
double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode );
|
|
|
|
virtual void SetLayerPolarity( bool aPositive );
|
|
|
|
protected:
|
|
void selectAperture( const wxSize& size, APERTURE::APERTURE_TYPE type );
|
|
void emitDcode( const DPOINT& pt, int dcode );
|
|
|
|
std::vector<APERTURE>::iterator
|
|
getAperture( const wxSize& size, APERTURE::APERTURE_TYPE type );
|
|
|
|
FILE* workFile;
|
|
FILE* finalFile;
|
|
wxString m_workFilename;
|
|
|
|
void writeApertureList();
|
|
|
|
std::vector<APERTURE> apertures;
|
|
std::vector<APERTURE>::iterator currentAperture;
|
|
};
|
|
|
|
|
|
class DXF_PLOTTER : public PLOTTER
|
|
{
|
|
public:
|
|
DXF_PLOTTER() : textAsLines( false )
|
|
{
|
|
}
|
|
|
|
virtual PlotFormat GetPlotterType() const
|
|
{
|
|
return PLOT_FORMAT_DXF;
|
|
}
|
|
|
|
static wxString GetDefaultFileExtension()
|
|
{
|
|
return wxString( wxT( "dxf" ) );
|
|
}
|
|
|
|
/**
|
|
* DXF handles NATIVE text emitting TEXT entities
|
|
*/
|
|
virtual void SetTextMode( PlotTextMode mode )
|
|
{
|
|
if( mode != PLOTTEXTMODE_DEFAULT )
|
|
textAsLines = ( mode != PLOTTEXTMODE_NATIVE );
|
|
}
|
|
|
|
virtual bool StartPlot();
|
|
virtual bool EndPlot();
|
|
|
|
// For now we don't use 'thick' primitives, so no line width
|
|
virtual void SetCurrentLineWidth( int width )
|
|
{
|
|
currentPenWidth = 0;
|
|
}
|
|
|
|
virtual void SetDefaultLineWidth( int width )
|
|
{
|
|
// DXF lines are infinitesimal
|
|
defaultPenWidth = 0;
|
|
}
|
|
|
|
virtual void SetDash( bool dashed );
|
|
|
|
virtual void SetColor( EDA_COLOR_T color );
|
|
|
|
virtual void SetViewport( const wxPoint& aOffset, double aIusPerDecimil,
|
|
double aScale, bool aMirror );
|
|
virtual void Rect( const wxPoint& p1, const wxPoint& p2, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void Circle( const wxPoint& pos, int diametre, FILL_T fill,
|
|
int width = DEFAULT_LINE_WIDTH );
|
|
virtual void PlotPoly( const std::vector< wxPoint >& aCornerList,
|
|
FILL_T aFill, int aWidth = DEFAULT_LINE_WIDTH );
|
|
virtual void ThickSegment( const wxPoint& start, const wxPoint& end, int width,
|
|
EDA_DRAW_MODE_T tracemode );
|
|
virtual void Arc( const wxPoint& centre, double StAngle, double EndAngle,
|
|
int rayon, FILL_T fill, int width = DEFAULT_LINE_WIDTH );
|
|
virtual void PenTo( const wxPoint& pos, char plume );
|
|
virtual void FlashPadCircle( const wxPoint& pos, int diametre,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadOval( const wxPoint& pos, const wxSize& size, double orient,
|
|
EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadRect( const wxPoint& pos, const wxSize& size,
|
|
double orient, EDA_DRAW_MODE_T trace_mode );
|
|
virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
|
|
double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode );
|
|
|
|
virtual void Text( const wxPoint& aPos,
|
|
enum EDA_COLOR_T 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 );
|
|
|
|
protected:
|
|
bool textAsLines;
|
|
EDA_COLOR_T m_currentColor;
|
|
};
|
|
|
|
class TITLE_BLOCK;
|
|
void PlotWorkSheet( PLOTTER* plotter, const TITLE_BLOCK& aTitleBlock,
|
|
const PAGE_INFO& aPageInfo,
|
|
int aSheetNumber, int aNumberOfSheets,
|
|
const wxString &aSheetDesc,
|
|
const wxString &aFilename );
|
|
|
|
/** Returns the default plot extension for a format
|
|
*/
|
|
wxString GetDefaultPlotExtension( PlotFormat aFormat );
|
|
|
|
|
|
#endif // PLOT_COMMON_H_
|