KiCad PCB EDA Suite
KIGFX::GERBVIEW_RENDER_SETTINGS Class Reference

GERBVIEW_RENDER_SETTINGS Stores 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 ImportLegacyColors (const COLORS_DESIGN_SETTINGS *aSettings) override
 Function ImportLegacyColors Loads a list of color settings for layers. More...
 
void LoadDisplayOptions (const GBR_DISPLAY_OPTIONS &aOptions)
 Function LoadDisplayOptions Loads settings related to display options. More...
 
virtual const COLOR4DGetColor (const VIEW_ITEM *aItem, int aLayer) const override
 Function GetColor Returns the color that should be used to draw the specific VIEW_ITEM on the specific layer using currently used render settings. More...
 
const COLOR4DGetLayerColor (int aLayer) const
 Function GetLayerColor Returns the color used to draw a layer. More...
 
void SetLayerColor (int aLayer, const COLOR4D &aColor)
 Function SetLayerColor Changes the color used to draw a layer. More...
 
const COLOR4DGetBackgroundColor () override
 Function GetBackgroundColor Returns current background color settings. More...
 
void SetBackgroundColor (const COLOR4D &aColor) override
 Sets the background color. More...
 
const COLOR4DGetGridColor () override
 Function GetGridColor Returns current grid color settings. More...
 
const COLOR4DGetCursorColor () override
 Function GetCursorColor Returns current cursor color settings. More...
 
bool IsSpotFill () const
 
bool IsLineFill () const
 
bool IsPolygonFill () const
 
bool IsShowNegativeItems () const
 
bool IsShowCodes () const
 
bool IsDiffMode () const
 
void SetActiveLayer (int aLayerId, bool aEnabled=true)
 Function SetActiveLayer Sets the specified layer as active - it means that it can be drawn in a specific mode (eg. More...
 
const std::set< unsigned int > GetActiveLayers ()
 Function GetActiveLayers() Returns the set of currently active layers. More...
 
void ClearActiveLayers ()
 Function ClearActiveLayers Clears the list of active layers. More...
 
bool IsActiveLayer (int aLayerId) const
 Function IsActiveLayer Returns information whether the queried layer is marked as active. More...
 
bool IsHighlightEnabled () const
 Function IsHighlightEnabled Returns current highlight setting. More...
 
int GetHighlightNetCode () const
 Function GetHighlightNetCode Returns netcode of currently highlighted net. More...
 
void SetHighlight (bool aEnabled, int aNetcode=-1, bool aHighlightItems=false)
 Function SetHighlight Turns on/off highlighting - it may be done for the active layer, the specified net, or items with their HIGHLIGHTED flags set. More...
 
void SetHighContrast (bool aEnabled)
 Function SetHighContrast Turns on/off high contrast display mode. More...
 
bool GetHighContrast () const
 Function GetHighContrast Returns information about high contrast display mode. More...
 
float GetWorksheetLineWidth () const
 
bool GetShowPageLimits () const
 
void SetShowPageLimits (bool aDraw)
 
virtual bool IsBackgroundDark () const
 
void SetOutlineWidth (float aWidth)
 Set line width used for drawing outlines. More...
 

Public Attributes

wxString m_componentHighlightString
 If set to anything but an empty string, will highlight items with matching component. More...
 
wxString m_netHighlightString
 If set to anything but an empty string, will highlight items with matching net. More...
 
wxString m_attributeHighlightString
 If set to anything but an empty string, will highlight items with matching attribute. More...
 

Protected Member Functions

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

Protected Attributes

bool m_spotFill
 Flag determining if spots should be drawn with fill. More...
 
bool m_lineFill
 Flag determining if lines should be drawn with fill. More...
 
bool m_polygonFill
 Flag determining if polygons should be drawn with fill. More...
 
bool m_showNegativeItems
 Flag determining if negative items should be drawn with a "ghost" color. More...
 
bool m_showCodes
 Flag determining if D-Codes should be drawn. More...
 
bool m_diffMode
 Flag determining if layers should be rendered in "diff" mode. More...
 
std::set< unsigned int > m_activeLayers
 Stores active layers number. More...
 
COLOR4D m_layerColors [LAYER_ID_COUNT]
 

Colors for all layers (normal)

More...
 
COLOR4D m_layerColorsHi [LAYER_ID_COUNT]
 

Colors for all layers (highlighted)

More...
 
COLOR4D m_layerColorsSel [LAYER_ID_COUNT]
 

Colors for all layers (selected)

More...
 
COLOR4D m_layerColorsDark [LAYER_ID_COUNT]
 

Colors for all layers (darkened)

More...
 
COLOR4D m_hiContrastColor [LAYER_ID_COUNT]
 
bool m_hiContrastEnabled
 Parameters for display modes. More...
 
float m_hiContrastFactor
 Factor used for computing high contrast color. More...
 
bool m_highlightEnabled
 Highlight display mode on/off. More...
 
int m_highlightNetcode
 Net number that is displayed in highlight -1 means that there is no specific net, and whole active layer is highlighted. More...
 
bool m_highlightItems
 Highlight items with their HIGHLIGHT flags set. More...
 
float m_highlightFactor
 Factor used for computing highlight color. More...
 
float m_selectFactor
 Specifies how color of selected items is changed. More...
 
float m_layerOpacity
 Determines opacity of all layers. More...
 
float m_outlineWidth
 Line width used when drawing outlines. More...
 
float m_worksheetLineWidth
 Line width used when drawing worksheet. More...
 
bool m_showPageLimits
 
COLOR4D m_backgroundColor
 The background color. More...
 

Static Protected Attributes

static const double MAX_FONT_SIZE = Millimeter2iu( 10.0 )
 Maximum font size for D-Codes and other strings. More...
 

Friends

class GERBVIEW_PAINTER
 

Detailed Description

GERBVIEW_RENDER_SETTINGS Stores GerbView specific render settings.

Definition at line 49 of file gerbview_painter.h.

Constructor & Destructor Documentation

◆ GERBVIEW_RENDER_SETTINGS()

GERBVIEW_RENDER_SETTINGS::GERBVIEW_RENDER_SETTINGS ( )

Definition at line 35 of file gerbview_painter.cpp.

36 {
38 
39  m_spotFill = true;
40  m_lineFill = true;
41  m_polygonFill = true;
42  m_showNegativeItems = false;
43  m_showCodes = false;
44  m_diffMode = true;
45 
49 
50  update();
51 }
bool m_showNegativeItems
Flag determining if negative items should be drawn with a "ghost" color.
bool m_lineFill
Flag determining if lines should be drawn with fill.
bool m_spotFill
Flag determining if spots should be drawn with fill.
bool m_showCodes
Flag determining if D-Codes should be drawn.
static const COLOR4D BLACK
Definition: color4d.h:311
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.
virtual void update()
Function update Precalculates extra colors for layers (e.g.
Definition: painter.cpp:54
wxString m_componentHighlightString
If set to anything but an empty string, will highlight items with matching component.
COLOR4D m_backgroundColor
The background color.
Definition: painter.h:297
bool m_polygonFill
Flag determining if polygons should be drawn with fill.
bool m_diffMode
Flag determining if layers should be rendered in "diff" mode.

References KIGFX::COLOR4D::BLACK, m_attributeHighlightString, KIGFX::RENDER_SETTINGS::m_backgroundColor, m_componentHighlightString, m_diffMode, m_lineFill, m_netHighlightString, m_polygonFill, m_showCodes, m_showNegativeItems, m_spotFill, and KIGFX::RENDER_SETTINGS::update().

Member Function Documentation

◆ ClearActiveLayers()

void KIGFX::RENDER_SETTINGS::ClearActiveLayers ( )
inlineinherited

Function ClearActiveLayers Clears the list of active layers.

Definition at line 98 of file painter.h.

99  {
100  m_activeLayers.clear();
101  }
std::set< unsigned int > m_activeLayers
Stores active layers number.
Definition: painter.h:262

References KIGFX::RENDER_SETTINGS::m_activeLayers.

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

◆ GetActiveLayers()

const std::set<unsigned int> KIGFX::RENDER_SETTINGS::GetActiveLayers ( )
inlineinherited

Function GetActiveLayers() Returns the set of currently active layers.

Returns
The set of currently active layers.

Definition at line 89 of file painter.h.

90  {
91  return m_activeLayers;
92  }
std::set< unsigned int > m_activeLayers
Stores active layers number.
Definition: painter.h:262

References KIGFX::RENDER_SETTINGS::m_activeLayers.

Referenced by GRID_HELPER::computeAnchors(), PNS_KICAD_IFACE::IsItemVisible(), GRID_HELPER::queryVisible(), and SELECTION_TOOL::Selectable().

◆ GetBackgroundColor()

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

Function GetBackgroundColor Returns current background color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 92 of file gerbview_painter.h.

COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265

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

◆ GetColor()

const COLOR4D & GERBVIEW_RENDER_SETTINGS::GetColor ( const VIEW_ITEM aItem,
int  aLayer 
) const
overridevirtual

Function GetColor 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 97 of file gerbview_painter.cpp.

98 {
99  const EDA_ITEM* item = static_cast<const EDA_ITEM*>( aItem );
100  static const COLOR4D transparent = COLOR4D( 0, 0, 0, 0 );
101  const GERBER_DRAW_ITEM* gbrItem = nullptr;
102 
103  if( item && item->Type() == GERBER_DRAW_ITEM_T )
104  gbrItem = static_cast<const GERBER_DRAW_ITEM*>( item );
105 
106  // All DCODE layers stored under a single color setting
107  if( IsDCodeLayer( aLayer ) )
108  return m_layerColors[ LAYER_DCODES ];
109 
110  if( item && item->IsSelected() )
111  return m_layerColorsSel[aLayer];
112 
113  if( gbrItem && gbrItem->GetLayerPolarity() )
114  {
115  if( m_showNegativeItems )
117  else
118  return transparent;
119  }
120 
121  if( !m_netHighlightString.IsEmpty() && gbrItem &&
123  return m_layerColorsHi[aLayer];
124 
125  if( !m_componentHighlightString.IsEmpty() && gbrItem &&
127  return m_layerColorsHi[aLayer];
128 
129  if( !m_attributeHighlightString.IsEmpty() && gbrItem && gbrItem->GetDcodeDescr() &&
131  return m_layerColorsHi[aLayer];
132 
133  // Return grayish color for non-highlighted layers in the high contrast mode
134  if( m_hiContrastEnabled && m_activeLayers.count( aLayer ) == 0)
135  return m_hiContrastColor[aLayer];
136 
137  // Catch the case when highlight and high-contraste modes are enabled
138  // and we are drawing a not highlighted track
139  if( m_highlightEnabled )
140  return m_layerColorsDark[aLayer];
141 
142  // No special modificators enabled
143  return m_layerColors[aLayer];
144 }
D_CODE * GetDcodeDescr() const
Function GetDcodeDescr returns the GetDcodeDescr of this object, or NULL.
bool m_showNegativeItems
Flag determining if negative items should be drawn with a "ghost" color.
bool IsDCodeLayer(int aLayer)
bool IsSelected() const
Definition: base_struct.h:223
COLOR4D m_layerColorsHi[LAYER_ID_COUNT]
Colors for all layers (highlighted)
Definition: painter.h:268
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265
wxString m_Cmpref
the component reference parent of the data
bool m_highlightEnabled
Highlight display mode on/off.
Definition: painter.h:283
COLOR4D m_hiContrastColor[LAYER_ID_COUNT]
Definition: painter.h:277
std::set< unsigned int > m_activeLayers
Stores active layers number.
Definition: painter.h:262
COLOR4D m_layerColorsDark[LAYER_ID_COUNT]
Colors for all layers (darkened)
Definition: painter.h:274
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.
bool m_hiContrastEnabled
Parameters for display modes.
Definition: painter.h:280
wxString m_Netname
for items associated to a net: the netname
wxString m_componentHighlightString
If set to anything but an empty string, will highlight items with matching component.
const GBR_NETLIST_METADATA & GetNetAttributes() const
wxString m_AperFunction
the aperture attribute (created by a TA.AperFunction command) attached to the D_CODE
Definition: dcode.h:105
EDA_ITEM is a base class for most all the KiCad significant classes, used in schematics and boards.
Definition: base_struct.h:163
bool GetLayerPolarity() const
COLOR4D m_layerColorsSel[LAYER_ID_COUNT]
Colors for all layers (selected)
Definition: painter.h:271
KICAD_T Type() const
Function Type()
Definition: base_struct.h:207
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

References GERBER_DRAW_ITEM_T, GERBER_DRAW_ITEM::GetDcodeDescr(), GERBER_DRAW_ITEM::GetLayerPolarity(), GERBER_DRAW_ITEM::GetNetAttributes(), IsDCodeLayer(), EDA_ITEM::IsSelected(), LAYER_DCODES, LAYER_NEGATIVE_OBJECTS, KIGFX::RENDER_SETTINGS::m_activeLayers, D_CODE::m_AperFunction, m_attributeHighlightString, GBR_NETLIST_METADATA::m_Cmpref, m_componentHighlightString, KIGFX::RENDER_SETTINGS::m_hiContrastColor, KIGFX::RENDER_SETTINGS::m_hiContrastEnabled, 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, m_showNegativeItems, and EDA_ITEM::Type().

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

◆ GetCursorColor()

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

Function GetCursorColor Returns current cursor color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 101 of file gerbview_painter.h.

101 { return m_layerColors[ LAYER_CURSOR ]; }
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265

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

◆ GetGridColor()

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

Function GetGridColor Returns current grid color settings.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 99 of file gerbview_painter.h.

99 { return m_layerColors[ LAYER_GRID ]; }
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265

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

◆ GetHighContrast()

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

Function GetHighContrast Returns information about high contrast display mode.

Returns
True if the high contrast mode is on, false otherwise.

Definition at line 163 of file painter.h.

164  {
165  return m_hiContrastEnabled;
166  }
bool m_hiContrastEnabled
Parameters for display modes.
Definition: painter.h:280

References KIGFX::RENDER_SETTINGS::m_hiContrastEnabled.

Referenced by PNS_KICAD_IFACE::IsItemVisible(), and SELECTION_TOOL::Selectable().

◆ GetHighlightNetCode()

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

Function GetHighlightNetCode Returns netcode of currently highlighted net.

Returns
Netcode of currently highlighted net.

Definition at line 128 of file painter.h.

129  {
130  return m_highlightNetcode;
131  }
int m_highlightNetcode
Net number that is displayed in highlight -1 means that there is no specific net, and whole active la...
Definition: painter.h:284

References KIGFX::RENDER_SETTINGS::m_highlightNetcode.

Referenced by PNS::TOOL_BASE::highlightNet().

◆ GetLayerColor()

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

Function GetLayerColor Returns the color used to draw a layer.

Parameters
aLayeris the layer number.

Definition at line 74 of file gerbview_painter.h.

75  {
76  return m_layerColors[aLayer];
77  }
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265

References KIGFX::RENDER_SETTINGS::m_layerColors.

◆ GetShowPageLimits()

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

Definition at line 183 of file painter.h.

184  {
185  return m_showPageLimits;
186  }

References KIGFX::RENDER_SETTINGS::m_showPageLimits.

◆ GetWorksheetLineWidth()

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

Definition at line 178 of file painter.h.

179  {
180  return m_worksheetLineWidth;
181  }
float m_worksheetLineWidth
Line width used when drawing worksheet.
Definition: painter.h:293

References KIGFX::RENDER_SETTINGS::m_worksheetLineWidth.

◆ ImportLegacyColors()

void GERBVIEW_RENDER_SETTINGS::ImportLegacyColors ( const COLORS_DESIGN_SETTINGS aSettings)
overridevirtual

Function ImportLegacyColors Loads a list of color settings for layers.

Parameters
aSettingsis a list of color settings.

Reimplemented from KIGFX::RENDER_SETTINGS.

Definition at line 54 of file gerbview_painter.cpp.

55 {
56  for( int i = GERBVIEW_LAYER_ID_START;
58  {
59  COLOR4D baseColor = aSettings->GetLayerColor( i );
60 
61  if( m_diffMode )
62  baseColor.a = 0.75;
63 
64  m_layerColors[i] = baseColor;
65  m_layerColorsHi[i] = baseColor.Brightened( 0.5 );
66  m_layerColorsSel[i] = baseColor.Brightened( 0.8 );
67  m_layerColorsDark[i] = baseColor.Darkened( 0.25 );
68  }
69 
70  for( int i = LAYER_DCODES; i < GERBVIEW_LAYER_ID_END; i++ )
71  m_layerColors[i] = aSettings->GetLayerColor( i );
72 
73  for( int i = GAL_LAYER_ID_START; i < GAL_LAYER_ID_END; i++ )
74  m_layerColors[i] = aSettings->GetLayerColor( i );
75 
76  update();
77 }
COLOR4D m_layerColorsHi[LAYER_ID_COUNT]
Colors for all layers (highlighted)
Definition: painter.h:268
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265
Add new GAL layers here.
COLOR4D Darkened(double aFactor) const
Function Darkened Returns a color that is darker by a given factor, without modifying object.
Definition: color4d.h:215
COLOR4D Brightened(double aFactor) const
Function Brightened Returns a color that is brighter by a given factor, without modifying object.
Definition: color4d.h:199
COLOR4D GetLayerColor(LAYER_NUM aLayer) const
Function GetLayerColor.
double a
Alpha component.
Definition: color4d.h:304
COLOR4D m_layerColorsDark[LAYER_ID_COUNT]
Colors for all layers (darkened)
Definition: painter.h:274
#define GERBER_DRAWLAYERS_COUNT
virtual void update()
Function update Precalculates extra colors for layers (e.g.
Definition: painter.cpp:54
bool m_diffMode
Flag determining if layers should be rendered in "diff" mode.
COLOR4D m_layerColorsSel[LAYER_ID_COUNT]
Colors for all layers (selected)
Definition: painter.h:271
COLOR4D is the color representation with 4 components: red, green, blue, alpha.
Definition: color4d.h:39

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, COLORS_DESIGN_SETTINGS::GetLayerColor(), LAYER_DCODES, m_diffMode, KIGFX::RENDER_SETTINGS::m_layerColors, KIGFX::RENDER_SETTINGS::m_layerColorsDark, KIGFX::RENDER_SETTINGS::m_layerColorsHi, KIGFX::RENDER_SETTINGS::m_layerColorsSel, and KIGFX::RENDER_SETTINGS::update().

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL(), and GERBVIEW_DRAW_PANEL_GAL::UseColorScheme().

◆ IsActiveLayer()

bool KIGFX::RENDER_SETTINGS::IsActiveLayer ( int  aLayerId) const
inlineinherited

Function IsActiveLayer Returns information whether the queried layer is marked as active.

Returns
True if the queried layer is marked as active.

Definition at line 108 of file painter.h.

109  {
110  return ( m_activeLayers.count( aLayerId ) > 0 );
111  }
std::set< unsigned int > m_activeLayers
Stores active layers number.
Definition: painter.h:262

References KIGFX::RENDER_SETTINGS::m_activeLayers.

◆ IsBackgroundDark()

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

◆ IsDiffMode()

bool KIGFX::GERBVIEW_RENDER_SETTINGS::IsDiffMode ( ) const
inline

Definition at line 128 of file gerbview_painter.h.

129  {
130  return m_diffMode;
131  }
bool m_diffMode
Flag determining if layers should be rendered in "diff" mode.

References m_diffMode.

◆ IsHighlightEnabled()

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

Function IsHighlightEnabled Returns current highlight setting.

Returns
True if highlight is enabled, false otherwise.

Definition at line 118 of file painter.h.

119  {
120  return m_highlightEnabled;
121  }
bool m_highlightEnabled
Highlight display mode on/off.
Definition: painter.h:283

References KIGFX::RENDER_SETTINGS::m_highlightEnabled.

Referenced by PNS::TOOL_BASE::highlightNet().

◆ IsLineFill()

bool KIGFX::GERBVIEW_RENDER_SETTINGS::IsLineFill ( ) const
inline

Definition at line 108 of file gerbview_painter.h.

109  {
110  return m_lineFill;
111  }
bool m_lineFill
Flag determining if lines should be drawn with fill.

References m_lineFill.

◆ IsPolygonFill()

bool KIGFX::GERBVIEW_RENDER_SETTINGS::IsPolygonFill ( ) const
inline

Definition at line 113 of file gerbview_painter.h.

114  {
115  return m_polygonFill;
116  }
bool m_polygonFill
Flag determining if polygons should be drawn with fill.

References m_polygonFill.

◆ IsShowCodes()

bool KIGFX::GERBVIEW_RENDER_SETTINGS::IsShowCodes ( ) const
inline

Definition at line 123 of file gerbview_painter.h.

124  {
125  return m_showCodes;
126  }
bool m_showCodes
Flag determining if D-Codes should be drawn.

References m_showCodes.

◆ IsShowNegativeItems()

bool KIGFX::GERBVIEW_RENDER_SETTINGS::IsShowNegativeItems ( ) const
inline

Definition at line 118 of file gerbview_painter.h.

119  {
120  return m_showNegativeItems;
121  }
bool m_showNegativeItems
Flag determining if negative items should be drawn with a "ghost" color.

References m_showNegativeItems.

◆ IsSpotFill()

bool KIGFX::GERBVIEW_RENDER_SETTINGS::IsSpotFill ( ) const
inline

Definition at line 103 of file gerbview_painter.h.

104  {
105  return m_spotFill;
106  }
bool m_spotFill
Flag determining if spots should be drawn with fill.

References m_spotFill.

◆ LoadDisplayOptions()

void GERBVIEW_RENDER_SETTINGS::LoadDisplayOptions ( const GBR_DISPLAY_OPTIONS aOptions)

Function LoadDisplayOptions Loads settings related to display options.

Parameters
aOptionsare settings that you want to use for displaying items.

Definition at line 80 of file gerbview_painter.cpp.

81 {
82 
84  m_lineFill = aOptions.m_DisplayLinesFill;
87  m_showCodes = aOptions.m_DisplayDCodes;
88  m_diffMode = aOptions.m_DiffMode;
92 
93  update();
94 }
bool m_DisplayPolygonsFill
Option to draw polygons (filled/sketch)
bool m_showNegativeItems
Flag determining if negative items should be drawn with a "ghost" color.
COLOR4D m_BgDrawColor
The background color.
bool m_lineFill
Flag determining if lines should be drawn with fill.
bool m_HighContrastMode
High contrast mode (dim un-highlighted objects)
bool m_DisplayNegativeObjects
Option to draw negative objects in a specific color.
bool m_spotFill
Flag determining if spots should be drawn with fill.
bool m_DisplayLinesFill
Option to draw line items (filled/sketch)
bool m_showCodes
Flag determining if D-Codes should be drawn.
bool m_DiffMode
Display layers in diff mode.
bool m_hiContrastEnabled
Parameters for display modes.
Definition: painter.h:280
virtual void update()
Function update Precalculates extra colors for layers (e.g.
Definition: painter.cpp:54
bool m_DisplayFlashedItemsFill
Option to draw flashed items (filled/sketch)
COLOR4D m_backgroundColor
The background color.
Definition: painter.h:297
bool m_polygonFill
Flag determining if polygons should be drawn with fill.
bool m_DisplayDCodes
Option to show dcode values on items drawn with a dcode tool.
bool m_diffMode
Flag determining if layers should be rendered in "diff" mode.

References KIGFX::RENDER_SETTINGS::m_backgroundColor, GBR_DISPLAY_OPTIONS::m_BgDrawColor, GBR_DISPLAY_OPTIONS::m_DiffMode, m_diffMode, GBR_DISPLAY_OPTIONS::m_DisplayDCodes, GBR_DISPLAY_OPTIONS::m_DisplayFlashedItemsFill, GBR_DISPLAY_OPTIONS::m_DisplayLinesFill, GBR_DISPLAY_OPTIONS::m_DisplayNegativeObjects, GBR_DISPLAY_OPTIONS::m_DisplayPageLimits, GBR_DISPLAY_OPTIONS::m_DisplayPolygonsFill, KIGFX::RENDER_SETTINGS::m_hiContrastEnabled, GBR_DISPLAY_OPTIONS::m_HighContrastMode, m_lineFill, m_polygonFill, m_showCodes, m_showNegativeItems, KIGFX::RENDER_SETTINGS::m_showPageLimits, m_spotFill, and KIGFX::RENDER_SETTINGS::update().

Referenced by GERBVIEW_FRAME::applyDisplaySettingsToGAL().

◆ SetActiveLayer()

void KIGFX::RENDER_SETTINGS::SetActiveLayer ( int  aLayerId,
bool  aEnabled = true 
)
inlineinherited

Function SetActiveLayer Sets the specified layer as active - it means that it can be drawn in a specific mode (eg.

highlighted, so it differs from other layers).

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 76 of file painter.h.

77  {
78  if( aEnabled )
79  m_activeLayers.insert( aLayerId );
80  else
81  m_activeLayers.erase( aLayerId );
82  }
std::set< unsigned int > m_activeLayers
Stores active layers number.
Definition: painter.h:262

References KIGFX::RENDER_SETTINGS::m_activeLayers.

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

◆ SetBackgroundColor()

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

Sets the background color.

Implements KIGFX::RENDER_SETTINGS.

Definition at line 94 of file gerbview_painter.h.

95  {
97  }
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265

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

◆ SetHighContrast()

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

Function SetHighContrast Turns on/off high contrast display mode.

Parameters
aEnableddetermines if high contrast display mode should be enabled or not.

Definition at line 153 of file painter.h.

154  {
155  m_hiContrastEnabled = aEnabled;
156  }
bool m_hiContrastEnabled
Parameters for display modes.
Definition: painter.h:280

References KIGFX::RENDER_SETTINGS::m_hiContrastEnabled.

◆ SetHighlight()

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

Function SetHighlight Turns on/off highlighting - it may be done for the active layer, the specified net, or items with their HIGHLIGHTED flags set.

Parameters
aEnabledtells if highlighting should be enabled.
aNetcodeis optional and if specified, turns on higlighting only for the net with number given as the parameter.

Definition at line 141 of file painter.h.

142  {
143  m_highlightEnabled = aEnabled;
144  m_highlightNetcode = aEnabled ? aNetcode : -1;
145  m_highlightItems = aEnabled ? aHighlightItems : false;
146  }
bool m_highlightItems
Highlight items with their HIGHLIGHT flags set.
Definition: painter.h:287
bool m_highlightEnabled
Highlight display mode on/off.
Definition: painter.h:283
int m_highlightNetcode
Net number that is displayed in highlight -1 means that there is no specific net, and whole active la...
Definition: painter.h:284

References KIGFX::RENDER_SETTINGS::m_highlightEnabled, KIGFX::RENDER_SETTINGS::m_highlightItems, and KIGFX::RENDER_SETTINGS::m_highlightNetcode.

Referenced by PCB_EDIT_FRAME::ExecuteRemoteCommand(), DIALOG_SELECT_NET_FROM_LIST::HighlightNet(), PNS::TOOL_BASE::highlightNet(), GERBVIEW_SELECTION_TOOL::Reset(), EE_SELECTION_TOOL::Reset(), and SELECTION_TOOL::Reset().

◆ SetLayerColor()

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

Function SetLayerColor Changes the color used to draw a layer.

Parameters
aLayeris the layer number.
aColoris the new color.

Definition at line 85 of file gerbview_painter.h.

86  {
87  m_layerColors[aLayer] = aColor;
88 
89  update(); // recompute other shades of the color
90  }
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265
virtual void update()
Function update Precalculates extra colors for layers (e.g.
Definition: painter.cpp:54

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

◆ SetOutlineWidth()

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

Set line width used for drawing outlines.

Parameters
aWidthis the new width.

Definition at line 249 of file painter.h.

250  {
251  m_outlineWidth = aWidth;
252  }
float m_outlineWidth
Line width used when drawing outlines.
Definition: painter.h:292

References KIGFX::RENDER_SETTINGS::m_outlineWidth.

◆ SetShowPageLimits()

void KIGFX::RENDER_SETTINGS::SetShowPageLimits ( bool  aDraw)
inlineinherited

◆ update()

void RENDER_SETTINGS::update ( )
protectedvirtualinherited

Function update Precalculates extra colors for layers (e.g.

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

Definition at line 54 of file painter.cpp.

55 {
56  // Calculate darkened/highlighted variants of layer colors
57  for( int i = 0; i < LAYER_ID_COUNT; i++ )
58  {
64  }
65 }
COLOR4D m_layerColorsHi[LAYER_ID_COUNT]
Colors for all layers (highlighted)
Definition: painter.h:268
COLOR4D m_layerColors[LAYER_ID_COUNT]
Colors for all layers (normal)
Definition: painter.h:265
float m_highlightFactor
Factor used for computing highlight color.
Definition: painter.h:288
COLOR4D Darkened(double aFactor) const
Function Darkened Returns a color that is darker by a given factor, without modifying object.
Definition: color4d.h:215
COLOR4D m_hiContrastColor[LAYER_ID_COUNT]
Definition: painter.h:277
COLOR4D Brightened(double aFactor) const
Function Brightened Returns a color that is brighter by a given factor, without modifying object.
Definition: color4d.h:199
COLOR4D m_layerColorsDark[LAYER_ID_COUNT]
Colors for all layers (darkened)
Definition: painter.h:274
#define LAYER_ID_COUNT
Must update this if you add any enums after GerbView!
float m_hiContrastFactor
Factor used for computing high contrast color.
Definition: painter.h:281
COLOR4D Mix(const COLOR4D &aColor, double aFactor) const
Function Mix Returns a color that is mixed with the input by a factor.
Definition: color4d.h:231
float m_selectFactor
Specifies how color of selected items is changed.
Definition: painter.h:290
COLOR4D m_layerColorsSel[LAYER_ID_COUNT]
Colors for all layers (selected)
Definition: painter.h:271

References KIGFX::COLOR4D::Brightened(), KIGFX::COLOR4D::Darkened(), 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, KIGFX::RENDER_SETTINGS::m_selectFactor, and KIGFX::COLOR4D::Mix().

Referenced by GERBVIEW_RENDER_SETTINGS(), ImportLegacyColors(), KIGFX::PCB_RENDER_SETTINGS::ImportLegacyColors(), LoadDisplayOptions(), KIGFX::PCB_RENDER_SETTINGS::PCB_RENDER_SETTINGS(), SetLayerColor(), KIGFX::RENDER_SETTINGS::SetLayerColor(), and KIGFX::WS_RENDER_SETTINGS::WS_RENDER_SETTINGS().

Friends And Related Function Documentation

◆ GERBVIEW_PAINTER

friend class GERBVIEW_PAINTER
friend

Definition at line 52 of file gerbview_painter.h.

Member Data Documentation

◆ m_activeLayers

std::set<unsigned int> KIGFX::RENDER_SETTINGS::m_activeLayers
protectedinherited

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

Referenced by GERBVIEW_RENDER_SETTINGS(), and GetColor().

◆ m_backgroundColor

◆ 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 134 of file gerbview_painter.h.

Referenced by GERBVIEW_RENDER_SETTINGS(), and GetColor().

◆ m_diffMode

bool KIGFX::GERBVIEW_RENDER_SETTINGS::m_diffMode
protected

Flag determining if layers should be rendered in "diff" mode.

Definition at line 159 of file gerbview_painter.h.

Referenced by GERBVIEW_RENDER_SETTINGS(), ImportLegacyColors(), IsDiffMode(), and LoadDisplayOptions().

◆ m_hiContrastColor

COLOR4D KIGFX::RENDER_SETTINGS::m_hiContrastColor[LAYER_ID_COUNT]
protectedinherited

◆ m_hiContrastEnabled

bool KIGFX::RENDER_SETTINGS::m_hiContrastEnabled
protectedinherited

◆ m_hiContrastFactor

float KIGFX::RENDER_SETTINGS::m_hiContrastFactor
protectedinherited

Factor used for computing high contrast color.

Definition at line 281 of file painter.h.

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

◆ m_highlightEnabled

bool KIGFX::RENDER_SETTINGS::m_highlightEnabled
protectedinherited

◆ m_highlightFactor

float KIGFX::RENDER_SETTINGS::m_highlightFactor
protectedinherited

Factor used for computing highlight color.

Definition at line 288 of file painter.h.

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

◆ m_highlightItems

bool KIGFX::RENDER_SETTINGS::m_highlightItems
protectedinherited

Highlight items with their HIGHLIGHT flags set.

Definition at line 287 of file painter.h.

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

◆ m_highlightNetcode

int KIGFX::RENDER_SETTINGS::m_highlightNetcode
protectedinherited

Net number that is displayed in highlight -1 means that there is no specific net, and whole active layer is highlighted.

Definition at line 284 of file painter.h.

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

◆ m_layerColors

◆ m_layerColorsDark

COLOR4D KIGFX::RENDER_SETTINGS::m_layerColorsDark[LAYER_ID_COUNT]
protectedinherited

Colors for all layers (darkened)

Colora used for high contrast display mode

Definition at line 274 of file painter.h.

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

◆ m_layerColorsHi

COLOR4D KIGFX::RENDER_SETTINGS::m_layerColorsHi[LAYER_ID_COUNT]
protectedinherited

Colors for all layers (highlighted)

Definition at line 268 of file painter.h.

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

◆ m_layerColorsSel

COLOR4D KIGFX::RENDER_SETTINGS::m_layerColorsSel[LAYER_ID_COUNT]
protectedinherited

Colors for all layers (selected)

Definition at line 271 of file painter.h.

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

◆ m_layerOpacity

float KIGFX::RENDER_SETTINGS::m_layerOpacity
protectedinherited

Determines opacity of all layers.

Definition at line 291 of file painter.h.

Referenced by KIGFX::RENDER_SETTINGS::RENDER_SETTINGS().

◆ m_lineFill

bool KIGFX::GERBVIEW_RENDER_SETTINGS::m_lineFill
protected

Flag determining if lines should be drawn with fill.

Definition at line 147 of file gerbview_painter.h.

Referenced by KIGFX::GERBVIEW_PAINTER::draw(), GERBVIEW_RENDER_SETTINGS(), IsLineFill(), and LoadDisplayOptions().

◆ 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 137 of file gerbview_painter.h.

Referenced by GERBVIEW_RENDER_SETTINGS(), and GetColor().

◆ m_outlineWidth

◆ m_polygonFill

bool KIGFX::GERBVIEW_RENDER_SETTINGS::m_polygonFill
protected

◆ m_selectFactor

float KIGFX::RENDER_SETTINGS::m_selectFactor
protectedinherited

Specifies how color of selected items is changed.

Definition at line 290 of file painter.h.

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

◆ m_showCodes

bool KIGFX::GERBVIEW_RENDER_SETTINGS::m_showCodes
protected

Flag determining if D-Codes should be drawn.

Definition at line 156 of file gerbview_painter.h.

Referenced by GERBVIEW_RENDER_SETTINGS(), IsShowCodes(), and LoadDisplayOptions().

◆ m_showNegativeItems

bool KIGFX::GERBVIEW_RENDER_SETTINGS::m_showNegativeItems
protected

Flag determining if negative items should be drawn with a "ghost" color.

Definition at line 153 of file gerbview_painter.h.

Referenced by GERBVIEW_RENDER_SETTINGS(), GetColor(), IsShowNegativeItems(), and LoadDisplayOptions().

◆ m_showPageLimits

◆ m_spotFill

bool KIGFX::GERBVIEW_RENDER_SETTINGS::m_spotFill
protected

Flag determining if spots should be drawn with fill.

Definition at line 144 of file gerbview_painter.h.

Referenced by KIGFX::GERBVIEW_PAINTER::draw(), GERBVIEW_RENDER_SETTINGS(), IsSpotFill(), and LoadDisplayOptions().

◆ m_worksheetLineWidth

float KIGFX::RENDER_SETTINGS::m_worksheetLineWidth
protectedinherited

Line width used when drawing worksheet.

Definition at line 293 of file painter.h.

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

◆ MAX_FONT_SIZE

const double GERBVIEW_RENDER_SETTINGS::MAX_FONT_SIZE = Millimeter2iu( 10.0 )
staticprotected

Maximum font size for D-Codes and other strings.

Definition at line 162 of file gerbview_painter.h.


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