juce::PositionedGlyph Class Reference

A glyph from a particular font, with a particular size, style, typeface and position. More...

#include <juce_GlyphArrangement.h>

Collaboration diagram for juce::PositionedGlyph:

Public Member Functions
	PositionedGlyph () noexcept
	PositionedGlyph (const Font &font, juce_wchar character, int glyphNumber, float anchorX, float baselineY, float width, bool isWhitespace)
void	createPath (Path &path) const
	Returns the path for this glyph.
void	draw (Graphics &g) const
	Draws the glyph into a graphics context.
void	draw (Graphics &g, AffineTransform transform) const
	Draws the glyph into a graphics context, with an extra transform applied to it.
float	getBaselineY () const noexcept
	Returns the y position of the glyph's baseline.
float	getBottom () const
	Returns the y position of the bottom of the glyph.
Rectangle< float >	getBounds () const
	Returns the bounds of the glyph.
juce_wchar	getCharacter () const noexcept
	Returns the character the glyph represents.
int	getGlyphIndex () const
	Returns the typeface glyph index for the glyph.
float	getLeft () const noexcept
	Returns the position of the glyph's left-hand edge.
float	getRight () const noexcept
	Returns the position of the glyph's right-hand edge.
float	getTop () const
	Returns the y position of the top of the glyph.
bool	hitTest (float x, float y) const
	Checks to see if a point lies within this glyph.
bool	isWhitespace () const noexcept
	Checks whether the glyph is actually empty.
void	moveBy (float deltaX, float deltaY)
	Shifts the glyph's position by a relative amount.

Private Attributes
juce_wchar	character
Font	font { FontOptions{} }
int	glyph
float	w
bool	whitespace
float	x
float	y

Friends
class	GlyphArrangement

Detailed Description

A glyph from a particular font, with a particular size, style, typeface and position.

You should rarely need to use this class directly - for most purposes, the GlyphArrangement class will do what you need for text layout.

See also

GlyphArrangement, Font

@tags{Graphics}

Constructor & Destructor Documentation

PositionedGlyph() [1/2]

juce::PositionedGlyph::PositionedGlyph ( )

noexcept

PositionedGlyph() [2/2]

juce::PositionedGlyph::PositionedGlyph	(	const Font &	font,
		juce_wchar	character,
		int	glyphNumber,
		float	anchorX,
		float	baselineY,
		float	width,
		bool	isWhitespace
	)

Member Function Documentation

createPath()

void juce::PositionedGlyph::createPath

(

Path &

path

)

const

Returns the path for this glyph.

Parameters

path	the glyph's outline will be appended to this path

draw() [1/2]

void juce::PositionedGlyph::draw

(

Graphics &

g

)

const

Draws the glyph into a graphics context.

(Note that this may change the context's currently selected font).

draw() [2/2]

void juce::PositionedGlyph::draw	(	Graphics &	g,
		AffineTransform	transform
	)		const

Draws the glyph into a graphics context, with an extra transform applied to it.

(Note that this may change the context's currently selected font).

getBaselineY()

float juce::PositionedGlyph::getBaselineY ( ) const

inlinenoexcept

Returns the y position of the glyph's baseline.

getBottom()

float juce::PositionedGlyph::getBottom ( ) const

inline

Returns the y position of the bottom of the glyph.

getBounds()

Rectangle< float > juce::PositionedGlyph::getBounds ( ) const

inline

Returns the bounds of the glyph.

getCharacter()

juce_wchar juce::PositionedGlyph::getCharacter ( ) const

inlinenoexcept

Returns the character the glyph represents.

getGlyphIndex()

int juce::PositionedGlyph::getGlyphIndex ( ) const

inline

Returns the typeface glyph index for the glyph.

getLeft()

float juce::PositionedGlyph::getLeft ( ) const

inlinenoexcept

Returns the position of the glyph's left-hand edge.

getRight()

float juce::PositionedGlyph::getRight ( ) const

inlinenoexcept

Returns the position of the glyph's right-hand edge.

getTop()

float juce::PositionedGlyph::getTop ( ) const

inline

Returns the y position of the top of the glyph.

hitTest()

bool juce::PositionedGlyph::hitTest	(	float	x,
		float	y
	)		const

Checks to see if a point lies within this glyph.

isWhitespace()

bool juce::PositionedGlyph::isWhitespace ( ) const

inlinenoexcept

Checks whether the glyph is actually empty.

moveBy()

void juce::PositionedGlyph::moveBy	(	float	deltaX,
		float	deltaY
	)

Shifts the glyph's position by a relative amount.

Friends And Related Symbol Documentation

GlyphArrangement

friend class GlyphArrangement

friend

Member Data Documentation

character

juce_wchar juce::PositionedGlyph::character

private

font

Font juce::PositionedGlyph::font { FontOptions{} }

private

glyph

int juce::PositionedGlyph::glyph

private

w

float juce::PositionedGlyph::w

private

whitespace

bool juce::PositionedGlyph::whitespace

private

x

float juce::PositionedGlyph::x

private

y

float juce::PositionedGlyph::y

private

---

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

• juce_GlyphArrangement.h