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::GERBVIEW_RENDER_SETTINGS Class Reference

Store GerbView specific render settings. More...

#include <gerbview_painter.h>

Inheritance diagram for KIGFX::GERBVIEW_RENDER_SETTINGS:
KIGFX::RENDER_SETTINGS

Public Member Functions

 GERBVIEW_RENDER_SETTINGS ()
 
void LoadColors (const COLOR_SETTINGS *aSettings) override
 
virtual 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.
 
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.
 
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.
 
bool GetShowPageLimits () const override
 
void ClearHighlightSelections ()
 Clear all highlight selections (dcode, net, component, attribute selection)
 
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
 
virtual bool IsBackgroundDark () const
 
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

wxString m_componentHighlightString
 If set to anything but an empty string, will highlight items with matching component.
 
wxString m_netHighlightString
 If set to anything but an empty string, will highlight items with matching net.
 
wxString m_attributeHighlightString
 If set to anything but an empty string, will highlight items with matching attribute.
 
int m_dcodeHighlightValue
 If set to anything but >0 (in fact 10 the min dcode value), will highlight items with matching dcode.
 

Protected Member Functions

virtual void update ()
 Precalculates extra colors for layers (e.g.
 

Protected Attributes

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 = gerbIUScale.mmToIU( 10.0 )
 Maximum font size for D-Codes and other strings.
 

Friends

class GERBVIEW_PAINTER
 

Detailed Description

Store GerbView specific render settings.

Definition at line 46 of file gerbview_painter.h.

Constructor & Destructor Documentation

◆ GERBVIEW_RENDER_SETTINGS()

GERBVIEW_RENDER_SETTINGS::GERBVIEW_RENDER_SETTINGS ( )

Definition at line 44 of file gerbview_painter.cpp.

References KIGFX::COLOR4D::BLACK, m_attributeHighlightString, KIGFX::RENDER_SETTINGS::m_backgroundColor, m_componentHighlightString, m_dcodeHighlightValue, m_netHighlightString, 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 m_highContrastLayers.

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

◆ ClearHighlightSelections()

void GERBVIEW_RENDER_SETTINGS::ClearHighlightSelections ( )

Clear all highlight selections (dcode, net, component, attribute selection)

Definition at line 91 of file gerbview_painter.cpp.

References m_attributeHighlightString, m_componentHighlightString, m_dcodeHighlightValue, and m_netHighlightString.

Referenced by GERBVIEW_CONTROL::ClearAllLayers().

◆ GetActiveLayer()

PCB_LAYER_ID KIGFX::RENDER_SETTINGS::GetActiveLayer ( ) const
inlineinherited

Definition at line 113 of file render_settings.h.

References m_activeLayer.

Referenced by KIGFX::PCB_RENDER_SETTINGS::GetColor().

◆ GetBackgroundColor()

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

Return current background color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 82 of file gerbview_painter.h.

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

◆ GetColor()

COLOR4D GERBVIEW_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.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 100 of file gerbview_painter.cpp.

References GERBER_DRAW_ITEM_T, GERBER_DRAW_ITEM::GetDcodeDescr(), GERBER_DRAW_ITEM::GetLayerPolarity(), GERBER_DRAW_ITEM::GetNetAttributes(), gvconfig(), IsDCodeLayer(), EDA_ITEM::IsSelected(), LAYER_DCODES, LAYER_NEGATIVE_OBJECTS, D_CODE::m_AperFunction, m_attributeHighlightString, GBR_NETLIST_METADATA::m_Cmpref, m_componentHighlightString, m_dcodeHighlightValue, KIGFX::RENDER_SETTINGS::m_hiContrastColor, KIGFX::RENDER_SETTINGS::m_hiContrastEnabled, KIGFX::RENDER_SETTINGS::m_highContrastLayers, KIGFX::RENDER_SETTINGS::m_highlightEnabled, KIGFX::RENDER_SETTINGS::m_layerColors, KIGFX::RENDER_SETTINGS::m_layerColorsDark, KIGFX::RENDER_SETTINGS::m_layerColorsHi, KIGFX::RENDER_SETTINGS::m_layerColorsSel, m_netHighlightString, GBR_NETLIST_METADATA::m_Netname, D_CODE::m_Num_Dcode, EDA_ITEM::Type(), and KIGFX::COLOR4D::WHITE.

◆ GetCursorColor()

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

Return current cursor color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 95 of file gerbview_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 m_dashLengthRatio.

Referenced by STROKE_PARAMS::Stroke().

◆ GetDashLengthRatio()

double KIGFX::RENDER_SETTINGS::GetDashLengthRatio ( ) const
inlineinherited

Definition at line 216 of file render_settings.h.

References m_dashLengthRatio.

◆ GetDefaultFont()

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

Definition at line 305 of file render_settings.h.

References m_defaultFont.

Referenced by SCH_ITEM::GetDefaultFont(), EDA_TEXT::GetDrawFont(), SCH_PIN::PlotPinTexts(), and DS_PROXY_VIEW_ITEM::ViewDraw().

◆ GetDefaultPenWidth()

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

Definition at line 210 of file render_settings.h.

References m_defaultPenWidth.

Referenced by SCH_ITEM::GetEffectivePenWidth(), 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(), and DS_DRAW_ITEM_RECT::PrintWsItem().

◆ GetDotLength()

double RENDER_SETTINGS::GetDotLength ( int aLineWidth) const
inherited

Definition at line 73 of file render_settings.cpp.

References correction.

Referenced by STROKE_PARAMS::Stroke().

◆ GetDrawBoundingBoxes()

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

Definition at line 196 of file render_settings.h.

References m_drawBoundingBoxes.

Referenced by EDITOR_CONDITIONS::bboxesFunc(), and COMMON_TOOLS::ToggleBoundingBoxes().

◆ GetDrawingSheetLineWidth()

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

Definition at line 208 of file render_settings.h.

References 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 m_gapLengthRatio.

Referenced by STROKE_PARAMS::Stroke().

◆ GetGapLengthRatio()

double KIGFX::RENDER_SETTINGS::GetGapLengthRatio ( ) const
inlineinherited

Definition at line 221 of file render_settings.h.

References m_gapLengthRatio.

◆ GetGridColor()

const COLOR4D & KIGFX::GERBVIEW_RENDER_SETTINGS::GetGridColor ( )
inlineoverridevirtual

Return current grid color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 93 of file gerbview_painter.h.

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

◆ GetHighContrast()

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

Definition at line 193 of file render_settings.h.

References 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 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 m_highlightNetcodes.

Referenced by PNS_KICAD_IFACE::DisplayRatline(), BOARD_INSPECTION_TOOL::highlightNet(), PNS::TOOL_BASE::highlightNets(), DRAWING_TOOL::Init(), PCB_SELECTION_TOOL::Init(), ROUTER_TOOL::Init(), PCB_NET_INSPECTOR_PANEL::OnNetsListContextMenu(), and PCB_EDIT_FRAME::setupUIConditions().

◆ GetLayerColor()

const COLOR4D & KIGFX::GERBVIEW_RENDER_SETTINGS::GetLayerColor ( int aLayer) const
inline

Return the color used to draw a layer.

Parameters
aLayeris the layer number.

Definition at line 63 of file gerbview_painter.h.

References KIGFX::RENDER_SETTINGS::m_layerColors, and KIGFX::COLOR4D::WHITE.

◆ 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 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 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 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().

◆ GetOutlineWidth()

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

Definition at line 299 of file render_settings.h.

References 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 m_highContrastLayers, PCB_LAYER_ID_COUNT, PCBNEW_LAYER_ID_START, and UNDEFINED_LAYER.

Referenced by PCB_GRID_HELPER::computeAnchors(), KIGFX::PCB_RENDER_SETTINGS::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 m_printDC.

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), EDA_DRAW_FRAME::PrintDrawingSheet(), EDA_TEXT::printOneLineOfText(), DS_DRAW_ITEM_BITMAP::PrintWsItem(), DS_DRAW_ITEM_LINE::PrintWsItem(), DS_DRAW_ITEM_POLYPOLYGONS::PrintWsItem(), and DS_DRAW_ITEM_RECT::PrintWsItem().

◆ GetPrintLayers()

LSET KIGFX::RENDER_SETTINGS::GetPrintLayers ( ) const
inlineinherited

Definition at line 119 of file render_settings.h.

References m_printLayers.

◆ GetShowPageLimits()

bool GERBVIEW_RENDER_SETTINGS::GetShowPageLimits ( ) const
overridevirtual

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 184 of file gerbview_painter.cpp.

References gvconfig(), GERBVIEW_SETTINGS::m_Display, and GBR_DISPLAY_OPTIONS::m_DisplayPageLimits.

◆ IsBackgroundDark()

virtual bool KIGFX::RENDER_SETTINGS::IsBackgroundDark ( ) const
inlinevirtualinherited

Reimplemented in KIGFX::DS_RENDER_SETTINGS, KIGFX::PCB_RENDER_SETTINGS, PCB_RENDER_SETTINGS, and SCH_RENDER_SETTINGS.

Definition at line 288 of file render_settings.h.

Referenced by KIGFX::PREVIEW::SELECTION_AREA::ViewDraw().

◆ 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 m_highlightEnabled.

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

◆ IsPrintBlackAndWhite()

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

Definition at line 230 of file render_settings.h.

References m_printBlackAndWite.

◆ IsPrinting()

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

Definition at line 227 of file render_settings.h.

References m_isPrinting.

Referenced by SCH_RENDER_SETTINGS::GetShowPageLimits(), and KIGFX::VIEW_ITEM::lodScaleForThreshold().

◆ LoadColors()

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

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 57 of file gerbview_painter.cpp.

References KIGFX::COLOR4D::a, KIGFX::COLOR4D::Brightened(), KIGFX::COLOR4D::Darkened(), GAL_LAYER_ID_END, GAL_LAYER_ID_START, GERBER_DRAWLAYERS_COUNT, GERBVIEW_LAYER_ID_END, GERBVIEW_LAYER_ID_START, COLOR_SETTINGS::GetColor(), gvconfig(), LAYER_DCODES, LAYER_DRAWINGSHEET, LAYER_GERBVIEW_DRAWINGSHEET, GERBVIEW_SETTINGS::m_Display, KIGFX::RENDER_SETTINGS::m_layerColors, KIGFX::RENDER_SETTINGS::m_layerColorsDark, KIGFX::RENDER_SETTINGS::m_layerColorsHi, KIGFX::RENDER_SETTINGS::m_layerColorsSel, GBR_DISPLAY_OPTIONS::m_OpacityModeAlphaValue, and KIGFX::RENDER_SETTINGS::update().

Referenced by GERBVIEW_FRAME::ApplyDisplaySettingsToGAL(), and GERBVIEW_DRAW_PANEL_GAL::GERBVIEW_DRAW_PANEL_GAL().

◆ PrintBlackAndWhiteReq()

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

Definition at line 236 of file render_settings.h.

References m_isPrinting, and m_printBlackAndWite.

◆ SetActiveLayer()

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

Definition at line 114 of file render_settings.h.

References m_activeLayer.

Referenced by PCB_DRAW_PANEL_GAL::SetHighContrastLayer().

◆ SetBackgroundColor()

void KIGFX::GERBVIEW_RENDER_SETTINGS::SetBackgroundColor ( const COLOR4D & aColor)
inlineoverridevirtual

Set the background color.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 88 of file gerbview_painter.h.

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

◆ SetDashLengthRatio()

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

Definition at line 217 of file render_settings.h.

References m_dashLengthRatio.

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), KIGFX::PCB_RENDER_SETTINGS::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 m_defaultFont.

Referenced by SCH_EDIT_FRAME::CommonSettingsChanged(), SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), PCB_BASE_FRAME::LoadSettings(), SCH_EDIT_FRAME::LoadSettings(), SYMBOL_EDIT_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 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(), StartPlotBoard(), SYMBOL_EDIT_FRAME::SVGPlotSymbol(), and DIALOG_PAGES_SETTINGS::UpdateDrawingSheetExample().

◆ SetDrawBoundingBoxes()

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

Definition at line 195 of file render_settings.h.

References 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 m_gapLengthRatio.

Referenced by BOARD_ADAPTER::addShape(), EXPORTER_STEP::buildGraphic3DShape(), EESCHEMA_JOBS_HANDLER::InitRenderSettings(), SCH_EDIT_FRAME::LoadProjectSettings(), KIGFX::PCB_RENDER_SETTINGS::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 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 m_highlightEnabled, and 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(), FOOTPRINT_PREVIEW_PANEL::New(), APPEARANCE_CONTROLS::onNetclassContextMenu(), GERBVIEW_SELECTION_TOOL::Reset(), PCB_SELECTION_TOOL::Reset(), SCH_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 m_highlightEnabled, and m_highlightNetcodes.

◆ SetHighlightFactor()

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

Definition at line 301 of file render_settings.h.

References 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 m_isPrinting.

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

◆ SetLayerColor()

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

Change the color used to draw a layer.

Parameters
aLayeris the layer number.
aColoris the new color.

Definition at line 75 of file gerbview_painter.h.

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

◆ 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 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 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 m_minPenWidth.

Referenced by DIALOG_PLOT_SCHEMATIC::getPlotOptions().

◆ 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 m_outlineWidth.

◆ SetPrintBlackAndWhite()

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

Definition at line 231 of file render_settings.h.

References 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 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 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 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, m_hiContrastColor, m_hiContrastFactor, m_highlightFactor, m_layerColors, m_layerColorsDark, m_layerColorsHi, m_layerColorsSel, and m_selectFactor.

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

Friends And Related Symbol Documentation

◆ GERBVIEW_PAINTER

friend class GERBVIEW_PAINTER
friend

Definition at line 49 of file gerbview_painter.h.

References GERBVIEW_PAINTER.

Referenced by GERBVIEW_PAINTER.

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 GetActiveLayer(), RENDER_SETTINGS(), and SetActiveLayer().

◆ m_attributeHighlightString

wxString KIGFX::GERBVIEW_RENDER_SETTINGS::m_attributeHighlightString

If set to anything but an empty string, will highlight items with matching attribute.

Definition at line 109 of file gerbview_painter.h.

Referenced by ClearHighlightSelections(), GERBVIEW_RENDER_SETTINGS(), and GetColor().

◆ 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(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), KIGFX::DS_RENDER_SETTINGS::IsBackgroundDark(), KIGFX::DS_RENDER_SETTINGS::LoadColors(), SCH_RENDER_SETTINGS::LoadColors(), KIGFX::PCB_RENDER_SETTINGS::PCB_RENDER_SETTINGS(), and KIGFX::DS_RENDER_SETTINGS::SetBackgroundColor().

◆ m_componentHighlightString

wxString KIGFX::GERBVIEW_RENDER_SETTINGS::m_componentHighlightString

If set to anything but an empty string, will highlight items with matching component.

Definition at line 103 of file gerbview_painter.h.

Referenced by ClearHighlightSelections(), GERBVIEW_RENDER_SETTINGS(), and GetColor().

◆ m_dashLengthRatio

double KIGFX::RENDER_SETTINGS::m_dashLengthRatio
protectedinherited

Definition at line 347 of file render_settings.h.

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

◆ m_dcodeHighlightValue

int KIGFX::GERBVIEW_RENDER_SETTINGS::m_dcodeHighlightValue

If set to anything but >0 (in fact 10 the min dcode value), will highlight items with matching dcode.

Definition at line 113 of file gerbview_painter.h.

Referenced by ClearHighlightSelections(), GERBVIEW_RENDER_SETTINGS(), and GetColor().

◆ m_defaultFont

wxString KIGFX::RENDER_SETTINGS::m_defaultFont
protectedinherited

Definition at line 350 of file render_settings.h.

Referenced by GetDefaultFont(), and 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(), GetDefaultPenWidth(), RENDER_SETTINGS(), and SetDefaultPenWidth().

◆ m_drawBoundingBoxes

bool KIGFX::RENDER_SETTINGS::m_drawBoundingBoxes
protectedinherited

Definition at line 338 of file render_settings.h.

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

◆ m_drawingSheetLineWidth

float KIGFX::RENDER_SETTINGS::m_drawingSheetLineWidth
protectedinherited

Definition at line 342 of file render_settings.h.

Referenced by GetDrawingSheetLineWidth(), and RENDER_SETTINGS().

◆ m_gapLengthRatio

double KIGFX::RENDER_SETTINGS::m_gapLengthRatio
protectedinherited

Definition at line 348 of file render_settings.h.

Referenced by GetGapLength(), GetGapLengthRatio(), RENDER_SETTINGS(), and 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 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 KIGFX::GERBVIEW_RENDER_SETTINGS::GetColor(), KIGFX::PCB_RENDER_SETTINGS::GetColor(), GetHighContrast(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), RENDER_SETTINGS(), and SetHighContrast().

◆ m_hiContrastFactor

float KIGFX::RENDER_SETTINGS::m_hiContrastFactor
protectedinherited

Definition at line 332 of file render_settings.h.

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

◆ m_highContrastLayers

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

Definition at line 320 of file render_settings.h.

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

◆ m_highlightEnabled

bool KIGFX::RENDER_SETTINGS::m_highlightEnabled
protectedinherited

Definition at line 334 of file render_settings.h.

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

◆ m_highlightFactor

float KIGFX::RENDER_SETTINGS::m_highlightFactor
protectedinherited

Definition at line 336 of file render_settings.h.

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

◆ m_highlightNetcodes

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

Definition at line 335 of file render_settings.h.

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

◆ m_isPrinting

bool KIGFX::RENDER_SETTINGS::m_isPrinting
protectedinherited

Definition at line 352 of file render_settings.h.

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

◆ m_layerColors

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

Definition at line 322 of file render_settings.h.

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

◆ m_layerColorsDark

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

Definition at line 326 of file render_settings.h.

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

◆ m_layerColorsHi

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

Definition at line 323 of file render_settings.h.

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

◆ m_layerColorsSel

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

Definition at line 324 of file render_settings.h.

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

◆ m_layerName

wxString KIGFX::RENDER_SETTINGS::m_layerName
protectedinherited

Definition at line 319 of file render_settings.h.

Referenced by GetLayerName(), and SetLayerName().

◆ m_minPenWidth

int KIGFX::RENDER_SETTINGS::m_minPenWidth
protectedinherited

Definition at line 345 of file render_settings.h.

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

◆ m_netHighlightString

wxString KIGFX::GERBVIEW_RENDER_SETTINGS::m_netHighlightString

If set to anything but an empty string, will highlight items with matching net.

Definition at line 106 of file gerbview_painter.h.

Referenced by ClearHighlightSelections(), GERBVIEW_RENDER_SETTINGS(), and GetColor().

◆ m_outlineWidth

float KIGFX::RENDER_SETTINGS::m_outlineWidth
protectedinherited

Definition at line 341 of file render_settings.h.

Referenced by GetOutlineWidth(), RENDER_SETTINGS(), and SetOutlineWidth().

◆ m_printBlackAndWite

bool KIGFX::RENDER_SETTINGS::m_printBlackAndWite
protectedinherited

Definition at line 353 of file render_settings.h.

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

◆ m_printDC

wxDC* KIGFX::RENDER_SETTINGS::m_printDC
protectedinherited

Definition at line 357 of file render_settings.h.

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

◆ m_printLayers

LSET KIGFX::RENDER_SETTINGS::m_printLayers
protectedinherited

Definition at line 355 of file render_settings.h.

Referenced by GetPrintLayers(), and SetPrintLayers().

◆ m_selectFactor

float KIGFX::RENDER_SETTINGS::m_selectFactor
protectedinherited

Definition at line 340 of file render_settings.h.

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

◆ MAX_FONT_SIZE

const double GERBVIEW_RENDER_SETTINGS::MAX_FONT_SIZE = gerbIUScale.mmToIU( 10.0 )
staticprotected

Maximum font size for D-Codes and other strings.

Definition at line 117 of file gerbview_painter.h.

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