2017-03-09 09:09:13 +00:00
|
|
|
/*
|
|
|
|
* This program source code file is part of KICAD, a free EDA CAD application.
|
|
|
|
*
|
2021-07-26 17:28:37 +00:00
|
|
|
* Copyright (C) 2017-2021 Kicad Developers, see AUTHORS.txt for contributors.
|
2017-03-09 09:09:13 +00:00
|
|
|
*
|
|
|
|
* 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 PREVIEW_PREVIEW_UTILS__H_
|
|
|
|
#define PREVIEW_PREVIEW_UTILS__H_
|
|
|
|
|
2020-10-24 14:45:37 +00:00
|
|
|
#include <eda_units.h>
|
2017-03-09 09:09:13 +00:00
|
|
|
#include <gal/color4d.h>
|
|
|
|
#include <math/vector2d.h>
|
|
|
|
|
|
|
|
namespace KIGFX
|
|
|
|
{
|
|
|
|
class GAL;
|
2017-08-04 12:43:02 +00:00
|
|
|
class VIEW;
|
2017-03-09 09:09:13 +00:00
|
|
|
|
|
|
|
namespace PREVIEW
|
|
|
|
{
|
|
|
|
|
2020-10-01 10:48:50 +00:00
|
|
|
struct TEXT_DIMS
|
|
|
|
{
|
|
|
|
double StrokeWidth;
|
|
|
|
double ShadowWidth;
|
|
|
|
double LinePitch;
|
|
|
|
};
|
|
|
|
|
2017-03-09 09:09:13 +00:00
|
|
|
/**
|
2021-07-26 17:28:37 +00:00
|
|
|
* Default alpha of "de-emphasised" features (like previously locked-in lines.
|
2017-03-09 09:09:13 +00:00
|
|
|
*/
|
|
|
|
double PreviewOverlayDeemphAlpha( bool aDeemph = true );
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
2021-07-26 17:28:37 +00:00
|
|
|
* Get a formatted string showing a dimension to a sane precision with an optional prefix and
|
|
|
|
* unit suffix.
|
2017-03-09 09:09:13 +00:00
|
|
|
*/
|
2020-10-01 10:48:50 +00:00
|
|
|
wxString DimensionLabel( const wxString& prefix, double aVal, EDA_UNITS aUnits,
|
|
|
|
bool aIncludeUnits = true );
|
2017-03-09 09:09:13 +00:00
|
|
|
|
|
|
|
/**
|
2021-07-26 17:28:37 +00:00
|
|
|
* Set the GAL glyph height to a constant scaled value, so that it always looks the same on screen.
|
2017-03-09 09:09:13 +00:00
|
|
|
*
|
2021-07-26 17:28:37 +00:00
|
|
|
* @param aGal the GAL to draw on.
|
2020-10-01 10:48:50 +00:00
|
|
|
* @param aRelativeSize similar to HTML font sizes; 0 will give a standard size while +1 etc.
|
|
|
|
* will give larger and -1 etc. will give smaller.
|
|
|
|
* @returns the text widths for the resulting glyph size.
|
2017-03-09 09:09:13 +00:00
|
|
|
*/
|
2020-10-01 10:48:50 +00:00
|
|
|
TEXT_DIMS SetConstantGlyphHeight( KIGFX::GAL* aGal, int aRelativeSize = 0 );
|
|
|
|
|
2021-07-26 17:28:37 +00:00
|
|
|
COLOR4D GetShadowColor( const COLOR4D& aColor );
|
2017-03-09 09:09:13 +00:00
|
|
|
|
|
|
|
/**
|
2021-07-26 17:28:37 +00:00
|
|
|
* Draw strings next to the cursor.
|
2017-03-09 09:09:13 +00:00
|
|
|
*
|
2021-07-26 17:28:37 +00:00
|
|
|
* @param aGal the GAL to draw on.
|
|
|
|
* @param aCursorPos the position of the cursor to draw next to.
|
|
|
|
* @param aTextQuadrant a vector pointing to the quadrant to draw the text in.
|
|
|
|
* @param aStrings list of strings to draw, top to bottom.
|
2017-03-09 09:09:13 +00:00
|
|
|
*/
|
2020-09-30 19:02:30 +00:00
|
|
|
void DrawTextNextToCursor( KIGFX::VIEW* aView, const VECTOR2D& aCursorPos,
|
|
|
|
const VECTOR2D& aTextQuadrant, const std::vector<wxString>& aStrings,
|
|
|
|
bool aDrawingDropShadows );
|
2017-03-09 09:09:13 +00:00
|
|
|
|
|
|
|
} // PREVIEW
|
|
|
|
} // KIGFX
|
|
|
|
|
|
|
|
#endif // PREVIEW_PREVIEW_UTILS__H_
|