com.viaversion.viaversion.libs.mcstructs.text.utils

Class TextWidthUtils

java.lang.Object

com.viaversion.viaversion.libs.mcstructs.text.utils.TextWidthUtils

public class TextWidthUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
TextWidthUtils()

Method Summary

Modifier and Type	Method and Description
static float	getCharWidth(char c, float boldOffset, boolean bold) Get the width of a char using the default widths. Minecraft takes the ceil of the width. This method reads the default char widths from the charwidths.bin resource. The widths array will be cached after the first call.
static float[]	getCharWidths() Get the default char widths array. The widths array will be cached after the first call. This method reads the default char widths from the charwidths.bin resource. The widths array will be cached after the first call.
static float	getComponentWidth(TextComponent component) Calculate the width of a component using the default widths. Minecraft takes the ceil of the width. This method reads the default char widths from the charwidths.bin resource. The widths array will be cached after the first call.
static float	getComponentWidth(TextComponent component, float[] widths) Calculate the width of a component using the given widths array. Minecraft takes the ceil of the width.
static float	getComponentWidth(TextComponent component, float[] widths, float boldOffset) Calculate the width of a component using the given widths array. The bold offset is 1 for the vanilla font and 0.5 for unihex fonts. Minecraft takes the ceil of the width.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

TextWidthUtils

public TextWidthUtils()

Method Detail

getCharWidths

public static float[] getCharWidths()

Get the default char widths array.
The widths array will be cached after the first call.

This method reads the default char widths from the charwidths.bin resource.
The widths array will be cached after the first call.

Returns:

The default char widths array

Throws:

java.lang.IllegalStateException - If the charwidths.bin resource could not be found

java.lang.RuntimeException - If the charwidths.bin resource could not be read

getCharWidth

public static float getCharWidth(char c,
                                 float boldOffset,
                                 boolean bold)

Get the width of a char using the default widths.
Minecraft takes the ceil of the width.

This method reads the default char widths from the charwidths.bin resource.
The widths array will be cached after the first call.

Parameters:

c - The char to calculate the width of

boldOffset - The bold offset

bold - If the char is bold

Returns:

The width of the char

Throws:

java.lang.IllegalStateException - If the charwidths.bin resource could not be found

java.lang.RuntimeException - If the charwidths.bin resource could not be read

getComponentWidth

public static float getComponentWidth(TextComponent component)

Calculate the width of a component using the default widths.
Minecraft takes the ceil of the width.

This method reads the default char widths from the charwidths.bin resource.
The widths array will be cached after the first call.

Parameters:

component - The component to calculate the width of

Returns:

The width of the component

Throws:

java.lang.IllegalStateException - If the charwidths.bin resource could not be found

java.lang.RuntimeException - If the charwidths.bin resource could not be read

getComponentWidth

public static float getComponentWidth(TextComponent component,
                                      float[] widths)

Calculate the width of a component using the given widths array.
Minecraft takes the ceil of the width.

Parameters:

component - The component to calculate the width of

widths - The char widths array

Returns:

The width of the component

getComponentWidth

public static float getComponentWidth(TextComponent component,
                                      float[] widths,
                                      float boldOffset)

Calculate the width of a component using the given widths array.
The bold offset is 1 for the vanilla font and 0.5 for unihex fonts.
Minecraft takes the ceil of the width.

Parameters:

component - The component to calculate the width of

widths - The char widths array

boldOffset - The bold offset

Returns:

The width of the component