KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | List of all members
STROKE_PARAMS Class Reference

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

#include <stroke_params.h>

Public Member Functions

 STROKE_PARAMS (int aWidth=0, LINE_STYLE aLineStyle=LINE_STYLE::DEFAULT, const KIGFX::COLOR4D &aColor=KIGFX::COLOR4D::UNSPECIFIED)
 
int GetWidth () const
 
void SetWidth (int aWidth)
 
LINE_STYLE GetLineStyle () const
 
void SetLineStyle (LINE_STYLE aLineStyle)
 
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 (LINE_STYLE aStyle)
 
static void Stroke (const SHAPE *aShape, LINE_STYLE aLineStyle, int aWidth, const KIGFX::RENDER_SETTINGS *aRenderSettings, const std::function< void(const VECTOR2I &a, const VECTOR2I &b)> &aStroker)
 

Private Attributes

int m_width
 
LINE_STYLE m_lineStyle
 
KIGFX::COLOR4D m_color
 

Detailed Description

Simple container to manage line stroke parameters.

Definition at line 80 of file stroke_params.h.

Constructor & Destructor Documentation

◆ STROKE_PARAMS()

STROKE_PARAMS::STROKE_PARAMS ( int  aWidth = 0,
LINE_STYLE  aLineStyle = LINE_STYLE::DEFAULT,
const KIGFX::COLOR4D &  aColor = KIGFX::COLOR4D::UNSPECIFIED 
)
inline

Definition at line 83 of file stroke_params.h.

Member Function Documentation

◆ Format()

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

Definition at line 247 of file stroke_params.cpp.

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

Referenced by PCB_IO_KICAD_SEXPR::format(), formatArc(), formatBezier(), formatCircle(), formatPoly(), formatRect(), SCH_IO_KICAD_SEXPR::saveBusEntry(), SCH_IO_KICAD_SEXPR::saveLine(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_IO_KICAD_SEXPR::saveTable(), SCH_IO_KICAD_SEXPR::saveTextBox(), and SCH_IO_KICAD_SEXPR_LIB_CACHE::saveTextBox().

◆ GetColor()

KIGFX::COLOR4D STROKE_PARAMS::GetColor ( ) const
inline

Definition at line 97 of file stroke_params.h.

References m_color.

Referenced by KIGFX::SCH_PAINTER::draw(), Format(), SCH_TABLE::GetBorderColor(), PCB_TABLE::GetBorderColor(), SCH_BUS_ENTRY_BASE::GetBusEntryColor(), SCH_LINE::GetLineColor(), EDA_SHAPE::GetLineColor(), KIGFX::SCH_PAINTER::getRenderColor(), SCH_TABLE::GetSeparatorsColor(), PCB_TABLE::GetSeparatorsColor(), SCH_LINE::IsStrokeEquivalent(), SCH_LINE::operator==(), SCH_IO_ALTIUM::ParsePolygon(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_TEXTBOX::Plot(), SCH_SHAPE::Print(), SCH_TEXTBOX::Print(), SetLibShapeFillAndColor(), SCH_LINE::Similarity(), DIALOG_LINE_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), and DIALOG_WIRE_BUS_PROPERTIES::TransferDataToWindow().

◆ GetLineStyle()

LINE_STYLE STROKE_PARAMS::GetLineStyle ( ) const
inline

Definition at line 94 of file stroke_params.h.

References m_lineStyle.

Referenced by BOARD_ADAPTER::addShape(), PCB_IO_IPC2581::addShape(), KI_TEST::CheckFpShape(), EDA_SHAPE::Compare(), KIGFX::PCB_PAINTER::draw(), Format(), SCH_TABLE::GetBorderStyle(), PCB_TABLE::GetBorderStyle(), SCH_LINE::GetEffectiveLineStyle(), SCH_SHAPE::GetEffectiveLineStyle(), SCH_BUS_ENTRY_BASE::GetLineStyle(), SCH_LINE::GetLineStyle(), EDA_SHAPE::GetLineStyle(), GetMsgPanelInfo(), SCH_TABLE::GetSeparatorsStyle(), PCB_TABLE::GetSeparatorsStyle(), SCH_LINE::IsStrokeEquivalent(), DIALOG_SHAPE_PROPERTIES::onFilledCheckbox(), EDA_SHAPE::operator==(), SCH_LINE::operator==(), SCH_IO_KICAD_SEXPR_PARSER::parseSchPolyLine(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_TEXTBOX::Plot(), BRDITEMS_PLOTTER::PlotShape(), SCH_TEXTBOX::Print(), EDA_SHAPE::Similarity(), SCH_LINE::Similarity(), DIALOG_LINE_PROPERTIES::TransferDataToWindow(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), DIALOG_TEXT_PROPERTIES::TransferDataToWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ GetLineStyleToken()

wxString STROKE_PARAMS::GetLineStyleToken ( LINE_STYLE  aStyle)
static

Definition at line 204 of file stroke_params.cpp.

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

◆ GetMsgPanelInfo()

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

Definition at line 222 of file stroke_params.cpp.

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

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

◆ GetWidth()

int STROKE_PARAMS::GetWidth ( ) const
inline

Definition at line 91 of file stroke_params.h.

References m_width.

Referenced by PCB_IO_IPC2581::addShape(), FOOTPRINT::BuildCourtyardCaches(), KI_TEST::CheckFpShape(), EDA_SHAPE::Compare(), CONVERT_TOOL::CreatePolys(), KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), EDA_SHAPE::flip(), Format(), SCH_TABLE::GetBorderWidth(), PCB_TABLE::GetBorderWidth(), PCB_TEXTBOX::GetBorderWidth(), PCB_TABLE::GetEffectiveShape(), SCH_LINE::GetLineWidth(), GetMsgPanelInfo(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_SHAPE::GetPenWidth(), SCH_TABLE::GetSeparatorsWidth(), PCB_TABLE::GetSeparatorsWidth(), EDA_SHAPE::GetWidth(), SCH_LINE::IsStrokeEquivalent(), EDA_SHAPE::operator==(), SCH_LINE::operator==(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_SHAPE(), SCH_IO_KICAD_SEXPR_PARSER::parseSheet(), PCB_IO_KICAD_SEXPR_PARSER::parseTextBoxContent(), SCH_TABLE::Plot(), BRDITEMS_PLOTTER::PlotTableBorders(), SetLibShapeFillAndColor(), EDA_SHAPE::Similarity(), SCH_LINE::Similarity(), DIALOG_LINE_PROPERTIES::TransferDataToWindow(), DIALOG_TABLE_PROPERTIES::TransferDataToWindow(), DIALOG_WIRE_BUS_PROPERTIES::TransferDataToWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataToWindow().

◆ operator!=()

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

Definition at line 100 of file stroke_params.h.

References m_color, m_lineStyle, and m_width.

◆ SetColor()

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

Definition at line 98 of file stroke_params.h.

References m_color.

Referenced by SCH_EASYEDAPRO_PARSER::ApplyLineStyle(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), STROKE_PARAMS_PARSER::ParseStroke(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRAWING_TOOL::Reset(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_TABLE::SetBorderColor(), PCB_TABLE::SetBorderColor(), SCH_BUS_ENTRY_BASE::SetBusEntryColor(), SCH_LINE::SetLineColor(), EDA_SHAPE::SetLineColor(), SCH_TABLE::SetSeparatorsColor(), PCB_TABLE::SetSeparatorsColor(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXT_PROPERTIES::TransferDataFromWindow().

◆ SetLineStyle()

void STROKE_PARAMS::SetLineStyle ( LINE_STYLE  aLineStyle)
inline

Definition at line 95 of file stroke_params.h.

References m_lineStyle.

Referenced by SCH_EASYEDAPRO_PARSER::ApplyLineStyle(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::drawShape(), SCH_IO_ALTIUM::ParsePolyline(), SCH_IO_KICAD_SEXPR_PARSER::parseSchPolyLine(), STROKE_PARAMS_PARSER::ParseStroke(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRAWING_TOOL::Reset(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_TABLE::SetBorderStyle(), PCB_TABLE::SetBorderStyle(), SCH_LINE::SetLineStyle(), EDA_SHAPE::SetLineStyle(), SCH_BUS_ENTRY_BASE::SetLineStyle(), SCH_TABLE::SetSeparatorsStyle(), PCB_TABLE::SetSeparatorsStyle(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ SetWidth()

void STROKE_PARAMS::SetWidth ( int  aWidth)
inline

Definition at line 92 of file stroke_params.h.

References m_width.

Referenced by SCH_EASYEDAPRO_PARSER::ApplyLineStyle(), PANEL_EESCHEMA_COLOR_SETTINGS::createPreviewItems(), DRAWING_TOOL::drawArc(), DRAWING_TOOL::DrawDimension(), DRAWING_TOOL::drawShape(), PCB_IO_KICAD_SEXPR_PARSER::parsePCB_SHAPE(), SCH_IO_ALTIUM::ParsePolygon(), STROKE_PARAMS_PARSER::ParseStroke(), DIALOG_GLOBAL_EDIT_TEXT_AND_GRAPHICS::processItem(), DRAWING_TOOL::Reset(), DRC_TEST_PROVIDER_EDGE_CLEARANCE::Run(), SCH_IO_KICAD_SEXPR::saveSheet(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), PCB_TEXTBOX::SetBorderWidth(), SCH_TABLE::SetBorderWidth(), PCB_TABLE::SetBorderWidth(), SetLibShapeFillAndColor(), SCH_LINE::SetLineWidth(), SCH_BUS_ENTRY_BASE::SetPenWidth(), SCH_TABLE::SetSeparatorsWidth(), PCB_TABLE::SetSeparatorsWidth(), EDA_SHAPE::SetWidth(), PCB_SHAPE::StyleFromSettings(), DIALOG_SHAPE_PROPERTIES::TransferDataFromWindow(), DIALOG_TABLE_PROPERTIES::TransferDataFromWindow(), DIALOG_TEXT_PROPERTIES::TransferDataFromWindow(), and DIALOG_TEXTBOX_PROPERTIES::TransferDataFromWindow().

◆ Stroke()

void STROKE_PARAMS::Stroke ( const SHAPE *  aShape,
LINE_STYLE  aLineStyle,
int  aWidth,
const KIGFX::RENDER_SETTINGS *  aRenderSettings,
const std::function< void(const VECTOR2I &a, const VECTOR2I &b)> &  aStroker 
)
static

Definition at line 45 of file stroke_params.cpp.

References SEG::A, ANGLE_0, ANGLE_360, SEG::B, ClipLine(), EDA_ANGLE::Cos(), 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_LINE_CHAIN::GetSegment(), SHAPE_SIMPLE::GetSegment(), SHAPE_SIMPLE::GetSegmentCount(), KI_FALLTHROUGH, KiROUND(), lineTypeNames, next(), EDA_ANGLE::Normalize(), BOX2< Vec >::Normalize(), SHAPE_LINE_CHAIN::SegmentCount(), SH_ARC, SH_CIRCLE, SH_RECT, 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::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), BRDITEMS_PLOTTER::PlotShape(), BRDITEMS_PLOTTER::PlotTableBorders(), SCH_BUS_ENTRY_BASE::Print(), SCH_LINE::Print(), SCH_SHAPE::Print(), SCH_TABLE::Print(), SCH_TEXTBOX::Print(), and Stroke().

Member Data Documentation

◆ m_color

KIGFX::COLOR4D STROKE_PARAMS::m_color
private

Definition at line 123 of file stroke_params.h.

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

◆ m_lineStyle

LINE_STYLE STROKE_PARAMS::m_lineStyle
private

Definition at line 122 of file stroke_params.h.

Referenced by GetLineStyle(), operator!=(), and SetLineStyle().

◆ m_width

int STROKE_PARAMS::m_width
private

Definition at line 121 of file stroke_params.h.

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

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