stroke_font.h

Go to the documentation of this file.

/*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
 * Copyright (C) 2012 Torsten Hueter, torstenhtr <at> gmx.de
 * Copyright (C) 2013 CERN
 * Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
 *
 * @author Maciej Suminski <maciej.suminski@cern.ch>
 *
 * Stroke font class
 *
 * 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_FONT_H_
#define STROKE_FONT_H_

#include <deque>
#include <algorithm>

#include <utf8.h>

#include <eda_text.h>

#include <math/box2.h>

namespace KIGFX
{
class GAL;

typedef std::vector<std::vector<VECTOR2D>*> GLYPH;
typedef std::vector<GLYPH*>                 GLYPH_LIST;

class STROKE_FONT
{
    friend class GAL;

public:
    STROKE_FONT( GAL* aGal );

    bool LoadNewStrokeFont( const char* const aNewStrokeFont[], int aNewStrokeFontSize );

    void Draw( const UTF8& aText, const VECTOR2D& aPosition, double aRotationAngle );

    void SetGAL( GAL* aGal )
    {
        m_gal = aGal;
    }

    VECTOR2D ComputeStringBoundaryLimits( const UTF8& aText, const VECTOR2D& aGlyphSize,
                                          double aGlyphThickness ) const;

    double ComputeOverbarVerticalPosition( double aGlyphHeight ) const;

    static double GetInterline( double aGlyphHeight );

private:
    VECTOR2D computeTextLineSize( const UTF8& aText ) const;

    double computeOverbarVerticalPosition() const;
    double computeUnderlineVerticalPosition() const;

    BOX2D computeBoundingBox( const GLYPH* aGlyph, double aGlyphWidth ) const;

    void drawSingleLineText( const UTF8& aText );

    inline unsigned linesCount( const UTF8& aText ) const
    {
        if( aText.empty() )
            return 0;   // std::count does not work well with empty strings
        else
            // aText.end() - 1 is to skip a newline character that is potentially at the end
            return std::count( aText.begin(), aText.end() - 1, '\n' ) + 1;
    }

    GAL*                      m_gal;                  
    const GLYPH_LIST*         m_glyphs;               
    const std::vector<BOX2D>* m_glyphBoundingBoxes;   

    static const double OVERBAR_POSITION_FACTOR;
    static const double UNDERLINE_POSITION_FACTOR;

    static const double BOLD_FACTOR;

    static const double STROKE_FONT_SCALE;

    static const double ITALIC_TILT;

    static const double INTERLINE_PITCH_RATIO;
};
} // namespace KIGFX

#endif // STROKE_FONT_H_