Package com.jogamp.graph.font

Interface Font

public interface Font

Interface wrapper for font implementation.

TrueType Font Specification:

• http://www.freetype.org/freetype2/documentation.html
• https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6.html
• http://www.microsoft.com/typography/SpecificationsOverview.mspx
• http://www.microsoft.com/typography/otspec/

TrueType Font Table Introduction:

• http://scripts.sil.org/cms/scripts/page.php?item_id=IWS-Chapter08

Misc.:

• Treatis on Font Rasterization https://freddie.witherden.org/pages/font-rasterisation/
• Glyph Hell http://walon.org/pub/ttf/ttf_glyphs.htm

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Font.Glyph	Glyph for font http://developer.apple.com/textfonts/TTRefMan/RM06/Chap6cmap.html http://developer.apple.com/textfonts/TTRefMan/RM06/Chap6glyf.html http://www.microsoft.com/typography/otspec/glyf.htm
static interface	Font.GlyphVisitor	General purpose Font.Glyph visitor.
static interface	Font.GlyphVisitor2	Constrained Font.Glyph visitor w/o AffineTransform.
static interface	Font.Metrics	Metrics for font Depending on the font's direction, horizontal or vertical, the following tables shall be used: Vertical https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6vhea.html Horizontal https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6hhea.html

Field Summary

Fields

Modifier and Type	Field	Description
static int	NAME_COPYRIGHT	font name indices for name table
static int	NAME_DESIGNER
static int	NAME_FAMILY
static int	NAME_FULLNAME
static int	NAME_MANUFACTURER
static int	NAME_SUBFAMILY
static int	NAME_UNIQUNAME
static int	NAME_VERSION

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)	Returns true if other instance is of same type and NAME_UNIQUNAME is equal.
String	fullString()	Return all font details as string.
float	getAdvanceWidth(int glyphID)	Return advance-width of given glyphID in font em-size [0..1], sourced from `hmtx` table.
int	getAdvanceWidthFU(int glyphID)	Return advance-width of given glyphID in font-units, sourced from `hmtx` table.
StringBuilder	getAllNames(StringBuilder string, String separator)
String	getFullFamilyName()	Shall return the family and subfamily name, separated a dash.
Font.Glyph	getGlyph(int glyph_id)	Return the Font.Glyph using given ID, see getGlyphCount().
AABBox	getGlyphBounds(CharSequence string)	Try using getGlyphBounds(CharSequence, AffineTransform, AffineTransform) to reuse AffineTransform instances.
AABBox	getGlyphBounds(CharSequence string, AffineTransform tmp1, AffineTransform tmp2)	Returns accurate bounding box by taking each glyph's font em-sized bounding box into account.
AABBox	getGlyphBoundsFU(CharSequence string)	Try using getGlyphBoundsFU(CharSequence, AffineTransform, AffineTransform) to reuse AffineTransform instances.
AABBox	getGlyphBoundsFU(CharSequence string, AffineTransform tmp1, AffineTransform tmp2)	Returns accurate bounding box by taking each glyph's font-units sized bounding box into account.
int	getGlyphCount()	Return number of Font.Glyph IDs available, i.e.
int	getGlyphID(char symbol)	Return the Font.Glyph ID mapped to given `symbol`, usually UTF16 unicode.
AABBox	getGlyphShapeBounds(AffineTransform transform, CharSequence string)	Returns accurate bounding box by taking each glyph's font em-sized OutlineShape into account.
AABBox	getGlyphShapeBounds(AffineTransform transform, CharSequence string, AffineTransform tmp1, AffineTransform tmp2)	Returns accurate bounding box by taking each glyph's font em-sized OutlineShape into account.
float	getLineHeight()	Return line height, baseline-to-baseline in em-size [0..1], composed from `hhea' table entries.
int	getLineHeightFU()	Return line height, baseline-to-baseline in font-units, composed from `hhea' table entries.
AABBox	getMetricBounds(CharSequence string)	Returns metric-bounds in font em-size.
AABBox	getMetricBoundsFU(CharSequence string)	Returns metric-bounds in font-units.
Font.Metrics	getMetrics()
String	getName(int nameIndex)
int	getNumGlyphs()
int	hashCode()	Returns the hash code based on NAME_UNIQUNAME.
boolean	isPrintableChar(char c)
void	processString(Font.GlyphVisitor2 visitor, CharSequence string)	Visit each Font.Glyph and perhaps its OutlineShape of the string with the constrained Font.GlyphVisitor2.
AABBox	processString(Font.GlyphVisitor visitor, AffineTransform transform, CharSequence string)	Try using processString(GlyphVisitor, AffineTransform, CharSequence, AffineTransform, AffineTransform) to reuse AffineTransform instances.
AABBox	processString(Font.GlyphVisitor visitor, AffineTransform transform, CharSequence string, AffineTransform temp1, AffineTransform temp2)	Visit each Font.Glyph and perhaps its OutlineShape of the string with the Font.GlyphVisitor while passing the progressed AffineTransform.
String	toString()	Returns getFullFamilyName()

Field Detail

NAME_COPYRIGHT

static final int NAME_COPYRIGHT

font name indices for name table

See Also:

Constant Field Values

NAME_FAMILY

static final int NAME_FAMILY

See Also:

Constant Field Values

NAME_SUBFAMILY

static final int NAME_SUBFAMILY

See Also:

Constant Field Values

NAME_UNIQUNAME

static final int NAME_UNIQUNAME

See Also:

Constant Field Values

NAME_FULLNAME

static final int NAME_FULLNAME

See Also:

Constant Field Values

NAME_VERSION

static final int NAME_VERSION

See Also:

Constant Field Values

NAME_MANUFACTURER

static final int NAME_MANUFACTURER

See Also:

Constant Field Values

NAME_DESIGNER

static final int NAME_DESIGNER

See Also:

Constant Field Values

Method Detail

getName

String getName(int nameIndex)

getFullFamilyName

String getFullFamilyName()

Shall return the family and subfamily name, separated a dash.

#getName(StringBuilder, int) w/ NAME_FAMILY and NAME_SUBFAMILY

Example: "Ubuntu-Regular"

getAllNames

StringBuilder getAllNames(StringBuilder string,
                          String separator)

hashCode

int hashCode()

Returns the hash code based on NAME_UNIQUNAME.

Overrides:

hashCode in class Object

equals

boolean equals(Object o)

Returns true if other instance is of same type and NAME_UNIQUNAME is equal.

Overrides:

equals in class Object

getAdvanceWidthFU

int getAdvanceWidthFU(int glyphID)

Return advance-width of given glyphID in font-units, sourced from `hmtx` table.

Parameters:

glyphID -

getAdvanceWidth

float getAdvanceWidth(int glyphID)

Return advance-width of given glyphID in font em-size [0..1], sourced from `hmtx` table.

Parameters:

glyphID -

getMetrics

Font.Metrics getMetrics()

getGlyphID

int getGlyphID(char symbol)

Return the Font.Glyph ID mapped to given `symbol`, usually UTF16 unicode. Returned ID can be used to retrieve the Font.Glyph via getGlyph(int).

getGlyphCount

int getGlyphCount()

Return number of Font.Glyph IDs available, i.e. retrievable via getGlyph(int) [0..count).

getGlyph

Font.Glyph getGlyph(int glyph_id)

Return the Font.Glyph using given ID, see getGlyphCount().

getNumGlyphs

int getNumGlyphs()

getLineHeightFU

int getLineHeightFU()

Return line height, baseline-to-baseline in font-units, composed from `hhea' table entries.

   return ascent - descent + linegap;
 

or

   // lineGap positive value
   // descent negative value
   // ascent positive value
   return ascent - descent + linegap;
 

See Also:

Font.Metrics.getAscentFU(), Font.Metrics.getDescentFU(), Font.Metrics.getLineGapFU()

getLineHeight

float getLineHeight()

Return line height, baseline-to-baseline in em-size [0..1], composed from `hhea' table entries.

   return ascent - descent + linegap;
 

or

   // lineGap positive value
   // descent negative value
   // ascent positive value
   return ascent - descent + linegap;
 

See Also:

Font.Metrics.getAscent(), Font.Metrics.getDescent(), Font.Metrics.getLineGap()

getMetricBoundsFU

AABBox getMetricBoundsFU(CharSequence string)

Returns metric-bounds in font-units.

Metric bounds is based on the `hmtx` table's advance of each glyph and `hhea' composed line height.

For accurate layout consider using getGlyphBoundsFU(CharSequence).

See Also:

getMetricBounds(CharSequence), getGlyphBoundsFU(CharSequence)

getMetricBounds

AABBox getMetricBounds(CharSequence string)

Returns metric-bounds in font em-size.

Metric bounds is based on the `hmtx` table's advance of each glyph and `hhea' composed line height.

For accurate layout consider using getGlyphBounds(CharSequence).

See Also:

getMetricBoundsFU(CharSequence), getGlyphBounds(CharSequence), #getGlyphShapeBounds(CharSequence)

getGlyphBounds

AABBox getGlyphBounds(CharSequence string)

Try using getGlyphBounds(CharSequence, AffineTransform, AffineTransform) to reuse AffineTransform instances.

getGlyphBounds

AABBox getGlyphBounds(CharSequence string,
                      AffineTransform tmp1,
                      AffineTransform tmp2)

Returns accurate bounding box by taking each glyph's font em-sized bounding box into account.

Glyph bounds is based on each glyph's bounding box and `hhea' composed line height.

Parameters:

string - string text

tmp1 - temp AffineTransform to be reused

tmp2 - temp AffineTransform to be reused

Returns:

the bounding box of the given string in font em-size [0..1]

See Also:

getGlyphBoundsFU(CharSequence), #getGlyphShapeBounds(CharSequence), getMetricBounds(CharSequence)

getGlyphBoundsFU

AABBox getGlyphBoundsFU(CharSequence string)

Try using getGlyphBoundsFU(CharSequence, AffineTransform, AffineTransform) to reuse AffineTransform instances.

getGlyphBoundsFU

AABBox getGlyphBoundsFU(CharSequence string,
                        AffineTransform tmp1,
                        AffineTransform tmp2)

Returns accurate bounding box by taking each glyph's font-units sized bounding box into account.

Glyph bounds is based on each glyph's bounding box and `hhea' composed line height.

Parameters:

string - string text

tmp1 - temp AffineTransform to be reused

tmp2 - temp AffineTransform to be reused

Returns:

the bounding box of the given string in font-units [0..1]

See Also:

getGlyphBounds(CharSequence)

getGlyphShapeBounds

AABBox getGlyphShapeBounds(AffineTransform transform,
                           CharSequence string)

Returns accurate bounding box by taking each glyph's font em-sized OutlineShape into account.

Glyph shape bounds is based on each glyph's OutlineShape and `hhea' composed line height.

This method is only exposed to validate the produced OutlineShape against getGlyphBounds(CharSequence).

Parameters:

transform - optional given transform

string - string text

Returns:

the bounding box of the given string in font-units [0..1]

See Also:

#getGlyphShapeBounds(CharSequence), getGlyphBounds(CharSequence), getMetricBounds(CharSequence)

getGlyphShapeBounds

AABBox getGlyphShapeBounds(AffineTransform transform,
                           CharSequence string,
                           AffineTransform tmp1,
                           AffineTransform tmp2)

Returns accurate bounding box by taking each glyph's font em-sized OutlineShape into account.

Glyph shape bounds is based on each glyph's OutlineShape and `hhea' composed line height.

This method is only exposed to validate the produced OutlineShape against getGlyphBounds(CharSequence).

Parameters:

transform - optional given transform

string - string text

tmp1 - temp AffineTransform to be reused

tmp2 - temp AffineTransform to be reused

Returns:

the bounding box of the given string in font-units [0..1]

See Also:

#getGlyphShapeBounds(CharSequence), getGlyphBounds(CharSequence), getMetricBounds(CharSequence)

isPrintableChar

boolean isPrintableChar(char c)

processString

AABBox processString(Font.GlyphVisitor visitor,
                     AffineTransform transform,
                     CharSequence string)

Try using processString(GlyphVisitor, AffineTransform, CharSequence, AffineTransform, AffineTransform) to reuse AffineTransform instances.

See Also:

processString(GlyphVisitor, AffineTransform, CharSequence, AffineTransform, AffineTransform)

processString

AABBox processString(Font.GlyphVisitor visitor,
                     AffineTransform transform,
                     CharSequence string,
                     AffineTransform temp1,
                     AffineTransform temp2)

Visit each Font.Glyph and perhaps its OutlineShape of the string with the Font.GlyphVisitor while passing the progressed AffineTransform.

The processed shapes are in font em-size [0..1], but can be adjusted with the given transform, progressed and passed to the visitor.

Parameters:

visitor - handling each Font.Glyph and perhaps its OutlineShape in font em-size [0..1] and the given AffineTransform

transform - optional given transform for size and position

font - the target Font

string - string text

temp1 - temporary AffineTransform storage, mandatory

temp2 - temporary AffineTransform storage, mandatory

Returns:

the bounding box of the given string by taking each glyph's font em-sized [0..1] OutlineShape into account.

See Also:

processString(GlyphVisitor, AffineTransform, CharSequence)

processString

void processString(Font.GlyphVisitor2 visitor,
                   CharSequence string)

Visit each Font.Glyph and perhaps its OutlineShape of the string with the constrained Font.GlyphVisitor2.

The processed shapes are in font em-size [0..1].

Parameters:

visitor - handling each Font.Glyph and perhaps its OutlineShape in font em-size [0..1]

string - string text

toString

String toString()

Returns getFullFamilyName()

Overrides:

toString in class Object

fullString

String fullString()

Return all font details as string.