KiCad PCB EDA Suite
LAYER_PRESET Struct Reference

A saved set of layers that are visible. More...

#include <board_project_settings.h>

Public Member Functions

 LAYER_PRESET (const wxString &aName=wxEmptyString)
 
 LAYER_PRESET (const wxString &aName, const LSET &aVisibleLayers)
 
 LAYER_PRESET (const wxString &aName, const LSET &aVisibleLayers, const GAL_SET &aVisibleObjects, PCB_LAYER_ID aActiveLayer)
 
bool LayersMatch (const LAYER_PRESET &aOther)
 

Public Attributes

wxString name
 A name for this layer set. More...
 
LSET layers
 Board layers that are visible. More...
 
GAL_SET renderLayers
 Render layers (e.g. object types) that are visible. More...
 
PCB_LAYER_ID activeLayer
 Optional layer to set active when this preset is loaded. More...
 
bool readOnly
 True if this is a read-only (built-in) preset. More...
 

Detailed Description

A saved set of layers that are visible.

Definition at line 130 of file board_project_settings.h.

Constructor & Destructor Documentation

◆ LAYER_PRESET() [1/3]

LAYER_PRESET::LAYER_PRESET ( const wxString &  aName = wxEmptyString)
inline

Definition at line 132 of file board_project_settings.h.

132 :
133 name( aName ),
135 {
138 readOnly = false;
139 }
static GAL_SET DefaultVisible()
Definition: lset.cpp:960
static LSET AllLayersMask()
Definition: lset.cpp:808
@ UNSELECTED_LAYER
Definition: layer_ids.h:61
GAL_SET renderLayers
Render layers (e.g. object types) that are visible.
wxString name
A name for this layer set.
LSET layers
Board layers that are visible.
bool readOnly
True if this is a read-only (built-in) preset.
PCB_LAYER_ID activeLayer
Optional layer to set active when this preset is loaded.

References LSET::AllLayersMask(), GAL_SET::DefaultVisible(), layers, readOnly, and renderLayers.

◆ LAYER_PRESET() [2/3]

LAYER_PRESET::LAYER_PRESET ( const wxString &  aName,
const LSET aVisibleLayers 
)
inline

Definition at line 141 of file board_project_settings.h.

141 :
142 name( aName ),
143 layers( aVisibleLayers ),
145 {
147 readOnly = false;
148 }

References GAL_SET::DefaultVisible(), readOnly, and renderLayers.

◆ LAYER_PRESET() [3/3]

LAYER_PRESET::LAYER_PRESET ( const wxString &  aName,
const LSET aVisibleLayers,
const GAL_SET aVisibleObjects,
PCB_LAYER_ID  aActiveLayer 
)
inline

Definition at line 150 of file board_project_settings.h.

151 :
152 name( aName ),
153 layers( aVisibleLayers ),
154 renderLayers( aVisibleObjects ),
155 activeLayer( aActiveLayer )
156 {
157 readOnly = false;
158 }

References readOnly.

Member Function Documentation

◆ LayersMatch()

bool LAYER_PRESET::LayersMatch ( const LAYER_PRESET aOther)
inline

Definition at line 160 of file board_project_settings.h.

161 {
162 return aOther.layers == layers && aOther.renderLayers == renderLayers;
163 }

References layers, and renderLayers.

Member Data Documentation

◆ activeLayer

PCB_LAYER_ID LAYER_PRESET::activeLayer

Optional layer to set active when this preset is loaded.

Definition at line 168 of file board_project_settings.h.

Referenced by APPEARANCE_CONTROLS::doApplyLayerPreset(), and PARAM_LAYER_PRESET::jsonToPresets().

◆ layers

◆ name

◆ readOnly

bool LAYER_PRESET::readOnly

True if this is a read-only (built-in) preset.

Definition at line 169 of file board_project_settings.h.

Referenced by APPEARANCE_CONTROLS::ApplyLayerPreset(), LAYER_PRESET(), and APPEARANCE_CONTROLS::onLayerPresetChanged().

◆ renderLayers

GAL_SET LAYER_PRESET::renderLayers

The documentation for this struct was generated from the following file: