juce_GlyphArrangement.h

Go to the documentation of this file.

/*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   By using JUCE, you agree to the terms of both the JUCE 7 End-User License
   Agreement and JUCE Privacy Policy.
 
   End User License Agreement: www.juce.com/juce-7-licence
   Privacy Policy: www.juce.com/juce-privacy-policy
 
   Or: You may also use this code under the terms of the GPL v3 (see
   www.gnu.org/licenses).
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
class JUCE_API  PositionedGlyph  final
{
public:
    //==============================================================================
    PositionedGlyph() noexcept;
 
    PositionedGlyph (const Font& font, juce_wchar character, int glyphNumber,
                     float anchorX, float baselineY, float width, bool isWhitespace);

    juce_wchar getCharacter() const noexcept    { return character; }
    bool isWhitespace() const noexcept          { return whitespace; }

    float getLeft() const noexcept              { return x; }
    float getRight() const noexcept             { return x + w; }
    float getBaselineY() const noexcept         { return y; }
    float getTop() const                        { return y - font.getAscent(); }
    float getBottom() const                     { return y + font.getDescent(); }
    Rectangle<float> getBounds() const          { return { x, getTop(), w, font.getHeight() }; }
 
    //==============================================================================
    void moveBy (float deltaX, float deltaY);
 
    //==============================================================================
    void draw (Graphics& g) const;

    void draw (Graphics& g, AffineTransform transform) const;

    void createPath (Path& path) const;

    bool hitTest (float x, float y) const;
 
private:
    //==============================================================================
    friend class GlyphArrangement;
    Font font;
    juce_wchar character;
    int glyph;
    float x, y, w;
    bool whitespace;
 
    JUCE_LEAK_DETECTOR (PositionedGlyph)
};
 
 
//==============================================================================
class JUCE_API  GlyphArrangement  final
{
public:
    //==============================================================================
    GlyphArrangement();
 
    GlyphArrangement (const GlyphArrangement&) = default;
    GlyphArrangement& operator= (const GlyphArrangement&) = default;
    GlyphArrangement (GlyphArrangement&&) = default;
    GlyphArrangement& operator= (GlyphArrangement&&) = default;

    ~GlyphArrangement() = default;
 
    //==============================================================================
    int getNumGlyphs() const noexcept                           { return glyphs.size(); }

    PositionedGlyph& getGlyph (int index) noexcept;
 
    const PositionedGlyph* begin() const                        { return glyphs.begin(); }
    const PositionedGlyph* end() const                          { return glyphs.end(); }
 
    //==============================================================================
    void clear();

    void addLineOfText (const Font& font,
                        const String& text,
                        float x, float y);

    void addCurtailedLineOfText (const Font& font,
                                 const String& text,
                                 float x, float y,
                                 float maxWidthPixels,
                                 bool useEllipsis);

    void addJustifiedText (const Font& font,
                           const String& text,
                           float x, float y,
                           float maxLineWidth,
                           Justification horizontalLayout,
                           float leading = 0.0f);

    void addFittedText (const Font& font,
                        const String& text,
                        float x, float y, float width, float height,
                        Justification layout,
                        int maximumLinesToUse,
                        float minimumHorizontalScale = 0.0f);

    void addGlyphArrangement (const GlyphArrangement&);

    void addGlyph (const PositionedGlyph&);
 
    //==============================================================================
    void draw (const Graphics&) const;

    void draw (const Graphics&, AffineTransform) const;

    void createPath (Path& path) const;

    int findGlyphIndexAt (float x, float y) const;
 
    //==============================================================================
    Rectangle<float> getBoundingBox (int startIndex, int numGlyphs, bool includeWhitespace) const;

    void moveRangeOfGlyphs (int startIndex, int numGlyphs,
                            float deltaX, float deltaY);

    void removeRangeOfGlyphs (int startIndex, int numGlyphs);

    void stretchRangeOfGlyphs (int startIndex, int numGlyphs,
                               float horizontalScaleFactor);

    void justifyGlyphs (int startIndex, int numGlyphs,
                        float x, float y, float width, float height,
                        Justification justification);
 
 
private:
    //==============================================================================
    Array<PositionedGlyph> glyphs;
 
    int insertEllipsis (const Font&, float maxXPos, int startIndex, int endIndex);
    int fitLineIntoSpace (int start, int numGlyphs, float x, float y, float w, float h, const Font&,
                          Justification, float minimumHorizontalScale);
    void spreadOutLine (int start, int numGlyphs, float targetWidth);
    void splitLines (const String&, Font, int start, float x, float y, float w, float h, int maxLines,
                     float lineWidth, Justification, float minimumHorizontalScale);
    void addLinesWithLineBreaks (const String&, const Font&, float x, float y, float width, float height, Justification);
    void drawGlyphUnderline (const Graphics&, const PositionedGlyph&, int, AffineTransform) const;
 
    JUCE_LEAK_DETECTOR (GlyphArrangement)
};
 
} // namespace juce