KiCad PCB EDA Suite
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | Friends | List of all members
KIGFX::PCB_RENDER_SETTINGS Class Reference

PCB specific render settings. More...

#include <pcb_painter.h>

Inheritance diagram for KIGFX::PCB_RENDER_SETTINGS:
KIGFX::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).
 
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.
 
COLOR4D GetColor (const BOARD_ITEM *aItem, int aLayer) const
 nullptr version
 
COLOR4D GetColor (std::nullptr_t, int aLayer) const
 
bool GetShowPageLimits () const override
 
bool IsBackgroundDark () const override
 
const COLOR4D & GetBackgroundColor () const override
 Return current background color settings.
 
void SetBackgroundColor (const COLOR4D &aColor) override
 Set the background color.
 
const COLOR4D & GetGridColor () override
 Return current grid color settings.
 
const COLOR4D & GetCursorColor () override
 Return current cursor color settings.
 
NET_COLOR_MODE GetNetColorMode () const
 
void SetNetColorMode (NET_COLOR_MODE aMode)
 
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.
 
bool GetLayerIsHighContrast (int aLayerId) const
 Return information whether the queried layer is marked as high-contrast.
 
const std::set< int > GetHighContrastLayers () const
 Returns the set of currently high-contrast layers.
 
PCB_LAYER_ID GetPrimaryHighContrastLayer () const
 Return the board layer which is in high-contrast mode.
 
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 (const LSET &aLayerSet)
 
void ClearHighContrastLayers ()
 Clear the list of active layers.
 
bool IsHighlightEnabled () const
 Return current highlight setting.
 
const std::set< int > & GetHighlightNetCodes () const
 Return the netcode of currently highlighted net.
 
void SetHighlight (bool aEnabled, int aNetcode=-1, bool aMulti=false)
 Turns on/off highlighting.
 
void SetHighlight (std::set< int > &aHighlight, bool aEnabled=true)
 Turns on highlighting and highlights multiple nets.
 
void SetHighContrast (bool aEnabled)
 Turns on/off high contrast display mode.
 
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)
 
bool IsPrintBlackAndWhite () const
 
void SetPrintBlackAndWhite (bool aPrintBlackAndWhite)
 
bool PrintBlackAndWhiteReq () const
 
const COLOR4D & GetLayerColor (int aLayer) const
 Return the color used to draw a layer.
 
void SetLayerColor (int aLayer, const COLOR4D &aColor)
 Change the color used to draw a layer.
 
void SetOutlineWidth (float aWidth)
 Set line width used for drawing outlines.
 
float GetOutlineWidth () const
 
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
 
bool m_ForceShowFieldsWhenFPSelected
 
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.
 

Protected Attributes

NET_COLOR_MODE m_netColorMode
 Overrides for specific netclass colors.
 
std::map< wxString, KIGFX::COLOR4D > m_netclassColors
 Overrides for specific net colors, stored as netcodes for the ratsnest to access easily.
 
std::map< int, KIGFX::COLOR4D > m_netColors
 Set of net codes that should not have their ratsnest displayed.
 
std::set< int > m_hiddenNets
 
double m_trackOpacity
 Opacity override for all tracks.
 
double m_viaOpacity
 Opacity override for all types of via.
 
double m_padOpacity
 Opacity override for SMD pads and PTHs.
 
double m_zoneOpacity
 Opacity override for filled zones.
 
double m_imageOpacity
 Opacity override for user images.
 
double m_filledShapeOpacity
 Opacity override for graphic shapes.
 
PCB_LAYER_ID m_activeLayer
 
wxString m_layerName
 
std::set< int > m_highContrastLayers
 
std::map< int, COLOR4D > m_layerColors
 
std::map< int, COLOR4D > m_layerColorsHi
 
std::map< int, COLOR4D > m_layerColorsSel
 
std::map< int, COLOR4D > m_hiContrastColor
 
std::map< int, COLOR4D > m_layerColorsDark
 
COLOR4D m_backgroundColor
 
bool m_hiContrastEnabled
 Parameters for display modes.
 
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
 
bool m_printBlackAndWite
 
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)
 

Friends

class PCB_PAINTER
 

Detailed Description

PCB specific render settings.

Definition at line 78 of file pcb_painter.h.

Constructor & Destructor Documentation

◆ PCB_RENDER_SETTINGS()

PCB_RENDER_SETTINGS::PCB_RENDER_SETTINGS ( )

Definition at line 107 of file pcb_painter.cpp.

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

Member Function Documentation

◆ ClearHighContrastLayers()

void KIGFX::RENDER_SETTINGS::ClearHighContrastLayers ( )
inlineinherited

Clear the list of active layers.

Definition at line 125 of file render_settings.h.

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 113 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_activeLayer.

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

◆ GetBackgroundColor()

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

Return current background color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 119 of file pcb_painter.h.

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

Referenced by FOOTPRINT_PREVIEW_PANEL::GetBackgroundColor().

◆ GetColor() [1/3]

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

nullptr version

Definition at line 199 of file pcb_painter.cpp.

References LSET::AllCuMask(), B_Cu, B_Mask, KIGFX::COLOR4D::BLACK, KIGFX::COLOR4D::Brighten(), KIGFX::COLOR4D::CLEAR, color, KIGFX::COLOR4D::Darken(), Edge_Cuts, F_Cu, F_Mask, KIGFX::RENDER_SETTINGS::GetActiveLayer(), BOARD_ITEM::GetBoard(), BOARD_CONNECTED_ITEM::GetEffectiveNetClass(), BOARD::GetEnabledLayers(), KIGFX::VIEW_ITEM::GetForcedTransparency(), BOARD_ITEM::GetLayerSet(), BOARD_CONNECTED_ITEM::GetNetCode(), GetNetnameLayer(), NETCLASS::GetPcbColor(), KIGFX::RENDER_SETTINGS::GetPrimaryHighContrastLayer(), BOARD::GetVisibleLayers(), NETCLASS::HasPcbColor(), EDA_ITEM::IsBrightened(), IsClearanceLayer(), BOARD_ITEM::IsConnected(), IsCopperLayer(), IsHoleLayer(), IsNetnameLayer(), BOARD_ITEM::IsOnCopperLayer(), IsPadCopperLayer(), EDA_ITEM::IsSelected(), IsViaCopperLayer(), IsZoneFillLayer(), LAYER_CLEARANCE_START, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_LOCKED_ITEM_SHADOW, LAYER_MARKER_SHADOWS, LAYER_NON_PLATEDHOLES, LAYER_PAD_BK_NETNAMES, LAYER_PAD_COPPER_START, LAYER_PAD_FR_NETNAMES, LAYER_PAD_HOLEWALLS, LAYER_PAD_PLATEDHOLES, LAYER_PADS, LAYER_PCB_BACKGROUND, LAYER_VIA_BBLIND, LAYER_VIA_COPPER_START, LAYER_VIA_HOLES, LAYER_VIA_HOLEWALLS, LAYER_VIA_MICROVIA, LAYER_VIA_THROUGH, LAYER_ZONE_START, KIGFX::RENDER_SETTINGS::m_backgroundColor, m_ContrastModeDisplay, m_filledShapeOpacity, KIGFX::RENDER_SETTINGS::m_hiContrastEnabled, KIGFX::RENDER_SETTINGS::m_hiContrastFactor, KIGFX::RENDER_SETTINGS::m_highContrastLayers, KIGFX::RENDER_SETTINGS::m_highlightEnabled, KIGFX::RENDER_SETTINGS::m_highlightFactor, KIGFX::RENDER_SETTINGS::m_highlightNetcodes, m_imageOpacity, KIGFX::RENDER_SETTINGS::m_isPrinting, KIGFX::RENDER_SETTINGS::m_layerColors, KIGFX::RENDER_SETTINGS::m_layerColorsDark, KIGFX::RENDER_SETTINGS::m_layerColorsHi, KIGFX::RENDER_SETTINGS::m_layerColorsSel, m_netColorMode, m_netColors, m_PadEditModePad, m_padOpacity, KIGFX::RENDER_SETTINGS::m_selectFactor, m_trackOpacity, m_viaOpacity, m_zoneOpacity, pad, PCB_ARC_T, PCB_PAD_T, PCB_REFERENCE_IMAGE_T, PCB_SHAPE_T, PCB_TABLE_T, PCB_TABLECELL_T, PCB_TRACE_T, PCB_VIA_T, PCB_ZONE_T, LSET::PhysicalLayersMask(), LSET::Seq(), EDA_ITEM::Type(), UNDEFINED_LAYER, KIGFX::COLOR4D::UNSPECIFIED, via, KIGFX::COLOR4D::WHITE, and KIGFX::COLOR4D::WithAlpha().

◆ GetColor() [2/3]

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
aItemis the VIEW_ITEM.
aLayeris the layer.
Returns
The color. Board-specific version

Implements KIGFX::RENDER_SETTINGS.

Definition at line 193 of file pcb_painter.cpp.

References GetColor().

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

◆ GetColor() [3/3]

COLOR4D KIGFX::PCB_RENDER_SETTINGS::GetColor ( std::nullptr_t  ,
int  aLayer 
) const
inline

Definition at line 102 of file pcb_painter.h.

References GetColor().

◆ GetCursorColor()

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

Return current cursor color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 132 of file pcb_painter.h.

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

◆ GetDashLength()

double RENDER_SETTINGS::GetDashLength ( int  aLineWidth) const
inherited

Definition at line 67 of file render_settings.cpp.

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 216 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_dashLengthRatio.

◆ GetDefaultFont()

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

Definition at line 305 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_defaultFont.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::getFont(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), PlotDrawingSheet(), SCH_PIN::PlotPinTexts(), BRDITEMS_PLOTTER::PlotText(), EDA_TEXT::printOneLineOfText(), and DS_PROXY_VIEW_ITEM::ViewDraw().

◆ GetDefaultPenWidth()

int KIGFX::RENDER_SETTINGS::GetDefaultPenWidth ( ) const
inlineinherited

Definition at line 210 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_defaultPenWidth.

Referenced by KIGFX::SCH_PAINTER::draw(), SCH_ITEM::GetEffectivePenWidth(), KIGFX::SCH_PAINTER::getTextThickness(), SCH_BITMAP::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), PlotDrawingSheet(), SCH_PIN::PlotPinTexts(), PrintDrawingSheet(), EDA_TEXT::printOneLineOfText(), 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 73 of file render_settings.cpp.

References correction.

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

◆ GetDrawBoundingBoxes()

bool KIGFX::RENDER_SETTINGS::GetDrawBoundingBoxes ( ) const
inlineinherited

Definition at line 196 of file render_settings.h.

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 208 of file render_settings.h.

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 81 of file render_settings.cpp.

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 221 of file render_settings.h.

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 130 of file pcb_painter.h.

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

◆ GetHiddenNets() [1/2]

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

Definition at line 139 of file pcb_painter.h.

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 140 of file pcb_painter.h.

References m_hiddenNets.

◆ GetHighContrast()

bool KIGFX::RENDER_SETTINGS::GetHighContrast ( ) const
inlineinherited

Definition at line 193 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_hiContrastEnabled.

Referenced by PCB_GRID_HELPER::computeAnchors(), PAD_TOOL::EnumeratePads(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), PCB_SELECTION_TOOL::GuessSelectionCandidates(), BOARD_INSPECTION_TOOL::highlightNet(), PNS_KICAD_IFACE::IsItemVisible(), PCB_GRID_HELPER::queryVisible(), PCB_SELECTION_TOOL::Selectable(), PAD::ViewGetLOD(), PCB_REFERENCE_IMAGE::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 91 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_highContrastLayers.

Referenced by PCB_GRID_HELPER::computeAnchors(), PAD_TOOL::EnumeratePads(), PCB_SELECTION_TOOL::FilterCollectorForFootprints(), 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 145 of file render_settings.h.

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_NET_INSPECTOR_PANEL::OnNetsListContextMenu(), and PCB_EDIT_FRAME::setupUIConditions().

◆ GetLayerColor()

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

Return the color used to draw a layer.

Parameters
aLayeris the layer number.

Definition at line 266 of file render_settings.h.

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

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::drawAnchor(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircle(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawCircleDashed(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLine(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineDashed(), KIGFX::PREVIEW::DRAW_CONTEXT::DrawLineWithAngleHighlight(), BOARD_PRINTOUT::DrawPage(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), KIGFX::SCH_PAINTER::getRenderColor(), GRID_HELPER::GRID_HELPER(), DIALOG_SHAPE_PROPERTIES::onBorderSwatch(), DIALOG_SHAPE_PROPERTIES::onFillRadioButton(), RULE_AREA_CREATE_HELPER::OnFirstPoint(), PCB_GRID_HELPER::PCB_GRID_HELPER(), LIB_SYMBOL::Plot(), SCH_BITMAP::Plot(), SCH_BUS_ENTRY_BASE::Plot(), SCH_FIELD::Plot(), SCH_JUNCTION::Plot(), SCH_LABEL_BASE::Plot(), SCH_LINE::Plot(), SCH_NO_CONNECT::Plot(), SCH_RULE_AREA::Plot(), SCH_SHAPE::Plot(), SCH_SHEET::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), SCH_TEXTBOX::Plot(), SCH_SYMBOL::PlotDNP(), LIB_SYMBOL::PlotFields(), SCH_PLOTTER::plotOneSheetDXF(), SCH_PLOTTER::plotOneSheetPDF(), SCH_PLOTTER::plotOneSheetPS(), SCH_PLOTTER::plotOneSheetSVG(), SCH_PIN::PlotPinTexts(), SCH_PIN::PlotPinType(), POSITION_RELATIVE_TOOL::PositionRelativeInteractively(), SCH_PRINTOUT::PrintPage(), DS_DRAW_ITEM_LINE::PrintWsItem(), DS_DRAW_ITEM_POLYPOLYGONS::PrintWsItem(), DS_DRAW_ITEM_RECT::PrintWsItem(), DS_DRAW_ITEM_TEXT::PrintWsItem(), setupPlotterNewPDFPage(), StartPlotBoard(), DIALOG_SHAPE_PROPERTIES::TransferDataToWindow(), DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample(), DS_PROXY_VIEW_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), KIGFX::PREVIEW::RULER_ITEM::ViewDraw(), and KIGFX::ANCHOR_DEBUG::ViewDraw().

◆ 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 83 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_highContrastLayers.

Referenced by PCB_REFERENCE_IMAGE::ViewGetLOD().

◆ GetLayerName()

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

Definition at line 116 of file render_settings.h.

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 213 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_minPenWidth.

Referenced by SCH_ITEM::GetEffectivePenWidth(), SCH_BUS_ENTRY_BASE::Plot(), SCH_FIELD::Plot(), SCH_LABEL_BASE::Plot(), SCH_TABLE::Plot(), SCH_TEXT::Plot(), and SCH_TEXTBOX::Plot().

◆ GetNetColorMap()

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

Definition at line 137 of file pcb_painter.h.

References m_netColors.

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

◆ GetNetColorMode()

NET_COLOR_MODE KIGFX::PCB_RENDER_SETTINGS::GetNetColorMode ( ) const
inline

Definition at line 134 of file pcb_painter.h.

References m_netColorMode.

Referenced by PNS_KICAD_IFACE::DisplayRatline().

◆ GetOutlineWidth()

float KIGFX::RENDER_SETTINGS::GetOutlineWidth ( ) const
inlineinherited

Definition at line 299 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_outlineWidth.

◆ 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 102 of file render_settings.h.

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

Referenced by PCB_GRID_HELPER::computeAnchors(), 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 308 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_printDC.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), EDA_DRAW_FRAME::PrintDrawingSheet(), EDA_TEXT::printOneLineOfText(), 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 119 of file render_settings.h.

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 548 of file pcb_painter.cpp.

References PCBNEW_SETTINGS::m_ShowPageLimits, and pcbconfig().

◆ IsBackgroundDark()

bool KIGFX::PCB_RENDER_SETTINGS::IsBackgroundDark ( ) const
inlineoverridevirtual

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 109 of file pcb_painter.h.

References 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 135 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_highlightEnabled.

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

◆ IsPrintBlackAndWhite()

bool KIGFX::RENDER_SETTINGS::IsPrintBlackAndWhite ( ) const
inlineinherited

Definition at line 230 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_printBlackAndWite.

◆ IsPrinting()

bool KIGFX::RENDER_SETTINGS::IsPrinting ( ) const
inlineinherited

Definition at line 227 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_isPrinting.

Referenced by KIGFX::PCB_PAINTER::draw(), KIGFX::SCH_PAINTER::draw(), KIGFX::SCH_PAINTER::drawAnchor(), KIGFX::SCH_PAINTER::drawDanglingIndicator(), SCH_RENDER_SETTINGS::GetShowPageLimits(), and KIGFX::VIEW_ITEM::lodScaleForThreshold().

◆ LoadColors()

void PCB_RENDER_SETTINGS::LoadColors ( const COLOR_SETTINGS *  aSettings)
overridevirtual

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 134 of file pcb_painter.cpp.

References LSET::AllCuMask(), GAL_LAYER_ID_END, GAL_LAYER_ID_START, COLOR_SETTINGS::GetColor(), PGM_BASE::GetCommonSettings(), GetNetnameLayer(), COMMON_SETTINGS::APPEARANCE::hicontrast_dimming_factor, KIGFX::COLOR4D::Inverted(), LAYER_PAD_NETNAMES, LAYER_PAD_PLATEDHOLES, LAYER_PCB_BACKGROUND, COMMON_SETTINGS::m_Appearance, KIGFX::RENDER_SETTINGS::m_hiContrastFactor, KIGFX::RENDER_SETTINGS::m_layerColors, NETNAMES_LAYER_ID_START, PCB_LAYER_ID_COUNT, Pgm(), PgmOrNull(), SetBackgroundColor(), and KIGFX::RENDER_SETTINGS::update().

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_DESIGN_BLOCK_PREVIEW_WIDGET::PCB_DESIGN_BLOCK_PREVIEW_WIDGET(), 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
aOptionsare settings that you want to use for displaying items.

Definition at line 177 of file pcb_painter.cpp.

References PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay, m_ContrastModeDisplay, PCB_DISPLAY_OPTIONS::m_FilledShapeOpacity, m_filledShapeOpacity, KIGFX::RENDER_SETTINGS::m_hiContrastEnabled, PCB_DISPLAY_OPTIONS::m_ImageOpacity, m_imageOpacity, PCB_DISPLAY_OPTIONS::m_NetColorMode, m_netColorMode, PCB_DISPLAY_OPTIONS::m_PadOpacity, m_padOpacity, PCB_DISPLAY_OPTIONS::m_TrackOpacity, m_trackOpacity, PCB_DISPLAY_OPTIONS::m_ViaOpacity, m_viaOpacity, PCB_DISPLAY_OPTIONS::m_ZoneDisplayMode, m_ZoneDisplayMode, PCB_DISPLAY_OPTIONS::m_ZoneOpacity, and m_zoneOpacity.

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

◆ PrintBlackAndWhiteReq()

bool KIGFX::RENDER_SETTINGS::PrintBlackAndWhiteReq ( ) const
inlineinherited

Definition at line 236 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_isPrinting, and KIGFX::RENDER_SETTINGS::m_printBlackAndWite.

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

◆ SetActiveLayer()

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

Definition at line 114 of file render_settings.h.

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 125 of file pcb_painter.h.

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 217 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_dashLengthRatio.

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_RENDER_SETTINGS(), 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 304 of file render_settings.h.

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 211 of file render_settings.h.

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(), SCH_RENDER_SETTINGS::SCH_RENDER_SETTINGS(), SCH_EDIT_FRAME::ShowSchematicSetupDialog(), GERBER_PLOTTER::StartPlot(), StartPlotBoard(), SYMBOL_EDIT_FRAME::SVGPlotSymbol(), SYMBOL_DIFF_FRAME::SYMBOL_DIFF_FRAME(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetDrawBoundingBoxes()

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

Definition at line 195 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_drawBoundingBoxes.

Referenced by COMMON_TOOLS::ToggleBoundingBoxes().

◆ SetGapLengthRatio()

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

Definition at line 222 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_gapLengthRatio.

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), PCB_RENDER_SETTINGS(), 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 192 of file render_settings.h.

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
aEnabledtells if highlighting should be enabled.
aNetcodeis optional and if specified, turns on highlighting only for the net with number given as the parameter.

Definition at line 159 of file render_settings.h.

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

Referenced by BOARD_INSPECTION_TOOL::ClearHighlight(), PCB_EDIT_FRAME::ExecuteRemoteCommand(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), PCB_NET_INSPECTOR_PANEL::highlightSelectedNets(), PCB_NET_INSPECTOR_PANEL::onClearHighlighting(), APPEARANCE_CONTROLS::onNetclassContextMenu(), SCH_SELECTION_TOOL::Reset(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Reset(), NETS_SEARCH_HANDLER::SelectItems(), and RATSNEST_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
aHighlightis a set of netcodes to highlight
aEnabledtells if highlighting should be enabled.

Definition at line 179 of file render_settings.h.

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

◆ SetHighlightFactor()

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

Definition at line 301 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_highlightFactor.

Referenced by PCB_BASE_FRAME::LoadSettings().

◆ SetIsPrinting()

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

Definition at line 228 of file render_settings.h.

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
aLayeris the layer number.
aColoris the new color.

Definition at line 281 of file render_settings.h.

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
aLayerIdis a layer number that should be displayed in a specific mode.
aEnabledis the new layer state ( true = active or false = not active).

Definition at line 70 of file render_settings.h.

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 117 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_layerName.

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

◆ SetMinPenWidth()

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

Definition at line 214 of file render_settings.h.

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 135 of file pcb_painter.h.

References m_netColorMode.

◆ SetOutlineWidth()

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

Set line width used for drawing outlines.

Parameters
aWidthis the new width.

Definition at line 298 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_outlineWidth.

◆ SetPrintBlackAndWhite()

void KIGFX::RENDER_SETTINGS::SetPrintBlackAndWhite ( bool  aPrintBlackAndWhite)
inlineinherited

Definition at line 231 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_printBlackAndWite.

Referenced by SCH_PRINTOUT::PrintPage().

◆ SetPrintDC()

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

Definition at line 309 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_printDC.

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

◆ SetPrintLayers()

void KIGFX::RENDER_SETTINGS::SetPrintLayers ( const LSET &  aLayerSet)
inlineinherited

Definition at line 120 of file render_settings.h.

References KIGFX::RENDER_SETTINGS::m_printLayers.

Referenced by BOARD_PRINTOUT::DrawPage().

◆ SetSelectFactor()

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

Definition at line 302 of file render_settings.h.

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 87 of file render_settings.cpp.

References IsNetnameLayer(), LAYER_ID_COUNT, LAYER_PCB_BACKGROUND, KIGFX::RENDER_SETTINGS::m_hiContrastColor, KIGFX::RENDER_SETTINGS::m_hiContrastFactor, KIGFX::RENDER_SETTINGS::m_highlightFactor, KIGFX::RENDER_SETTINGS::m_layerColors, KIGFX::RENDER_SETTINGS::m_layerColorsDark, KIGFX::RENDER_SETTINGS::m_layerColorsHi, KIGFX::RENDER_SETTINGS::m_layerColorsSel, and KIGFX::RENDER_SETTINGS::m_selectFactor.

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 81 of file pcb_painter.h.

Member Data Documentation

◆ m_activeLayer

PCB_LAYER_ID KIGFX::RENDER_SETTINGS::m_activeLayer
protectedinherited

Definition at line 318 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 328 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(), 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 147 of file pcb_painter.h.

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

◆ m_dashLengthRatio

double KIGFX::RENDER_SETTINGS::m_dashLengthRatio
protectedinherited

Definition at line 347 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 350 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 344 of file render_settings.h.

Referenced by SCH_RENDER_SETTINGS::GetDanglingIndicatorThickness(), 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 338 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 342 of file render_settings.h.

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

◆ m_filledShapeOpacity

double KIGFX::PCB_RENDER_SETTINGS::m_filledShapeOpacity
protected

Opacity override for graphic shapes.

Definition at line 173 of file pcb_painter.h.

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

◆ m_ForcePadSketchModeOn

bool KIGFX::PCB_RENDER_SETTINGS::m_ForcePadSketchModeOn

Definition at line 143 of file pcb_painter.h.

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

◆ m_ForceShowFieldsWhenFPSelected

bool KIGFX::PCB_RENDER_SETTINGS::m_ForceShowFieldsWhenFPSelected

Definition at line 144 of file pcb_painter.h.

Referenced by PCB_BASE_FRAME::ActivateGalCanvas(), PCB_BASE_FRAME::CommonSettingsChanged(), PCB_DRAW_PANEL_GAL::OnShow(), PCB_RENDER_SETTINGS(), and PCB_FIELD::ViewGetLOD().

◆ m_gapLengthRatio

double KIGFX::RENDER_SETTINGS::m_gapLengthRatio
protectedinherited

Definition at line 348 of file render_settings.h.

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

◆ m_hiContrastColor

std::map<int, COLOR4D> KIGFX::RENDER_SETTINGS::m_hiContrastColor
protectedinherited

Definition at line 325 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 331 of file render_settings.h.

Referenced by GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::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 332 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 165 of file pcb_painter.h.

Referenced by GetHiddenNets().

◆ m_highContrastLayers

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

Definition at line 320 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::ClearHighContrastLayers(), GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::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 334 of file render_settings.h.

Referenced by GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::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 336 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 335 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 172 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 352 of file render_settings.h.

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

◆ m_layerColors

std::map<int, COLOR4D> KIGFX::RENDER_SETTINGS::m_layerColors
protectedinherited

Definition at line 322 of file render_settings.h.

Referenced by SCH_RENDER_SETTINGS::GetBackgroundColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetBackgroundColor(), GetBackgroundColor(), GetColor(), SCH_RENDER_SETTINGS::GetColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), SCH_RENDER_SETTINGS::GetCursorColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetCursorColor(), GetCursorColor(), SCH_RENDER_SETTINGS::GetGridColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetGridColor(), GetGridColor(), KIGFX::GERBVIEW_RENDER_SETTINGS::GetLayerColor(), KIGFX::RENDER_SETTINGS::GetLayerColor(), SCH_RENDER_SETTINGS::IsBackgroundDark(), IsBackgroundDark(), SCH_RENDER_SETTINGS::LoadColors(), KIGFX::GERBVIEW_RENDER_SETTINGS::LoadColors(), KIGFX::DS_RENDER_SETTINGS::LoadColors(), LoadColors(), 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

std::map<int, COLOR4D> KIGFX::RENDER_SETTINGS::m_layerColorsDark
protectedinherited

Definition at line 326 of file render_settings.h.

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

◆ m_layerColorsHi

std::map<int, COLOR4D> KIGFX::RENDER_SETTINGS::m_layerColorsHi
protectedinherited

Definition at line 323 of file render_settings.h.

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

◆ m_layerColorsSel

std::map<int, COLOR4D> KIGFX::RENDER_SETTINGS::m_layerColorsSel
protectedinherited

Definition at line 324 of file render_settings.h.

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

◆ m_layerName

wxString KIGFX::RENDER_SETTINGS::m_layerName
protectedinherited

Definition at line 319 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 345 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::GetMinPenWidth(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), 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 159 of file pcb_painter.h.

◆ m_netColorMode

NET_COLOR_MODE KIGFX::PCB_RENDER_SETTINGS::m_netColorMode
protected

Overrides for specific netclass colors.

Definition at line 156 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 162 of file pcb_painter.h.

Referenced by GetColor(), and GetNetColorMap().

◆ m_outlineWidth

float KIGFX::RENDER_SETTINGS::m_outlineWidth
protectedinherited

Definition at line 341 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::GetOutlineWidth(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetOutlineWidth().

◆ m_PadEditModePad

PAD* KIGFX::PCB_RENDER_SETTINGS::m_PadEditModePad

Definition at line 149 of file pcb_painter.h.

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

◆ m_padOpacity

double KIGFX::PCB_RENDER_SETTINGS::m_padOpacity
protected

Opacity override for SMD pads and PTHs.

Definition at line 170 of file pcb_painter.h.

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

◆ m_printBlackAndWite

bool KIGFX::RENDER_SETTINGS::m_printBlackAndWite
protectedinherited

Definition at line 353 of file render_settings.h.

Referenced by KIGFX::RENDER_SETTINGS::IsPrintBlackAndWhite(), KIGFX::RENDER_SETTINGS::PrintBlackAndWhiteReq(), KIGFX::RENDER_SETTINGS::RENDER_SETTINGS(), and KIGFX::RENDER_SETTINGS::SetPrintBlackAndWhite().

◆ m_printDC

wxDC* KIGFX::RENDER_SETTINGS::m_printDC
protectedinherited

Definition at line 357 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 355 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 340 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 168 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 169 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 146 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 171 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 153 of file pcb_painter.h.

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

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