Merge pull request #4 from FOSSEE/develop

merging dev into master

1 files changed, 226 insertions, 0 deletions

diff --git a/include/gal/stroke_font.h b/include/gal/stroke_font.h
new file mode 100644
index 0000000..2cea7fd
--- /dev/null
+++ b/include/gal/stroke_font.h
@@ -0,0 +1,226 @@
+/*
+ * 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) 2012 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2013 CERN
+ * @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 <utf8.h>
+
+#include <eda_text.h>
+
+#include <math/box2.h>
+
+namespace KIGFX
+{
+class GAL;
+
+typedef std::deque< std::deque<VECTOR2D> > GLYPH;
+typedef std::vector<GLYPH>                 GLYPH_LIST;
+
+/**
+ * @brief Class STROKE_FONT implements stroke font drawing.
+ *
+ * A stroke font is composed of lines.
+ */
+class STROKE_FONT
+{
+public:
+    /// Constructor
+    STROKE_FONT( GAL* aGal );
+
+    /**
+     * @brief Load the new stroke font.
+     *
+     * @param aNewStrokeFont is the pointer to the font data.
+     * @param aNewStrokeFontSize is the size of the font data.
+     * @return True, if the font was successfully loaded, else false.
+     */
+    bool LoadNewStrokeFont( const char* const aNewStrokeFont[], int aNewStrokeFontSize );
+
+    /**
+     * @brief Draw a string.
+     *
+     * @param aText is the text to be drawn.
+     * @param aPosition is the text position in world coordinates.
+     * @param aRotationAngle is the text rotation angle.
+     */
+    void Draw( const UTF8& aText, const VECTOR2D& aPosition, double aRotationAngle );
+
+    /**
+     * @brief Set the glyph size.
+     *
+     * @param aGlyphSize is the glyph size.
+     */
+    inline void SetGlyphSize( const VECTOR2D aGlyphSize )
+    {
+        m_glyphSize = aGlyphSize;
+    }
+
+    /**
+     * @brief Set a bold property of current font.
+     *
+     * @param aBold tells if the font should be bold or not.
+     */
+    inline void SetBold( const bool aBold )
+    {
+        m_bold = aBold;
+    }
+
+    /**
+     * @brief Set an italic property of current font.
+     *
+     * @param aItalic tells if the font should be italic or not.
+     */
+    inline void SetItalic( const bool aItalic )
+    {
+        m_italic = aItalic;
+    }
+
+    /**
+     * @brief Set a mirrored property of text.
+     *
+     * @param aMirrored tells if the text should be mirrored or not.
+     */
+    inline void SetMirrored( const bool aMirrored )
+    {
+        m_mirrored = aMirrored;
+    }
+
+    /**
+     * @brief Set the horizontal justify for text drawing.
+     *
+     * @param aHorizontalJustify is the horizontal justify value.
+     */
+    inline void SetHorizontalJustify( const EDA_TEXT_HJUSTIFY_T aHorizontalJustify )
+    {
+        m_horizontalJustify = aHorizontalJustify;
+    }
+
+    /**
+     * @brief Set the vertical justify for text drawing.
+     *
+     * @param aVerticalJustify is the vertical justify value.
+     */
+    inline void SetVerticalJustify( const EDA_TEXT_VJUSTIFY_T aVerticalJustify )
+    {
+        m_verticalJustify = aVerticalJustify;
+    }
+
+    /**
+     * Function SetGAL
+     * Changes Graphics Abstraction Layer used for drawing items for a new one.
+     * @param aGal is the new GAL instance.
+     */
+    void SetGAL( GAL* aGal )
+    {
+        m_gal = aGal;
+    }
+
+private:
+    GAL*                m_gal;                                    ///< Pointer to the GAL
+    GLYPH_LIST          m_glyphs;                                 ///< Glyph list
+    std::vector<BOX2D>  m_glyphBoundingBoxes;                     ///< Bounding boxes of the glyphs
+    VECTOR2D            m_glyphSize;                              ///< Size of the glyphs
+    EDA_TEXT_HJUSTIFY_T m_horizontalJustify;                      ///< Horizontal justification
+    EDA_TEXT_VJUSTIFY_T m_verticalJustify;                        ///< Vertical justification
+    bool                m_bold, m_italic, m_mirrored, m_overbar;  ///< Properties of text
+
+    /**
+     * @brief Returns a single line height using current settings.
+     *
+     * @return The line height.
+     */
+    int getInterline() const;
+
+    /**
+     * @brief Compute the bounding box of a given glyph.
+     *
+     * @param aGlyph is the glyph.
+     * @param aGlyphBoundingX is the x-component of the bounding box size.
+     * @return is the complete bounding box size.
+     */
+    BOX2D computeBoundingBox( const GLYPH& aGlyph, const VECTOR2D& aGlyphBoundingX ) const;
+
+    /**
+     * @brief Draws a single line of text. Multiline texts should be split before using the
+     * function.
+     *
+     * @param aText is the text to be drawn.
+     */
+    void drawSingleLineText( const UTF8& aText );
+
+    /**
+     * @brief Compute the size of a given text.
+     *
+     * @param aText is the text string.
+     * @return is the text size.
+     */
+    VECTOR2D computeTextSize( const UTF8& aText ) const;
+
+    /**
+     * @brief Returns number of lines for a given text.
+     *
+     * @param aText is the text to be checked.
+     * @return unsigned - The number of lines in 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;
+    }
+
+public:
+    // These members are declared public only to be (temporary, I am expecting)
+    // used in legacy canvas, to avoid multiple declarations of the same constants,
+    // having multiple declarations of the same constants is really a thing to avoid.
+    //
+    // They will be private later, when the legacy canvas is removed.
+
+    ///> Factor that determines the pitch between 2 lines.
+    static const double INTERLINE_PITCH_RATIO;
+
+    ///> Factor that determines relative height of overbar.
+    static const double OVERBAR_HEIGHT;
+
+    ///> Factor that determines relative line width for bold text.
+    static const double BOLD_FACTOR;
+
+    ///> Scale factor for a glyph
+    static const double STROKE_FONT_SCALE;
+
+    ///> Tilt factor for italic style (the is is the scaling factor
+    ///> on dY relative coordinates to give a tilst shape
+    static const double ITALIC_TILT;
+};
+} // namespace KIGFX
+
+#endif // STROKE_FONT_H_