Class UIUtility

Various helper functionality that's useful when creating UI elements.

Index

Constructors

Methods

calculateSizeHintInPixels calculateTextSize generateLoremIpsum toPixels toPixelsVector2 toPoints toPointsVector2

Constructors

`Protected`constructor

new UIUtility(isInternalConstructor?: boolean): UIUtility
Parameters
- OptionalisInternalConstructor: boolean
Returns UIUtility

Inherited from UIUtilityGenerated.constructor

Methods

`Static`calculateSizeHintInPixels

calculateSizeHintInPixels(element: UIElementBase): Vector2
Calculates optimal size of a UI element. This is the size that allows the UI element to properly display all of its content.
Parameters
- element: UIElementBase
Returns Vector2

Inherited from UIUtilityGenerated.calculateSizeHintInPixels

`Static`calculateTextSize

calculateTextSize(
    text: string,
    font: Font | ResourceHandle<Font>,
    fontSize: number,
    maximumWidthInPixels?: number,
): Vector2
Calculates size hint for the provided text using the provided font and size. Size is calculated without word wrap.
Parameters
- text: string
  Text to calculate the size for.
- font: Font | ResourceHandle<Font>
  Font to use for rendering the text.
- fontSize: number
  Size of individual characters in the font, in points.
- OptionalmaximumWidthInPixels: number
  The maximum width in pixels.
Returns Vector2
Width/height required to display the text, in pixels.

Inherited from UIUtilityGenerated.calculateTextSize

`Static`generateLoremIpsum

generateLoremIpsum(wordCount: number): string
Generates the lorem impsum place holder text with the specified number of words.
Parameters
- wordCount: number
Returns string

`Static`toPixels

toPixels(element: UIElementBase, valueInPoints: number): number
Scales a point value by using the element's DPI scale to the current pixel value.
Parameters
- element: UIElementBase
  The element to scale a value for. This element must be attached to a valid widget in order to retrieve the scale factor. If the element is not attached to a widget, no scaling is performed.
- valueInPoints: number
  The value to be scaled. This will effectively multiply the value by the widget scale factor.
Returns number
The value in pixels.

`Static`toPixelsVector2

toPixelsVector2(
element: UIElementBase,
valueInPoints: Immutable<rsx.UIPoint>,
): Vector2
Scales a point value by using the element's DPI scale to the current pixel value.
Parameters
- element: UIElementBase
  The element used to get the DPI scaling factor.
- valueInPoints: Immutable<rsx.UIPoint>
  Input value in points.
Returns Vector2
Result value in pixels.

`Static`toPoints

toPoints(element: UIElementBase, valueInPixels: number): number
Converts a pixel value to points by using the element's DPI scale.
Parameters
- element: UIElementBase
  The element to scale a value for. This element must be attached to a valid widget in order to retrieve the scale factor. If the element is not attached to a widget, no scaling is performed.
- valueInPixels: number
  The value to be scaled. This will effectively multiply the value by the widget scale factor.
Returns number
The value in points.

`Static`toPointsVector2

toPointsVector2(
element: UIElementBase,
valueInPixels: Immutable<rsx.UIPixel>,
): Vector2
Scales a point value by using the element's DPI scale to the current point value.
Parameters
- element: UIElementBase
  The element used to get the DPI scaling factor.
- valueInPixels: Immutable<rsx.UIPixel>
Returns Vector2
Result value in points.