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_WIDTH_MILS), PLOT_DASH_TYPE aPlotStyle=PLOT_DASH_TYPE::DEFAULT, const COLOR4D &aColor=COLOR4D::UNSPECIFIED)
int	GetWidth () const
void	SetWidth (int aWidth)
PLOT_DASH_TYPE	GetPlotStyle () const
void	SetPlotStyle (PLOT_DASH_TYPE aPlotStyle)
COLOR4D	GetColor () const
void	SetColor (const COLOR4D &aColor)
bool	operator!= (const STROKE_PARAMS &aOther)

Private Attributes
int	m_width
PLOT_DASH_TYPE	m_plotstyle
COLOR4D	m_color

Detailed Description

Simple container to manage line stroke parameters.

Definition at line 151 of file sch_item.h.

Constructor & Destructor Documentation

STROKE_PARAMS()

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

inline

Definition at line 154 of file sch_item.h.

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

Member Function Documentation

GetColor()

COLOR4D STROKE_PARAMS::GetColor ( ) const

inline

Definition at line 169 of file sch_item.h.

{ return m_color; }

References m_color.

Referenced by formatStroke(), SCH_LINE::GetLineColor(), SCH_BUS_ENTRY_BASE::GetStrokeColor(), SCH_LINE::IsStrokeEquivalent(), SCH_SEXPR_PARSER::parseSheet(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow(), and SCH_LINE::UsesDefaultStroke().

GetPlotStyle()

PLOT_DASH_TYPE STROKE_PARAMS::GetPlotStyle ( ) const

inline

Definition at line 166 of file sch_item.h.

{ return m_plotstyle; }

References m_plotstyle.

Referenced by formatStroke(), SCH_LINE::GetEffectiveLineStyle(), SCH_LINE::GetLineStyle(), SCH_BUS_ENTRY_BASE::GetStrokeStyle(), SCH_LINE::IsStrokeEquivalent(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow(), and SCH_LINE::UsesDefaultStroke().

GetWidth()

int STROKE_PARAMS::GetWidth ( ) const

inline

Definition at line 163 of file sch_item.h.

{ return m_width; }

References m_width.

Referenced by formatStroke(), SCH_LINE::GetBoundingBox(), SCH_LINE::GetLineSize(), SCH_BUS_WIRE_ENTRY::GetPenWidth(), SCH_LINE::GetPenWidth(), SCH_BUS_BUS_ENTRY::GetPenWidth(), SCH_LINE::IsStrokeEquivalent(), SCH_SEXPR_PARSER::parseSheet(), SCH_LINE::Plot(), DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataToWindow(), and SCH_LINE::UsesDefaultStroke().

operator!=()

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

inline

Definition at line 172 of file sch_item.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 COLOR4D &  aColor )

inline

Definition at line 170 of file sch_item.h.

{ m_color = aColor; }

References m_color.

Referenced by SCH_SEXPR_PARSER::parseStroke(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_LINE::SetLineColor(), SCH_BUS_ENTRY_BASE::SetStrokeColor(), and DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataFromWindow().

SetPlotStyle()

void STROKE_PARAMS::SetPlotStyle ( PLOT_DASH_TYPE  aPlotStyle )

inline

Definition at line 167 of file sch_item.h.

{ m_plotstyle = aPlotStyle; }

References m_plotstyle.

Referenced by SCH_SEXPR_PARSER::parseStroke(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_LINE::SetLineStyle(), SCH_BUS_ENTRY_BASE::SetStrokeStyle(), and DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataFromWindow().

SetWidth()

void STROKE_PARAMS::SetWidth ( int  aWidth )

inline

Definition at line 164 of file sch_item.h.

{ m_width = aWidth; }

References m_width.

Referenced by SCH_SEXPR_PARSER::parseStroke(), SCH_SEXPR_PLUGIN::saveSheet(), SCH_BUS_ENTRY_BASE::SCH_BUS_ENTRY_BASE(), SCH_LINE::SCH_LINE(), SCH_LINE::SetLineWidth(), SCH_BUS_ENTRY_BASE::SetPenWidth(), and DIALOG_LINE_WIRE_BUS_PROPERTIES::TransferDataFromWindow().

Member Data Documentation

m_color

COLOR4D STROKE_PARAMS::m_color

private

Definition at line 182 of file sch_item.h.

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

m_plotstyle

PLOT_DASH_TYPE STROKE_PARAMS::m_plotstyle

private

Definition at line 181 of file sch_item.h.

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

m_width

int STROKE_PARAMS::m_width

private

Definition at line 180 of file sch_item.h.

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

---

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

• sch_item.h