board_project_settings.h

Go to the documentation of this file.

/*
 * 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>

struct SELECTION_FILTER_OPTIONS
{
    bool lockedItems;   
    bool footprints;    
    bool text;          
    bool tracks;        
    bool vias;          
    bool pads;          
    bool graphics;      
    bool zones;         
    bool keepouts;      
    bool dimensions;    
    bool otherItems;    

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

    bool Any()
    {
        return ( footprints || text || tracks || vias || pads || graphics || zones
                 || keepouts || dimensions || otherItems );
    }

    bool All()
    {
        return ( footprints && text && tracks && vias && pads && graphics && zones
                 && keepouts && dimensions && otherItems );
    }
};

enum class HIGH_CONTRAST_MODE
{
    NORMAL = 0,     
    DIMMED,         
    HIDDEN          
};

enum class ZONE_DISPLAY_MODE
{
    SHOW_FILLED,    
    HIDE_FILLED,    
    SHOW_OUTLINED   
};

enum class NET_COLOR_MODE
{
    OFF,        
    RATSNEST,   
    ALL         
};

enum class RATSNEST_MODE
{
    ALL,        
    VISIBLE     
};

struct LAYER_PRESET
{
    wxString     name;          
    LSET         layers;        
    GAL_SET      renderLayers;  
    PCB_LAYER_ID activeLayer;   
    bool         readOnly;      

    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