JUCE: GlyphArrangement Class Reference

JUCE

Public Member Functions | List of all members
GlyphArrangement Class Referencefinal

A set of glyphs, each with a position. More...

## Public Member Functions
| GlyphArrangement ()
| Creates an empty arrangement. More...
| GlyphArrangement (const GlyphArrangement &)=default
GlyphArrangement & | operator= (const GlyphArrangement &)=default
| GlyphArrangement (GlyphArrangement &&)=default
GlyphArrangement & | operator= (GlyphArrangement &&)=default
| ~GlyphArrangement ()=default
| Destructor. More...
int | getNumGlyphs () const noexcept
| Returns the total number of glyphs in the arrangement. More...
PositionedGlyph & | getGlyph (int index) noexcept
| Returns one of the glyphs from the arrangement. More...
const PositionedGlyph * | begin () const
const PositionedGlyph * | end () const
void | clear ()
| Clears all text from the arrangement and resets it. More...
void | addLineOfText (const Font &font, const String &text, float x, float y)
| Appends a line of text to the arrangement. More...
void | addCurtailedLineOfText (const Font &font, const String &text, float x, float y, float maxWidthPixels, bool useEllipsis)
| Adds a line of text, truncating it if it's wider than a specified size. More...
void | addJustifiedText (const Font &font, const String &text, float x, float y, float maxLineWidth, Justification horizontalLayout, float leading=0.0f)
| Adds some multi-line text, breaking lines at word-boundaries if they are too wide. More...
void | addFittedText (const Font &font, const String &text, float x, float y, float width, float height, Justification layout, int maximumLinesToUse, float minimumHorizontalScale=0.0f)
| Tries to fit some text within a given space. More...
void | addGlyphArrangement (const GlyphArrangement &)
| Appends another glyph arrangement to this one. More...
void | addGlyph (const PositionedGlyph &)
| Appends a custom glyph to the arrangement. More...
void | draw (const Graphics &) const
| Draws this glyph arrangement to a graphics context. More...
void | draw (const Graphics &, AffineTransform) const
| Draws this glyph arrangement to a graphics context. More...
void | createPath (Path &path) const
| Converts the set of glyphs into a path. More...
int | findGlyphIndexAt (float x, float y) const
| Looks for a glyph that contains the given coordinate. More...
Rectangle< float > | getBoundingBox (int startIndex, int numGlyphs, bool includeWhitespace) const
| Finds the smallest rectangle that will enclose a subset of the glyphs. More...
void | moveRangeOfGlyphs (int startIndex, int numGlyphs, float deltaX, float deltaY)
| Shifts a set of glyphs by a given amount. More...
void | removeRangeOfGlyphs (int startIndex, int numGlyphs)
| Removes a set of glyphs from the arrangement. More...
void | stretchRangeOfGlyphs (int startIndex, int numGlyphs, float horizontalScaleFactor)
| Expands or compresses a set of glyphs horizontally. More...
void | justifyGlyphs (int startIndex, int numGlyphs, float x, float y, float width, float height, Justification justification)
| Justifies a set of glyphs within a given space. More...

## Detailed Description

A set of glyphs, each with a position.

You can create a GlyphArrangement, text to it and then draw it onto a graphics context. It's used internally by the text methods in the Graphics class, but can be used directly if more control is needed.

See also
  Font, PositionedGlyph

## Constructor & Destructor Documentation

## ◆ GlyphArrangement() [1/3]

GlyphArrangement::GlyphArrangement | ( |  | ) |

Creates an empty arrangement.

## ◆ GlyphArrangement() [2/3]

GlyphArrangement::GlyphArrangement | ( | const GlyphArrangement & |  | ) |
| default

## ◆ GlyphArrangement() [3/3]

GlyphArrangement::GlyphArrangement | ( | GlyphArrangement && |  | ) |
| default

## ◆ ~GlyphArrangement()

GlyphArrangement::~GlyphArrangement | ( |  | ) |
| default

Destructor.

## Member Function Documentation

## ◆ operator=() [1/2]

GlyphArrangement& GlyphArrangement::operator= | ( | const GlyphArrangement & |  | ) |
| default

## ◆ operator=() [2/2]

GlyphArrangement& GlyphArrangement::operator= | ( | GlyphArrangement && |  | ) |
| default

## ◆ getNumGlyphs()

int GlyphArrangement::getNumGlyphs | ( |  | ) | const
| noexcept

Returns the total number of glyphs in the arrangement.

## ◆ getGlyph()

PositionedGlyph& GlyphArrangement::getGlyph | ( | int | index | ) |
| noexcept

Returns one of the glyphs from the arrangement.

Parameters

  index | the glyph's index, from 0 to (getNumGlyphs() - 1). Be careful not to pass an out-of-range index here, as it doesn't do any bounds-checking.

## ◆ begin()

const PositionedGlyph* GlyphArrangement::begin | ( |  | ) | const

## ◆ end()

const PositionedGlyph* GlyphArrangement::end | ( |  | ) | const

## ◆ clear()

void GlyphArrangement::clear | ( |  | ) |

Clears all text from the arrangement and resets it.

## ◆ addLineOfText()

void GlyphArrangement::addLineOfText | ( | const Font & | font,
|  | const String & | text,
|  | float | x,
|  | float | y
| ) |  |

Appends a line of text to the arrangement.

This will add the text as a single line, where x is the left-hand edge of the first character, and y is the position for the text's baseline.

If the text contains new-lines or carriage-returns, this will ignore them - use addJustifiedText() to add multi-line arrangements.

## ◆ addCurtailedLineOfText()

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

Adds a line of text, truncating it if it's wider than a specified size.

This is the same as addLineOfText(), but if the line's width exceeds the value specified in maxWidthPixels, it will be truncated using either ellipsis (i.e. dots: "..."), if useEllipsis is true, or if this is false, it will just drop any subsequent characters.

## ◆ addJustifiedText()

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

Adds some multi-line text, breaking lines at word-boundaries if they are too wide.

This will add text to the arrangement, breaking it into new lines either where there is a new-line or carriage-return character in the text, or where a line's width exceeds the value set in maxLineWidth.

Each line that is added will be laid out using the flags set in horizontalLayout, so the lines can be left- or right-justified, or centred horizontally in the space between x and (x + maxLineWidth).

The y coordinate is the position of the baseline of the first line of text - subsequent lines will be placed below it, separated by a distance of font.getHeight() + leading.

## ◆ addFittedText()

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

Tries to fit some text within a given space.

This does its best to make the given text readable within the specified rectangle, so it's useful for labelling things.

If the text is too big, it'll be squashed horizontally or broken over multiple lines if the maximumLinesToUse value allows this. If the text just won't fit into the space, it'll cram as much as possible in there, and put some ellipsis at the end to show that it's been truncated.

A Justification parameter lets you specify how the text is laid out within the rectangle, both horizontally and vertically.

The minimumHorizontalScale parameter specifies how much the text can be squashed horizontally to try to squeeze it into the space. If you don't want any horizontal scaling to occur, you can set this value to 1.0f. Pass 0 if you want it to use the default value.

See also
  Graphics::drawFittedText

## ◆ addGlyphArrangement()

void GlyphArrangement::addGlyphArrangement | ( | const GlyphArrangement & |  | ) |

Appends another glyph arrangement to this one.

## ◆ addGlyph()

void GlyphArrangement::addGlyph | ( | const PositionedGlyph & |  | ) |

Appends a custom glyph to the arrangement.

## ◆ draw() [1/2]

void GlyphArrangement::draw | ( | const Graphics & |  | ) | const

Draws this glyph arrangement to a graphics context.

This uses cached bitmaps so is much faster than the draw (Graphics&, AffineTransform) method, which renders the glyphs as filled vectors.

## ◆ draw() [2/2]

void GlyphArrangement::draw | ( | const Graphics & | ,
|  | AffineTransform |
| ) |  | const

Draws this glyph arrangement to a graphics context.

This renders the paths as filled vectors, so is far slower than the draw (Graphics&) method for non-transformed arrangements.

## ◆ createPath()

void GlyphArrangement::createPath | ( | Path & | path | ) | const

Converts the set of glyphs into a path.

Parameters

  path | the glyphs' outlines will be appended to this path

## ◆ findGlyphIndexAt()

int GlyphArrangement::findGlyphIndexAt | ( | float | x,
|  | float | y
| ) |  | const

Looks for a glyph that contains the given coordinate.

Returns
  the index of the glyph, or -1 if none were found.

## ◆ getBoundingBox()

Rectangle<float> GlyphArrangement::getBoundingBox | ( | int | startIndex,
|  | int | numGlyphs,
|  | bool | includeWhitespace
| ) |  | const

Finds the smallest rectangle that will enclose a subset of the glyphs.

Parameters

  startIndex | the first glyph to test
  numGlyphs | the number of glyphs to include; if this is < 0, all glyphs after startIndex will be included
  includeWhitespace | if true, the extent of any whitespace characters will also be taken into account

## ◆ moveRangeOfGlyphs()

void GlyphArrangement::moveRangeOfGlyphs | ( | int | startIndex,
|  | int | numGlyphs,
|  | float | deltaX,
|  | float | deltaY
| ) |  |

Shifts a set of glyphs by a given amount.

Parameters

  startIndex | the first glyph to transform
  numGlyphs | the number of glyphs to move; if this is < 0, all glyphs after startIndex will be used
  deltaX | the amount to add to their x-positions
  deltaY | the amount to add to their y-positions

## ◆ removeRangeOfGlyphs()

void GlyphArrangement::removeRangeOfGlyphs | ( | int | startIndex,
|  | int | numGlyphs
| ) |  |

Removes a set of glyphs from the arrangement.

Parameters

  startIndex | the first glyph to remove
  numGlyphs | the number of glyphs to remove; if this is < 0, all glyphs after startIndex will be deleted

## ◆ stretchRangeOfGlyphs()

void GlyphArrangement::stretchRangeOfGlyphs | ( | int | startIndex,
|  | int | numGlyphs,
|  | float | horizontalScaleFactor
| ) |  |

Expands or compresses a set of glyphs horizontally.

Parameters

  startIndex | the first glyph to transform
  numGlyphs | the number of glyphs to stretch; if this is < 0, all glyphs after startIndex will be used
  horizontalScaleFactor | how much to scale their horizontal width by

## ◆ justifyGlyphs()

void GlyphArrangement::justifyGlyphs | ( | int | startIndex,
|  | int | numGlyphs,
|  | float | x,
|  | float | y,
|  | float | width,
|  | float | height,
|  | Justification | justification
| ) |  |

Justifies a set of glyphs within a given space.

This moves the glyphs as a block so that the whole thing is located within the given rectangle with the specified layout.

If the Justification::horizontallyJustified flag is specified, each line will be stretched out to fill the specified width.

The documentation for this class was generated from the following file:

- juce_GlyphArrangement.h