KiCad PCB EDA Suite
PCB_DISPLAY_OPTIONS Class Reference

Class PCB_DISPLAY_OPTIONS handles 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_CLEARANCE_NEW_TRACKS, SHOW_CLEARANCE_NEW_TRACKS_AND_VIA_AREAS, SHOW_CLEARANCE_NEW_AND_EDITED_TRACKS_AND_VIA_AREAS,
  SHOW_CLEARANCE_ALWAYS
}
 Enum TRACE_CLEARANCE_DISPLAY_MODE_T is the set of values for DISPLAY_OPTIONS.ShowTrackClearanceMode parameter option. More...
 

Public Member Functions

 PCB_DISPLAY_OPTIONS ()
 

Public Attributes

bool m_DisplayPadFill
 
bool m_DisplayViaFill
 
bool m_DisplayPadNum
 
bool m_DisplayPadIsol
 
bool m_DisplayModEdgeFill
 
bool m_DisplayModTextFill
 
bool m_DisplayPcbTrackFill
 
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
 How trace clearances are displayed. More...
 
bool m_DisplayPolarCood
 
int m_DisplayZonesMode
 
int m_DisplayNetNamesMode
 
bool m_DisplayDrawItemsFill
 
bool m_ContrastModeDisplay
 
int m_MaxLinksShowed
 
bool m_Show_Module_Ratsnest
 

Detailed Description

Class PCB_DISPLAY_OPTIONS handles display options like enable/disable some optional drawings.

Definition at line 37 of file pcb_display_options.h.

Member Enumeration Documentation

Enum TRACE_CLEARANCE_DISPLAY_MODE_T is 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_CLEARANCE_NEW_TRACKS 
SHOW_CLEARANCE_NEW_TRACKS_AND_VIA_AREAS 
SHOW_CLEARANCE_NEW_AND_EDITED_TRACKS_AND_VIA_AREAS 
SHOW_CLEARANCE_ALWAYS 

Definition at line 46 of file pcb_display_options.h.

46  {
47  DO_NOT_SHOW_CLEARANCE = 0, // Do not show clearance areas
48  SHOW_CLEARANCE_NEW_TRACKS, /* Show clearance areas only for new track
49  * during track creation. */
50  SHOW_CLEARANCE_NEW_TRACKS_AND_VIA_AREAS, /* Show clearance areas only for new track
51  * during track creation, and shows a via
52  * clearance area at end of current new
53  * segment (guide to place a new via
54  */
56  /* Show clearance for new, moving and
57  * dragging tracks and vias
58  */
59  SHOW_CLEARANCE_ALWAYS /* Show Always clearance areas
60  * for track and vias
61  */
62  };

Constructor & Destructor Documentation

PCB_DISPLAY_OPTIONS::PCB_DISPLAY_OPTIONS ( )

Definition at line 34 of file pcb_display_options.cpp.

References FILLED, m_ContrastModeDisplay, m_DisplayDrawItemsFill, m_DisplayModEdgeFill, m_DisplayModTextFill, m_DisplayNetNamesMode, m_DisplayPadFill, m_DisplayPadIsol, m_DisplayPadNum, m_DisplayPcbTrackFill, m_DisplayPolarCood, m_DisplayViaFill, m_DisplayZonesMode, m_MaxLinksShowed, m_Show_Module_Ratsnest, m_ShowTrackClearanceMode, and SHOW_CLEARANCE_NEW_TRACKS_AND_VIA_AREAS.

35 {
38  m_DisplayPadNum = true;
39  m_DisplayPadIsol = true;
40 
43  m_DisplayPcbTrackFill = FILLED; // false = sketch , true = filled
45 
46  m_DisplayPolarCood = false; /* false = display absolute coordinates,
47  * true = display polar cordinates */
48  m_DisplayZonesMode = 0; /* 0 = Show filled areas outlines in zones,
49  * 1 = do not show filled areas outlines
50  * 2 = show outlines of filled areas */
51  m_DisplayNetNamesMode = 3; /* 0 do not show netnames,
52  * 1 show netnames on pads
53  * 2 show netnames on tracks
54  * 3 show netnames on tracks and pads */
56  m_ContrastModeDisplay = false;
57  m_MaxLinksShowed = 3; // in track creation: number of hairwires shown
58  m_Show_Module_Ratsnest = true; // When moving a footprint: allows displaying a ratsnest
59 }
TRACE_CLEARANCE_DISPLAY_MODE_T m_ShowTrackClearanceMode
How trace clearances are displayed.

Member Data Documentation

bool PCB_DISPLAY_OPTIONS::m_DisplayDrawItemsFill
bool PCB_DISPLAY_OPTIONS::m_DisplayModEdgeFill
bool PCB_DISPLAY_OPTIONS::m_DisplayModTextFill
bool PCB_DISPLAY_OPTIONS::m_DisplayPcbTrackFill
bool PCB_DISPLAY_OPTIONS::m_DisplayPolarCood

Definition at line 75 of file pcb_display_options.h.

Referenced by PCB_DISPLAY_OPTIONS().

int PCB_DISPLAY_OPTIONS::m_DisplayZonesMode
int PCB_DISPLAY_OPTIONS::m_MaxLinksShowed

Definition at line 85 of file pcb_display_options.h.

Referenced by PCB_DISPLAY_OPTIONS().

bool PCB_DISPLAY_OPTIONS::m_Show_Module_Ratsnest

Definition at line 86 of file pcb_display_options.h.

Referenced by PCB_DISPLAY_OPTIONS().


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