kicad/include/project/board_project_settings.h

178 lines
5.7 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2020 Jon Evans <jon@craftyjon.com>
* Copyright (C) 2020 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software: you can redistribute it and/or modify it
* under the terms of the GNU General Public License as published by the
* Free Software Foundation, either version 3 of the License, or (at your
* option) any later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* General Public License for more details.
*
* You should have received a copy of the GNU General Public License along
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KICAD_BOARD_PROJECT_SETTINGS_H
#define KICAD_BOARD_PROJECT_SETTINGS_H
#include <layers_id_colors_and_visibility.h>
#include <settings/parameters.h>
/**
* This file contains data structures that are saved in the project file or project local settings
* file that are specific to PcbNew. This is done so that these structures are available in common.
*/
/**
* Selection filtering that applies all the time (not the "filter selection" dialog that modifies
* the current selection)
*/
struct SELECTION_FILTER_OPTIONS
{
bool lockedItems; ///< Allow selecting locked items
bool footprints; ///< Allow selecting entire footprints
bool text; ///< Text (free or attached to a footprint)
bool tracks; ///< Copper tracks
bool vias; ///< Vias (all types>
bool pads; ///< Footprint pads
bool graphics; ///< Graphic lines, shapes, polygons
bool zones; ///< Copper zones
bool keepouts; ///< Keepout zones
bool dimensions; ///< Dimension items
bool otherItems; ///< Anything not fitting one of the above categories
SELECTION_FILTER_OPTIONS()
{
lockedItems = true;
footprints = true;
text = true;
tracks = true;
vias = true;
pads = true;
graphics = true;
zones = true;
keepouts = true;
dimensions = true;
otherItems = true;
}
/**
* @return true if any of the item types are enabled (excluding "locked items" which is special)
*/
bool Any()
{
return ( footprints || text || tracks || vias || pads || graphics || zones
|| keepouts || dimensions || otherItems );
}
/**
* @return true if all the item types are enabled (excluding "locked items" which is special)
*/
bool All()
{
return ( footprints && text && tracks && vias && pads && graphics && zones
&& keepouts && dimensions && otherItems );
}
};
/**
* Determines how inactive layers should be displayed
*/
enum class HIGH_CONTRAST_MODE
{
NORMAL = 0, ///> Non-active layers are shown normally (no high-contrast mode)
DIMMED, ///> Non-active layers are dimmed (old high-contrast mode)
HIDDEN ///> Non-active layers are hidden
};
///> Determines how zones should be displayed
enum class ZONE_DISPLAY_MODE
{
SHOW_FILLED, ///< Filled polygons are shown
SHOW_ZONE_OUTLINE, ///< Only the zone outline is shown
SHOW_FILLED_OUTLINE ///< Outlines of filled polygons are shown
};
///> Determines how net color overrides should be applied
enum class NET_COLOR_MODE
{
OFF, ///< Net (and netclass) colors are not shown
RATSNEST, ///< Net/netclass colors are shown on ratsnest lines only
ALL ///< Net/netclass colors are shown on all net copper
};
///> Determines how ratsnest lines are drawn
enum class RATSNEST_MODE
{
ALL, ///< Ratsnest lines are drawn to items on all layers (default)
VISIBLE ///< Ratsnest lines are drawn to items on visible layers only
};
/**
* A saved set of layers that are visible
*/
struct LAYER_PRESET
{
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
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
LAYER_PRESET( const wxString& aName = wxEmptyString ) :
name( aName ),
activeLayer( UNSELECTED_LAYER )
{
layers = LSET::AllLayersMask();
renderLayers = GAL_SET::DefaultVisible();
readOnly = false;
}
LAYER_PRESET( const wxString& aName, const LSET& aVisibleLayers ) :
name( aName ),
layers( aVisibleLayers ),
activeLayer( UNSELECTED_LAYER )
{
renderLayers = GAL_SET::DefaultVisible();
readOnly = false;
}
LAYER_PRESET( const wxString& aName, const LSET& aVisibleLayers, const GAL_SET& aVisibleObjects,
PCB_LAYER_ID aActiveLayer ) :
name( aName ),
layers( aVisibleLayers ),
renderLayers( aVisibleObjects ),
activeLayer( aActiveLayer )
{
readOnly = false;
}
bool LayersMatch( const LAYER_PRESET& aOther )
{
return aOther.layers == layers && aOther.renderLayers == renderLayers;
}
};
class PARAM_LAYER_PRESET : public PARAM_LAMBDA<nlohmann::json>
{
public:
PARAM_LAYER_PRESET( const std::string& aPath, std::vector<LAYER_PRESET>* aPresetList );
private:
nlohmann::json presetsToJson();
void jsonToPresets( const nlohmann::json& aJson );
std::vector<LAYER_PRESET>* m_presets;
};
#endif // KICAD_BOARD_PROJECT_SETTINGS_H