PositionedGlyphs

NO_OVERRIDE

static val NO_OVERRIDE: Float

A special value returned by getWeightOverride(int) and getItalicOverride(int) that indicates no font variation setting is overridden.

Value: 1.4E-45f

equals

fun equals(other: Any?): Boolean

Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

• It is reflexive: for any non-null reference value x, x.equals(x) should return true.
• It is symmetric: for any non-null reference values x and y, x.equals(y) should return true if and only if y.equals(x) returns true.
• It is transitive: for any non-null reference values x, y, and z, if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.
• It is consistent: for any non-null reference values x and y, multiple invocations of x.equals(y) consistently return true or consistently return false, provided no information used in equals comparisons on the objects is modified.
• For any non-null reference value x, x.equals(null) should return false.

An equivalence relation partitions the elements it operates on into equivalence classes; all the members of an equivalence class are equal to each other. Members of an equivalence class are substitutable for each other, at least for some purposes.

getAdvance

fun getAdvance(): Float

Returns the total amount of advance consumed by this positioned glyphs. The advance is an amount of width consumed by the glyph. The total amount of advance is a total amount of advance consumed by this series of glyphs. In other words, if another glyph is placed next to this series of glyphs, it's X offset should be shifted this amount of width.

getAscent

fun getAscent(): Float

Effective ascent value of this positioned glyphs. If two or more font files are used in this series of glyphs, the effective ascent will be the minimum ascent value across the all font files.

getDescent

fun getDescent(): Float

Effective descent value of this positioned glyphs. If two or more font files are used in this series of glyphs, the effective descent will be the maximum descent value across the all font files.

getFakeBold

fun getFakeBold(index: Int): Boolean

Returns true if the fake bold option used for drawing, otherwise false.

getFakeItalic

fun getFakeItalic(index: Int): Boolean

Returns true if the fake italic option used for drawing, otherwise false.

getFont

fun getFont(index: Int): Font

Returns the font object used for drawing the glyph at the given index.

getGlyphId

fun getGlyphId(index: Int): Int

Returns the glyph ID used for drawing the glyph at the given index.

getGlyphX

fun getGlyphX(index: Int): Float

Returns the x coordinate of the glyph position at the given index.

getGlyphY

fun getGlyphY(index: Int): Float

Returns the y coordinate of the glyph position at the given index.

getItalicOverride

fun getItalicOverride(index: Int): Float

Returns overridden italic value if the font is variable font and `ital` value is overridden for drawing. Otherwise returns NO_OVERRIDE.

getOffsetX

fun getOffsetX(): Float

Returns the amount of X offset added to glyph position.

getOffsetY

fun getOffsetY(): Float

Returns the amount of Y offset added to glyph position.

getWeightOverride

fun getWeightOverride(index: Int): Float

Returns overridden weight value if the font is variable font and `wght` value is overridden for drawing. Otherwise returns NO_OVERRIDE.

glyphCount

fun glyphCount(): Int

Returns the number of glyphs stored.

hashCode

fun hashCode(): Int

Returns a hash code value for the object. This method is supported for the benefit of hash tables such as those provided by java.util.HashMap.

The general contract of hashCode is:

• Whenever it is invoked on the same object more than once during an execution of a Java application, the hashCode method must consistently return the same integer, provided no information used in equals comparisons on the object is modified. This integer need not remain consistent from one execution of an application to another execution of the same application.
• If two objects are equal according to the equals method, then calling the hashCode method on each of the two objects must produce the same integer result.
• It is not required that if two objects are unequal according to the equals method, then calling the hashCode method on each of the two objects must produce distinct integer results. However, the programmer should be aware that producing distinct integer results for unequal objects may improve the performance of hash tables.

toString

fun toString(): String

Returns a string representation of the object.