stroke_params.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright (C) 2021 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 STROKE_PARAMS_H
#define STROKE_PARAMS_H
 
#include <map>
#include <bitmaps.h>
#include <units_provider.h>
#include <gal/color4d.h>
#include <wx/translation.h>
#include <geometry/shape.h>
#include <stroke_params_lexer.h>
 
class STROKE_PARAMS_LEXER;
class MSG_PANEL_ITEM;
 
namespace KIGFX
{
class RENDER_SETTINGS;
}
 
 
enum class LINE_STYLE
{
 DEFAULT = -1,
 SOLID = 0,
 FIRST_TYPE = SOLID,
 DASH,
 DOT,
 DASHDOT,
 DASHDOTDOT,
 LAST_TYPE = DASHDOTDOT
};
 
 
struct LINE_STYLE_DESC
{
 wxString name;
 const BITMAPS bitmap;
};
 
 
/*
 * Conversion map between LINE_STYLE values and style names displayed
 */
extern const std::map<LINE_STYLE, struct LINE_STYLE_DESC> lineTypeNames;
 
 
#define DEFAULT_STYLE _( "Default" )
#define INDETERMINATE_STYLE _( "Leave unchanged" )
 
 
class STROKE_PARAMS
{
public:
 STROKE_PARAMS( int aWidth = 0, LINE_STYLE aLineStyle = LINE_STYLE::DEFAULT,
 const KIGFX::COLOR4D& aColor = KIGFX::COLOR4D::UNSPECIFIED ) :
 m_width( aWidth ),
 m_lineStyle( aLineStyle ),
 m_color( aColor )
 {
 }
 
 int GetWidth() const { return m_width; }
 void SetWidth( int aWidth ) { m_width = aWidth; }
 
 LINE_STYLE GetLineStyle() const { return m_lineStyle; }
 void SetLineStyle( LINE_STYLE aLineStyle ) { m_lineStyle = aLineStyle; }
 
 KIGFX::COLOR4D GetColor() const { return m_color; }
 void SetColor( const KIGFX::COLOR4D& aColor ) { m_color = aColor; }
 
 bool operator!=( const STROKE_PARAMS& aOther ) const
 {
 return m_width != aOther.m_width
 || m_lineStyle != aOther.m_lineStyle
 || m_color != aOther.m_color;
 }
 
 void Format( OUTPUTFORMATTER* out, const EDA_IU_SCALE& aIuScale, int nestLevel ) const;
 
 void GetMsgPanelInfo( UNITS_PROVIDER* aUnitsProvider, std::vector<MSG_PANEL_ITEM>& aList,
 bool aIncludeStyle = true, bool aIncludeWidth = true );
 
 // Helper functions
 
 static wxString GetLineStyleToken( LINE_STYLE aStyle );
 
 static void Stroke( const SHAPE* aShape, LINE_STYLE aLineStyle, int aWidth,
 const KIGFX::RENDER_SETTINGS* aRenderSettings,
 const std::function<void( const VECTOR2I& a, const VECTOR2I& b )>& aStroker );
 
private:
 int m_width;
 LINE_STYLE m_lineStyle;
 KIGFX::COLOR4D m_color;
};
 
 
class STROKE_PARAMS_PARSER : public STROKE_PARAMS_LEXER
{
public:
 STROKE_PARAMS_PARSER( LINE_READER* aReader, int iuPerMM ) :
 STROKE_PARAMS_LEXER( aReader ),
 m_iuPerMM( iuPerMM )
 {
 }
 
 void ParseStroke( STROKE_PARAMS& aStroke );
 
private:
 int parseInt( const char* aText );
 double parseDouble( const char* aText );
 
private:
 int m_iuPerMM;
};
 
 
#endif // STROKE_PARAMS_H