layer_settings_utils.h File Reference

#include <optional>
#include <layer_ids.h>

Go to the source code of this file.

Enumerations
enum class	VISIBILITY_LAYER {   TRACKS , VIAS , PADS , ZONES ,   SHAPES , BITMAPS , FOOTPRINTS_FRONT , FOOTPRINTS_BACK ,   FOOTPRINT_VALUES , FOOTPRINT_REFERENCES , FOOTPRINT_TEXT , FOOTPRINT_ANCHORS ,   RATSNEST , DRC_WARNINGS , DRC_ERRORS , DRC_EXCLUSIONS ,   LOCKED_ITEM_SHADOWS , CONFLICT_SHADOWS , DRAWING_SHEET , GRID }
	The set of things that can have visibility settings stored in a project file (for example in a view preset). More...

Functions
GAL_SET	UserVisbilityLayers ()
	The set of GAL_LAYER_IDs that correspond to VISIBILITY_LAYERS.
GAL_LAYER_ID	RenderLayerFromVisibilityLayer (VISIBILITY_LAYER aLayer)
std::optional< VISIBILITY_LAYER >	VisibilityLayerFromRenderLayer (GAL_LAYER_ID aLayerId)
std::optional< GAL_LAYER_ID >	RenderLayerFromVisbilityString (const std::string &aLayer)
std::string	VisibilityLayerToString (VISIBILITY_LAYER aLayerId)

Enumeration Type Documentation

VISIBILITY_LAYER

enum class VISIBILITY_LAYER

strong

The set of things that can have visibility settings stored in a project file (for example in a view preset).

This is maintained separately from the enums in layer_ids.h because not all GAL layers get visibility controls, and these are turned into strings for storing in JSON settings files.

Enumerator
TRACKS
VIAS
PADS
ZONES
SHAPES
BITMAPS
FOOTPRINTS_FRONT
FOOTPRINTS_BACK
FOOTPRINT_VALUES
FOOTPRINT_REFERENCES
FOOTPRINT_TEXT
FOOTPRINT_ANCHORS
RATSNEST
DRC_WARNINGS
DRC_ERRORS
DRC_EXCLUSIONS
LOCKED_ITEM_SHADOWS
CONFLICT_SHADOWS
DRAWING_SHEET
GRID

Definition at line 32 of file layer_settings_utils.h.

Function Documentation

RenderLayerFromVisbilityString()

std::optional< GAL_LAYER_ID > RenderLayerFromVisbilityString

(

const std::string &

aLayer

)

Definition at line 119 of file layer_settings_utils.cpp.

References RenderLayerFromVisibilityLayer().

Referenced by PARAM_LAYER_PRESET::jsonToPresets(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

RenderLayerFromVisibilityLayer()

GAL_LAYER_ID RenderLayerFromVisibilityLayer

(

VISIBILITY_LAYER

aLayer

)

Definition at line 57 of file layer_settings_utils.cpp.

References BITMAPS, CONFLICT_SHADOWS, DRAWING_SHEET, DRC_ERRORS, DRC_EXCLUSIONS, DRC_WARNINGS, FOOTPRINT_ANCHORS, FOOTPRINT_REFERENCES, FOOTPRINT_TEXT, FOOTPRINT_VALUES, FOOTPRINTS_BACK, FOOTPRINTS_FRONT, GAL_LAYER_ID_END, GRID, LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_DRAW_BITMAPS, LAYER_DRAWINGSHEET, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_FP_REFERENCES, LAYER_FP_TEXT, LAYER_FP_VALUES, LAYER_GRID, LAYER_LOCKED_ITEM_SHADOW, LAYER_PADS, LAYER_RATSNEST, LAYER_SHAPES, LAYER_TRACKS, LAYER_VIAS, LAYER_ZONES, LOCKED_ITEM_SHADOWS, PADS, RATSNEST, SHAPES, TRACKS, VIAS, and ZONES.

Referenced by RenderLayerFromVisbilityString().

UserVisbilityLayers()

GAL_SET UserVisbilityLayers

(

)

The set of GAL_LAYER_IDs that correspond to VISIBILITY_LAYERS.

Definition at line 27 of file layer_settings_utils.cpp.

References arrayDim(), LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_DRAW_BITMAPS, LAYER_DRAWINGSHEET, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_FP_REFERENCES, LAYER_FP_TEXT, LAYER_FP_VALUES, LAYER_GRID, LAYER_LOCKED_ITEM_SHADOW, LAYER_PADS, LAYER_RATSNEST, LAYER_SHAPES, LAYER_TRACKS, LAYER_VIAS, and LAYER_ZONES.

Referenced by PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

VisibilityLayerFromRenderLayer()

std::optional< VISIBILITY_LAYER > VisibilityLayerFromRenderLayer

(

GAL_LAYER_ID

aLayerId

)

Definition at line 87 of file layer_settings_utils.cpp.

References BITMAPS, CONFLICT_SHADOWS, DRAWING_SHEET, DRC_ERRORS, DRC_EXCLUSIONS, DRC_WARNINGS, FOOTPRINT_ANCHORS, FOOTPRINT_REFERENCES, FOOTPRINT_TEXT, FOOTPRINT_VALUES, FOOTPRINTS_BACK, FOOTPRINTS_FRONT, GRID, LAYER_ANCHOR, LAYER_CONFLICTS_SHADOW, LAYER_DRAW_BITMAPS, LAYER_DRAWINGSHEET, LAYER_DRC_ERROR, LAYER_DRC_EXCLUSION, LAYER_DRC_WARNING, LAYER_FOOTPRINTS_BK, LAYER_FOOTPRINTS_FR, LAYER_FP_REFERENCES, LAYER_FP_TEXT, LAYER_FP_VALUES, LAYER_GRID, LAYER_LOCKED_ITEM_SHADOW, LAYER_PADS, LAYER_RATSNEST, LAYER_SHAPES, LAYER_TRACKS, LAYER_VIAS, LAYER_ZONES, LOCKED_ITEM_SHADOWS, PADS, RATSNEST, SHAPES, TRACKS, VIAS, and ZONES.

Referenced by PARAM_LAYER_PRESET::MigrateToNamedRenderLayers(), PARAM_LAYER_PRESET::presetsToJson(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().

VisibilityLayerToString()

std::string VisibilityLayerToString

(

VISIBILITY_LAYER

aLayerId

)

Definition at line 131 of file layer_settings_utils.cpp.

Referenced by PARAM_LAYER_PRESET::MigrateToNamedRenderLayers(), PARAM_LAYER_PRESET::presetsToJson(), and PROJECT_LOCAL_SETTINGS::PROJECT_LOCAL_SETTINGS().