PCB specific render settings. More...

#include <pcb_painter.h>

Inheritance diagram for KIGFX::PCB_RENDER_SETTINGS:

Public Member Functions
	PCB_RENDER_SETTINGS ()

void	LoadDisplayOptions (const PCB_DISPLAY_OPTIONS &aOptions)
	Load settings related to display options (high-contrast mode, full or outline modes for vias/pads/tracks and so on). More...

void	LoadColors (const COLOR_SETTINGS *aSettings) override

COLOR4D	GetColor (const VIEW_ITEM *aItem, int aLayer) const override
	Returns the color that should be used to draw the specific VIEW_ITEM on the specific layer using currently used render settings. More...

bool	GetShowPageLimits () const override

bool	IsBackgroundDark () const override

const COLOR4D &	GetBackgroundColor () const override
	Return current background color settings. More...

void	SetBackgroundColor (const COLOR4D &aColor) override
	Set the background color. More...

const COLOR4D &	GetGridColor () override
	Return current grid color settings. More...

const COLOR4D &	GetCursorColor () override
	Return current cursor color settings. More...

NET_COLOR_MODE	GetNetColorMode () const

void	SetNetColorMode (NET_COLOR_MODE aMode)

std::map< wxString, KIGFX::COLOR4D > &	GetNetclassColorMap ()

std::map< int, KIGFX::COLOR4D > &	GetNetColorMap ()

std::set< int > &	GetHiddenNets ()

const std::set< int > &	GetHiddenNets () const

void	SetLayerIsHighContrast (int aLayerId, bool aEnabled=true)
	Set the specified layer as high-contrast. More...

bool	GetLayerIsHighContrast (int aLayerId) const
	Return information whether the queried layer is marked as high-contrast. More...

const std::set< int >	GetHighContrastLayers () const
	Returns the set of currently high-contrast layers. More...

PCB_LAYER_ID	GetPrimaryHighContrastLayer () const
	Return the board layer which is in high-contrast mode. More...

PCB_LAYER_ID	GetActiveLayer () const

void	SetActiveLayer (PCB_LAYER_ID aLayer)

const wxString &	GetLayerName () const

void	SetLayerName (const wxString &aLayerName)

LSET	GetPrintLayers () const

void	SetPrintLayers (LSET aLayerSet)

void	ClearHighContrastLayers ()
	Clear the list of active layers. More...

bool	IsHighlightEnabled () const
	Return current highlight setting. More...

const std::set< int > &	GetHighlightNetCodes () const
	Return the netcode of currently highlighted net. More...

void	SetHighlight (bool aEnabled, int aNetcode=-1, bool aMulti=false)
	Turns on/off highlighting. More...

void	SetHighlight (std::set< int > &aHighlight, bool aEnabled=true)
	Turns on highlighting and highlights multiple nets. More...

void	SetHighContrast (bool aEnabled)
	Turns on/off high contrast display mode. More...

bool	GetHighContrast () const

void	SetDrawBoundingBoxes (bool aEnabled)

bool	GetDrawBoundingBoxes () const

float	GetDrawingSheetLineWidth () const

int	GetDefaultPenWidth () const

void	SetDefaultPenWidth (int aWidth)

int	GetMinPenWidth () const

void	SetMinPenWidth (int aWidth)

double	GetDashLengthRatio () const

void	SetDashLengthRatio (double aRatio)

double	GetDashLength (int aLineWidth) const

double	GetDotLength (int aLineWidth) const

double	GetGapLengthRatio () const

void	SetGapLengthRatio (double aRatio)

double	GetGapLength (int aLineWidth) const

bool	IsPrinting () const

void	SetIsPrinting (bool isPrinting)

const COLOR4D &	GetLayerColor (int aLayer) const
	Return the color used to draw a layer. More...

void	SetLayerColor (int aLayer, const COLOR4D &aColor)
	Change the color used to draw a layer. More...

void	SetOutlineWidth (float aWidth)
	Set line width used for drawing outlines. More...

void	SetHighlightFactor (float aFactor)

void	SetSelectFactor (float aFactor)

void	SetDefaultFont (const wxString &aFont)

const wxString &	GetDefaultFont () const

wxDC *	GetPrintDC () const

void	SetPrintDC (wxDC *aDC)

Public Attributes
bool	m_ForcePadSketchModeOn

ZONE_DISPLAY_MODE	m_ZoneDisplayMode

HIGH_CONTRAST_MODE	m_ContrastModeDisplay

PAD *	m_PadEditModePad

Protected Member Functions
virtual void	update ()
	Precalculates extra colors for layers (e.g. More...

Protected Attributes
NET_COLOR_MODE	m_netColorMode
	Overrides for specific netclass colors. More...

std::map< wxString, KIGFX::COLOR4D >	m_netclassColors
	Overrides for specific net colors, stored as netcodes for the ratsnest to access easily. More...

std::map< int, KIGFX::COLOR4D >	m_netColors
	Set of net codes that should not have their ratsnest displayed. More...

std::set< int >	m_hiddenNets

double	m_trackOpacity
	Opacity override for all tracks. More...

double	m_viaOpacity
	Opacity override for all types of via. More...

double	m_padOpacity
	Opacity override for SMD pads and PTHs. More...

double	m_zoneOpacity
	Opacity override for filled zones. More...

double	m_imageOpacity
	Opacity override for user images. More...

PCB_LAYER_ID	m_activeLayer

wxString	m_layerName

std::set< int >	m_highContrastLayers

COLOR4D	m_layerColors [LAYER_ID_COUNT]

COLOR4D	m_layerColorsHi [LAYER_ID_COUNT]

COLOR4D	m_layerColorsSel [LAYER_ID_COUNT]

COLOR4D	m_hiContrastColor [LAYER_ID_COUNT]

COLOR4D	m_layerColorsDark [LAYER_ID_COUNT]

COLOR4D	m_backgroundColor

bool	m_hiContrastEnabled
	Parameters for display modes. More...

float	m_hiContrastFactor

bool	m_highlightEnabled

std::set< int >	m_highlightNetcodes

float	m_highlightFactor

bool	m_drawBoundingBoxes

float	m_selectFactor

float	m_outlineWidth

float	m_drawingSheetLineWidth

int	m_defaultPenWidth

int	m_minPenWidth

double	m_dashLengthRatio

double	m_gapLengthRatio

wxString	m_defaultFont

bool	m_isPrinting

LSET	m_printLayers

wxDC *	m_printDC

Static Protected Attributes
static const double	MAX_FONT_SIZE = pcbIUScale.mmToIU( 10.0 )
	< Maximum font size for netnames (and other dynamically shown strings) More...

Friends
class	PCB_PAINTER

Detailed Description

PCB specific render settings.

Definition at line 71 of file pcb_painter.h.

Constructor & Destructor Documentation

◆ PCB_RENDER_SETTINGS()

PCB_RENDER_SETTINGS::PCB_RENDER_SETTINGS ( )

Definition at line 101 of file pcb_painter.cpp.

{
 m_backgroundColor = COLOR4D( 0.0, 0.0, 0.0, 1.0 );
 m_ZoneDisplayMode = ZONE_DISPLAY_MODE::SHOW_FILLED;
 m_netColorMode = NET_COLOR_MODE::RATSNEST;
 m_ContrastModeDisplay = HIGH_CONTRAST_MODE::NORMAL;
 
 m_trackOpacity = 1.0;
 m_viaOpacity = 1.0;
 m_padOpacity = 1.0;
 m_zoneOpacity = 1.0;
 m_imageOpacity = 1.0;
 
 m_ForcePadSketchModeOn = false;
 
 m_PadEditModePad = nullptr;
 
 SetDashLengthRatio( 12 ); // From ISO 128-2
 SetGapLengthRatio( 3 ); // From ISO 128-2
 
 update();
}

References KIGFX::RENDER_SETTINGS::m_backgroundColor, m_ContrastModeDisplay, m_ForcePadSketchModeOn, m_imageOpacity, m_netColorMode, m_PadEditModePad, m_padOpacity, m_trackOpacity, m_viaOpacity, m_ZoneDisplayMode, m_zoneOpacity, NORMAL, RATSNEST, KIGFX::RENDER_SETTINGS::SetDashLengthRatio(), KIGFX::RENDER_SETTINGS::SetGapLengthRatio(), SHOW_FILLED, and KIGFX::RENDER_SETTINGS::update().

Member Function Documentation

◆ ClearHighContrastLayers()

void KIGFX::RENDER_SETTINGS::ClearHighContrastLayers ( )

inlineinherited

Clear the list of active layers.

Definition at line 124 of file render_settings.h.

 {
 m_highContrastLayers.clear();
 }

References KIGFX::RENDER_SETTINGS::m_highContrastLayers.

Referenced by EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), and PCB_DRAW_PANEL_GAL::SetHighContrastLayer().

◆ GetActiveLayer()

PCB_LAYER_ID KIGFX::RENDER_SETTINGS::GetActiveLayer ( ) const

inlineinherited

Definition at line 112 of file render_settings.h.

112{ return m_activeLayer; }

KIGFX::RENDER_SETTINGS::m_activeLayer

PCB_LAYER_ID m_activeLayer

Definition: render_settings.h:308

References KIGFX::RENDER_SETTINGS::m_activeLayer.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ GetBackgroundColor()

const COLOR4D & KIGFX::PCB_RENDER_SETTINGS::GetBackgroundColor ( ) const

inlineoverridevirtual

Return current background color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 100 of file pcb_painter.h.

100{ return m_layerColors[ LAYER_PCB_BACKGROUND ]; }

KIGFX::RENDER_SETTINGS::m_layerColors

COLOR4D m_layerColors[LAYER_ID_COUNT]

Definition: render_settings.h:312

LAYER_PCB_BACKGROUND

@ LAYER_PCB_BACKGROUND

PCB background color.

Definition: layer_ids.h:220

References LAYER_PCB_BACKGROUND, and KIGFX::RENDER_SETTINGS::m_layerColors.

Referenced by FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor().

◆ GetColor()

COLOR4D PCB_RENDER_SETTINGS::GetColor	(	const VIEW_ITEM *	aItem,
		int	aLayer
	)		const

overridevirtual

Returns the color that should be used to draw the specific VIEW_ITEM on the specific layer using currently used render settings.

Parameters

aItem	is the VIEW_ITEM.
aLayer	is the layer.

Returns: The color.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 189 of file pcb_painter.cpp.

{
 const EDA_ITEM* item = dynamic_cast<const EDA_ITEM*>( aItem );
 const BOARD_CONNECTED_ITEM* conItem = dynamic_cast<const BOARD_CONNECTED_ITEM*> ( aItem );
 int netCode = -1;
 int originalLayer = aLayer;
 
 // Marker shadows
 if( aLayer == LAYER_MARKER_SHADOWS )
 return m_backgroundColor.WithAlpha( 0.6 );
 
 if( IsHoleLayer( aLayer ) && m_isPrinting )
 {
 // Careful that we don't end up with the same colour for the annular ring and the hole
 // when printing in B&W.
 const PAD* pad = dynamic_cast<const PAD*>( item );
 const PCB_VIA* via = dynamic_cast<const PCB_VIA*>( item );
 int holeLayer = aLayer;
 int annularRingLayer = UNDEFINED_LAYER;
 
 if( pad && pad->GetAttribute() == PAD_ATTRIB::PTH )
 annularRingLayer = LAYER_PADS_TH;
 else if( via && via->GetViaType() == VIATYPE::MICROVIA )
 annularRingLayer = LAYER_VIA_MICROVIA;
 else if( via && via->GetViaType() == VIATYPE::BLIND_BURIED )
 annularRingLayer = LAYER_VIA_BBLIND;
 else if( via && via->GetViaType() == VIATYPE::THROUGH )
 annularRingLayer = LAYER_VIA_THROUGH;
 
 if( annularRingLayer != UNDEFINED_LAYER
 && m_layerColors[ holeLayer ] == m_layerColors[ annularRingLayer ] )
 {
 aLayer = LAYER_PCB_BACKGROUND;
 }
 }
 
 // Zones should pull from the copper layer
 if( item && ( item->Type() == PCB_ZONE_T || item->Type() == PCB_FP_ZONE_T ) )
 {
 if( IsZoneFillLayer( aLayer ) )
 aLayer = aLayer - LAYER_ZONE_START;
 }
 
 // Hole walls should pull from the copper layer
 if( aLayer == LAYER_PAD_HOLEWALLS )
 aLayer = LAYER_PADS_TH;
 else if( aLayer == LAYER_VIA_HOLEWALLS )
 aLayer = LAYER_VIA_THROUGH;
 
 // Normal path: get the layer base color
 COLOR4D color = m_layerColors[aLayer];
 
 if( !item )
 return m_layerColors[aLayer];
 
 // Selection disambiguation
 if( item->IsBrightened() )
 return color.Brightened( m_selectFactor ).WithAlpha( 0.8 );
 
 // Normal selection
 if( item->IsSelected() )
 color = m_layerColorsSel[aLayer];
 
 // Try to obtain the netcode for the item
 if( conItem )
 netCode = conItem->GetNetCode();
 
 bool highlighted = m_highlightEnabled && m_highlightNetcodes.count( netCode );
 bool selected = item->IsSelected();
 
 // Apply net color overrides
 if( conItem && m_netColorMode == NET_COLOR_MODE::ALL && IsNetCopperLayer( aLayer ) )
 {
 COLOR4D netColor = COLOR4D::UNSPECIFIED;
 
 auto ii = m_netColors.find( netCode );
 
 if( ii != m_netColors.end() )
 netColor = ii->second;
 
 if( netColor == COLOR4D::UNSPECIFIED )
 {
 auto jj = m_netclassColors.find( conItem->GetNetClassName() );
 
 if( jj != m_netclassColors.end() )
 netColor = jj->second;
 }
 
 if( netColor == COLOR4D::UNSPECIFIED )
 netColor = color;
 
 if( selected )
 {
 // Selection brightening overrides highlighting
 netColor.Brighten( m_selectFactor );
 }
 else if( m_highlightEnabled )
 {
 // Highlight brightens objects on all layers and darkens everything else for contrast
 if( highlighted )
 netColor.Brighten( m_highlightFactor );
 else
 netColor.Darken( 1.0 - m_highlightFactor );
 }
 
 color = netColor;
 }
 else if( !selected && m_highlightEnabled )
 {
 // Single net highlight mode
 color = m_highlightNetcodes.count( netCode ) ? m_layerColorsHi[aLayer]
 : m_layerColorsDark[aLayer];
 }
 
 // Apply high-contrast dimming
 if( m_hiContrastEnabled && m_highContrastLayers.size() && !highlighted && !selected )
 {
 PCB_LAYER_ID primary = GetPrimaryHighContrastLayer();
 bool isActive = m_highContrastLayers.count( aLayer );
 bool hide = false;
 
 switch( originalLayer )
 {
 case LAYER_PADS_TH:
 {
 const PAD* pad = static_cast<const PAD*>( item );
 
 if( !pad->FlashLayer( primary ) )
 {
 isActive = false;
 
 if( IsCopperLayer( primary ) )
 hide = true;
 }
 
 if( m_PadEditModePad && pad != m_PadEditModePad )
 isActive = false;
 
 break;
 }
 
 case LAYER_VIA_BBLIND:
 case LAYER_VIA_MICROVIA:
 {
 const PCB_VIA* via = static_cast<const PCB_VIA*>( item );
 
 // Target graphic is active if the via crosses the primary layer
 if( via->GetLayerSet().test( primary ) == 0 )
 {
 isActive = false;
 hide = true;
 }
 
 break;
 }
 
 case LAYER_VIA_THROUGH:
 {
 const PCB_VIA* via = static_cast<const PCB_VIA*>( item );
 
 if( !via->FlashLayer( primary ) )
 {
 isActive = false;
 
 if( IsCopperLayer( primary ) )
 hide = true;
 }
 
 break;
 }
 
 case LAYER_PAD_PLATEDHOLES:
 case LAYER_PAD_HOLEWALLS:
 case LAYER_NON_PLATEDHOLES:
 // Pad holes are active is any physical layer is active
 if( LSET::PhysicalLayersMask().test( primary ) == 0 )
 isActive = false;
 
 break;
 
 case LAYER_VIA_HOLES:
 case LAYER_VIA_HOLEWALLS:
 {
 const PCB_VIA* via = static_cast<const PCB_VIA*>( item );
 
 if( via->GetViaType() == VIATYPE::BLIND_BURIED
 || via->GetViaType() == VIATYPE::MICROVIA )
 {
 // A blind or micro via's hole is active if it crosses the primary layer
 if( via->GetLayerSet().test( primary ) == 0 )
 isActive = false;
 }
 else
 {
 // A through via's hole is active if any physical layer is active
 if( LSET::PhysicalLayersMask().test( primary ) == 0 )
 isActive = false;
 }
 
 break;
 }
 
 default:
 break;
 }
 
 if( !isActive )
 {
 if( m_ContrastModeDisplay == HIGH_CONTRAST_MODE::HIDDEN
 || IsNetnameLayer( aLayer )
 || hide )
 {
 color = COLOR4D::CLEAR;
 }
 else
 {
 color = color.Mix( m_layerColors[LAYER_PCB_BACKGROUND], m_hiContrastFactor );
 
 // Bitmaps can't have their color mixed so just reduce the opacity a bit so they
 // show through less
 if( item->Type() == PCB_BITMAP_T )
 color.a *= m_hiContrastFactor;
 }
 }
 }
 else if( originalLayer == LAYER_VIA_BBLIND || originalLayer == LAYER_VIA_MICROVIA )
 {
 const PCB_VIA* via = static_cast<const PCB_VIA*>( item );
 const BOARD* board = via->GetBoard();
 LSET visibleLayers = board->GetVisibleLayers() & board->GetEnabledLayers();
 
 // Target graphic is visible if the via crosses a visible layer
 if( ( via->GetLayerSet() & visibleLayers ).none() )
 color = COLOR4D::CLEAR;
 }
 
 // Apply per-type opacity overrides
 if( item->Type() == PCB_TRACE_T || item->Type() == PCB_ARC_T )
 color.a *= m_trackOpacity;
 else if( item->Type() == PCB_VIA_T )
 color.a *= m_viaOpacity;
 else if( item->Type() == PCB_PAD_T )
 color.a *= m_padOpacity;
 else if( item->Type() == PCB_ZONE_T || item->Type() == PCB_FP_ZONE_T )
 color.a *= m_zoneOpacity;
 else if( item->Type() == PCB_BITMAP_T )
 color.a *= m_imageOpacity;
 
 // No special modifiers enabled
 return color;
}

Referenced by PNS_KICAD_IFACE::DisplayRatline(), and KIGFX::PCB_PAINTER::draw().

◆ GetCursorColor()

const COLOR4D & KIGFX::PCB_RENDER_SETTINGS::GetCursorColor ( )

inlineoverridevirtual

Return current cursor color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 109 of file pcb_painter.h.

109{ return m_layerColors[ LAYER_CURSOR ]; }

LAYER_CURSOR

@ LAYER_CURSOR

PCB cursor.

Definition: layer_ids.h:221

References LAYER_CURSOR, and KIGFX::RENDER_SETTINGS::m_layerColors.

◆ GetDashLength()

double RENDER_SETTINGS::GetDashLength ( int aLineWidth ) const

inherited

Definition at line 63 of file render_settings.cpp.

{
 return std::max( m_dashLengthRatio - correction, 1.0 ) * aLineWidth;
}

References correction, and KIGFX::RENDER_SETTINGS::m_dashLengthRatio.

Referenced by PLOTTER::GetDashMarkLenIU(), and STROKE_PARAMS::Stroke().

◆ GetDashLengthRatio()

double KIGFX::RENDER_SETTINGS::GetDashLengthRatio ( ) const

inlineinherited

Definition at line 215 of file render_settings.h.

215{ return m_dashLengthRatio; }

References KIGFX::RENDER_SETTINGS::m_dashLengthRatio.

◆ GetDefaultFont()

const wxString & KIGFX::RENDER_SETTINGS::GetDefaultFont ( ) const

inlineinherited

Definition at line 295 of file render_settings.h.

295{ return m_defaultFont; }

KIGFX::RENDER_SETTINGS::m_defaultFont

wxString m_defaultFont

Definition: render_settings.h:341

References KIGFX::RENDER_SETTINGS::m_defaultFont.

Referenced by KIGFX::PCB_PAINTER::draw(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), PlotDrawingSheet(), BRDITEMS_PLOTTER::PlotFootprintTextItem(), BRDITEMS_PLOTTER::PlotPcbText(), LIB_PIN::PlotPinTexts(), SCH_FIELD::Print(), LIB_FIELD::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_TEXT::Print(), EDA_TEXT::printOneLineOfText(), LIB_PIN::printPinElectricalTypeName(), LIB_PIN::printPinTexts(), and DS_PROXY_VIEW_ITEM::ViewDraw().

◆ GetDefaultPenWidth()

int KIGFX::RENDER_SETTINGS::GetDefaultPenWidth ( ) const

inlineinherited

Definition at line 209 of file render_settings.h.

209{ return m_defaultPenWidth; }

KIGFX::RENDER_SETTINGS::m_defaultPenWidth

int m_defaultPenWidth

Definition: render_settings.h:335

References KIGFX::RENDER_SETTINGS::m_defaultPenWidth.

Referenced by LIB_ITEM::GetEffectivePenWidth(), SCH_SCREEN::Plot(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_NO_CONNECT::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), PlotDrawingSheet(), LIB_PIN::PlotPinTexts(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_LINE::Print(), SCH_NO_CONNECT::Print(), SCH_SHEET::Print(), LIB_SHAPE::print(), LIB_TEXT::print(), SCH_LABEL_BASE::Print(), PrintDrawingSheet(), EDA_TEXT::printOneLineOfText(), LIB_PIN::printPinTexts(), DS_DRAW_ITEM_LINE::PrintWsItem(), DS_DRAW_ITEM_POLYPOLYGONS::PrintWsItem(), DS_DRAW_ITEM_RECT::PrintWsItem(), GERBER_PLOTTER::SetCurrentLineWidth(), PS_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::SetCurrentLineWidth(), SVG_PLOTTER::SetCurrentLineWidth(), PDF_PLOTTER::StartPage(), PS_PLOTTER::StartPlot(), and GERBER_PLOTTER::StartPlot().

◆ GetDotLength()

double RENDER_SETTINGS::GetDotLength ( int aLineWidth ) const

inherited

Definition at line 69 of file render_settings.cpp.

{
 return ( 1.0 - correction ) * aLineWidth;
}

References correction.

Referenced by PLOTTER::GetDotMarkLenIU(), and STROKE_PARAMS::Stroke().

◆ GetDrawBoundingBoxes()

bool KIGFX::RENDER_SETTINGS::GetDrawBoundingBoxes ( ) const

inlineinherited

Definition at line 195 of file render_settings.h.

195{ return m_drawBoundingBoxes; }

KIGFX::RENDER_SETTINGS::m_drawBoundingBoxes

bool m_drawBoundingBoxes

Definition: render_settings.h:329

References KIGFX::RENDER_SETTINGS::m_drawBoundingBoxes.

Referenced by EDITOR_CONDITIONS::bboxesFunc(), KIGFX::SCH_PAINTER::draw(), KIGFX::PCB_PAINTER::Draw(), and COMMON_TOOLS::ToggleBoundingBoxes().

◆ GetDrawingSheetLineWidth()

float KIGFX::RENDER_SETTINGS::GetDrawingSheetLineWidth ( ) const

inlineinherited

Definition at line 207 of file render_settings.h.

207{ return m_drawingSheetLineWidth; }

KIGFX::RENDER_SETTINGS::m_drawingSheetLineWidth

float m_drawingSheetLineWidth

Definition: render_settings.h:333

References KIGFX::RENDER_SETTINGS::m_drawingSheetLineWidth.

Referenced by DS_PROXY_VIEW_ITEM::buildDrawList().

◆ GetGapLength()

double RENDER_SETTINGS::GetGapLength ( int aLineWidth ) const

inherited

Definition at line 75 of file render_settings.cpp.

{
 return std::max( m_gapLengthRatio + correction, 1.0 ) * aLineWidth;
}

References correction, and KIGFX::RENDER_SETTINGS::m_gapLengthRatio.

Referenced by PLOTTER::GetDashGapLenIU(), and STROKE_PARAMS::Stroke().

◆ GetGapLengthRatio()

double KIGFX::RENDER_SETTINGS::GetGapLengthRatio ( ) const

inlineinherited

Definition at line 220 of file render_settings.h.

220{ return m_gapLengthRatio; }

References KIGFX::RENDER_SETTINGS::m_gapLengthRatio.

◆ GetGridColor()

const COLOR4D & KIGFX::PCB_RENDER_SETTINGS::GetGridColor ( )

inlineoverridevirtual

Return current grid color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 107 of file pcb_painter.h.

107{ return m_layerColors[ LAYER_GRID ]; }

LAYER_GRID

@ LAYER_GRID

Definition: layer_ids.h:205

References LAYER_GRID, and KIGFX::RENDER_SETTINGS::m_layerColors.

◆ GetHiddenNets() [1/2]

std::set< int > & KIGFX::PCB_RENDER_SETTINGS::GetHiddenNets ( )

inline

Definition at line 118 of file pcb_painter.h.

118{ return m_hiddenNets; }

KIGFX::PCB_RENDER_SETTINGS::m_hiddenNets

std::set< int > m_hiddenNets

Definition: pcb_painter.h:143

References m_hiddenNets.

Referenced by BOARD_INSPECTION_TOOL::doHideRatsnestNet(), PCB_EDIT_FRAME::LoadProjectSettings(), NET_GRID_TABLE::Rebuild(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ GetHiddenNets() [2/2]

const std::set< int > & KIGFX::PCB_RENDER_SETTINGS::GetHiddenNets ( ) const

inline

Definition at line 119 of file pcb_painter.h.

119{ return m_hiddenNets; }

References m_hiddenNets.

◆ GetHighContrast()

bool KIGFX::RENDER_SETTINGS::GetHighContrast ( ) const

inlineinherited

Definition at line 192 of file render_settings.h.

192{ return m_hiContrastEnabled; }

References KIGFX::RENDER_SETTINGS::m_hiContrastEnabled.

Referenced by PCB_GRID_HELPER::computeAnchors(), BOARD_INSPECTION_TOOL::highlightNet(), PNS_KICAD_IFACE::IsItemVisible(), PCB_GRID_HELPER::queryVisible(), PCB_SELECTION_TOOL::Selectable(), PAD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), and PCB_VIA::ViewGetLOD().

◆ GetHighContrastLayers()

const std::set< int > KIGFX::RENDER_SETTINGS::GetHighContrastLayers ( ) const

inlineinherited

Returns the set of currently high-contrast layers.

Definition at line 90 of file render_settings.h.

 {
 return m_highContrastLayers;
 }

References KIGFX::RENDER_SETTINGS::m_highContrastLayers.

Referenced by PCB_GRID_HELPER::computeAnchors(), PCB_GRID_HELPER::queryVisible(), and PCB_SELECTION_TOOL::Selectable().

◆ GetHighlightNetCodes()

const std::set< int > & KIGFX::RENDER_SETTINGS::GetHighlightNetCodes ( ) const

inlineinherited

Return the netcode of currently highlighted net.

Returns: Netcode of currently highlighted net.

Definition at line 144 of file render_settings.h.

 {
 return m_highlightNetcodes;
 }

References KIGFX::RENDER_SETTINGS::m_highlightNetcodes.

Referenced by PNS_KICAD_IFACE::DisplayRatline(), BOARD_INSPECTION_TOOL::HighlightNet(), PNS::TOOL_BASE::highlightNets(), ROUTER_TOOL::Init(), DRAWING_TOOL::Init(), PCB_SELECTION_TOOL::Init(), PCB_EDIT_FRAME::setupUIConditions(), and RATSNEST_VIEW_ITEM::ViewDraw().

◆ GetLayerColor()

const COLOR4D & KIGFX::RENDER_SETTINGS::GetLayerColor ( int aLayer ) const

inlineinherited

Return the color used to draw a layer.

Parameters

aLayer is the layer number.

Definition at line 254 of file render_settings.h.

 {
 // We don't (yet?) have a separate color for intersheet refs
 if( aLayer == LAYER_INTERSHEET_REFS )
 aLayer = LAYER_GLOBLABEL;
 
 return m_layerColors[aLayer];
 }

References LAYER_GLOBLABEL, LAYER_INTERSHEET_REFS, and KIGFX::RENDER_SETTINGS::m_layerColors.

Referenced by DIALOG_PIN_PROPERTIES::DIALOG_PIN_PROPERTIES(), KIGFX::PCB_PAINTER::draw(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircle(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLine(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineWithAngleHighlight(), BOARD_PRINTOUT::DrawPage(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), KIGFX::SCH_PAINTER::getRenderColor(), DIALOG_LIB_SHAPE_PROPERTIES::onFill(), PCB_GRID_HELPER::PCB_GRID_HELPER(), SCH_BITMAP::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LABEL_BASE::Plot(), SCH_NO_CONNECT::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_FIELD::Plot(), LIB_SHAPE::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), LIB_SYMBOL::Plot(), LIB_SYMBOL::PlotLibFields(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), LIB_PIN::PlotPinTexts(), LIB_PIN::PlotSymbol(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_NO_CONNECT::Print(), SCH_SHAPE::Print(), SCH_SHEET::Print(), SCH_SYMBOL::Print(), LIB_FIELD::print(), LIB_PIN::print(), LIB_SHAPE::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_LABEL_BASE::Print(), SCH_TEXT::Print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), SCH_PRINTOUT::PrintPage(), LIB_PIN::printPinElectricalTypeName(), LIB_PIN::printPinSymbol(), LIB_PIN::printPinTexts(), DS_DRAW_ITEM_LINE::PrintWsItem(), DS_DRAW_ITEM_POLYPOLYGONS::PrintWsItem(), DS_DRAW_ITEM_RECT::PrintWsItem(), DS_DRAW_ITEM_TEXT::PrintWsItem(), DIALOG_LIB_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), DS_PROXY_VIEW_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), and FP_TEXTBOX::ViewGetLOD().

◆ GetLayerIsHighContrast()

bool KIGFX::RENDER_SETTINGS::GetLayerIsHighContrast ( int aLayerId ) const

inlineinherited

Return information whether the queried layer is marked as high-contrast.

Returns: True if the queried layer is marked as active.

Definition at line 82 of file render_settings.h.

 {
 return ( m_highContrastLayers.count( aLayerId ) > 0 );
 }

References KIGFX::RENDER_SETTINGS::m_highContrastLayers.

◆ GetLayerName()

const wxString & KIGFX::RENDER_SETTINGS::GetLayerName ( ) const

inlineinherited

Definition at line 115 of file render_settings.h.

115{ return m_layerName; }

KIGFX::RENDER_SETTINGS::m_layerName

wxString m_layerName

Definition: render_settings.h:309

References KIGFX::RENDER_SETTINGS::m_layerName.

Referenced by DS_PROXY_VIEW_ITEM::buildDrawList(), and PlotDrawingSheet().

◆ GetMinPenWidth()

int KIGFX::RENDER_SETTINGS::GetMinPenWidth ( ) const

inlineinherited

Definition at line 212 of file render_settings.h.

212{ return m_minPenWidth; }

KIGFX::RENDER_SETTINGS::m_minPenWidth

int m_minPenWidth

Definition: render_settings.h:336

References KIGFX::RENDER_SETTINGS::m_minPenWidth.

Referenced by LIB_ITEM::GetEffectivePenWidth(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), LIB_TEXT::Plot(), LIB_TEXTBOX::Plot(), SCH_SHAPE::Print(), LIB_TEXTBOX::print(), and SCH_TEXTBOX::Print().

◆ GetNetclassColorMap()

std::map< wxString, KIGFX::COLOR4D > & KIGFX::PCB_RENDER_SETTINGS::GetNetclassColorMap ( )

inline

Definition at line 114 of file pcb_painter.h.

114{ return m_netclassColors; }

References m_netclassColors.

Referenced by PNS_KICAD_IFACE::DisplayRatline(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onNetclassColorChanged(), APPEARANCE_CONTROLS::onNetclassContextMenu(), APPEARANCE_CONTROLS::rebuildNets(), and PCB_EDIT_FRAME::SaveProjectSettings().

◆ GetNetColorMap()

std::map< int, KIGFX::COLOR4D > & KIGFX::PCB_RENDER_SETTINGS::GetNetColorMap ( )

inline

Definition at line 116 of file pcb_painter.h.

116{ return m_netColors; }

References m_netColors.

Referenced by PNS_KICAD_IFACE::DisplayRatline(), PCB_EDIT_FRAME::LoadProjectSettings(), NET_GRID_TABLE::Rebuild(), PCB_EDIT_FRAME::SaveProjectSettings(), and NET_GRID_TABLE::updateNetColor().

◆ GetNetColorMode()

NET_COLOR_MODE KIGFX::PCB_RENDER_SETTINGS::GetNetColorMode ( ) const

inline

Definition at line 111 of file pcb_painter.h.

111{ return m_netColorMode; }

References m_netColorMode.

Referenced by PNS_KICAD_IFACE::DisplayRatline().

◆ GetPrimaryHighContrastLayer()

PCB_LAYER_ID KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer ( ) const

inlineinherited

Return the board layer which is in high-contrast mode.

There should only be one board layer which is high-contrast at any given time, although there might be many high-contrast synthetic (GAL) layers.

Definition at line 101 of file render_settings.h.

 {
 for( int layer : m_highContrastLayers )
 {
 if( layer >= PCBNEW_LAYER_ID_START && layer < PCB_LAYER_ID_COUNT )
 return (PCB_LAYER_ID) layer;
 }
 
 return UNDEFINED_LAYER;
 }

References KIGFX::RENDER_SETTINGS::m_highContrastLayers, PCB_LAYER_ID_COUNT, PCBNEW_LAYER_ID_START, and UNDEFINED_LAYER.

Referenced by GetColor(), BOARD_INSPECTION_TOOL::highlightNet(), PNS_KICAD_IFACE::IsItemVisible(), PAD::ViewGetLOD(), PCB_SHAPE::ViewGetLOD(), PCB_TEXT::ViewGetLOD(), PCB_TEXTBOX::ViewGetLOD(), PCB_TRACK::ViewGetLOD(), and PCB_VIA::ViewGetLOD().

◆ GetPrintDC()

wxDC * KIGFX::RENDER_SETTINGS::GetPrintDC ( ) const

inlineinherited

Definition at line 298 of file render_settings.h.

298{ return m_printDC; }

KIGFX::RENDER_SETTINGS::m_printDC

wxDC * m_printDC

Definition: render_settings.h:346

References KIGFX::RENDER_SETTINGS::m_printDC.

Referenced by SCH_BITMAP::Print(), SCH_BUS_ENTRY_BASE::Print(), SCH_FIELD::Print(), SCH_JUNCTION::Print(), SCH_LINE::Print(), SCH_NO_CONNECT::Print(), SCH_SHAPE::Print(), SCH_SHEET::Print(), SCH_SYMBOL::Print(), LIB_FIELD::print(), LIB_PIN::print(), LIB_SHAPE::print(), LIB_TEXT::print(), LIB_TEXTBOX::print(), SCH_LABEL_BASE::Print(), SCH_TEXTBOX::Print(), SCH_SHAPE::PrintBackground(), EDA_DRAW_FRAME::PrintDrawingSheet(), MARKER_BASE::PrintMarker(), EDA_TEXT::printOneLineOfText(), SCH_EDIT_FRAME::PrintPage(), LIB_PIN::printPinElectricalTypeName(), LIB_PIN::printPinSymbol(), LIB_PIN::printPinTexts(), DS_DRAW_ITEM_LINE::PrintWsItem(), DS_DRAW_ITEM_POLYPOLYGONS::PrintWsItem(), DS_DRAW_ITEM_RECT::PrintWsItem(), and DS_DRAW_ITEM_BITMAP::PrintWsItem().

◆ GetPrintLayers()

LSET KIGFX::RENDER_SETTINGS::GetPrintLayers ( ) const

inlineinherited

Definition at line 118 of file render_settings.h.

118{ return m_printLayers; }

KIGFX::RENDER_SETTINGS::m_printLayers

LSET m_printLayers

Definition: render_settings.h:344

References KIGFX::RENDER_SETTINGS::m_printLayers.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ GetShowPageLimits()

bool PCB_RENDER_SETTINGS::GetShowPageLimits ( ) const

overridevirtual

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 442 of file pcb_painter.cpp.

{
 return pcbconfig() && pcbconfig()->m_ShowPageLimits;
}

References PCBNEW_SETTINGS::m_ShowPageLimits, and pcbconfig().

◆ IsBackgroundDark()

bool KIGFX::PCB_RENDER_SETTINGS::IsBackgroundDark ( ) const

inlineoverridevirtual

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 93 of file pcb_painter.h.

 {
 auto luma = m_layerColors[ LAYER_PCB_BACKGROUND ].GetBrightness();
 
 return luma < 0.5;
 }

References KIGFX::COLOR4D::GetBrightness(), LAYER_PCB_BACKGROUND, and KIGFX::RENDER_SETTINGS::m_layerColors.

◆ IsHighlightEnabled()

bool KIGFX::RENDER_SETTINGS::IsHighlightEnabled ( ) const

inlineinherited

Return current highlight setting.

Returns: True if highlight is enabled, false otherwise.

Definition at line 134 of file render_settings.h.

 {
 return m_highlightEnabled;
 }

References KIGFX::RENDER_SETTINGS::m_highlightEnabled.

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), and PNS::TOOL_BASE::highlightNets().

◆ IsPrinting()

bool KIGFX::RENDER_SETTINGS::IsPrinting ( ) const

inlineinherited

Definition at line 226 of file render_settings.h.

226{ return m_isPrinting; }

References KIGFX::RENDER_SETTINGS::m_isPrinting.

Referenced by KIGFX::PCB_PAINTER::draw().

◆ LoadColors()

void PCB_RENDER_SETTINGS::LoadColors ( const COLOR_SETTINGS * aSettings )

overridevirtual

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 125 of file pcb_painter.cpp.

{
 SetBackgroundColor( aSettings->GetColor( LAYER_PCB_BACKGROUND ) );
 
 // Init board layers colors:
 for( int i = 0; i < PCB_LAYER_ID_COUNT; i++ )
 {
 m_layerColors[i] = aSettings->GetColor( i );
 
 // Guard: if the alpha channel is too small, the layer is not visible.
 if( m_layerColors[i].a < 0.2 )
 m_layerColors[i].a = 0.2;
 }
 
 // Init specific graphic layers colors:
 for( int i = GAL_LAYER_ID_START; i < GAL_LAYER_ID_END; i++ )
 m_layerColors[i] = aSettings->GetColor( i );
 
 // Colors for layers that aren't theme-able
 m_layerColors[LAYER_PAD_PLATEDHOLES] = aSettings->GetColor( LAYER_PCB_BACKGROUND );
 m_layerColors[LAYER_VIA_NETNAMES] = COLOR4D( 0.2, 0.2, 0.2, 0.9 );
 m_layerColors[LAYER_PAD_NETNAMES] = COLOR4D( 1.0, 1.0, 1.0, 0.9 );
 m_layerColors[LAYER_PAD_FR] = aSettings->GetColor( F_Cu );
 m_layerColors[LAYER_PAD_BK] = aSettings->GetColor( B_Cu );
 m_layerColors[LAYER_PAD_FR_NETNAMES] = COLOR4D( 1.0, 1.0, 1.0, 0.9 );
 m_layerColors[LAYER_PAD_BK_NETNAMES] = COLOR4D( 1.0, 1.0, 1.0, 0.9 );
 
 // Netnames for copper layers
 for( LSEQ cu = LSET::AllCuMask().CuStack(); cu; ++cu )
 {
 const COLOR4D lightLabel( 1.0, 1.0, 1.0, 0.7 );
 const COLOR4D darkLabel = lightLabel.Inverted();
 PCB_LAYER_ID layer = *cu;
 
 if( m_layerColors[layer].GetBrightness() > 0.5 )
 m_layerColors[GetNetnameLayer( layer )] = darkLabel;
 else
 m_layerColors[GetNetnameLayer( layer )] = lightLabel;
 }
 
 if( PgmOrNull() ) // can be null if used without project (i.e. from python script)
 m_hiContrastFactor = 1.0f - Pgm().GetCommonSettings()->m_Appearance.hicontrast_dimming_factor;
 else
 m_hiContrastFactor = 1.0f - 0.8f; // default value
 
 update();
}

References KIGFX::COLOR4D::a, LSET::AllCuMask(), B_Cu, F_Cu, GAL_LAYER_ID_END, GAL_LAYER_ID_START, COLOR_SETTINGS::GetColor(), GetNetnameLayer(), KIGFX::COLOR4D::Inverted(), LAYER_PAD_BK, LAYER_PAD_BK_NETNAMES, LAYER_PAD_FR, LAYER_PAD_FR_NETNAMES, LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_PCB_BACKGROUND, LAYER_VIA_NETNAMES, KIGFX::RENDER_SETTINGS::m_hiContrastFactor, KIGFX::RENDER_SETTINGS::m_layerColors, PCB_LAYER_ID_COUNT, Pgm(), PgmOrNull(), SetBackgroundColor(), and KIGFX::RENDER_SETTINGS::update().

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::CommonSettingsChanged(), StartPlotBoard(), PCB_DRAW_PANEL_GAL::UpdateColors(), and PANEL_PCBNEW_COLOR_SETTINGS::updatePreview().

◆ LoadDisplayOptions()

void PCB_RENDER_SETTINGS::LoadDisplayOptions ( const PCB_DISPLAY_OPTIONS & aOptions )

Load settings related to display options (high-contrast mode, full or outline modes for vias/pads/tracks and so on).

Parameters

aOptions are settings that you want to use for displaying items.

Definition at line 174 of file pcb_painter.cpp.

{
 m_hiContrastEnabled = aOptions.m_ContrastModeDisplay != HIGH_CONTRAST_MODE::NORMAL;
 m_ZoneDisplayMode = aOptions.m_ZoneDisplayMode;
 m_ContrastModeDisplay = aOptions.m_ContrastModeDisplay;
 m_netColorMode = aOptions.m_NetColorMode;
 
 m_trackOpacity = aOptions.m_TrackOpacity;
 m_viaOpacity = aOptions.m_ViaOpacity;
 m_padOpacity = aOptions.m_PadOpacity;
 m_zoneOpacity = aOptions.m_ZoneOpacity;
 m_imageOpacity = aOptions.m_ImageOpacity;
}

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_EDIT_FRAME::CommonSettingsChanged(), PCB_DRAW_PANEL_GAL::OnShow(), and KIGFX::PCB_VIEW::UpdateDisplayOptions().

◆ SetActiveLayer()

void KIGFX::RENDER_SETTINGS::SetActiveLayer ( PCB_LAYER_ID aLayer )

inlineinherited

Definition at line 113 of file render_settings.h.

113{ m_activeLayer = aLayer; }

References KIGFX::RENDER_SETTINGS::m_activeLayer.

Referenced by PCB_DRAW_PANEL_GAL::SetHighContrastLayer().

◆ SetBackgroundColor()

void KIGFX::PCB_RENDER_SETTINGS::SetBackgroundColor ( const COLOR4D & aColor )

inlineoverridevirtual

Set the background color.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 102 of file pcb_painter.h.

 {
 m_layerColors[ LAYER_PCB_BACKGROUND ] = aColor;
 }

References LAYER_PCB_BACKGROUND, and KIGFX::RENDER_SETTINGS::m_layerColors.

Referenced by LoadColors().

◆ SetDashLengthRatio()

void KIGFX::RENDER_SETTINGS::SetDashLengthRatio ( double aRatio )

inlineinherited

Definition at line 216 of file render_settings.h.

216{ m_dashLengthRatio = aRatio; }

References KIGFX::RENDER_SETTINGS::m_dashLengthRatio.

Referenced by BOARD_ADAPTER::addShape(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_RENDER_SETTINGS(), KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), PCB_BASE_FRAME::SetBoard(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ SetDefaultFont()

void KIGFX::RENDER_SETTINGS::SetDefaultFont ( const wxString & aFont )

inlineinherited

Definition at line 294 of file render_settings.h.

294{ m_defaultFont = aFont; }

References KIGFX::RENDER_SETTINGS::m_defaultFont.

Referenced by SCH_EDIT_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), SCH_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_FRAME::LoadSettings(), PCB_BASE_FRAME::LoadSettings(), and SCH_PRINTOUT::PrintPage().

◆ SetDefaultPenWidth()

void KIGFX::RENDER_SETTINGS::SetDefaultPenWidth ( int aWidth )

inlineinherited

Definition at line 210 of file render_settings.h.

210{ m_defaultPenWidth = aWidth; }

References KIGFX::RENDER_SETTINGS::m_defaultPenWidth.

Referenced by GENDRILL_WRITER_BASE::genDrillMapFile(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), EESCHEMA_JOBS_HANDLER::JobSymExportSvg(), SCH_EDIT_FRAME::LoadProjectSettings(), SCH_PLOTTER::plotOneSheetDXF(), PLEDITOR_PRINTOUT::PrintPage(), KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), GERBER_PLOTTER::StartPlot(), StartPlotBoard(), SYMBOL_EDIT_FRAME::SVGPlotSymbol(), SYMBOL_VIEWER_FRAME::SYMBOL_VIEWER_FRAME(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetDrawBoundingBoxes()

void KIGFX::RENDER_SETTINGS::SetDrawBoundingBoxes ( bool aEnabled )

inlineinherited

Definition at line 194 of file render_settings.h.

194{ m_drawBoundingBoxes = aEnabled; }

References KIGFX::RENDER_SETTINGS::m_drawBoundingBoxes.

Referenced by COMMON_TOOLS::ToggleBoundingBoxes().

◆ SetGapLengthRatio()

void KIGFX::RENDER_SETTINGS::SetGapLengthRatio ( double aRatio )

inlineinherited

Definition at line 221 of file render_settings.h.

221{ m_gapLengthRatio = aRatio; }

References KIGFX::RENDER_SETTINGS::m_gapLengthRatio.

Referenced by BOARD_ADAPTER::addShape(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_RENDER_SETTINGS(), KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), PCB_BASE_FRAME::SetBoard(), and SCH_EDIT_FRAME::ShowSchematicSetupDialog().

◆ SetHighContrast()

void KIGFX::RENDER_SETTINGS::SetHighContrast ( bool aEnabled )

inlineinherited

Turns on/off high contrast display mode.

Definition at line 191 of file render_settings.h.

191{ m_hiContrastEnabled = aEnabled; }

References KIGFX::RENDER_SETTINGS::m_hiContrastEnabled.

Referenced by GERBVIEW_FRAME::ApplyDisplaySettingsToGAL().

◆ SetHighlight() [1/2]

void KIGFX::RENDER_SETTINGS::SetHighlight	(	bool	aEnabled,
		int	aNetcode = `-1`,
		bool	aMulti = `false`
	)

inlineinherited

Turns on/off highlighting.

It may be done for the active layer or the specified net(s)..

Parameters

aEnabled	tells if highlighting should be enabled.
aNetcode	is optional and if specified, turns on highlighting only for the net with number given as the parameter.

Definition at line 158 of file render_settings.h.

 {
 m_highlightEnabled = aEnabled;
 
 if( aEnabled )
 {
 if( !aMulti )
 m_highlightNetcodes.clear();
 
 m_highlightNetcodes.insert( aNetcode );
 }
 else
 m_highlightNetcodes.clear();
 }

References KIGFX::RENDER_SETTINGS::m_highlightEnabled, and KIGFX::RENDER_SETTINGS::m_highlightNetcodes.

Referenced by DIALOG_NET_INSPECTOR::buildNetsList(), BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), APPEARANCE_CONTROLS::onNetclassContextMenu(), DIALOG_NET_INSPECTOR::onSelChanged(), DIALOG_NET_INSPECTOR::onSortingChanged(), EE_SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Reset(), and NETS_SEARCH_HANDLER::SelectItems().

◆ SetHighlight() [2/2]

void KIGFX::RENDER_SETTINGS::SetHighlight	(	std::set< int > &	aHighlight,
		bool	aEnabled = `true`
	)

inlineinherited

Turns on highlighting and highlights multiple nets.

Parameters

aHighlight	is a set of netcodes to highlight
aEnabled	tells if highlighting should be enabled.

Definition at line 178 of file render_settings.h.

  {
 m_highlightEnabled = aEnabled;
 
 if( aEnabled )
 m_highlightNetcodes = aHighlight;
 else
 m_highlightNetcodes.clear();
 }

References KIGFX::RENDER_SETTINGS::m_highlightEnabled, and KIGFX::RENDER_SETTINGS::m_highlightNetcodes.

◆ SetHighlightFactor()

void KIGFX::RENDER_SETTINGS::SetHighlightFactor ( float aFactor )

inlineinherited

Definition at line 291 of file render_settings.h.

291{ m_highlightFactor = aFactor; }

References KIGFX::RENDER_SETTINGS::m_highlightFactor.

Referenced by PCB_BASE_FRAME::LoadSettings().

◆ SetIsPrinting()

void KIGFX::RENDER_SETTINGS::SetIsPrinting ( bool isPrinting )

inlineinherited

Definition at line 227 of file render_settings.h.

227{ m_isPrinting = isPrinting; }

References KIGFX::RENDER_SETTINGS::m_isPrinting.

Referenced by BOARD_PRINTOUT::DrawPage(), and SCH_PRINTOUT::PrintPage().

◆ SetLayerColor()

void KIGFX::RENDER_SETTINGS::SetLayerColor	(	int	aLayer,
		const COLOR4D &	aColor
	)

inlineinherited

Change the color used to draw a layer.

Parameters

aLayer	is the layer number.
aColor	is the new color.

Definition at line 269 of file render_settings.h.

 {
 m_layerColors[aLayer] = aColor;
 
 update(); // recompute other shades of the color
 }

References KIGFX::RENDER_SETTINGS::m_layerColors, and KIGFX::RENDER_SETTINGS::update().

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), BOARD_PRINTOUT::DrawPage(), PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), DIALOG_PAD_PROPERTIES::redraw(), PCBNEW_PRINTOUT::setupPainter(), PCBNEW_PRINTOUT::setupViewLayers(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetLayerIsHighContrast()

void KIGFX::RENDER_SETTINGS::SetLayerIsHighContrast	(	int	aLayerId,
		bool	aEnabled = `true`
	)

inlineinherited

Set the specified layer as high-contrast.

Parameters

aLayerId	is a layer number that should be displayed in a specific mode.
aEnabled	is the new layer state ( true = active or false = not active).

Definition at line 69 of file render_settings.h.

 {
 if( aEnabled )
 m_highContrastLayers.insert( aLayerId );
 else
 m_highContrastLayers.erase( aLayerId );
 }

References KIGFX::RENDER_SETTINGS::m_highContrastLayers.

Referenced by EDA_DRAW_PANEL_GAL::SetHighContrastLayer(), GERBVIEW_DRAW_PANEL_GAL::SetHighContrastLayer(), and PCB_DRAW_PANEL_GAL::SetHighContrastLayer().

◆ SetLayerName()

void KIGFX::RENDER_SETTINGS::SetLayerName ( const wxString & aLayerName )

inlineinherited

Definition at line 116 of file render_settings.h.

116{ m_layerName = aLayerName; }

References KIGFX::RENDER_SETTINGS::m_layerName.

Referenced by BOARD_PRINTOUT::DrawPage(), and StartPlotBoard().

◆ SetMinPenWidth()

void KIGFX::RENDER_SETTINGS::SetMinPenWidth ( int aWidth )

inlineinherited

Definition at line 213 of file render_settings.h.

213{ m_minPenWidth = aWidth; }

References KIGFX::RENDER_SETTINGS::m_minPenWidth.

Referenced by DIALOG_PLOT_SCHEMATIC::getPlotOptions().

◆ SetNetColorMode()

void KIGFX::PCB_RENDER_SETTINGS::SetNetColorMode ( NET_COLOR_MODE aMode )

inline

Definition at line 112 of file pcb_painter.h.

112{ m_netColorMode = aMode; }

References m_netColorMode.

◆ SetOutlineWidth()

void KIGFX::RENDER_SETTINGS::SetOutlineWidth ( float aWidth )

inlineinherited

Set line width used for drawing outlines.

Parameters

aWidth is the new width.

Definition at line 286 of file render_settings.h.

 {
 m_outlineWidth = aWidth;
 }

References KIGFX::RENDER_SETTINGS::m_outlineWidth.

◆ SetPrintDC()

void KIGFX::RENDER_SETTINGS::SetPrintDC ( wxDC * aDC )

inlineinherited

Definition at line 299 of file render_settings.h.

299{ m_printDC = aDC; }

References KIGFX::RENDER_SETTINGS::m_printDC.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), DIALOG_PIN_PROPERTIES::OnPaintShowPanel(), PLEDITOR_PRINTOUT::PrintPage(), SCH_PRINTOUT::PrintPage(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetPrintLayers()

void KIGFX::RENDER_SETTINGS::SetPrintLayers ( LSET aLayerSet )

inlineinherited

Definition at line 119 of file render_settings.h.

119{ m_printLayers = aLayerSet; }

References KIGFX::RENDER_SETTINGS::m_printLayers.

Referenced by BOARD_PRINTOUT::DrawPage().

◆ SetSelectFactor()

void KIGFX::RENDER_SETTINGS::SetSelectFactor ( float aFactor )

inlineinherited

Definition at line 292 of file render_settings.h.

292{ m_selectFactor = aFactor; }

References KIGFX::RENDER_SETTINGS::m_selectFactor.

Referenced by PCB_BASE_FRAME::LoadSettings().

◆ update()

void RENDER_SETTINGS::update ( )

protectedvirtualinherited

Precalculates extra colors for layers (e.g.

highlighted, darkened and any needed version of base colors).

Definition at line 81 of file render_settings.cpp.

{
 // Calculate darkened/highlighted variants of layer colors
 for( int i = 0; i < LAYER_ID_COUNT; i++ )
 {
 m_hiContrastColor[i] = m_layerColors[i].Mix( m_layerColors[LAYER_PCB_BACKGROUND],
 m_hiContrastFactor );
 
 m_layerColorsHi[i] = m_layerColors[i].Brightened( m_highlightFactor );
 m_layerColorsDark[i] = m_layerColors[i].Darkened( 1.0 - m_highlightFactor );
 
 if( IsNetnameLayer( i ) || IsHoleLayer( i ) )
 {
 m_layerColorsSel[i] = m_layerColors[i];
 continue;
 }
 
 // Linear brightening doesn't work well for colors near white
 double factor = ( m_selectFactor * 0.5 ) + pow( m_layerColors[i].GetBrightness(), 3 );
 factor = std::min( 1.0, factor );
 
 m_layerColorsSel[i] = m_layerColors[i].Brightened( factor );
 
 // If we are maxed out on brightening as a highlight, fallback to darkening but keep
 // the blue that acts as a "glowing" color
 if( std::fabs( m_layerColorsSel[i].GetBrightness() - m_layerColors[i].GetBrightness() )
 < 0.05 )
 {
 m_layerColorsSel[i] = m_layerColors[i].Darkened( m_selectFactor * 0.4 );
 m_layerColorsSel[i].b = m_layerColors[i].b * ( 1.0 - factor ) + factor;
 }
 
 }
}

Referenced by KIGFX::DS_RENDER_SETTINGS::DS_RENDER_SETTINGS(), KIGFX::GERBVIEW_RENDER_SETTINGS::GERBVIEW_RENDER_SETTINGS(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), LoadColors(), PCB_RENDER_SETTINGS(), KIGFX::GERBVIEW_RENDER_SETTINGS::SetLayerColor(), and KIGFX::RENDER_SETTINGS::SetLayerColor().

Friends And Related Function Documentation

◆ PCB_PAINTER

friend class PCB_PAINTER

friend

Definition at line 74 of file pcb_painter.h.

Member Data Documentation

◆ m_activeLayer

PCB_LAYER_ID KIGFX::RENDER_SETTINGS::m_activeLayer

protectedinherited

Definition at line 308 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetActiveLayer(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetActiveLayer().

◆ m_backgroundColor

COLOR4D KIGFX::RENDER_SETTINGS::m_backgroundColor

protectedinherited

Definition at line 319 of file render_settings.h.

Referenced by KIGFX::DS_RENDER_SETTINGS::DS_RENDER_SETTINGS(), KIGFX::GERBVIEW_RENDER_SETTINGS::GERBVIEW_RENDER_SETTINGS(), KIGFX::DS_RENDER_SETTINGS::GetBackgroundColor(), GetColor(), KIGFX::DS_RENDER_SETTINGS::IsBackgroundDark(), KIGFX::SCH_RENDER_SETTINGS::LoadColors(), KIGFX::DS_RENDER_SETTINGS::LoadColors(), PCB_RENDER_SETTINGS(), and KIGFX::DS_RENDER_SETTINGS::SetBackgroundColor().

◆ m_ContrastModeDisplay

HIGH_CONTRAST_MODE KIGFX::PCB_RENDER_SETTINGS::m_ContrastModeDisplay

Definition at line 125 of file pcb_painter.h.

Referenced by GetColor(), LoadDisplayOptions(), PCB_RENDER_SETTINGS(), and FOOTPRINT_PREVIEW_PANEL::renderFootprint().

◆ m_dashLengthRatio

double KIGFX::RENDER_SETTINGS::m_dashLengthRatio

protectedinherited

Definition at line 338 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetDashLength(), KIGFX::RENDER_SETTINGS::GetDashLengthRatio(), and KIGFX::RENDER_SETTINGS::SetDashLengthRatio().

◆ m_defaultFont

wxString KIGFX::RENDER_SETTINGS::m_defaultFont

protectedinherited

Definition at line 341 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetDefaultFont(), and KIGFX::RENDER_SETTINGS::SetDefaultFont().

◆ m_defaultPenWidth

int KIGFX::RENDER_SETTINGS::m_defaultPenWidth

protectedinherited

Definition at line 335 of file render_settings.h.

Referenced by KIGFX::SCH_RENDER_SETTINGS::GetDanglineSymbolThickness(), KIGFX::RENDER_SETTINGS::GetDefaultPenWidth(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetDefaultPenWidth().

◆ m_drawBoundingBoxes

bool KIGFX::RENDER_SETTINGS::m_drawBoundingBoxes

protectedinherited

Definition at line 329 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetDrawBoundingBoxes(), and KIGFX::RENDER_SETTINGS::SetDrawBoundingBoxes().

◆ m_drawingSheetLineWidth

float KIGFX::RENDER_SETTINGS::m_drawingSheetLineWidth

protectedinherited

Definition at line 333 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetDrawingSheetLineWidth(), and KIGFX::RENDER_SETTINGS::RENDER_SETTINGS().

◆ m_ForcePadSketchModeOn

bool KIGFX::PCB_RENDER_SETTINGS::m_ForcePadSketchModeOn

Definition at line 122 of file pcb_painter.h.

Referenced by KIGFX::PCB_PAINTER::draw(), DIALOG_PAD_PROPERTIES::onChangePadMode(), PCB_RENDER_SETTINGS(), and DIALOG_PAD_PROPERTIES::prepareCanvas().

◆ m_gapLengthRatio

double KIGFX::RENDER_SETTINGS::m_gapLengthRatio

protectedinherited

Definition at line 339 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetGapLength(), KIGFX::RENDER_SETTINGS::GetGapLengthRatio(), and KIGFX::RENDER_SETTINGS::SetGapLengthRatio().

◆ m_hiContrastColor

COLOR4D KIGFX::RENDER_SETTINGS::m_hiContrastColor[LAYER_ID_COUNT]

protectedinherited

Definition at line 316 of file render_settings.h.

Referenced by KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), and KIGFX::RENDER_SETTINGS::update().

◆ m_hiContrastEnabled

bool KIGFX::RENDER_SETTINGS::m_hiContrastEnabled

protectedinherited

Parameters for display modes.

Definition at line 322 of file render_settings.h.

Referenced by KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GetColor(), KIGFX::RENDER_SETTINGS::GetHighContrast(), LoadDisplayOptions(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetHighContrast().

◆ m_hiContrastFactor

float KIGFX::RENDER_SETTINGS::m_hiContrastFactor

protectedinherited

Definition at line 323 of file render_settings.h.

Referenced by GetColor(), LoadColors(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::update().

◆ m_hiddenNets

std::set<int> KIGFX::PCB_RENDER_SETTINGS::m_hiddenNets

protected

Definition at line 143 of file pcb_painter.h.

Referenced by GetHiddenNets().

◆ m_highContrastLayers

std::set<int> KIGFX::RENDER_SETTINGS::m_highContrastLayers

protectedinherited

Definition at line 310 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::ClearHighContrastLayers(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GetColor(), KIGFX::RENDER_SETTINGS::GetHighContrastLayers(), KIGFX::RENDER_SETTINGS::GetLayerIsHighContrast(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), and KIGFX::RENDER_SETTINGS::SetLayerIsHighContrast().

◆ m_highlightEnabled

bool KIGFX::RENDER_SETTINGS::m_highlightEnabled

protectedinherited

Definition at line 325 of file render_settings.h.

Referenced by KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GetColor(), KIGFX::RENDER_SETTINGS::IsHighlightEnabled(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetHighlight().

◆ m_highlightFactor

float KIGFX::RENDER_SETTINGS::m_highlightFactor

protectedinherited

Definition at line 327 of file render_settings.h.

Referenced by GetColor(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), KIGFX::RENDER_SETTINGS::SetHighlightFactor(), and KIGFX::RENDER_SETTINGS::update().

◆ m_highlightNetcodes

std::set<int> KIGFX::RENDER_SETTINGS::m_highlightNetcodes

protectedinherited

Definition at line 326 of file render_settings.h.

Referenced by GetColor(), KIGFX::RENDER_SETTINGS::GetHighlightNetCodes(), and KIGFX::RENDER_SETTINGS::SetHighlight().

◆ m_imageOpacity

double KIGFX::PCB_RENDER_SETTINGS::m_imageOpacity

protected

Opacity override for user images.

Definition at line 150 of file pcb_painter.h.

Referenced by GetColor(), LoadDisplayOptions(), and PCB_RENDER_SETTINGS().

◆ m_isPrinting

bool KIGFX::RENDER_SETTINGS::m_isPrinting

protectedinherited

Definition at line 343 of file render_settings.h.

Referenced by KIGFX::PCB_PAINTER::draw(), GetColor(), KIGFX::RENDER_SETTINGS::IsPrinting(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetIsPrinting().

◆ m_layerColors

COLOR4D KIGFX::RENDER_SETTINGS::m_layerColors[LAYER_ID_COUNT]

protectedinherited

Definition at line 312 of file render_settings.h.

Referenced by KIGFX::SCH_RENDER_SETTINGS::GetBackgroundColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetBackgroundColor(), GetBackgroundColor(), KIGFX::SCH_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GetColor(), KIGFX::SCH_RENDER_SETTINGS::GetCursorColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetCursorColor(), GetCursorColor(), KIGFX::SCH_RENDER_SETTINGS::GetGridColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetGridColor(), GetGridColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetLayerColor(), KIGFX::SCH_RENDER_SETTINGS::IsBackgroundDark(), IsBackgroundDark(), KIGFX::SCH_RENDER_SETTINGS::LoadColors(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), KIGFX::DS_RENDER_SETTINGS::LoadColors(), LoadColors(), KIGFX::SCH_RENDER_SETTINGS::SetBackgroundColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::SetBackgroundColor(), SetBackgroundColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::SetLayerColor(), KIGFX::RENDER_SETTINGS::SetLayerColor(), and KIGFX::RENDER_SETTINGS::update().

◆ m_layerColorsDark

COLOR4D KIGFX::RENDER_SETTINGS::m_layerColorsDark[LAYER_ID_COUNT]

protectedinherited

Definition at line 317 of file render_settings.h.

Referenced by KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), and KIGFX::RENDER_SETTINGS::update().

◆ m_layerColorsHi

COLOR4D KIGFX::RENDER_SETTINGS::m_layerColorsHi[LAYER_ID_COUNT]

protectedinherited

Definition at line 313 of file render_settings.h.

Referenced by KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), and KIGFX::RENDER_SETTINGS::update().

◆ m_layerColorsSel

COLOR4D KIGFX::RENDER_SETTINGS::m_layerColorsSel[LAYER_ID_COUNT]

protectedinherited

Definition at line 314 of file render_settings.h.

Referenced by KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), and KIGFX::RENDER_SETTINGS::update().

◆ m_layerName

wxString KIGFX::RENDER_SETTINGS::m_layerName

protectedinherited

Definition at line 309 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetLayerName(), and KIGFX::RENDER_SETTINGS::SetLayerName().

◆ m_minPenWidth

int KIGFX::RENDER_SETTINGS::m_minPenWidth

protectedinherited

Definition at line 336 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetMinPenWidth(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), KIGFX::SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetMinPenWidth().

◆ m_netclassColors

std::map<wxString, KIGFX::COLOR4D> KIGFX::PCB_RENDER_SETTINGS::m_netclassColors

protected

Overrides for specific net colors, stored as netcodes for the ratsnest to access easily.

Definition at line 137 of file pcb_painter.h.

Referenced by GetColor(), and GetNetclassColorMap().

◆ m_netColorMode

NET_COLOR_MODE KIGFX::PCB_RENDER_SETTINGS::m_netColorMode

protected

Overrides for specific netclass colors.

Definition at line 134 of file pcb_painter.h.

Referenced by GetColor(), GetNetColorMode(), LoadDisplayOptions(), PCB_RENDER_SETTINGS(), and SetNetColorMode().

◆ m_netColors

std::map<int, KIGFX::COLOR4D> KIGFX::PCB_RENDER_SETTINGS::m_netColors

protected

Set of net codes that should not have their ratsnest displayed.

Definition at line 140 of file pcb_painter.h.

Referenced by GetColor(), and GetNetColorMap().

◆ m_outlineWidth

float KIGFX::RENDER_SETTINGS::m_outlineWidth

protectedinherited

Definition at line 332 of file render_settings.h.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::draw(), KIGFX::GERBVIEW_PAINTER::drawApertureMacro(), KIGFX::GERBVIEW_PAINTER::drawFlashedShape(), KIGFX::GERBVIEW_PAINTER::drawPolygon(), KIGFX::GERBVIEW_PAINTER::getLineThickness(), KIGFX::PCB_PAINTER::getLineThickness(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetOutlineWidth().

◆ m_PadEditModePad

PAD* KIGFX::PCB_RENDER_SETTINGS::m_PadEditModePad

Definition at line 127 of file pcb_painter.h.

Referenced by PAD_TOOL::EditPad(), GetColor(), and PCB_RENDER_SETTINGS().

◆ m_padOpacity

double KIGFX::PCB_RENDER_SETTINGS::m_padOpacity

protected

Opacity override for SMD pads and PTHs.

Definition at line 148 of file pcb_painter.h.

Referenced by GetColor(), LoadDisplayOptions(), and PCB_RENDER_SETTINGS().

◆ m_printDC

wxDC* KIGFX::RENDER_SETTINGS::m_printDC

protectedinherited

Definition at line 346 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetPrintDC(), and KIGFX::RENDER_SETTINGS::SetPrintDC().

◆ m_printLayers

LSET KIGFX::RENDER_SETTINGS::m_printLayers

protectedinherited

Definition at line 344 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetPrintLayers(), and KIGFX::RENDER_SETTINGS::SetPrintLayers().

◆ m_selectFactor

float KIGFX::RENDER_SETTINGS::m_selectFactor

protectedinherited

Definition at line 331 of file render_settings.h.

Referenced by GetColor(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), KIGFX::RENDER_SETTINGS::SetSelectFactor(), and KIGFX::RENDER_SETTINGS::update().

◆ m_trackOpacity

double KIGFX::PCB_RENDER_SETTINGS::m_trackOpacity

protected

Opacity override for all tracks.

Definition at line 146 of file pcb_painter.h.

Referenced by GetColor(), LoadDisplayOptions(), and PCB_RENDER_SETTINGS().

◆ m_viaOpacity

double KIGFX::PCB_RENDER_SETTINGS::m_viaOpacity

protected

Opacity override for all types of via.

Definition at line 147 of file pcb_painter.h.

Referenced by GetColor(), LoadDisplayOptions(), and PCB_RENDER_SETTINGS().

◆ m_ZoneDisplayMode

ZONE_DISPLAY_MODE KIGFX::PCB_RENDER_SETTINGS::m_ZoneDisplayMode

Definition at line 124 of file pcb_painter.h.

Referenced by KIGFX::PCB_PAINTER::draw(), LoadDisplayOptions(), and PCB_RENDER_SETTINGS().

◆ m_zoneOpacity

double KIGFX::PCB_RENDER_SETTINGS::m_zoneOpacity

protected

Opacity override for filled zones.

Definition at line 149 of file pcb_painter.h.

Referenced by GetColor(), LoadDisplayOptions(), and PCB_RENDER_SETTINGS().

◆ MAX_FONT_SIZE

const double PCB_RENDER_SETTINGS::MAX_FONT_SIZE = pcbIUScale.mmToIU( 10.0 )

staticprotected

< Maximum font size for netnames (and other dynamically shown strings)

How to display nets and netclasses with color overrides

Definition at line 131 of file pcb_painter.h.

Referenced by KIGFX::PCB_PAINTER::draw().

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

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ PCB_RENDER_SETTINGS()

Member Function Documentation

◆ ClearHighContrastLayers()

◆ GetActiveLayer()

◆ GetBackgroundColor()

◆ GetColor()

◆ GetCursorColor()

◆ GetDashLength()

◆ GetDashLengthRatio()

◆ GetDefaultFont()

◆ GetDefaultPenWidth()

◆ GetDotLength()

◆ GetDrawBoundingBoxes()

◆ GetDrawingSheetLineWidth()

◆ GetGapLength()

◆ GetGapLengthRatio()

◆ GetGridColor()

◆ GetHiddenNets() [1/2]

◆ GetHiddenNets() [2/2]

◆ GetHighContrast()

◆ GetHighContrastLayers()

◆ GetHighlightNetCodes()

◆ GetLayerColor()

◆ GetLayerIsHighContrast()

◆ GetLayerName()

◆ GetMinPenWidth()

◆ GetNetclassColorMap()

◆ GetNetColorMap()

◆ GetNetColorMode()

◆ GetPrimaryHighContrastLayer()

◆ GetPrintDC()

◆ GetPrintLayers()

◆ GetShowPageLimits()

◆ IsBackgroundDark()

◆ IsHighlightEnabled()

◆ IsPrinting()

◆ LoadColors()

◆ LoadDisplayOptions()

◆ SetActiveLayer()

◆ SetBackgroundColor()

◆ SetDashLengthRatio()

◆ SetDefaultFont()

◆ SetDefaultPenWidth()

◆ SetDrawBoundingBoxes()

◆ SetGapLengthRatio()

◆ SetHighContrast()

◆ SetHighlight() [1/2]

◆ SetHighlight() [2/2]

◆ SetHighlightFactor()

◆ SetIsPrinting()

◆ SetLayerColor()

◆ SetLayerIsHighContrast()

◆ SetLayerName()

◆ SetMinPenWidth()

◆ SetNetColorMode()

◆ SetOutlineWidth()

◆ SetPrintDC()

◆ SetPrintLayers()

◆ SetSelectFactor()

◆ update()

Friends And Related Function Documentation

◆ PCB_PAINTER

Member Data Documentation

◆ m_activeLayer

◆ m_backgroundColor

◆ m_ContrastModeDisplay

◆ m_dashLengthRatio

◆ m_defaultFont

◆ m_defaultPenWidth

◆ m_drawBoundingBoxes

◆ m_drawingSheetLineWidth

◆ m_ForcePadSketchModeOn