KiCad PCB EDA Suite
PCB_DISPLAY_OPTIONS Class Reference

Container for display options like enable/disable some optional drawings. More...

#include <pcb_display_options.h>

Public Types

enum  TRACE_CLEARANCE_DISPLAY_MODE_T {
  DO_NOT_SHOW_CLEARANCE = 0, SHOW_TRACK_CLEARANCE_WHILE_ROUTING, SHOW_TRACK_CLEARANCE_WITH_VIA_WHILE_ROUTING, SHOW_WHILE_ROUTING_OR_DRAGGING,
  SHOW_TRACK_CLEARANCE_WITH_VIA_ALWAYS
}
 The set of values for DISPLAY_OPTIONS.ShowTrackClearanceMode parameter option. More...
 
enum  PCB_DISPLAY_ORIGIN_OPTIONS_T { PCB_ORIGIN_PAGE = 0, PCB_ORIGIN_AUX, PCB_ORIGIN_GRID }
 The set of values for DISPLAY_OPTIONS.DisplayOrigin parameter option. More...
 

Public Member Functions

 PCB_DISPLAY_OPTIONS ()
 

Public Attributes

bool m_DisplayPadFill
 
bool m_DisplayViaFill
 
bool m_DisplayPadNum
 
bool m_DisplayPadClearance
 
bool m_DisplayPadNoConnects
 
bool m_DisplayGraphicsFill
 
bool m_DisplayTextFill
 
bool m_DisplayPcbTrackFill
 
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
 How trace clearances are displayed. More...
 
ZONE_DISPLAY_MODE m_ZoneDisplayMode
 
int m_DisplayNetNamesMode
 
HIGH_CONTRAST_MODE m_ContrastModeDisplay
 How inactive layers are displayed. More...
 
NET_COLOR_MODE m_NetColorMode
 How to use color overrides on specific nets and netclasses. More...
 
RATSNEST_MODE m_RatsnestMode
 Ratsnest draw mode (all layers vs only visible layers) More...
 
int m_MaxLinksShowed
 
bool m_ShowModuleRatsnest
 
bool m_ShowGlobalRatsnest
 
bool m_DisplayRatsnestLinesCurved
 
double m_TrackOpacity
 Opacity override for all tracks. More...
 
double m_ViaOpacity
 Opacity override for all types of via. More...
 
double m_PadOpacity
 Opacity override for SMD pads and PTHs. More...
 
double m_ZoneOpacity
 Opacity override for filled zone areas. More...
 
PCB_DISPLAY_ORIGIN_OPTIONS_T m_DisplayOrigin
 Which origin is used for display transforms. More...
 
bool m_DisplayInvertXAxis
 
bool m_DisplayInvertYAxis
 
bool m_Live3DRefresh
 If true, 3D viewer will redraw on every modification operation. More...
 

Detailed Description

Container for display options like enable/disable some optional drawings.

Definition at line 38 of file pcb_display_options.h.

Member Enumeration Documentation

◆ PCB_DISPLAY_ORIGIN_OPTIONS_T

The set of values for DISPLAY_OPTIONS.DisplayOrigin parameter option.

This parameter controls what is used as the origin point for location values

Enumerator
PCB_ORIGIN_PAGE 
PCB_ORIGIN_AUX 
PCB_ORIGIN_GRID 

Definition at line 104 of file pcb_display_options.h.

◆ TRACE_CLEARANCE_DISPLAY_MODE_T

The set of values for DISPLAY_OPTIONS.ShowTrackClearanceMode parameter option.

This parameter controls how to show tracks and vias clearance area.

Enumerator
DO_NOT_SHOW_CLEARANCE 
SHOW_TRACK_CLEARANCE_WHILE_ROUTING 
SHOW_TRACK_CLEARANCE_WITH_VIA_WHILE_ROUTING 
SHOW_WHILE_ROUTING_OR_DRAGGING 
SHOW_TRACK_CLEARANCE_WITH_VIA_ALWAYS 

Definition at line 48 of file pcb_display_options.h.

Constructor & Destructor Documentation

◆ PCB_DISPLAY_OPTIONS()

PCB_DISPLAY_OPTIONS::PCB_DISPLAY_OPTIONS ( )

Definition at line 35 of file pcb_display_options.cpp.

36 {
39  m_DisplayPadNum = true;
40  m_DisplayPadClearance = true;
42 
45  m_DisplayPcbTrackFill = FILLED; // false = sketch , true = filled
47 
49  m_DisplayNetNamesMode = 3; /* 0 do not show netnames,
50  * 1 show netnames on pads
51  * 2 show netnames on tracks
52  * 3 show netnames on tracks and pads */
56  m_MaxLinksShowed = 3; // in track creation: number of hairwires shown
57  m_ShowModuleRatsnest = true; // When moving a footprint: allows displaying a ratsnest
59  m_ShowGlobalRatsnest = true;
60 
61  m_TrackOpacity = 1.0;
62  m_ViaOpacity = 1.0;
63  m_PadOpacity = 1.0;
64  m_ZoneOpacity = 1.0;
65 
67  m_DisplayInvertXAxis = false;
68  m_DisplayInvertYAxis = false;
69  m_Live3DRefresh = false;
70 }
double m_TrackOpacity
Opacity override for all tracks.
double m_ViaOpacity
Opacity override for all types of via.
Net/netclass colors are shown on ratsnest lines only.
Ratsnest lines are drawn to items on all layers (default)
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
How trace clearances are displayed.
RATSNEST_MODE m_RatsnestMode
Ratsnest draw mode (all layers vs only visible layers)
PCB_DISPLAY_ORIGIN_OPTIONS_T m_DisplayOrigin
Which origin is used for display transforms.
Inactive layers are shown normally (no high-contrast mode)
HIGH_CONTRAST_MODE m_ContrastModeDisplay
How inactive layers are displayed.
double m_ZoneOpacity
Opacity override for filled zone areas.
double m_PadOpacity
Opacity override for SMD pads and PTHs.
bool m_Live3DRefresh
If true, 3D viewer will redraw on every modification operation.
ZONE_DISPLAY_MODE m_ZoneDisplayMode
NET_COLOR_MODE m_NetColorMode
How to use color overrides on specific nets and netclasses.

References ALL, FILLED, m_ContrastModeDisplay, m_DisplayGraphicsFill, m_DisplayInvertXAxis, m_DisplayInvertYAxis, m_DisplayNetNamesMode, m_DisplayOrigin, m_DisplayPadClearance, m_DisplayPadFill, m_DisplayPadNoConnects, m_DisplayPadNum, m_DisplayPcbTrackFill, m_DisplayRatsnestLinesCurved, m_DisplayTextFill, m_DisplayViaFill, m_Live3DRefresh, m_MaxLinksShowed, m_NetColorMode, m_PadOpacity, m_RatsnestMode, m_ShowGlobalRatsnest, m_ShowModuleRatsnest, m_ShowTrackClearanceMode, m_TrackOpacity, m_ViaOpacity, m_ZoneDisplayMode, m_ZoneOpacity, NORMAL, PCB_ORIGIN_PAGE, RATSNEST, SHOW_FILLED, and SHOW_TRACK_CLEARANCE_WITH_VIA_WHILE_ROUTING.

Member Data Documentation

◆ m_ContrastModeDisplay

◆ m_DisplayGraphicsFill

◆ m_DisplayInvertXAxis

◆ m_DisplayInvertYAxis

◆ m_DisplayNetNamesMode

◆ m_DisplayOrigin

◆ m_DisplayPadClearance

◆ m_DisplayPadFill

◆ m_DisplayPadNoConnects

bool PCB_DISPLAY_OPTIONS::m_DisplayPadNoConnects

◆ m_DisplayPadNum

◆ m_DisplayPcbTrackFill

◆ m_DisplayRatsnestLinesCurved

◆ m_DisplayTextFill

◆ m_DisplayViaFill

◆ m_Live3DRefresh

◆ m_MaxLinksShowed

int PCB_DISPLAY_OPTIONS::m_MaxLinksShowed

Definition at line 86 of file pcb_display_options.h.

Referenced by PCB_DISPLAY_OPTIONS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

◆ m_NetColorMode

◆ m_PadOpacity

◆ m_RatsnestMode

◆ m_ShowGlobalRatsnest

◆ m_ShowModuleRatsnest

◆ m_ShowTrackClearanceMode

◆ m_TrackOpacity

◆ m_ViaOpacity

◆ m_ZoneDisplayMode

◆ m_ZoneOpacity


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