KiCad PCB EDA Suite
stroke_params.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) 2021-2022 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#include <macros.h>
20#include <base_units.h>
21#include <charconv>
22#include <string_utils.h>
23#include <render_settings.h>
24#include <geometry/shape.h>
28#include <stroke_params.h>
29#include <trigo.h>
30#include <widgets/msgpanel.h>
31
32using namespace STROKEPARAMS_T;
33
34
35void STROKE_PARAMS::Stroke( const SHAPE* aShape, PLOT_DASH_TYPE aLineStyle, int aWidth,
36 const KIGFX::RENDER_SETTINGS* aRenderSettings,
37 std::function<void( const VECTOR2I& a, const VECTOR2I& b )> aStroker )
38{
39 double strokes[6] = { aWidth * 1.0, aWidth * 1.0, aWidth * 1.0, aWidth * 1.0, aWidth * 1.0,
40 aWidth * 1.0 };
41 int wrapAround = 6;
42
43 switch( aLineStyle )
44 {
46 strokes[0] = aRenderSettings->GetDashLength( aWidth );
47 strokes[1] = aRenderSettings->GetGapLength( aWidth );
48 wrapAround = 2;
49 break;
51 strokes[0] = aRenderSettings->GetDotLength( aWidth );
52 strokes[1] = aRenderSettings->GetGapLength( aWidth );
53 wrapAround = 2;
54 break;
56 strokes[0] = aRenderSettings->GetDashLength( aWidth );
57 strokes[1] = aRenderSettings->GetGapLength( aWidth );
58 strokes[2] = aRenderSettings->GetDotLength( aWidth );
59 strokes[3] = aRenderSettings->GetGapLength( aWidth );
60 wrapAround = 4;
61 break;
63 strokes[0] = aRenderSettings->GetDashLength( aWidth );
64 strokes[1] = aRenderSettings->GetGapLength( aWidth );
65 strokes[2] = aRenderSettings->GetDotLength( aWidth );
66 strokes[3] = aRenderSettings->GetGapLength( aWidth );
67 strokes[4] = aRenderSettings->GetDotLength( aWidth );
68 strokes[5] = aRenderSettings->GetGapLength( aWidth );
69 wrapAround = 6;
70 break;
71 default:
72 UNIMPLEMENTED_FOR( lineTypeNames.at( aLineStyle ).name );
73 }
74
75 switch( aShape->Type() )
76 {
77 case SH_SIMPLE:
78 {
79 const SHAPE_SIMPLE* poly = static_cast<const SHAPE_SIMPLE*>( aShape );
80
81 for( size_t ii = 0; ii < poly->GetSegmentCount(); ++ii )
82 {
83 SEG seg = poly->GetSegment( ii );
84 SHAPE_SEGMENT line( seg.A, seg.B );
85 STROKE_PARAMS::Stroke( &line, aLineStyle, aWidth, aRenderSettings, aStroker );
86 }
87 }
88 break;
89
90 case SH_SEGMENT:
91 {
92 const SHAPE_SEGMENT* line = static_cast<const SHAPE_SEGMENT*>( aShape );
93
94 VECTOR2D start = line->GetSeg().A;
95 VECTOR2D end = line->GetSeg().B;
96 BOX2I clip( start, VECTOR2I( end.x - start.x, end.y - start.y ) );
97 clip.Normalize();
98
99 double theta = atan2( end.y - start.y, end.x - start.x );
100
101 for( size_t i = 0; i < 10000; ++i )
102 {
103 // Calculations MUST be done in doubles to keep from accumulating rounding
104 // errors as we go.
105 VECTOR2D next( start.x + strokes[ i % wrapAround ] * cos( theta ),
106 start.y + strokes[ i % wrapAround ] * sin( theta ) );
107
108 // Drawing each segment can be done rounded to ints.
109 VECTOR2I a( KiROUND( start.x ), KiROUND( start.y ) );
110 VECTOR2I b( KiROUND( next.x ), KiROUND( next.y ) );
111
112 if( ClipLine( &clip, a.x, a.y, b.x, b.y ) )
113 break;
114 else if( i % 2 == 0 )
115 aStroker( a, b );
116
117 start = next;
118 }
119 }
120 break;
121
122 case SH_ARC:
123 {
124 const SHAPE_ARC* arc = static_cast<const SHAPE_ARC*>( aShape );
125
126 double r = arc->GetRadius();
127 double C = 2.0 * M_PI * r;
128 VECTOR2I center = arc->GetCenter();
129 VECTOR2D startRadial( arc->GetP0() - center );
130 EDA_ANGLE startAngle( startRadial );
131 VECTOR2D endRadial( arc->GetP1() - center );
132 EDA_ANGLE arcEndAngle( endRadial );
133
134 if( arcEndAngle == startAngle )
135 arcEndAngle = startAngle + ANGLE_360; // ring, not null
136
137 if( startAngle > arcEndAngle )
138 {
139 if( arcEndAngle < ANGLE_0 )
140 arcEndAngle = arcEndAngle.Normalize();
141 else
142 startAngle = startAngle.Normalize() - ANGLE_360;
143 }
144
145 wxASSERT( startAngle < arcEndAngle );
146
147 for( size_t i = 0; i < 10000 && startAngle < arcEndAngle; ++i )
148 {
149 EDA_ANGLE theta = ANGLE_360 * strokes[ i % wrapAround ] / C;
150 EDA_ANGLE endAngle = std::min( startAngle + theta, arcEndAngle );
151
152 if( i % 2 == 0 )
153 {
154 VECTOR2I a( center.x + r * startAngle.Cos(), center.y + r * startAngle.Sin() );
155 VECTOR2I b( center.x + r * endAngle.Cos(), center.y + r * endAngle.Sin() );
156
157 aStroker( a, b );
158 }
159
160 startAngle = endAngle;
161 }
162 }
163 break;
164
165 case SH_CIRCLE:
166 // A circle is always filled; a ring is represented by a 360° arc.
168
169 default:
171 }
172}
173
174
176{
177 wxString token;
178
179 switch( aStyle )
180 {
181 case PLOT_DASH_TYPE::DASH: token = wxT( "dash" ); break;
182 case PLOT_DASH_TYPE::DOT: token = wxT( "dot" ); break;
183 case PLOT_DASH_TYPE::DASHDOT: token = wxT( "dash_dot" ); break;
184 case PLOT_DASH_TYPE::DASHDOTDOT: token = wxT( "dash_dot_dot" ); break;
185 case PLOT_DASH_TYPE::SOLID: token = wxT( "solid" ); break;
186 case PLOT_DASH_TYPE::DEFAULT: token = wxT( "default" ); break;
187 }
188
189 return token;
190}
191
192
194 std::vector<MSG_PANEL_ITEM>& aList,
195 bool aIncludeStyle, bool aIncludeWidth )
196{
197 if( aIncludeStyle )
198 {
199 wxString lineStyle = _( "Default" );
200
201 for( const std::pair<const PLOT_DASH_TYPE, lineTypeStruct>& typeEntry : lineTypeNames )
202 {
203 if( typeEntry.first == GetPlotStyle() )
204 {
205 lineStyle = typeEntry.second.name;
206 break;
207 }
208 }
209
210 aList.emplace_back( _( "Line Style" ), lineStyle );
211 }
212
213 if( aIncludeWidth )
214 aList.emplace_back( _( "Line Width" ), aUnitsProvider->MessageTextFromValue( GetWidth() ) );
215}
216
217
218void STROKE_PARAMS::Format( OUTPUTFORMATTER* aFormatter, const EDA_IU_SCALE& aIuScale,
219 int aNestLevel ) const
220{
221 wxASSERT( aFormatter != nullptr );
222
224 {
225 aFormatter->Print( aNestLevel, "(stroke (width %s) (type %s))",
226 EDA_UNIT_UTILS::FormatInternalUnits( aIuScale, GetWidth() ).c_str(),
228 }
229 else
230 {
231 aFormatter->Print( aNestLevel, "(stroke (width %s) (type %s) (color %d %d %d %s))",
232 EDA_UNIT_UTILS::FormatInternalUnits( aIuScale, GetWidth() ).c_str(),
234 KiROUND( GetColor().r * 255.0 ),
235 KiROUND( GetColor().g * 255.0 ),
236 KiROUND( GetColor().b * 255.0 ),
237 FormatDouble2Str( GetColor().a ).c_str() );
238 }
239}
240
241
243{
244 for( T token = NextTok(); token != T_RIGHT; token = NextTok() )
245 {
246 if( token != T_LEFT )
247 Expecting( T_LEFT );
248
249 token = NextTok();
250
251 switch( token )
252 {
253 case T_width:
254 aStroke.SetWidth( parseDouble( "stroke width" ) * m_iuPerMM );
255 NeedRIGHT();
256 break;
257
258 case T_type:
259 {
260 token = NextTok();
261
262 switch( token )
263 {
264 case T_dash: aStroke.SetPlotStyle( PLOT_DASH_TYPE::DASH ); break;
265 case T_dot: aStroke.SetPlotStyle( PLOT_DASH_TYPE::DOT ); break;
266 case T_dash_dot: aStroke.SetPlotStyle( PLOT_DASH_TYPE::DASHDOT ); break;
267 case T_dash_dot_dot: aStroke.SetPlotStyle( PLOT_DASH_TYPE::DASHDOTDOT ); break;
268 case T_solid: aStroke.SetPlotStyle( PLOT_DASH_TYPE::SOLID ); break;
269 case T_default: aStroke.SetPlotStyle( PLOT_DASH_TYPE::DEFAULT ); break;
270 default:
271 Expecting( "solid, dash, dash_dot, dash_dot_dot, dot or default" );
272 }
273
274 NeedRIGHT();
275 break;
276 }
277
278 case T_color:
279 {
281
282 color.r = parseInt( "red" ) / 255.0;
283 color.g = parseInt( "green" ) / 255.0;
284 color.b = parseInt( "blue" ) / 255.0;
285 color.a = Clamp( parseDouble( "alpha" ), 0.0, 1.0 );
286
287 aStroke.SetColor( color );
288 NeedRIGHT();
289 break;
290 }
291
292 default:
293 Expecting( "width, type, or color" );
294 }
295 }
296}
297
298
299int STROKE_PARAMS_PARSER::parseInt( const char* aText )
300{
301 T token = NextTok();
302
303 if( token != T_NUMBER )
304 Expecting( aText );
305
306 return atoi( CurText() );
307}
308
309
310double STROKE_PARAMS_PARSER::parseDouble( const char* aText )
311{
312 T token = NextTok();
313
314 if( token != T_NUMBER )
315 Expecting( aText );
316
317 return DSNLEXER::parseDouble();
318}
319
320
int color
Definition: DXF_plotter.cpp:57
BOX2< Vec > & Normalize()
Ensure that the height and width are positive.
Definition: box2.h:119
double parseDouble()
Parse the current token as an ASCII numeric string with possible leading whitespace into a double pre...
Definition: dsnlexer.cpp:825
EDA_ANGLE Normalize()
Definition: eda_angle.h:249
double Sin() const
Definition: eda_angle.h:206
double Cos() const
Definition: eda_angle.h:221
A color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:104
static const COLOR4D UNSPECIFIED
For legacy support; used as a value to indicate color hasn't been set yet.
Definition: color4d.h:390
Container for all the knowledge about how graphical objects are drawn on any output surface/device.
double GetGapLength(int aLineWidth) const
double GetDotLength(int aLineWidth) const
double GetDashLength(int aLineWidth) const
An interface used to output 8 bit text in a convenient way.
Definition: richio.h:310
int PRINTF_FUNC Print(int nestLevel, const char *fmt,...)
Format and write text to the output stream.
Definition: richio.cpp:431
Definition: seg.h:42
VECTOR2I A
Definition: seg.h:49
VECTOR2I B
Definition: seg.h:50
const VECTOR2I & GetP1() const
Definition: shape_arc.h:113
double GetRadius() const
Definition: shape_arc.cpp:458
VECTOR2I GetCenter() const
Definition: shape_arc.cpp:433
const VECTOR2I & GetP0() const
Definition: shape_arc.h:112
SHAPE_TYPE Type() const
Return the type of the shape.
Definition: shape.h:95
const SEG & GetSeg() const
Represent a simple polygon consisting of a zero-thickness closed chain of connected line segments.
Definition: shape_simple.h:42
virtual const SEG GetSegment(int aIndex) const override
Definition: shape_simple.h:174
virtual size_t GetSegmentCount() const override
Definition: shape_simple.h:176
An abstract shape on 2D plane.
Definition: shape.h:123
int parseInt(const char *aText)
void ParseStroke(STROKE_PARAMS &aStroke)
double parseDouble(const char *aText)
Simple container to manage line stroke parameters.
Definition: stroke_params.h:88
int GetWidth() const
Definition: stroke_params.h:98
void SetWidth(int aWidth)
Definition: stroke_params.h:99
void SetColor(const KIGFX::COLOR4D &aColor)
void GetMsgPanelInfo(UNITS_PROVIDER *aUnitsProvider, std::vector< MSG_PANEL_ITEM > &aList, bool aIncludeStyle=true, bool aIncludeWidth=true)
static void Stroke(const SHAPE *aShape, PLOT_DASH_TYPE aLineStyle, int aWidth, const KIGFX::RENDER_SETTINGS *aRenderSettings, std::function< void(const VECTOR2I &a, const VECTOR2I &b)> aStroker)
KIGFX::COLOR4D GetColor() const
PLOT_DASH_TYPE GetPlotStyle() const
static wxString GetLineStyleToken(PLOT_DASH_TYPE aStyle)
void Format(OUTPUTFORMATTER *out, const EDA_IU_SCALE &aIuScale, int nestLevel) const
void SetPlotStyle(PLOT_DASH_TYPE aPlotStyle)
wxString MessageTextFromValue(double aValue, bool aAddUnitLabel=true, EDA_DATA_TYPE aType=EDA_DATA_TYPE::DISTANCE)
A lower-precision version of StringFromValue().
#define _(s)
static constexpr EDA_ANGLE & ANGLE_360
Definition: eda_angle.h:418
static constexpr EDA_ANGLE & ANGLE_0
Definition: eda_angle.h:412
E_SERIE r
Definition: eserie.cpp:41
a few functions useful in geometry calculations.
bool ClipLine(const BOX2I *aClipBox, int &x1, int &y1, int &x2, int &y2)
Test if any part of a line falls within the bounds of a rectangle.
This file contains miscellaneous commonly used macros and functions.
#define KI_FALLTHROUGH
The KI_FALLTHROUGH macro is to be used when switch statement cases should purposely fallthrough from ...
Definition: macros.h:83
#define UNIMPLEMENTED_FOR(type)
Definition: macros.h:120
#define TO_UTF8(wxstring)
Convert a wxString to a UTF8 encoded C string for all wxWidgets build modes.
Definition: macros.h:96
Message panel definition file.
std::string FormatInternalUnits(const EDA_IU_SCALE &aIuScale, int aValue)
Converts aValue from internal units to a string appropriate for writing to file.
Definition: eda_units.cpp:139
CITER next(CITER it)
Definition: ptree.cpp:126
@ SH_CIRCLE
circle
Definition: shape.h:47
@ SH_SIMPLE
simple polygon
Definition: shape.h:48
@ SH_SEGMENT
line segment
Definition: shape.h:45
@ SH_ARC
circular arc
Definition: shape.h:51
static wxString SHAPE_TYPE_asString(SHAPE_TYPE a)
Definition: shape.h:56
std::string FormatDouble2Str(double aValue)
Print a float number without using scientific notation and no trailing 0 This function is intended in...
PLOT_DASH_TYPE
Dashed line types.
Definition: stroke_params.h:48
const std::map< PLOT_DASH_TYPE, struct lineTypeStruct > lineTypeNames
Definition: stroke_params.h:70
constexpr ret_type KiROUND(fp_type v)
Round a floating point number to an integer using "round halfway cases away from zero".
Definition: util.h:85
constexpr T Clamp(const T &lower, const T &value, const T &upper)
Limit value within the range lower <= value <= upper.
Definition: util.h:64
VECTOR2< int > VECTOR2I
Definition: vector2d.h:618