KiCad PCB EDA Suite
Loading...
Searching...
No Matches
plotter_dxf.h
Go to the documentation of this file.
1/*
2 * This program source code file is part of KiCad, a free EDA CAD application.
3 *
4 * Copyright (C) 2016-2023 KiCad Developers, see AUTHORS.txt for contributors.
5 *
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation, either version 3 of the License, or (at your
9 * option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License along
17 * with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
19
20#pragma once
21
22#include "plotter.h"
23
24
25class DXF_PLOTTER : public PLOTTER
26{
27public:
29 {
30 m_textAsLines = true;
31 m_currentColor = COLOR4D::BLACK;
32 m_currentLineType = LINE_STYLE::SOLID;
33 SetUnits( DXF_UNITS::INCHES );
34 }
35
36 virtual PLOT_FORMAT GetPlotterType() const override
37 {
38 return PLOT_FORMAT::DXF;
39 }
40
41 static wxString GetDefaultFileExtension()
42 {
43 return wxString( wxT( "dxf" ) );
44 }
45
49 virtual void SetTextMode( PLOT_TEXT_MODE mode ) override
50 {
51 if( mode != PLOT_TEXT_MODE::DEFAULT )
52 m_textAsLines = ( mode != PLOT_TEXT_MODE::NATIVE );
53 }
54
58 virtual bool StartPlot( const wxString& aPageNumber ) override;
59 virtual bool EndPlot() override;
60
61 // For now we don't use 'thick' primitives, so no line width
62 virtual void SetCurrentLineWidth( int width, void* aData = nullptr ) override
63 {
65 }
66
67 virtual void SetDash( int aLineWidth, LINE_STYLE aLineStyle ) override;
68
72 virtual void SetColor( const COLOR4D& color ) override;
73
80 virtual void SetViewport( const VECTOR2I& aOffset, double aIusPerDecimil,
81 double aScale, bool aMirror ) override;
82
86 virtual void Rect( const VECTOR2I& p1, const VECTOR2I& p2, FILL_T fill,
87 int width = USE_DEFAULT_LINE_WIDTH ) override;
88
95 virtual void Circle( const VECTOR2I& pos, int diametre, FILL_T fill,
96 int width = USE_DEFAULT_LINE_WIDTH ) override;
97
98 virtual void Arc( const VECTOR2D& aCenter, const EDA_ANGLE& aStartAngle,
99 const EDA_ANGLE& aAngle, double aRadius, FILL_T aFill, int aWidth ) override;
100
108 virtual void PlotPoly( const std::vector<VECTOR2I>& aCornerList, FILL_T aFill,
109 int aWidth = USE_DEFAULT_LINE_WIDTH, void* aData = nullptr ) override;
110 virtual void ThickSegment( const VECTOR2I& start, const VECTOR2I& end, int width,
111 OUTLINE_MODE tracemode, void* aData ) override;
112
113 virtual void PenTo( const VECTOR2I& pos, char plume ) override;
114
119 virtual void FlashPadCircle( const VECTOR2I& pos, int diametre,
120 OUTLINE_MODE trace_mode, void* aData ) override;
121
125 virtual void FlashPadOval( const VECTOR2I& aPos, const VECTOR2I& aSize,
126 const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
127 void* aData ) override;
128
132 virtual void FlashPadRect( const VECTOR2I& aPos, const VECTOR2I& aSize,
133 const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
134 void* aData ) override;
135 virtual void FlashPadRoundRect( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
136 int aCornerRadius, const EDA_ANGLE& aOrient,
137 OUTLINE_MODE aTraceMode, void* aData ) override;
138 virtual void FlashPadCustom( const VECTOR2I& aPadPos, const VECTOR2I& aSize,
139 const EDA_ANGLE& aOrient, SHAPE_POLY_SET* aPolygons,
140 OUTLINE_MODE aTraceMode, void* aData ) override;
141
145 virtual void FlashPadTrapez( const VECTOR2I& aPadPos, const VECTOR2I* aCorners,
146 const EDA_ANGLE& aPadOrient, OUTLINE_MODE aTraceMode,
147 void* aData ) override;
148 virtual void FlashRegularPolygon( const VECTOR2I& aShapePos, int aDiameter, int aCornerCount,
149 const EDA_ANGLE& aOrient, OUTLINE_MODE aTraceMode,
150 void* aData ) override;
151
152 virtual void Text( const VECTOR2I& aPos,
153 const COLOR4D& aColor,
154 const wxString& aText,
155 const EDA_ANGLE& aOrient,
156 const VECTOR2I& aSize,
157 enum GR_TEXT_H_ALIGN_T aH_justify,
158 enum GR_TEXT_V_ALIGN_T aV_justify,
159 int aWidth,
160 bool aItalic,
161 bool aBold,
162 bool aMultilineAllowed,
163 KIFONT::FONT* aFont,
164 const KIFONT::METRICS& aFontMetrics,
165 void* aData = nullptr ) override;
166
167 virtual void PlotText( const VECTOR2I& aPos,
168 const COLOR4D& aColor,
169 const wxString& aText,
170 const TEXT_ATTRIBUTES& aAttributes,
171 KIFONT::FONT* aFont,
172 const KIFONT::METRICS& aFontMetrics,
173 void* aData = nullptr ) override;
174
180 void SetUnits( DXF_UNITS aUnit );
181
188 {
189 return m_plotUnits;
190 }
191
198 double GetUnitScaling() const
199 {
200 return m_unitScalingFactor;
201 }
202
208 unsigned int GetMeasurementDirective() const
209 {
211 }
212
213protected:
214 void plotOneLineOfText( const VECTOR2I& aPos, const COLOR4D& aColor, const wxString& aText,
215 const TEXT_ATTRIBUTES& aAttrs );
216
220
224};
int color
Definition: DXF_plotter.cpp:58
virtual void ThickSegment(const VECTOR2I &start, const VECTOR2I &end, int width, OUTLINE_MODE tracemode, void *aData) override
void plotOneLineOfText(const VECTOR2I &aPos, const COLOR4D &aColor, const wxString &aText, const TEXT_ATTRIBUTES &aAttrs)
DXF_UNITS m_plotUnits
Definition: plotter_dxf.h:221
virtual void FlashPadCircle(const VECTOR2I &pos, int diametre, OUTLINE_MODE trace_mode, void *aData) override
DXF round pad: always done in sketch mode; it could be filled but it isn't pretty if other kinds of p...
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
bool m_textAsLines
Definition: plotter_dxf.h:217
static wxString GetDefaultFileExtension()
Definition: plotter_dxf.h:41
virtual void FlashPadRect(const VECTOR2I &aPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
DXF rectangular pad: always done in sketch mode.
virtual void FlashPadCustom(const VECTOR2I &aPadPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, SHAPE_POLY_SET *aPolygons, OUTLINE_MODE aTraceMode, void *aData) override
void SetUnits(DXF_UNITS aUnit)
Set the units to use for plotting the DXF file.
virtual void FlashPadTrapez(const VECTOR2I &aPadPos, const VECTOR2I *aCorners, const EDA_ANGLE &aPadOrient, OUTLINE_MODE aTraceMode, void *aData) override
DXF trapezoidal pad: only sketch mode is supported.
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the scale/position for the DXF plot.
virtual void Arc(const VECTOR2D &aCenter, const EDA_ANGLE &aStartAngle, const EDA_ANGLE &aAngle, double aRadius, FILL_T aFill, int aWidth) override
double GetUnitScaling() const
Get the scale factor to apply to convert the device units to be in the currently set units.
Definition: plotter_dxf.h:198
virtual void FlashRegularPolygon(const VECTOR2I &aShapePos, int aDiameter, int aCornerCount, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
Flash a regular polygon.
virtual void FlashPadOval(const VECTOR2I &aPos, const VECTOR2I &aSize, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
DXF oval pad: always done in sketch mode.
virtual void FlashPadRoundRect(const VECTOR2I &aPadPos, const VECTOR2I &aSize, int aCornerRadius, const EDA_ANGLE &aOrient, OUTLINE_MODE aTraceMode, void *aData) override
virtual bool StartPlot(const wxString &aPageNumber) override
Open the DXF plot with a skeleton header.
unsigned int GetMeasurementDirective() const
Get the correct value for the $MEASUREMENT field given the current units.
Definition: plotter_dxf.h:208
virtual void Circle(const VECTOR2I &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
DXF circle: full functionality; it even does 'fills' drawing a circle with a dual-arc polyline wide a...
virtual void PlotPoly(const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
DXF polygon: doesn't fill it but at least it close the filled ones DXF does not know thick outline.
virtual void SetTextMode(PLOT_TEXT_MODE mode) override
DXF handles NATIVE text emitting TEXT entities.
Definition: plotter_dxf.h:49
unsigned int m_measurementDirective
Definition: plotter_dxf.h:223
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the line width for the next drawing.
Definition: plotter_dxf.h:62
virtual bool EndPlot() override
virtual void PenTo(const VECTOR2I &pos, char plume) override
Moveto/lineto primitive, moves the 'pen' to the specified direction.
virtual void SetColor(const COLOR4D &color) override
The DXF exporter handles 'colors' as layers...
virtual void Rect(const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
DXF rectangle: fill not supported.
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
Draw text with the plotter.
virtual PLOT_FORMAT GetPlotterType() const override
Returns the effective plot engine in use.
Definition: plotter_dxf.h:36
DXF_UNITS GetUnits() const
The units currently enabled for plotting.
Definition: plotter_dxf.h:187
double m_unitScalingFactor
Definition: plotter_dxf.h:222
virtual void SetDash(int aLineWidth, LINE_STYLE aLineStyle) override
COLOR4D m_currentColor
Definition: plotter_dxf.h:218
LINE_STYLE m_currentLineType
Definition: plotter_dxf.h:219
FONT is an abstract base class for both outline and stroke fonts.
Definition: font.h:131
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
Base plotter engine class.
Definition: plotter.h:104
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:108
int m_currentPenWidth
Definition: plotter.h:666
Represent a set of closed polygons.
FILL_T
Definition: eda_shape.h:55
OUTLINE_MODE
Definition: outline_mode.h:25
DXF_UNITS
Definition: plotter.h:52
PLOT_TEXT_MODE
Which kind of text to output with the PSLIKE plotters.
Definition: plotter.h:90
PLOT_FORMAT
The set of supported output plot formats.
Definition: plotter.h:64
LINE_STYLE
Dashed line types.
Definition: stroke_params.h:48
GR_TEXT_H_ALIGN_T
GR_TEXT_V_ALIGN_T