KiCad PCB EDA Suite
STROKE_PARAMS Class Reference

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

#include <sch_item.h>

Public Member Functions

 STROKE_PARAMS (int aWidth=Mils2iu(DEFAULT_LINE_THICKNESS), PLOT_DASH_TYPE aType=PLOT_DASH_TYPE::DEFAULT, const COLOR4D &aColor=COLOR4D::UNSPECIFIED)
 
int GetWidth () const
 
void SetWidth (int aWidth)
 
PLOT_DASH_TYPE GetType () const
 
void SetType (PLOT_DASH_TYPE aType)
 
COLOR4D GetColor () const
 
void SetColor (const COLOR4D &aColor)
 
bool operator!= (const STROKE_PARAMS &aOther)
 

Private Attributes

int m_width
 
PLOT_DASH_TYPE m_type
 
COLOR4D m_color
 

Detailed Description

Simple container to manage line stroke parameters.

Definition at line 153 of file sch_item.h.

Constructor & Destructor Documentation

◆ STROKE_PARAMS()

STROKE_PARAMS::STROKE_PARAMS ( int  aWidth = Mils2iu( DEFAULT_LINE_THICKNESS ),
PLOT_DASH_TYPE  aType = PLOT_DASH_TYPE::DEFAULT,
const COLOR4D aColor = COLOR4D::UNSPECIFIED 
)
inline

Definition at line 160 of file sch_item.h.

162  :
163  m_width( aWidth ),
164  m_type( aType ),
165  m_color( aColor )
166  {
167  }
PLOT_DASH_TYPE m_type
Definition: sch_item.h:156
COLOR4D m_color
Definition: sch_item.h:157

Member Function Documentation

◆ GetColor()

COLOR4D STROKE_PARAMS::GetColor ( ) const
inline

◆ GetType()

PLOT_DASH_TYPE STROKE_PARAMS::GetType ( ) const
inline

◆ GetWidth()

◆ operator!=()

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

Definition at line 178 of file sch_item.h.

179  {
180  return m_width != aOther.m_width
181  || m_type != aOther.m_type
182  || m_color != aOther.m_color;
183  }
PLOT_DASH_TYPE m_type
Definition: sch_item.h:156
COLOR4D m_color
Definition: sch_item.h:157

References m_color, m_type, and m_width.

◆ SetColor()

void STROKE_PARAMS::SetColor ( const COLOR4D aColor)
inline

◆ SetType()

void STROKE_PARAMS::SetType ( PLOT_DASH_TYPE  aType)
inline

◆ SetWidth()

void STROKE_PARAMS::SetWidth ( int  aWidth)
inline

Member Data Documentation

◆ m_color

COLOR4D STROKE_PARAMS::m_color
private

Definition at line 157 of file sch_item.h.

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

◆ m_type

PLOT_DASH_TYPE STROKE_PARAMS::m_type
private

Definition at line 156 of file sch_item.h.

Referenced by GetType(), operator!=(), and SetType().

◆ m_width

int STROKE_PARAMS::m_width
private

Definition at line 155 of file sch_item.h.

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


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