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

enum PCB_DISPLAY_OPTIONS::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.

 {
 PCB_ORIGIN_PAGE = 0,
 PCB_ORIGIN_AUX,
 PCB_ORIGIN_GRID,
 };

TRACE_CLEARANCE_DISPLAY_MODE_T

enum PCB_DISPLAY_OPTIONS::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.

 {
 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
 };

Constructor & Destructor Documentation

PCB_DISPLAY_OPTIONS()

PCB_DISPLAY_OPTIONS::PCB_DISPLAY_OPTIONS

(

)

Definition at line 35 of file pcb_display_options.cpp.

{
 m_DisplayPadFill = FILLED;
 m_DisplayViaFill = FILLED;
 m_DisplayPadNum = true;
 m_DisplayPadClearance = true;
 m_DisplayPadNoConnects = true;

 m_DisplayGraphicsFill = FILLED;
 m_DisplayTextFill = FILLED;
 m_DisplayPcbTrackFill = FILLED; // false = sketch , true = filled
 m_ShowTrackClearanceMode = SHOW_TRACK_CLEARANCE_WITH_VIA_WHILE_ROUTING;

 m_ZoneDisplayMode = ZONE_DISPLAY_MODE::SHOW_FILLED;
 m_DisplayNetNamesMode = 3; /* 0 do not show netnames,
 * 1 show netnames on pads
 * 2 show netnames on tracks
 * 3 show netnames on tracks and pads */
 m_ContrastModeDisplay = HIGH_CONTRAST_MODE::NORMAL;
 m_NetColorMode = NET_COLOR_MODE::RATSNEST;
 m_RatsnestMode = RATSNEST_MODE::ALL;
 m_MaxLinksShowed = 3; // in track creation: number of hairwires shown
 m_ShowModuleRatsnest = true; // When moving a footprint: allows displaying a ratsnest
 m_DisplayRatsnestLinesCurved = false;
 m_ShowGlobalRatsnest = true;

 m_TrackOpacity = 1.0;
 m_ViaOpacity = 1.0;
 m_PadOpacity = 1.0;
 m_ZoneOpacity = 1.0;

 m_DisplayOrigin = PCB_ORIGIN_PAGE;
 m_DisplayInvertXAxis = false;
 m_DisplayInvertYAxis = false;
 m_Live3DRefresh = false;
}

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

HIGH_CONTRAST_MODE PCB_DISPLAY_OPTIONS::m_ContrastModeDisplay

How inactive layers are displayed.

See also

HIGH_CONTRAST_MODE - stored in the project

Definition at line 78 of file pcb_display_options.h.

Referenced by APPEARANCE_CONTROLS::APPEARANCE_CONTROLS(), PAD_TOOL::EditPad(), PCB_CONTROL::HighContrastMode(), PCB_CONTROL::HighContrastModeCycle(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_DISPLAY_OPTIONS(), PNS::TOOL_BASE::pickSingleItem(), PCB_EDIT_FRAME::Process_Special_Functions(), PAD_TOOL::Reset(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_BASE_FRAME::SetDisplayOptions(), FOOTPRINT_EDIT_FRAME::setupUIConditions(), and APPEARANCE_CONTROLS::UpdateDisplayOptions().

m_DisplayGraphicsFill

bool PCB_DISPLAY_OPTIONS::m_DisplayGraphicsFill

Definition at line 61 of file pcb_display_options.h.

Referenced by CVPCB_SETTINGS::CVPCB_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), PCB_VIEWER_TOOLS::GraphicOutlines(), PCB_EDITOR_CONDITIONS::graphicsFillDisplayFunc(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

m_DisplayInvertXAxis

bool PCB_DISPLAY_OPTIONS::m_DisplayInvertXAxis

Definition at line 112 of file pcb_display_options.h.

Referenced by PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), and PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataToWindow().

m_DisplayInvertYAxis

bool PCB_DISPLAY_OPTIONS::m_DisplayInvertYAxis

Definition at line 113 of file pcb_display_options.h.

Referenced by PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), and PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataToWindow().

m_DisplayNetNamesMode

int PCB_DISPLAY_OPTIONS::m_DisplayNetNamesMode

Definition at line 71 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_DISPLAY_OPTIONS::TransferDataToWindow().

m_DisplayOrigin

PCB_DISPLAY_ORIGIN_OPTIONS_T PCB_DISPLAY_OPTIONS::m_DisplayOrigin

Which origin is used for display transforms.

Definition at line 111 of file pcb_display_options.h.

Referenced by PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataFromWindow(), and PANEL_PCBNEW_DISPLAY_ORIGIN::TransferDataToWindow().

m_DisplayPadClearance

bool PCB_DISPLAY_OPTIONS::m_DisplayPadClearance

Definition at line 59 of file pcb_display_options.h.

Referenced by EVT_GRID_CMD_CELL_CHANGED(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_DISPLAY_OPTIONS::TransferDataToWindow().

m_DisplayPadFill

bool PCB_DISPLAY_OPTIONS::m_DisplayPadFill

Definition at line 56 of file pcb_display_options.h.

Referenced by CVPCB_SETTINGS::CVPCB_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDITOR_CONDITIONS::padFillDisplayFunc(), PCB_DISPLAY_OPTIONS(), and PCBNEW_SETTINGS::PCBNEW_SETTINGS().

m_DisplayPadNoConnects

bool PCB_DISPLAY_OPTIONS::m_DisplayPadNoConnects

Definition at line 60 of file pcb_display_options.h.

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

m_DisplayPadNum

bool PCB_DISPLAY_OPTIONS::m_DisplayPadNum

Definition at line 58 of file pcb_display_options.h.

Referenced by CVPCB_SETTINGS::CVPCB_SETTINGS(), EVT_GRID_CMD_CELL_CHANGED(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDITOR_CONDITIONS::padNumberDisplayFunc(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_DISPLAY_OPTIONS::TransferDataToWindow().

m_DisplayPcbTrackFill

bool PCB_DISPLAY_OPTIONS::m_DisplayPcbTrackFill

Definition at line 63 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PCB_CONTROL::TrackDisplayMode(), and PCB_EDITOR_CONDITIONS::trackFillDisplayFunc().

m_DisplayRatsnestLinesCurved

bool PCB_DISPLAY_OPTIONS::m_DisplayRatsnestLinesCurved

Definition at line 89 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PCB_CONTROL::ToggleRatsnest(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), and PANEL_EDIT_OPTIONS::TransferDataToWindow().

m_DisplayTextFill

bool PCB_DISPLAY_OPTIONS::m_DisplayTextFill

Definition at line 62 of file pcb_display_options.h.

Referenced by CVPCB_SETTINGS::CVPCB_SETTINGS(), FOOTPRINT_EDITOR_SETTINGS::FOOTPRINT_EDITOR_SETTINGS(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PCB_EDITOR_CONDITIONS::textFillDisplayFunc(), and PCB_VIEWER_TOOLS::TextOutlines().

m_DisplayViaFill

bool PCB_DISPLAY_OPTIONS::m_DisplayViaFill

Definition at line 57 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PCB_CONTROL::ViaDisplayMode(), and PCB_EDITOR_CONDITIONS::viaFillDisplayFunc().

m_Live3DRefresh

bool PCB_DISPLAY_OPTIONS::m_Live3DRefresh

If true, 3D viewer will redraw on every modification operation.

Definition at line 115 of file pcb_display_options.h.

Referenced by EDIT_TOOL::doMoveSelection(), BOARD_INSPECTION_TOOL::HighlightItem(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), BOARD_COMMIT::Push(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_DISPLAY_OPTIONS::TransferDataToWindow().

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

NET_COLOR_MODE PCB_DISPLAY_OPTIONS::m_NetColorMode

How to use color overrides on specific nets and netclasses.

Definition at line 81 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_CONTROL::NetColorModeCycle(), APPEARANCE_CONTROLS::onNetColorMode(), PCB_DISPLAY_OPTIONS(), PCB_EDIT_FRAME::SaveProjectSettings(), and APPEARANCE_CONTROLS::UpdateDisplayOptions().

m_PadOpacity

double PCB_DISPLAY_OPTIONS::m_PadOpacity

Opacity override for SMD pads and PTHs.

Definition at line 96 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), PCB_DISPLAY_OPTIONS(), PCB_EDIT_FRAME::SaveProjectSettings(), and APPEARANCE_CONTROLS::syncObjectSettings().

m_RatsnestMode

RATSNEST_MODE PCB_DISPLAY_OPTIONS::m_RatsnestMode

Ratsnest draw mode (all layers vs only visible layers)

Definition at line 84 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onRatsnestMode(), PCB_DISPLAY_OPTIONS(), PCB_CONTROL::RatsnestModeCycle(), PCB_EDIT_FRAME::SaveProjectSettings(), and APPEARANCE_CONTROLS::UpdateDisplayOptions().

m_ShowGlobalRatsnest

bool PCB_DISPLAY_OPTIONS::m_ShowGlobalRatsnest

Definition at line 88 of file pcb_display_options.h.

Referenced by FOOTPRINT_VIEWER_FRAME::AddFootprintToPCB(), BOARD_NETLIST_UPDATER::addNewFootprint(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), BOARD_INSPECTION_TOOL::LocalRatsnestTool(), APPEARANCE_CONTROLS::onObjectVisibilityChanged(), APPEARANCE_CONTROLS::onRatsnestMode(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), BOARD_EDITOR_CONTROL::PlaceFootprint(), PCB_CONTROL::RatsnestModeCycle(), APPEARANCE_CONTROLS::setVisibleObjects(), PCB_CONTROL::ToggleRatsnest(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), and APPEARANCE_CONTROLS::UpdateDisplayOptions().

m_ShowModuleRatsnest

bool PCB_DISPLAY_OPTIONS::m_ShowModuleRatsnest

Definition at line 87 of file pcb_display_options.h.

Referenced by BOARD_INSPECTION_TOOL::calculateSelectionRatsnest(), ROUTER_TOOL::InlineDrag(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_EDIT_OPTIONS::TransferDataFromWindow(), and PANEL_EDIT_OPTIONS::TransferDataToWindow().

m_ShowTrackClearanceMode

TRACE_CLEARANCE_DISPLAY_MODE_T PCB_DISPLAY_OPTIONS::m_ShowTrackClearanceMode

How trace clearances are displayed.

See also

TRACE_CLEARANCE_DISPLAY_MODE_T.

Definition at line 66 of file pcb_display_options.h.

Referenced by PNS_KICAD_IFACE::DisplayItem(), KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PANEL_DISPLAY_OPTIONS::TransferDataFromWindow(), and PANEL_DISPLAY_OPTIONS::TransferDataToWindow().

m_TrackOpacity

double PCB_DISPLAY_OPTIONS::m_TrackOpacity

Opacity override for all tracks.

Definition at line 94 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), PCB_DISPLAY_OPTIONS(), PCB_EDIT_FRAME::SaveProjectSettings(), and APPEARANCE_CONTROLS::syncObjectSettings().

m_ViaOpacity

double PCB_DISPLAY_OPTIONS::m_ViaOpacity

Opacity override for all types of via.

Definition at line 95 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), PCB_DISPLAY_OPTIONS(), PCB_EDIT_FRAME::SaveProjectSettings(), and APPEARANCE_CONTROLS::syncObjectSettings().

m_ZoneDisplayMode

ZONE_DISPLAY_MODE PCB_DISPLAY_OPTIONS::m_ZoneDisplayMode

See also

ZONE_DISPLAY_MODE - stored in the project

Definition at line 69 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), PCB_DISPLAY_OPTIONS(), PCBNEW_SETTINGS::PCBNEW_SETTINGS(), PCB_EDIT_FRAME::SaveProjectSettings(), PCB_SELECTION_TOOL::selectPoint(), PCB_CONTROL::ZoneDisplayMode(), and PCB_EDITOR_CONDITIONS::zoneDisplayModeFunc().

m_ZoneOpacity

double PCB_DISPLAY_OPTIONS::m_ZoneOpacity

Opacity override for filled zone areas.

Definition at line 97 of file pcb_display_options.h.

Referenced by KIGFX::PCB_RENDER_SETTINGS::LoadDisplayOptions(), PCB_EDIT_FRAME::LoadProjectSettings(), APPEARANCE_CONTROLS::onObjectOpacitySlider(), PCB_DISPLAY_OPTIONS(), PCB_EDIT_FRAME::SaveProjectSettings(), and APPEARANCE_CONTROLS::syncObjectSettings().

---

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

• pcb_display_options.h
• pcb_display_options.cpp