KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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.

Member Function Documentation

◆ Format()

◆ GetColor()

◆ GetLineStyleToken()

wxString STROKE_PARAMS::GetLineStyleToken ( PLOT_DASH_TYPE  aStyle)
static

Definition at line 175 of file stroke_params.cpp.

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 
)

◆ GetPlotStyle()

◆ GetWidth()

◆ operator!=()

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

Definition at line 107 of file stroke_params.h.

References m_color, m_plotstyle, and m_width.

◆ SetColor()

◆ SetPlotStyle()

◆ SetWidth()

◆ 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: