KiCad PCB EDA Suite
Loading...
Searching...
No Matches
SVG_plotter.cpp
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) 2020 Jean-Pierre Charras, jp.charras at wanadoo.fr
5 * Copyright (C) 1992-2024 KiCad Developers, see AUTHORS.txt for contributors.
6 *
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, you may find one here:
19 * http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
20 * or you may search the http://www.gnu.org website for the version 2 license,
21 * or you may write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
23 */
24
25/* Some info on basic items SVG format, used here:
26 * The root element of all SVG files is the <svg> element.
27 *
28 * The <g> element is used to group SVG shapes together.
29 * Once grouped you can transform the whole group of shapes as if it was a single shape.
30 * This is an advantage compared to a nested <svg> element
31 * which cannot be the target of transformation by itself.
32 *
33 * The <rect> element represents a rectangle.
34 * Using this element you can draw rectangles of various width, height,
35 * with different stroke (outline) and fill colors, with sharp or rounded corners etc.
36 *
37 * <svg xmlns="http://www.w3.org/2000/svg"
38 * xmlns:xlink="http://www.w3.org/1999/xlink">
39 *
40 * <rect x="10" y="10" height="100" width="100"
41 * style="stroke:#006600; fill: #00cc00"/>
42 *
43 * </svg>
44 *
45 * The <circle> element is used to draw circles.
46 * <circle cx="40" cy="40" r="24" style="stroke:#006600; fill:#00cc00"/>
47 *
48 * The <ellipse> element is used to draw ellipses.
49 * An ellipse is a circle that does not have equal height and width.
50 * Its radius in the x and y directions are different, in other words.
51 * <ellipse cx="40" cy="40" rx="30" ry="15"
52 * style="stroke:#006600; fill:#00cc00"/>
53 *
54 * The <line> element is used to draw lines.
55 *
56 * <line x1="0" y1="10" x2="0" y2="100" style="stroke:#006600;"/>
57 * <line x1="10" y1="10" x2="100" y2="100" style="stroke:#006600;"/>
58 *
59 * The <polyline> element is used to draw multiple connected lines
60 * Here is a simple example:
61 *
62 * <polyline points="0,0 30,0 15,30" style="stroke:#006600;"/>
63 *
64 * The <polygon> element is used to draw with multiple (3 or more) sides / edges.
65 * Here is a simple example:
66 *
67 * <polygon points="0,0 50,0 25,50" style="stroke:#660000; fill:#cc3333;"/>
68 *
69 * The <path> element is used to draw advanced shapes combined from lines and arcs,
70 * with or without fill.
71 * It is probably the most advanced and versatile SVG shape of them all.
72 * It is probably also the hardest element to master.
73 * <path d="M50,50
74 * A30,30 0 0,1 35,20
75 * L100,100
76 * M110,110
77 * L100,0"
78 * style="stroke:#660000; fill:none;"/>
79 *
80 * Draw an elliptic arc: it is one of basic path command:
81 * <path d="M(startx,starty) A(radiusx,radiusy)
82 * rotation-axe-x
83 * flag_arc_large,flag_sweep endx,endy">
84 * flag_arc_large: 0 = small arc > 180 deg, 1 = large arc > 180 deg
85 * flag_sweep : 0 = CCW, 1 = CW
86 * The center of ellipse is automatically calculated.
87 */
88
89#include <core/base64.h>
90#include <eda_shape.h>
91#include <string_utils.h>
92#include <font/font.h>
93#include <macros.h>
94#include <trigo.h>
95
96#include <cstdint>
97#include <wx/mstream.h>
98
100
101// Note:
102// During tests, we (JPC) found issues when the coordinates used 6 digits in mantissa
103// especially for stroke-width using very small (but not null) values < 0.00001 mm
104// So to avoid this king of issue, we are using 4 digits in mantissa
105// The resolution (m_precision ) is 0.1 micron, that looks enougt for a SVG file
106
112static wxString XmlEsc( const wxString& aStr, bool isAttribute = false )
113{
114 wxString escaped;
115
116 escaped.reserve( aStr.length() );
117
118 for( wxString::const_iterator it = aStr.begin(); it != aStr.end(); ++it )
119 {
120 const wxChar c = *it;
121
122 switch( c )
123 {
124 case wxS( '<' ):
125 escaped.append( wxS( "&lt;" ) );
126 break;
127 case wxS( '>' ):
128 escaped.append( wxS( "&gt;" ) );
129 break;
130 case wxS( '&' ):
131 escaped.append( wxS( "&amp;" ) );
132 break;
133 case wxS( '\r' ):
134 escaped.append( wxS( "&#xD;" ) );
135 break;
136 default:
137 if( isAttribute )
138 {
139 switch( c )
140 {
141 case wxS( '"' ):
142 escaped.append( wxS( "&quot;" ) );
143 break;
144 case wxS( '\t' ):
145 escaped.append( wxS( "&#x9;" ) );
146 break;
147 case wxS( '\n' ):
148 escaped.append( wxS( "&#xA;" ));
149 break;
150 default:
151 escaped.append(c);
152 }
153 }
154 else
155 {
156 escaped.append(c);
157 }
158 }
159 }
160
161 return escaped;
162}
163
164
166{
167 m_graphics_changed = true;
168 SetTextMode( PLOT_TEXT_MODE::STROKE );
169 m_fillMode = FILL_T::NO_FILL; // or FILLED_SHAPE or FILLED_WITH_BG_BODYCOLOR
170 m_pen_rgb_color = 0; // current color value (black)
171 m_brush_rgb_color = 0; // current color value with alpha(black)
172 m_brush_alpha = 1.0;
173 m_dashed = LINE_STYLE::SOLID;
174 m_precision = 4; // default: 4 digits in mantissa.
175}
176
177
178void SVG_PLOTTER::SetViewport( const VECTOR2I& aOffset, double aIusPerDecimil,
179 double aScale, bool aMirror )
180{
181 m_plotMirror = aMirror;
182 m_yaxisReversed = true; // unlike other plotters, SVG has Y axis reversed
183 m_plotOffset = aOffset;
184 m_plotScale = aScale;
185 m_IUsPerDecimil = aIusPerDecimil;
186
187 // Compute the paper size in IUs. for historical reasons the page size is in mils
189 m_paperSize.x *= 10.0 * aIusPerDecimil;
190 m_paperSize.y *= 10.0 * aIusPerDecimil;
191
192 // gives now a default value to iuPerDeviceUnit (because the units of the caller is now known)
193 double iusPerMM = m_IUsPerDecimil / 2.54 * 1000;
194 m_iuPerDeviceUnit = 1 / iusPerMM;
195
197}
198
199
200void SVG_PLOTTER::SetSvgCoordinatesFormat( unsigned aPrecision )
201{
202 // Only number of digits in mantissa are adjustable.
203 // SVG units are always mm
204 m_precision = aPrecision;
205}
206
207
209{
210 if( m_fillMode != fill )
211 {
212 m_graphics_changed = true;
213 m_fillMode = fill;
214 }
215}
216
217
218void SVG_PLOTTER::setSVGPlotStyle( int aLineWidth, bool aIsGroup, const std::string& aExtraStyle )
219{
220 if( aIsGroup )
221 fputs( "</g>\n<g ", m_outputFile );
222
223 fputs( "style=\"", m_outputFile );
224
225 if( m_fillMode == FILL_T::NO_FILL )
226 {
227 fputs( "fill:none; ", m_outputFile );
228 }
229 else
230 {
231 // output the background fill color
232 fprintf( m_outputFile, "fill:#%6.6lX; ", m_brush_rgb_color );
233
234 switch( m_fillMode )
235 {
236 case FILL_T::FILLED_SHAPE:
237 case FILL_T::FILLED_WITH_BG_BODYCOLOR:
238 case FILL_T::FILLED_WITH_COLOR:
239 fprintf( m_outputFile, "fill-opacity:%.*f; ", m_precision, m_brush_alpha );
240 break;
241 default: break;
242 }
243 }
244
245 double pen_w = userToDeviceSize( aLineWidth );
246
247 if( pen_w <= 0 )
248 {
249 fputs( "stroke:none;", m_outputFile );
250 }
251 else
252 {
253 // Fix a strange issue found in Inkscape: aWidth < 100 nm create issues on degrouping objects
254 // So we use only 4 digits in mantissa for stroke-width.
255 // TODO: perhaps used only 3 or 4 digits in mantissa for all values in mm, because some
256 // issues were previously reported reported when using nm as integer units
257
258 fprintf( m_outputFile, "\nstroke:#%6.6lX; stroke-width:%.*f; stroke-opacity:1; \n",
260 fputs( "stroke-linecap:round; stroke-linejoin:round;", m_outputFile );
261
262 //set any extra attributes for non-solid lines
263 switch( m_dashed )
264 {
265 case LINE_STYLE::DASH:
266 fprintf( m_outputFile, "stroke-dasharray:%.*f,%.*f;", m_precision,
267 GetDashMarkLenIU( aLineWidth ), m_precision, GetDashGapLenIU( aLineWidth ) );
268 break;
269
270 case LINE_STYLE::DOT:
271 fprintf( m_outputFile, "stroke-dasharray:%f,%f;", GetDotMarkLenIU( aLineWidth ),
272 GetDashGapLenIU( aLineWidth ) );
273 break;
274
275 case LINE_STYLE::DASHDOT:
276 fprintf( m_outputFile, "stroke-dasharray:%f,%f,%f,%f;", GetDashMarkLenIU( aLineWidth ),
277 GetDashGapLenIU( aLineWidth ), GetDotMarkLenIU( aLineWidth ),
278 GetDashGapLenIU( aLineWidth ) );
279 break;
280
281 case LINE_STYLE::DASHDOTDOT:
282 fprintf( m_outputFile, "stroke-dasharray:%f,%f,%f,%f,%f,%f;",
283 GetDashMarkLenIU( aLineWidth ), GetDashGapLenIU( aLineWidth ),
284 GetDotMarkLenIU( aLineWidth ), GetDashGapLenIU( aLineWidth ),
285 GetDotMarkLenIU( aLineWidth ), GetDashGapLenIU( aLineWidth ) );
286 break;
287
288 case LINE_STYLE::DEFAULT:
289 case LINE_STYLE::SOLID:
290 default:
291 //do nothing
292 break;
293 }
294 }
295
296 if( aExtraStyle.length() )
297 fputs( aExtraStyle.c_str(), m_outputFile );
298
299 fputs( "\"", m_outputFile );
300
301 if( aIsGroup )
302 {
303 fputs( ">", m_outputFile );
304 m_graphics_changed = false;
305 }
306
307 fputs( "\n", m_outputFile );
308}
309
310
311void SVG_PLOTTER::SetCurrentLineWidth( int aWidth, void* aData )
312{
313 if( aWidth == DO_NOT_SET_LINE_WIDTH )
314 return;
315 else if( aWidth == USE_DEFAULT_LINE_WIDTH )
317
318 // Note: aWidth == 0 is fine: used for filled shapes with no outline thickness
319
320 wxASSERT_MSG( aWidth >= 0, "Plotter called to set negative pen width" );
321
322 if( aWidth != m_currentPenWidth )
323 {
324 m_graphics_changed = true;
325 m_currentPenWidth = aWidth;
326 }
327}
328
329
330void SVG_PLOTTER::StartBlock( void* aData )
331{
332 // We can't use <g></g> for blocks because we're already using it for graphics context, and
333 // our graphics context handling is lazy (ie: it leaves the last group open until the context
334 // changes).
335}
336
337
338void SVG_PLOTTER::EndBlock( void* aData )
339{
340}
341
342
343void SVG_PLOTTER::emitSetRGBColor( double r, double g, double b, double a )
344{
345 int red = (int) ( 255.0 * r );
346 int green = (int) ( 255.0 * g );
347 int blue = (int) ( 255.0 * b );
348 long rgb_color = (red << 16) | (green << 8) | blue;
349
350 if( m_pen_rgb_color != rgb_color || m_brush_alpha != a )
351 {
352 m_graphics_changed = true;
353 m_pen_rgb_color = rgb_color;
354
355 // Currently, use the same color for brush and pen (i.e. to draw and fill a contour).
356 m_brush_rgb_color = rgb_color;
357 m_brush_alpha = a;
358 }
359}
360
361
362void SVG_PLOTTER::SetDash( int aLineWidth, LINE_STYLE aLineStyle )
363{
364 if( m_dashed != aLineStyle )
365 {
366 m_graphics_changed = true;
367 m_dashed = aLineStyle;
368 }
369}
370
371
372void SVG_PLOTTER::Rect( const VECTOR2I& p1, const VECTOR2I& p2, FILL_T fill, int width )
373{
374 BOX2I rect( p1, VECTOR2I( p2.x - p1.x, p2.y - p1.y ) );
375 rect.Normalize();
376
377 VECTOR2D org_dev = userToDeviceCoordinates( rect.GetOrigin() );
378 VECTOR2D end_dev = userToDeviceCoordinates( rect.GetEnd() );
379 VECTOR2D size_dev = end_dev - org_dev;
380
381 // Ensure size of rect in device coordinates is > 0
382 // I don't know if this is a SVG issue or a Inkscape issue, but
383 // Inkscape has problems with negative or null values for width and/or height, so avoid them
384 BOX2D rect_dev( org_dev, size_dev );
385 rect_dev.Normalize();
386
387 setFillMode( fill );
388 SetCurrentLineWidth( width );
389
392
393 // Rectangles having a 0 size value for height or width are just not drawn on Inkscape,
394 // so use a line when happens.
395 if( rect_dev.GetSize().x == 0.0 || rect_dev.GetSize().y == 0.0 ) // Draw a line
396 {
397 fprintf( m_outputFile,
398 "<line x1=\"%.*f\" y1=\"%.*f\" x2=\"%.*f\" y2=\"%.*f\" />\n",
399 m_precision, rect_dev.GetPosition().x, m_precision, rect_dev.GetPosition().y,
400 m_precision, rect_dev.GetEnd().x, m_precision, rect_dev.GetEnd().y );
401 }
402 else
403 {
404 fprintf( m_outputFile,
405 "<rect x=\"%f\" y=\"%f\" width=\"%f\" height=\"%f\" rx=\"%f\" />\n",
406 rect_dev.GetPosition().x, rect_dev.GetPosition().y,
407 rect_dev.GetSize().x, rect_dev.GetSize().y,
408 0.0 /* radius of rounded corners */ );
409 }
410}
411
412
413void SVG_PLOTTER::Circle( const VECTOR2I& pos, int diametre, FILL_T fill, int width )
414{
415 VECTOR2D pos_dev = userToDeviceCoordinates( pos );
416 double radius = userToDeviceSize( diametre / 2.0 );
417
418 setFillMode( fill );
419 SetCurrentLineWidth( width );
420
423
424 // If diameter is less than width, switch to filled mode
425 if( fill == FILL_T::NO_FILL && diametre < width )
426 {
427 setFillMode( FILL_T::FILLED_SHAPE );
429
430 radius = userToDeviceSize( ( diametre / 2.0 ) + ( width / 2.0 ) );
431 }
432
433 fprintf( m_outputFile,
434 "<circle cx=\"%.*f\" cy=\"%.*f\" r=\"%.*f\" /> \n",
435 m_precision, pos_dev.x, m_precision, pos_dev.y, m_precision, radius );
436}
437
438
439void SVG_PLOTTER::Arc( const VECTOR2D& aCenter, const EDA_ANGLE& aStartAngle,
440 const EDA_ANGLE& aAngle, double aRadius, FILL_T aFill, int aWidth )
441{
442 /* Draws an arc of a circle, centered on (xc,yc), with starting point (x1, y1) and ending
443 * at (x2, y2). The current pen is used for the outline and the current brush for filling
444 * the shape.
445 *
446 * The arc is drawn in an anticlockwise direction from the start point to the end point.
447 */
448
449 if( aRadius <= 0 )
450 {
451 Circle( aCenter, aWidth, FILL_T::FILLED_SHAPE, 0 );
452 return;
453 }
454
455 EDA_ANGLE startAngle = -aStartAngle;
456 EDA_ANGLE endAngle = startAngle - aAngle;
457
458 if( endAngle < startAngle )
459 std::swap( startAngle, endAngle );
460
461 // Calculate start point.
462 VECTOR2D centre_device = userToDeviceCoordinates( aCenter );
463 double radius_device = userToDeviceSize( aRadius );
464
465 if( m_plotMirror )
466 {
468 {
469 std::swap( startAngle, endAngle );
470 startAngle = ANGLE_180 - startAngle;
471 endAngle = ANGLE_180 - endAngle;
472 }
473 else
474 {
475 startAngle = -startAngle;
476 endAngle = -endAngle;
477 }
478 }
479
480 VECTOR2D start;
481 start.x = radius_device;
482 RotatePoint( start, startAngle );
483 VECTOR2D end;
484 end.x = radius_device;
485 RotatePoint( end, endAngle );
486 start += centre_device;
487 end += centre_device;
488
489 double theta1 = startAngle.AsRadians();
490
491 if( theta1 < 0 )
492 theta1 = theta1 + M_PI * 2;
493
494 double theta2 = endAngle.AsRadians();
495
496 if( theta2 < 0 )
497 theta2 = theta2 + M_PI * 2;
498
499 if( theta2 < theta1 )
500 theta2 = theta2 + M_PI * 2;
501
502 int flg_arc = 0; // flag for large or small arc. 0 means less than 180 degrees
503
504 if( fabs( theta2 - theta1 ) > M_PI )
505 flg_arc = 1;
506
507 int flg_sweep = 0; // flag for sweep always 0
508
509 // Draw a single arc: an arc is one of 3 curve commands (2 other are 2 bezier curves)
510 // params are start point, radius1, radius2, X axe rotation,
511 // flag arc size (0 = small arc > 180 deg, 1 = large arc > 180 deg),
512 // sweep arc ( 0 = CCW, 1 = CW),
513 // end point
514 if( aFill != FILL_T::NO_FILL )
515 {
516 // Filled arcs (in Eeschema) consist of the pie wedge and a stroke only on the arc
517 // This needs to be drawn in two steps.
518 setFillMode( aFill );
520
523
524 fprintf( m_outputFile, "<path d=\"M%.*f %.*f A%.*f %.*f 0.0 %d %d %.*f %.*f L %.*f %.*f Z\" />\n",
525 m_precision, start.x, m_precision, start.y,
526 m_precision, radius_device, m_precision, radius_device,
527 flg_arc, flg_sweep,
528 m_precision, end.x, m_precision, end.y,
529 m_precision, centre_device.x, m_precision, centre_device.y );
530 }
531
532 setFillMode( FILL_T::NO_FILL );
533 SetCurrentLineWidth( aWidth );
534
537
538 fprintf( m_outputFile, "<path d=\"M%.*f %.*f A%.*f %.*f 0.0 %d %d %.*f %.*f\" />\n",
539 m_precision, start.x, m_precision, start.y,
540 m_precision, radius_device, m_precision, radius_device,
541 flg_arc, flg_sweep,
542 m_precision, end.x, m_precision, end.y );
543}
544
545
546void SVG_PLOTTER::BezierCurve( const VECTOR2I& aStart, const VECTOR2I& aControl1,
547 const VECTOR2I& aControl2, const VECTOR2I& aEnd,
548 int aTolerance, int aLineThickness )
549{
550#if 1
551 setFillMode( FILL_T::NO_FILL );
552 SetCurrentLineWidth( aLineThickness );
553
556
557 VECTOR2D start = userToDeviceCoordinates( aStart );
558 VECTOR2D ctrl1 = userToDeviceCoordinates( aControl1 );
559 VECTOR2D ctrl2 = userToDeviceCoordinates( aControl2 );
560 VECTOR2D end = userToDeviceCoordinates( aEnd );
561
562 // Generate a cubic curve: start point and 3 other control points.
563 fprintf( m_outputFile, "<path d=\"M%.*f,%.*f C%.*f,%.*f %.*f,%.*f %.*f,%.*f\" />\n",
564 m_precision, start.x, m_precision, start.y,
565 m_precision, ctrl1.x, m_precision, ctrl1.y,
566 m_precision, ctrl2.x, m_precision, ctrl2.y,
567 m_precision, end.x, m_precision, end.y );
568#else
569 PLOTTER::BezierCurve( aStart, aControl1, aControl2, aEnd, aTolerance, aLineThickness );
570#endif
571}
572
573
574void SVG_PLOTTER::PlotPoly( const std::vector<VECTOR2I>& aCornerList, FILL_T aFill,
575 int aWidth, void* aData )
576{
577 if( aCornerList.size() <= 1 )
578 return;
579
580 setFillMode( aFill );
581 SetCurrentLineWidth( aWidth );
582 fprintf( m_outputFile, "<path ");
583
584 switch( aFill )
585 {
586 case FILL_T::NO_FILL:
587 setSVGPlotStyle( aWidth, false, "fill:none" );
588 break;
589
590 case FILL_T::FILLED_WITH_BG_BODYCOLOR:
591 case FILL_T::FILLED_SHAPE:
592 case FILL_T::FILLED_WITH_COLOR:
593 setSVGPlotStyle( aWidth, false, "fill-rule:evenodd;" );
594 break;
595 }
596
597 VECTOR2D pos = userToDeviceCoordinates( aCornerList[0] );
598 fprintf( m_outputFile, "d=\"M %.*f,%.*f\n", m_precision, pos.x, m_precision, pos.y );
599
600 for( unsigned ii = 1; ii < aCornerList.size() - 1; ii++ )
601 {
602 pos = userToDeviceCoordinates( aCornerList[ii] );
603 fprintf( m_outputFile, "%.*f,%.*f\n", m_precision, pos.x, m_precision, pos.y );
604 }
605
606 // If the corner list ends where it begins, then close the poly
607 if( aCornerList.front() == aCornerList.back() )
608 {
609 fprintf( m_outputFile, "Z\" /> \n" );
610 }
611 else
612 {
613 pos = userToDeviceCoordinates( aCornerList.back() );
614 fprintf( m_outputFile, "%.*f,%.*f\n\" /> \n", m_precision, pos.x, m_precision, pos.y );
615 }
616}
617
618
619void SVG_PLOTTER::PlotImage( const wxImage& aImage, const VECTOR2I& aPos, double aScaleFactor )
620{
621 VECTOR2I pix_size( aImage.GetWidth(), aImage.GetHeight() );
622
623 // Requested size (in IUs)
624 VECTOR2D drawsize( aScaleFactor * pix_size.x, aScaleFactor * pix_size.y );
625
626 // calculate the bitmap start position
627 VECTOR2I start( aPos.x - drawsize.x / 2, aPos.y - drawsize.y / 2 );
628
629 // Rectangles having a 0 size value for height or width are just not drawn on Inkscape,
630 // so use a line when happens.
631 if( drawsize.x == 0.0 || drawsize.y == 0.0 ) // Draw a line
632 {
633 PLOTTER::PlotImage( aImage, aPos, aScaleFactor );
634 }
635 else
636 {
637 wxMemoryOutputStream img_stream;
638
639 if( m_colorMode )
640 {
641 aImage.SaveFile( img_stream, wxBITMAP_TYPE_PNG );
642 }
643 else // Plot in B&W
644 {
645 wxImage image = aImage.ConvertToGreyscale();
646 image.SaveFile( img_stream, wxBITMAP_TYPE_PNG );
647 }
648 size_t input_len = img_stream.GetOutputStreamBuffer()->GetBufferSize();
649 std::vector<uint8_t> buffer( input_len );
650 std::vector<uint8_t> encoded;
651
652 img_stream.CopyTo( buffer.data(), buffer.size() );
653 base64::encode( buffer, encoded );
654
655 fprintf( m_outputFile,
656 "<image x=\"%f\" y=\"%f\" xlink:href=\"data:image/png;base64,",
657 userToDeviceSize( start.x ), userToDeviceSize( start.y ) );
658
659 for( size_t i = 0; i < encoded.size(); i++ )
660 {
661 fprintf( m_outputFile, "%c", static_cast<char>( encoded[i] ) );
662
663 if( ( i % 64 ) == 63 )
664 fprintf( m_outputFile, "\n" );
665 }
666
667 fprintf( m_outputFile, "\"\npreserveAspectRatio=\"none\" width=\"%.*f\" height=\"%.*f\" />",
668 m_precision, userToDeviceSize( drawsize.x ), m_precision, userToDeviceSize( drawsize.y ) );
669 }
670}
671
672
673void SVG_PLOTTER::PenTo( const VECTOR2I& pos, char plume )
674{
675 if( plume == 'Z' )
676 {
677 if( m_penState != 'Z' )
678 {
679 fputs( "\" />\n", m_outputFile );
680 m_penState = 'Z';
681 m_penLastpos.x = -1;
682 m_penLastpos.y = -1;
683 }
684
685 return;
686 }
687
688 if( m_penState == 'Z' ) // here plume = 'D' or 'U'
689 {
690 VECTOR2D pos_dev = userToDeviceCoordinates( pos );
691
692 // Ensure we do not use a fill mode when moving the pen,
693 // in SVG mode (i;e. we are plotting only basic lines, not a filled area
694 if( m_fillMode != FILL_T::NO_FILL )
695 setFillMode( FILL_T::NO_FILL );
696
699
700 fprintf( m_outputFile, "<path d=\"M%.*f %.*f\n",
701 m_precision, pos_dev.x,
702 m_precision, pos_dev.y );
703 }
704 else if( m_penState != plume || pos != m_penLastpos )
705 {
708
709 VECTOR2D pos_dev = userToDeviceCoordinates( pos );
710
711 fprintf( m_outputFile, "L%.*f %.*f\n",
712 m_precision, pos_dev.x,
713 m_precision, pos_dev.y );
714 }
715
716 m_penState = plume;
717 m_penLastpos = pos;
718}
719
720
721bool SVG_PLOTTER::StartPlot( const wxString& aPageNumber )
722{
723 wxASSERT( m_outputFile );
724
725 static const char* header[] =
726 {
727 "<?xml version=\"1.0\" standalone=\"no\"?>\n",
728 " <!DOCTYPE svg PUBLIC \"-//W3C//DTD SVG 1.1//EN\" \n",
729 " \"http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd\"> \n",
730 "<svg\n"
731 " xmlns:svg=\"http://www.w3.org/2000/svg\"\n"
732 " xmlns=\"http://www.w3.org/2000/svg\"\n",
733 " xmlns:xlink=\"http://www.w3.org/1999/xlink\"\n",
734 " version=\"1.1\"\n",
735 nullptr
736 };
737
738 // Write header.
739 for( int ii = 0; header[ii] != nullptr; ii++ )
740 {
741 fputs( header[ii], m_outputFile );
742 }
743
744 // Write viewport pos and size
745 VECTOR2D origin; // TODO set to actual value
746 fprintf( m_outputFile, " width=\"%.*fmm\" height=\"%.*fmm\" viewBox=\"%.*f %.*f %.*f %.*f\">\n",
747 m_precision, (double) m_paperSize.x / m_IUsPerDecimil * 2.54 / 1000,
748 m_precision, (double) m_paperSize.y / m_IUsPerDecimil * 2.54 / 1000,
749 m_precision, origin.x, m_precision, origin.y,
752
753 // Write title
754 char date_buf[250];
755 time_t ltime = time( nullptr );
756 strftime( date_buf, 250, "%Y/%m/%d %H:%M:%S", localtime( &ltime ) );
757
758 fprintf( m_outputFile,
759 "<title>SVG Image created as %s date %s </title>\n",
760 TO_UTF8( XmlEsc( wxFileName( m_filename ).GetFullName() ) ), date_buf );
761
762 // End of header
763 fprintf( m_outputFile, " <desc>Image generated by %s </desc>\n",
764 TO_UTF8( XmlEsc( m_creator ) ) );
765
766 // output the pen and brush color (RVB values in hex) and opacity
767 double opacity = 1.0; // 0.0 (transparent to 1.0 (solid)
768 fprintf( m_outputFile,
769 "<g style=\"fill:#%6.6lX; fill-opacity:%.*f;stroke:#%6.6lX; stroke-opacity:%.*f;\n",
771
772 // output the pen cap and line joint
773 fputs( "stroke-linecap:round; stroke-linejoin:round;\"\n", m_outputFile );
774 fputs( " transform=\"translate(0 0) scale(1 1)\">\n", m_outputFile );
775 return true;
776}
777
778
780{
781 fputs( "</g> \n</svg>\n", m_outputFile );
782 fclose( m_outputFile );
783 m_outputFile = nullptr;
784
785 return true;
786}
787
788
789void SVG_PLOTTER::Text( const VECTOR2I& aPos,
790 const COLOR4D& aColor,
791 const wxString& aText,
792 const EDA_ANGLE& aOrient,
793 const VECTOR2I& aSize,
794 enum GR_TEXT_H_ALIGN_T aH_justify,
795 enum GR_TEXT_V_ALIGN_T aV_justify,
796 int aWidth,
797 bool aItalic,
798 bool aBold,
799 bool aMultilineAllowed,
800 KIFONT::FONT* aFont,
801 const KIFONT::METRICS& aFontMetrics,
802 void* aData )
803{
804 setFillMode( FILL_T::NO_FILL );
805 SetColor( aColor );
806 SetCurrentLineWidth( aWidth );
807
810
811 VECTOR2I text_pos = aPos;
812 const char* hjust = "start";
813
814 switch( aH_justify )
815 {
816 case GR_TEXT_H_ALIGN_CENTER: hjust = "middle"; break;
817 case GR_TEXT_H_ALIGN_RIGHT: hjust = "end"; break;
818 case GR_TEXT_H_ALIGN_LEFT: hjust = "start"; break;
820 wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) );
821 break;
822 }
823
824 switch( aV_justify )
825 {
826 case GR_TEXT_V_ALIGN_CENTER: text_pos.y += aSize.y / 2; break;
827 case GR_TEXT_V_ALIGN_TOP: text_pos.y += aSize.y; break;
828 case GR_TEXT_V_ALIGN_BOTTOM: break;
830 wxFAIL_MSG( wxT( "Indeterminate state legal only in dialogs." ) );
831 break;
832 }
833
834 VECTOR2I text_size;
835
836 // aSize.x or aSize.y is < 0 for mirrored texts.
837 // The actual text size value is the absolute value
838 text_size.x = std::abs( GRTextWidth( aText, aFont, aSize, aWidth, aBold, aItalic, aFontMetrics ) );
839 text_size.y = std::abs( aSize.x * 4/3 ); // Hershey font height to em size conversion
840 VECTOR2D anchor_pos_dev = userToDeviceCoordinates( aPos );
841 VECTOR2D text_pos_dev = userToDeviceCoordinates( text_pos );
842 VECTOR2D sz_dev = userToDeviceSize( text_size );
843
844 if( !aOrient.IsZero() )
845 {
846 fprintf( m_outputFile, "<g transform=\"rotate(%f %.*f %.*f)\">\n",
847 m_plotMirror ? aOrient.AsDegrees() : -aOrient.AsDegrees(), m_precision,
848 anchor_pos_dev.x, m_precision, anchor_pos_dev.y );
849 }
850
851 fprintf( m_outputFile, "<text x=\"%.*f\" y=\"%.*f\"\n",
852 m_precision, text_pos_dev.x, m_precision, text_pos_dev.y );
853
855 if( m_plotMirror != ( aSize.x < 0 ) )
856 fprintf( m_outputFile, "transform=\"scale(-1 1) translate(%f 0)\"\n", -2 * text_pos_dev.x );
857
858 fprintf( m_outputFile,
859 "textLength=\"%.*f\" font-size=\"%.*f\" lengthAdjust=\"spacingAndGlyphs\"\n"
860 "text-anchor=\"%s\" opacity=\"0\">%s</text>\n",
861 m_precision, sz_dev.x, m_precision, sz_dev.y, hjust, TO_UTF8( XmlEsc( aText ) ) );
862
863 if( !aOrient.IsZero() )
864 fputs( "</g>\n", m_outputFile );
865
866 fprintf( m_outputFile, "<g class=\"stroked-text\"><desc>%s</desc>\n",
867 TO_UTF8( XmlEsc( aText ) ) );
868
869 PLOTTER::Text( aPos, aColor, aText, aOrient, aSize, aH_justify, aV_justify, aWidth, aItalic,
870 aBold, aMultilineAllowed, aFont, aFontMetrics );
871
872 fputs( "</g>", m_outputFile );
873}
874
875
877 const COLOR4D& aColor,
878 const wxString& aText,
879 const TEXT_ATTRIBUTES& aAttributes,
880 KIFONT::FONT* aFont,
881 const KIFONT::METRICS& aFontMetrics,
882 void* aData )
883{
884 VECTOR2I size = aAttributes.m_Size;
885
886 if( aAttributes.m_Mirrored )
887 size.x = -size.x;
888
889 SVG_PLOTTER::Text( aPos, aColor, aText, aAttributes.m_Angle, size, aAttributes.m_Halign,
890 aAttributes.m_Valign, aAttributes.m_StrokeWidth, aAttributes.m_Italic,
891 aAttributes.m_Bold, aAttributes.m_Multiline, aFont, aFontMetrics, aData );
892}
static wxString XmlEsc(const wxString &aStr, bool isAttribute=false)
Translates '<' to "<", '>' to ">" and so on, according to the spec: http://www.w3....
BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition: box2.h:120
const Vec & GetPosition() const
Definition: box2.h:185
const Vec & GetOrigin() const
Definition: box2.h:184
const Vec GetEnd() const
Definition: box2.h:186
const Vec & GetSize() const
Definition: box2.h:180
double AsDegrees() const
Definition: eda_angle.h:155
bool IsZero() const
Definition: eda_angle.h:175
double AsRadians() const
Definition: eda_angle.h:159
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
int GetDefaultPenWidth() const
const VECTOR2D & GetSizeMils() const
Definition: page_info.h:144
double GetDotMarkLenIU(int aLineWidth) const
Definition: plotter.cpp:131
virtual void PlotImage(const wxImage &aImage, const VECTOR2I &aPos, double aScaleFactor)
Only PostScript plotters can plot bitmaps.
Definition: plotter.cpp:259
double GetDashGapLenIU(int aLineWidth) const
Definition: plotter.cpp:143
bool m_mirrorIsHorizontal
Definition: plotter.h:649
PAGE_INFO m_pageInfo
Definition: plotter.h:665
bool m_plotMirror
Definition: plotter.h:647
static const int USE_DEFAULT_LINE_WIDTH
Definition: plotter.h:108
virtual void BezierCurve(const VECTOR2I &aStart, const VECTOR2I &aControl1, const VECTOR2I &aControl2, const VECTOR2I &aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH)
Generic fallback: Cubic Bezier curve rendered as a polyline In KiCad the bezier curves have 4 control...
Definition: plotter.cpp:229
bool m_yaxisReversed
Definition: plotter.h:650
double m_iuPerDeviceUnit
Definition: plotter.h:644
VECTOR2I m_plotOffset
Definition: plotter.h:646
VECTOR2I m_penLastpos
Definition: plotter.h:660
virtual VECTOR2D userToDeviceCoordinates(const VECTOR2I &aCoordinate)
Modify coordinates according to the orientation, scale factor, and offsets trace.
Definition: plotter.cpp:90
VECTOR2I m_paperSize
Definition: plotter.h:666
virtual VECTOR2D userToDeviceSize(const VECTOR2I &size)
Modify size according to the plotter scale factors (VECTOR2I version, returns a VECTOR2D).
Definition: plotter.cpp:115
char m_penState
Definition: plotter.h:659
wxString m_creator
Definition: plotter.h:662
int m_currentPenWidth
Definition: plotter.h:658
double m_plotScale
Plot scale - chosen by the user (even implicitly with 'fit in a4')
Definition: plotter.h:636
FILE * m_outputFile
Output file.
Definition: plotter.h:653
static const int DO_NOT_SET_LINE_WIDTH
Definition: plotter.h:107
RENDER_SETTINGS * m_renderSettings
Definition: plotter.h:670
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 aPenWidth, bool aItalic, bool aBold, bool aMultilineAllowed, KIFONT::FONT *aFont, const KIFONT::METRICS &aFontMetrics, void *aData=nullptr)
Draw text with the plotter.
Definition: plotter.cpp:691
double m_IUsPerDecimil
Definition: plotter.h:642
virtual int GetCurrentLineWidth() const
Definition: plotter.h:147
bool m_colorMode
Definition: plotter.h:656
double GetDashMarkLenIU(int aLineWidth) const
Definition: plotter.cpp:137
wxString m_filename
Definition: plotter.h:663
virtual void SetColor(const COLOR4D &color) override
The SetColor implementation is split with the subclasses: the PSLIKE computes the rgb values,...
Definition: PS_plotter.cpp:63
virtual void SetTextMode(PLOT_TEXT_MODE mode) override
PS and PDF fully implement native text (for the Latin-1 subset)
virtual void emitSetRGBColor(double r, double g, double b, double a) override
Initialize m_pen_rgb_color from reduced values r, g ,b ( reduced values are 0.0 to 1....
virtual void PlotImage(const wxImage &aImage, const VECTOR2I &aPos, double aScaleFactor) override
PostScript-likes at the moment are the only plot engines supporting bitmaps.
unsigned m_precision
virtual bool StartPlot(const wxString &aPageNumber) override
Create SVG file header.
virtual void EndBlock(void *aData) override
Calling this function allows one to define the end of a group of drawing items the group is started b...
virtual void PlotPoly(const std::vector< VECTOR2I > &aCornerList, FILL_T aFill, int aWidth=USE_DEFAULT_LINE_WIDTH, void *aData=nullptr) override
Draw a polygon ( filled or not ).
virtual void SetViewport(const VECTOR2I &aOffset, double aIusPerDecimil, double aScale, bool aMirror) override
Set the plot offset and scaling for the current plot.
LINE_STYLE m_dashed
virtual void BezierCurve(const VECTOR2I &aStart, const VECTOR2I &aControl1, const VECTOR2I &aControl2, const VECTOR2I &aEnd, int aTolerance, int aLineThickness=USE_DEFAULT_LINE_WIDTH) override
Generic fallback: Cubic Bezier curve rendered as a polyline In KiCad the bezier curves have 4 control...
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.
double m_brush_alpha
virtual void Rect(const VECTOR2I &p1, const VECTOR2I &p2, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
virtual void SetSvgCoordinatesFormat(unsigned aPrecision) override
Select SVG coordinate precision (number of digits needed for 1 mm ) (SVG plotter uses always metric u...
virtual bool EndPlot() override
void setSVGPlotStyle(int aLineWidth, bool aIsGroup=true, const std::string &aExtraStyle={})
Output the string which define pen and brush color, shape, transparency.
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 PenTo(const VECTOR2I &pos, char plume) override
Moveto/lineto primitive, moves the 'pen' to the specified direction.
long m_brush_rgb_color
virtual void Circle(const VECTOR2I &pos, int diametre, FILL_T fill, int width=USE_DEFAULT_LINE_WIDTH) override
bool m_graphics_changed
virtual void SetDash(int aLineWidth, LINE_STYLE aLineStyle) override
SVG supports dashed lines.
virtual void StartBlock(void *aData) override
Calling this function allows one to define the beginning of a group of drawing items (used in SVG for...
void setFillMode(FILL_T fill)
Prepare parameters for setSVGPlotStyle()
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
virtual void SetCurrentLineWidth(int width, void *aData=nullptr) override
Set the current line width (in IUs) for the next plot.
GR_TEXT_H_ALIGN_T m_Halign
GR_TEXT_V_ALIGN_T m_Valign
static constexpr EDA_ANGLE ANGLE_180
Definition: eda_angle.h:439
FILL_T
Definition: eda_shape.h:54
int GRTextWidth(const wxString &aText, KIFONT::FONT *aFont, const VECTOR2I &aSize, int aThickness, bool aBold, bool aItalic, const KIFONT::METRICS &aFontMetrics)
Definition: gr_text.cpp:113
This file contains miscellaneous commonly used macros and functions.
void encode(const std::vector< uint8_t > &aInput, std::vector< uint8_t > &aOutput)
Definition: base64.cpp:76
EDA_ANGLE abs(const EDA_ANGLE &aAngle)
Definition: eda_angle.h:424
Plotting engines similar to ps (PostScript, Gerber, svg)
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: string_utils.h:391
LINE_STYLE
Dashed line types.
Definition: stroke_params.h:48
GR_TEXT_H_ALIGN_T
@ GR_TEXT_H_ALIGN_CENTER
@ GR_TEXT_H_ALIGN_RIGHT
@ GR_TEXT_H_ALIGN_LEFT
@ GR_TEXT_H_ALIGN_INDETERMINATE
GR_TEXT_V_ALIGN_T
@ GR_TEXT_V_ALIGN_BOTTOM
@ GR_TEXT_V_ALIGN_INDETERMINATE
@ GR_TEXT_V_ALIGN_CENTER
@ GR_TEXT_V_ALIGN_TOP
void RotatePoint(int *pX, int *pY, const EDA_ANGLE &aAngle)
Calculate the new point of coord coord pX, pY, for a rotation center 0, 0.
Definition: trigo.cpp:228
VECTOR2< int > VECTOR2I
Definition: vector2d.h:588