STROKE_PARAMS Class Reference

Simple container to manage line stroke parameters. More...

#include <stroke_params.h>

Public Member Functions
	STROKE_PARAMS (int aWidth=0, PLOT_DASH_TYPE aPlotStyle=PLOT_DASH_TYPE::DEFAULT, const KIGFX::COLOR4D &aColor=KIGFX::COLOR4D::UNSPECIFIED)
int	GetWidth () const
void	SetWidth (int aWidth)
PLOT_DASH_TYPE	GetPlotStyle () const
void	SetPlotStyle (PLOT_DASH_TYPE aPlotStyle)
KIGFX::COLOR4D	GetColor () const
void	SetColor (const KIGFX::COLOR4D &aColor)
bool	operator!= (const STROKE_PARAMS &aOther)
void	Format (OUTPUTFORMATTER *out, const EDA_IU_SCALE &aIuScale, int nestLevel) const
void	GetMsgPanelInfo (UNITS_PROVIDER *aUnitsProvider, std::vector< MSG_PANEL_ITEM > &aList, bool aIncludeStyle=true, bool aIncludeWidth=true)

Static Public Member Functions
static wxString	GetLineStyleToken (PLOT_DASH_TYPE aStyle)
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)

Private Attributes
int	m_width
PLOT_DASH_TYPE	m_plotstyle
KIGFX::COLOR4D	m_color

Detailed Description

Simple container to manage line stroke parameters.

Definition at line 87 of file stroke_params.h.

Constructor & Destructor Documentation

STROKE_PARAMS()

STROKE_PARAMS::STROKE_PARAMS ( int  aWidth = 0, PLOT_DASH_TYPE  aPlotStyle = PLOT_DASH_TYPE::DEFAULT, const KIGFX::COLOR4D &  aColor = KIGFX::COLOR4D::UNSPECIFIED  )

inline

Definition at line 90 of file stroke_params.h.

 :
 m_width( aWidth ),
 m_plotstyle( aPlotStyle ),
 m_color( aColor )
 {
 }

Member Function Documentation

Format()

void STROKE_PARAMS::Format	(	OUTPUTFORMATTER *	out,
		const EDA_IU_SCALE &	aIuScale,
		int	nestLevel
	)		const

Definition at line 218 of file stroke_params.cpp.

{
 wxASSERT( aFormatter != nullptr );
 
 if( GetColor() == KIGFX::COLOR4D::UNSPECIFIED )
 {
 aFormatter->Print( aNestLevel, "(stroke (width %s) (type %s))",
 EDA_UNIT_UTILS::FormatInternalUnits( aIuScale, GetWidth() ).c_str(),
 TO_UTF8( GetLineStyleToken( GetPlotStyle() ) ) );
 }
 else
 {
 aFormatter->Print( aNestLevel, "(stroke (width %s) (type %s) (color %d %d %d %s))",
 EDA_UNIT_UTILS::FormatInternalUnits( aIuScale, GetWidth() ).c_str(),
 TO_UTF8( GetLineStyleToken( GetPlotStyle() ) ),
 KiROUND( GetColor().r * 255.0 ),
 KiROUND( GetColor().g * 255.0 ),
 KiROUND( GetColor().b * 255.0 ),
 FormatDouble2Str( GetColor().a ).c_str() );
 }
}

References FormatDouble2Str(), EDA_UNIT_UTILS::FormatInternalUnits(), GetColor(), GetLineStyleToken(), GetPlotStyle(), GetWidth(), KiROUND(), OUTPUTFORMATTER::Print(), r, TO_UTF8, and KIGFX::COLOR4D::UNSPECIFIED.

Referenced by PCB_PLUGIN::format(), formatArc(), formatBezier(), formatCircle(), formatPoly(), formatRect(), SCH_SEXPR_PLUGIN::saveBusEntry(), SCH_SEXPR_PLUGIN::saveLine(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_SEXPR_PLUGIN_CACHE::saveTextBox(), and SCH_SEXPR_PLUGIN::saveTextBox().

GetColor()

KIGFX::COLOR4D STROKE_PARAMS::GetColor ( ) const

inline

Definition at line 104 of file stroke_params.h.

{ return m_color; }

References m_color.

Referenced by KIGFX::SCH_PAINTER::draw(), Format(), SCH_BUS_ENTRY_BASE::GetBusEntryColor(), SCH_LINE::GetLineColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_LINE::IsStrokeEquivalent(), DIALOG_LIB_SHAPE_PROPERTIES::onFill(), SCH_SEXPR_PARSER::parseSheet(), SCH_TEXTBOX::Plot(), LIB_SHAPE::Plot(), LIB_TEXTBOX::Plot(), SCH_SHAPE::Print(), LIB_SHAPE::print(), LIB_TEXTBOX::print(), SCH_TEXTBOX::Print(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_LINE_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_WIRE_BUS_PROPERTIES::TransferDataToWindow().

GetLineStyleToken()

wxString STROKE_PARAMS::GetLineStyleToken ( PLOT_DASH_TYPE  aStyle )

static

Definition at line 175 of file stroke_params.cpp.

{
 wxString token;
 
 switch( aStyle )
 {
 case PLOT_DASH_TYPE::DASH: token = wxT( "dash" ); break;
 case PLOT_DASH_TYPE::DOT: token = wxT( "dot" ); break;
 case PLOT_DASH_TYPE::DASHDOT: token = wxT( "dash_dot" ); break;
 case PLOT_DASH_TYPE::DASHDOTDOT: token = wxT( "dash_dot_dot" ); break;
 case PLOT_DASH_TYPE::SOLID: token = wxT( "solid" ); break;
 case PLOT_DASH_TYPE::DEFAULT: token = wxT( "default" ); break;
 }
 
 return token;
}

References DASH, DASHDOT, DASHDOTDOT, DEFAULT, DOT, and SOLID.

Referenced by Format(), and SCH_LEGACY_PLUGIN::saveLine().

GetMsgPanelInfo()

void STROKE_PARAMS::GetMsgPanelInfo	(	UNITS_PROVIDER *	aUnitsProvider,
		std::vector< MSG_PANEL_ITEM > &	aList,
		bool	aIncludeStyle = true,
		bool	aIncludeWidth = true
	)

Definition at line 193 of file stroke_params.cpp.

{
 if( aIncludeStyle )
 {
 wxString lineStyle = _( "Default" );
 
 for( const std::pair<const PLOT_DASH_TYPE, lineTypeStruct>& typeEntry : lineTypeNames )
 {
 if( typeEntry.first == GetPlotStyle() )
 {
 lineStyle = typeEntry.second.name;
 break;
 }
 }
 
 aList.emplace_back( _( "Line Style" ), lineStyle );
 }
 
 if( aIncludeWidth )
 aList.emplace_back( _( "Line Width" ), aUnitsProvider->MessageTextFromValue( GetWidth() ) );
}

References _, GetPlotStyle(), GetWidth(), lineTypeNames, and UNITS_PROVIDER::MessageTextFromValue().

Referenced by LIB_TEXTBOX::GetMsgPanelInfo(), SCH_LINE::GetMsgPanelInfo(), SCH_TEXTBOX::GetMsgPanelInfo(), FP_TEXTBOX::GetMsgPanelInfo(), PCB_TEXTBOX::GetMsgPanelInfo(), and EDA_SHAPE::ShapeGetMsgPanelInfo().

GetPlotStyle()

PLOT_DASH_TYPE STROKE_PARAMS::GetPlotStyle ( ) const

inline

Definition at line 101 of file stroke_params.h.

{ return m_plotstyle; }

References m_plotstyle.

Referenced by BOARD_ADAPTER::addShape(), KI_TEST::CheckFpShape(), EDA_SHAPE::Compare(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), Format(), LIB_SHAPE::GetEffectiveLineStyle(), SCH_LINE::GetEffectiveLineStyle(), SCH_SHAPE::GetEffectiveLineStyle(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_LINE::GetLineStyle(), GetMsgPanelInfo(), SCH_LINE::IsStrokeEquivalent(), DIALOG_GRAPHIC_ITEM_PROPERTIES::onFilledCheckbox(), SCH_TEXTBOX::Plot(), LIB_SHAPE::Plot(), LIB_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), LIB_TEXTBOX::print(), SCH_TEXTBOX::Print(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataToWindow(), DIALOG_LINE_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

GetWidth()

int STROKE_PARAMS::GetWidth ( ) const

inline

Definition at line 98 of file stroke_params.h.

{ return m_width; }

References m_width.

Referenced by KI_TEST::CheckFpShape(), EDA_SHAPE::Compare(), CONVERT_TOOL::CreatePolys(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), EDA_SHAPE::flip(), PCB_PLUGIN::format(), Format(), SCH_LINE::GetLineSize(), GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_SHAPE::GetPenWidth(), EDA_SHAPE::GetWidth(), SCH_LINE::IsStrokeEquivalent(), PCB_PARSER::parseFP_SHAPE(), PCB_PARSER::parsePCB_SHAPE(), SCH_SEXPR_PARSER::parseSheet(), DIALOG_LINE_PROPERTIES::TransferDataToWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataToWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

operator!=()

bool STROKE_PARAMS::operator!= ( const STROKE_PARAMS &  aOther )

inline

Definition at line 107 of file stroke_params.h.

 {
 return m_width != aOther.m_width
 || m_plotstyle != aOther.m_plotstyle
 || m_color != aOther.m_color;
 }

References m_color, m_plotstyle, and m_width.

SetColor()

void STROKE_PARAMS::SetColor ( const KIGFX::COLOR4D &  aColor )

inline

Definition at line 105 of file stroke_params.h.

{ m_color = aColor; }

References m_color.

Referenced by DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), STROKE_PARAMS_PARSER::ParseStroke(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_BUS_ENTRY_BASE::SetBusEntryColor(), SCH_LINE::SetLineColor(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

SetPlotStyle()

void STROKE_PARAMS::SetPlotStyle ( PLOT_DASH_TYPE  aPlotStyle )

inline

Definition at line 102 of file stroke_params.h.

{ m_plotstyle = aPlotStyle; }

References m_plotstyle.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), STROKE_PARAMS_PARSER::ParseStroke(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_LINE::SetLineStyle(), SCH_BUS_ENTRY_BASE::SetLineStyle(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

SetWidth()

void STROKE_PARAMS::SetWidth ( int  aWidth )

inline

Definition at line 99 of file stroke_params.h.

{ m_width = aWidth; }

References m_width.

Referenced by PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), PCB_PARSER::parseFP_SHAPE(), PCB_PARSER::parsePCB_SHAPE(), STROKE_PARAMS_PARSER::ParseStroke(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_LINE::SetLineWidth(), SCH_BUS_ENTRY_BASE::SetPenWidth(), EDA_SHAPE::SetWidth(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_LIB_TEXTBOX_PROPERTIES::TransferDataFromWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), DIALOG_GRAPHIC_ITEM_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVES_PROPERTIES::TransferDataFromWindow(), DIALOG_PAD_PRIMITIVE_POLY_PROPS::TransferDataFromWindow(), DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow(), and DIALOG_PAD_PRIMITIVES_TRANSFORM::Transform().

Stroke()

void STROKE_PARAMS::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  )

static

Definition at line 35 of file stroke_params.cpp.

{
 double strokes[6] = { aWidth * 1.0, aWidth * 1.0, aWidth * 1.0, aWidth * 1.0, aWidth * 1.0,
 aWidth * 1.0 };
 int wrapAround = 6;
 
 switch( aLineStyle )
 {
 case PLOT_DASH_TYPE::DASH:
 strokes[0] = aRenderSettings->GetDashLength( aWidth );
 strokes[1] = aRenderSettings->GetGapLength( aWidth );
 wrapAround = 2;
 break;
 case PLOT_DASH_TYPE::DOT:
 strokes[0] = aRenderSettings->GetDotLength( aWidth );
 strokes[1] = aRenderSettings->GetGapLength( aWidth );
 wrapAround = 2;
 break;
 case PLOT_DASH_TYPE::DASHDOT:
 strokes[0] = aRenderSettings->GetDashLength( aWidth );
 strokes[1] = aRenderSettings->GetGapLength( aWidth );
 strokes[2] = aRenderSettings->GetDotLength( aWidth );
 strokes[3] = aRenderSettings->GetGapLength( aWidth );
 wrapAround = 4;
 break;
 case PLOT_DASH_TYPE::DASHDOTDOT:
 strokes[0] = aRenderSettings->GetDashLength( aWidth );
 strokes[1] = aRenderSettings->GetGapLength( aWidth );
 strokes[2] = aRenderSettings->GetDotLength( aWidth );
 strokes[3] = aRenderSettings->GetGapLength( aWidth );
 strokes[4] = aRenderSettings->GetDotLength( aWidth );
 strokes[5] = aRenderSettings->GetGapLength( aWidth );
 wrapAround = 6;
 break;
 default:
 UNIMPLEMENTED_FOR( lineTypeNames.at( aLineStyle ).name );
 }
 
 switch( aShape->Type() )
 {
 case SH_SIMPLE:
 {
 const SHAPE_SIMPLE* poly = static_cast<const SHAPE_SIMPLE*>( aShape );
 
 for( size_t ii = 0; ii < poly->GetSegmentCount(); ++ii )
 {
 SEG seg = poly->GetSegment( ii );
 SHAPE_SEGMENT line( seg.A, seg.B );
 STROKE_PARAMS::Stroke( &line, aLineStyle, aWidth, aRenderSettings, aStroker );
 }
 }
 break;
 
 case SH_SEGMENT:
 {
 const SHAPE_SEGMENT* line = static_cast<const SHAPE_SEGMENT*>( aShape );
 
 VECTOR2D start = line->GetSeg().A;
 VECTOR2D end = line->GetSeg().B;
 BOX2I clip( start, VECTOR2I( end.x - start.x, end.y - start.y ) );
 clip.Normalize();
 
 double theta = atan2( end.y - start.y, end.x - start.x );
 
 for( size_t i = 0; i < 10000; ++i )
 {
 // Calculations MUST be done in doubles to keep from accumulating rounding
 // errors as we go.
 VECTOR2D next( start.x + strokes[ i % wrapAround ] * cos( theta ),
 start.y + strokes[ i % wrapAround ] * sin( theta ) );
 
 // Drawing each segment can be done rounded to ints.
 VECTOR2I a( KiROUND( start.x ), KiROUND( start.y ) );
 VECTOR2I b( KiROUND( next.x ), KiROUND( next.y ) );
 
 if( ClipLine( &clip, a.x, a.y, b.x, b.y ) )
 break;
 else if( i % 2 == 0 )
 aStroker( a, b );
 
 start = next;
 }
 }
 break;
 
 case SH_ARC:
 {
 const SHAPE_ARC* arc = static_cast<const SHAPE_ARC*>( aShape );
 
 double r = arc->GetRadius();
 double C = 2.0 * M_PI * r;
 VECTOR2I center = arc->GetCenter();
 VECTOR2D startRadial( arc->GetP0() - center );
 EDA_ANGLE startAngle( startRadial );
 VECTOR2D endRadial( arc->GetP1() - center );
 EDA_ANGLE arcEndAngle( endRadial );
 
 if( arcEndAngle == startAngle )
 arcEndAngle = startAngle + ANGLE_360; // ring, not null
 
 if( startAngle > arcEndAngle )
 {
 if( arcEndAngle < ANGLE_0 )
 arcEndAngle = arcEndAngle.Normalize();
 else
 startAngle = startAngle.Normalize() - ANGLE_360;
 }
 
 wxASSERT( startAngle < arcEndAngle );
 
 for( size_t i = 0; i < 10000 && startAngle < arcEndAngle; ++i )
 {
 EDA_ANGLE theta = ANGLE_360 * strokes[ i % wrapAround ] / C;
 EDA_ANGLE endAngle = std::min( startAngle + theta, arcEndAngle );
 
 if( i % 2 == 0 )
 {
 VECTOR2I a( center.x + r * startAngle.Cos(), center.y + r * startAngle.Sin() );
 VECTOR2I b( center.x + r * endAngle.Cos(), center.y + r * endAngle.Sin() );
 
 aStroker( a, b );
 }
 
 startAngle = endAngle;
 }
 }
 break;
 
 case SH_CIRCLE:
 // A circle is always filled; a ring is represented by a 360° arc.
 KI_FALLTHROUGH;
 
 default:
 UNIMPLEMENTED_FOR( SHAPE_TYPE_asString( aShape->Type() ) );
 }
}

References SEG::A, ANGLE_0, ANGLE_360, SEG::B, C, ClipLine(), EDA_ANGLE::Cos(), DASH, DASHDOT, DASHDOTDOT, DOT, SHAPE_ARC::GetCenter(), KIGFX::RENDER_SETTINGS::GetDashLength(), KIGFX::RENDER_SETTINGS::GetDotLength(), KIGFX::RENDER_SETTINGS::GetGapLength(), SHAPE_ARC::GetP0(), SHAPE_ARC::GetP1(), SHAPE_ARC::GetRadius(), SHAPE_SEGMENT::GetSeg(), SHAPE_SIMPLE::GetSegment(), SHAPE_SIMPLE::GetSegmentCount(), KI_FALLTHROUGH, KiROUND(), lineTypeNames, next(), EDA_ANGLE::Normalize(), BOX2< Vec >::Normalize(), r, SH_ARC, SH_CIRCLE, SH_SEGMENT, SH_SIMPLE, SHAPE_TYPE_asString(), EDA_ANGLE::Sin(), Stroke(), SHAPE_BASE::Type(), UNIMPLEMENTED_FOR, VECTOR2< T >::x, and VECTOR2< T >::y.

Referenced by BOARD_ADAPTER::addShape(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::draw(), BRDITEMS_PLOTTER::PlotFootprintShape(), BRDITEMS_PLOTTER::PlotPcbShape(), SCH_BUS_ENTRY_BASE::Print(), SCH_LINE::Print(), SCH_SHAPE::Print(), LIB_SHAPE::print(), LIB_TEXTBOX::print(), SCH_TEXTBOX::Print(), and Stroke().

Member Data Documentation

m_color

KIGFX::COLOR4D STROKE_PARAMS::m_color

private

Definition at line 130 of file stroke_params.h.

Referenced by GetColor(), operator!=(), and SetColor().

m_plotstyle

PLOT_DASH_TYPE STROKE_PARAMS::m_plotstyle

private

Definition at line 129 of file stroke_params.h.

Referenced by GetPlotStyle(), operator!=(), and SetPlotStyle().

m_width

int STROKE_PARAMS::m_width

private

Definition at line 128 of file stroke_params.h.

Referenced by GetWidth(), operator!=(), and SetWidth().

---

The documentation for this class was generated from the following files:

• stroke_params.h
• stroke_params.cpp