Minimal concrete render settings suitable for plotters in tests. More...

#include <pdf_test_utils.h>

Inheritance diagram for SIMPLE_RENDER_SETTINGS:

Public Member Functions
	SIMPLE_RENDER_SETTINGS ()

KIGFX::COLOR4D	GetColor (const KIGFX::VIEW_ITEM *, int) 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 KIGFX::COLOR4D &	GetBackgroundColor () const override
	Return current background color settings.

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

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

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

virtual void	LoadColors (const COLOR_SETTINGS *aSettings)

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

virtual bool	GetShowPageLimits () 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.

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)

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

Private Attributes
KIGFX::COLOR4D	m_background

KIGFX::COLOR4D	m_grid

KIGFX::COLOR4D	m_cursor

Detailed Description

Minimal concrete render settings suitable for plotters in tests.

Definition at line 45 of file pdf_test_utils.h.

Constructor & Destructor Documentation

◆ SIMPLE_RENDER_SETTINGS()

SIMPLE_RENDER_SETTINGS::SIMPLE_RENDER_SETTINGS ( )

Definition at line 43 of file pdf_test_utils.cpp.

References m_background, m_cursor, and m_grid.

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

◆ 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 KIGFX::COLOR4D & SIMPLE_RENDER_SETTINGS::GetBackgroundColor ( ) const

inlineoverridevirtual

Return current background color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 51 of file pdf_test_utils.h.

References m_background.

◆ GetColor()

KIGFX::COLOR4D SIMPLE_RENDER_SETTINGS::GetColor	(	const KIGFX::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 50 of file pdf_test_utils.cpp.

◆ GetCursorColor()

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

inlineoverridevirtual

Return current cursor color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 54 of file pdf_test_utils.h.

References m_cursor.

◆ 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 KIGFX::COLOR4D & SIMPLE_RENDER_SETTINGS::GetGridColor ( )

inlineoverridevirtual

Return current grid color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 53 of file pdf_test_utils.h.

References m_grid.

◆ 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::RENDER_SETTINGS::GetLayerColor ( int aLayer ) const

inlineinherited

Return the color used to draw a layer.

Parameters

aLayer is the layer number.

Definition at line 266 of file render_settings.h.

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

Referenced by SCH_EDIT_FRAME::DrawCurrentSheetToClipboard(), BOARD_PRINTOUT::DrawPage(), KIGFX::PREVIEW::ANGLE_ITEM::drawPreviewShape(), KIGFX::PREVIEW::POLYGON_ITEM::drawPreviewShape(), KIGFX::PREVIEW::DrawTextNextToCursor(), FOOTPRINT_PREVIEW_PANEL::GetForegroundColor(), 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(), 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_PAGES_SETTINGS::UpdateDrawingSheetExample(), DS_PROXY_VIEW_ITEM::ViewDraw(), EDIT_POINTS::ViewDraw(), KIGFX::ANCHOR_DEBUG::ViewDraw(), and KIGFX::PREVIEW::RULER_ITEM::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 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()

virtual bool KIGFX::RENDER_SETTINGS::GetShowPageLimits ( ) const

inlinevirtualinherited

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

Definition at line 225 of file render_settings.h.

Referenced by DS_PROXY_VIEW_ITEM::ViewDraw().

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

virtual void KIGFX::RENDER_SETTINGS::LoadColors ( const COLOR_SETTINGS * aSettings )

inlinevirtualinherited

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

Definition at line 62 of file render_settings.h.

Referenced by PL_EDITOR_FRAME::CommonSettingsChanged(), SCH_BASE_FRAME::CommonSettingsChanged(), BOARD_PRINTOUT::DrawPage(), DIALOG_PLOT_SCHEMATIC::getPlotOptions(), GERBER_LAYER_WIDGET::OnLayerColorChange(), and SCH_PLOTTER::plotOneSheetDXF().

◆ 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 SIMPLE_RENDER_SETTINGS::SetBackgroundColor ( const KIGFX::COLOR4D & aColor )

inlineoverridevirtual

Set the background color.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 52 of file pdf_test_utils.h.

References m_background.

◆ 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

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 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

aHighlight	is a set of netcodes to highlight
aEnabled	tells 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::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 281 of file render_settings.h.

References m_layerColors, and 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 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

aWidth is 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().

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_background

KIGFX::COLOR4D SIMPLE_RENDER_SETTINGS::m_background

private

Definition at line 57 of file pdf_test_utils.h.

Referenced by GetBackgroundColor(), SetBackgroundColor(), and SIMPLE_RENDER_SETTINGS().

◆ 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_cursor

KIGFX::COLOR4D SIMPLE_RENDER_SETTINGS::m_cursor

private

Definition at line 59 of file pdf_test_utils.h.

Referenced by GetCursorColor(), and SIMPLE_RENDER_SETTINGS().

◆ 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_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_grid

KIGFX::COLOR4D SIMPLE_RENDER_SETTINGS::m_grid

private

Definition at line 58 of file pdf_test_utils.h.

Referenced by GetGridColor(), and SIMPLE_RENDER_SETTINGS().

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SIMPLE_RENDER_SETTINGS()

Member Function Documentation

◆ ClearHighContrastLayers()

◆ GetActiveLayer()

◆ GetBackgroundColor()

◆ GetColor()

◆ GetCursorColor()

◆ GetDashLength()

◆ GetDashLengthRatio()

◆ GetDefaultFont()

◆ GetDefaultPenWidth()

◆ GetDotLength()

◆ GetDrawBoundingBoxes()

◆ GetDrawingSheetLineWidth()

◆ GetGapLength()

◆ GetGapLengthRatio()

◆ GetGridColor()

◆ GetHighContrast()

◆ GetHighContrastLayers()

◆ GetHighlightNetCodes()

◆ GetLayerColor()

◆ GetLayerIsHighContrast()

◆ GetLayerName()

◆ GetMinPenWidth()

◆ GetOutlineWidth()

◆ GetPrimaryHighContrastLayer()

◆ GetPrintDC()

◆ GetPrintLayers()

◆ GetShowPageLimits()

◆ IsBackgroundDark()

◆ IsHighlightEnabled()

◆ IsPrintBlackAndWhite()

◆ IsPrinting()

◆ LoadColors()

◆ PrintBlackAndWhiteReq()

◆ SetActiveLayer()

◆ SetBackgroundColor()

◆ SetDashLengthRatio()

◆ SetDefaultFont()

◆ SetDefaultPenWidth()

◆ SetDrawBoundingBoxes()

◆ SetGapLengthRatio()

◆ SetHighContrast()

◆ SetHighlight() [1/2]

◆ SetHighlight() [2/2]

◆ SetHighlightFactor()

◆ SetIsPrinting()

◆ SetLayerColor()

◆ SetLayerIsHighContrast()

◆ SetLayerName()

◆ SetMinPenWidth()

◆ SetOutlineWidth()

◆ SetPrintBlackAndWhite()

◆ SetPrintDC()

◆ SetPrintLayers()

◆ SetSelectFactor()

◆ update()

Member Data Documentation

◆ m_activeLayer

◆ m_background

◆ m_backgroundColor

◆ m_cursor

◆ m_dashLengthRatio

◆ m_defaultFont

◆ m_defaultPenWidth

◆ m_drawBoundingBoxes

◆ m_drawingSheetLineWidth

◆ m_gapLengthRatio

◆ m_grid

◆ m_hiContrastColor

◆ m_hiContrastEnabled

◆ m_hiContrastFactor

◆ m_highContrastLayers

◆ m_highlightEnabled