KiCad PCB EDA Suite
Loading...
Searching...
No Matches
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=wxS(""))
 
 LAYER_PRESET (const wxString &aName, const LSET &aVisibleLayers, bool aFlipBoard)
 
 LAYER_PRESET (const wxString &aName, const LSET &aVisibleLayers, const GAL_SET &aVisibleObjects, PCB_LAYER_ID aActiveLayer, bool aFlipBoard)
 
bool LayersMatch (const LAYER_PRESET &aOther)
 

Public Attributes

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

Detailed Description

A saved set of layers that are visible.

Definition at line 141 of file board_project_settings.h.

Constructor & Destructor Documentation

◆ LAYER_PRESET() [1/3]

LAYER_PRESET::LAYER_PRESET ( const wxString &  aName = wxS( "" ))
inline

Definition at line 143 of file board_project_settings.h.

◆ LAYER_PRESET() [2/3]

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

Definition at line 153 of file board_project_settings.h.

◆ LAYER_PRESET() [3/3]

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

Definition at line 163 of file board_project_settings.h.

Member Function Documentation

◆ LayersMatch()

bool LAYER_PRESET::LayersMatch ( const LAYER_PRESET aOther)
inline

Definition at line 174 of file board_project_settings.h.

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 183 of file board_project_settings.h.

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

◆ flipBoard

bool LAYER_PRESET::flipBoard

True if the flip board is enabled.

Definition at line 182 of file board_project_settings.h.

Referenced by APPEARANCE_CONTROLS::doApplyLayerPreset(), and APPEARANCE_CONTROLS::onLayerPresetChanged().

◆ layers

◆ name

◆ readOnly

bool LAYER_PRESET::readOnly

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

Definition at line 184 of file board_project_settings.h.

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

◆ renderLayers

GAL_SET LAYER_PRESET::renderLayers

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