7
mirror of https://gitlab.com/kicad/code/kicad.git synced 2024-11-21 22:35:00 +00:00
kicad/include/widgets/layer_presentation.h
2024-08-13 08:36:10 +01:00

76 lines
2.7 KiB
C++

/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2024 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 2
* 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, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef LAYER_PRESENTATION_H
#define LAYER_PRESENTATION_H
#include <gal/color4d.h>
#include <layer_ids.h>
class wxBitmap;
using KIGFX::COLOR4D;
/**
* Base class for an object that can provide information about
* presenting layers (colours, etc).
*/
class LAYER_PRESENTATION
{
public:
virtual ~LAYER_PRESENTATION() {}
// Return a color index from the layer id
virtual COLOR4D getLayerColor( int aLayer ) const = 0;
// Return the name of the layer id
virtual wxString getLayerName( int aLayer ) const = 0;
// Fill the layer bitmap aLayerbmp with the layer color
static void DrawColorSwatch( wxBitmap& aLayerbmp, const COLOR4D& aBackground,
const COLOR4D& aColor );
/**
* Fill the layer bitmap aLayerbmp with the layer color
* for the layer ID.
*/
void DrawColorSwatch( wxBitmap& aLayerbmp, int aLayer ) const;
/**
* Create a layer pair "side-by-side swatch" icon
*/
static std::unique_ptr<wxBitmap> CreateLayerPairIcon( const KIGFX::COLOR4D& aBgColor,
const KIGFX::COLOR4D& aTopColor,
const KIGFX::COLOR4D& aBottomColor,
int aScale );
/**
* Create a layer pair "side-by-side swatch" icon for the given
* layer pair with the style of this presentation.
*/
std::unique_ptr<wxBitmap> CreateLayerPairIcon( int aLeftLayer, int aRightLayer,
int aScale ) const;
};
#endif // LAYER_PRESENTATION_H