Creates a new horizontal layout.
Sets the bounds of the UI element. Relative to a parent UI panel. Equivalent to calling setPosition(), setWidth() and setHeight().
If scalable is set to true, the size will be scaled linearly with the DPI scaling factor of the surface the elements gets
attached. It false, the element will have this exact size no matter the DPI scaling factor.
Returns number of child elements in the layout.
Returns an array of all children of this layout.
Returns the clipped bounds of the UI element including the margins. Relative to a parent UI panel.
Returns the clipped bounds of the UI element including the margins. Relative to a parent UI panel.
Returns the clipped bounds of the UI element including the margins. In Screenspace.
Returns the clipped bounds of the UI element including the margins. In Screenspace.
Gets the content padding in points.
Sets the debug flags for the UI element.
Sets the debug name for the UI element.
Disables or enables the element. Disabled elements cannot be interacted with and have a faded out appearance.
Hides or shows this element and recursively applies the same state to all the child elements. This will not remove the element from the layout, the room for it will still be reserved but it just won't be visible.
Gets the scaling factor for the element's parent surface. This element must be attached to a valid surface in order to retrieve the scale factor. If the element is not attached to a surface, 1.0 is returned.
The scale factor for the element's parent surface.
Sets the element size to be fixed using the specified value.
Sets the element size to be fixed using the specified value in pixels.
Sets the element size to be fixed using the specified value.
Sets the element size to be fixed using the specified value in pixels.
Checks if the underlying native UIElement has been destroyed.
Determines if this element is a fixed on its height.
Determines if this element is a fixed on its width.
Determines if this element is a flexible on its height.
Determines if this element is a flexible on its width.
Specifies that layout passes of children elements should start from this element.
Specifies that overflow content (e.g. shadows from CSS filters) are clipped at this element's bounds.
Specifies that per-frame updates are enabled. If enabled, the element's onUpdate method will be called every frame.
Activates or deactivates this element and recursively applies the same state to all the child elements. This has the same effect as SetDisplayType(UIDisplayType::Hidden), but when disabled it will also remove the element from the layout, essentially having the same effect is if you destroyed the element.
Sets the horizontal alignment of the element when used in a layout.
Sets the vertical alignment of the element when used in a layout.
Sets the minimum height in points of the element when used in a layout.
Sets the minimum width in points of the element when used in a layout.
Returns the layout this element belongs to, if any.
Disables or enables the element. Disabled elements cannot be interacted with and have a faded out appearance.
Returns the screen on which the element is displayed, if any.
Returns non-clipped bounds of the UI element in screenspace.
Returns non-clipped bounds of the UI element in screenspace.
Gets the size hint for this element.
Gets the size hint for this element.
Sets the CSS class names for this element (space-separated).
Sets the element ID for CSS selectors.
Returns non-clipped visible bounds of the UI element (bounds exclude the margins). Relative to the parent UI panel.
Returns non-clipped visible bounds of the UI element (bounds exclude the margins). Relative to the parent UI panel.
Get the window in which the element is positioned.
Adds a new element to the layout after all existing elements.
The non-null element to add.
Adds a new flexible space as a child of this layout. Flexible space expands to fill all available space in the layout. Space is inserted after all existing elements.
Newly created flexible space.
Adds a new UIGridLayout as a child of this layout. Layout is inserted after all existing elements.
Newly created vertical layout.
Adds a new horizontal layout as a child of this layout. Layout is inserted after all existing elements.
Options that allow you to control how is the layout positioned and sized.
Newly created horizontal layout.
Add a new vertical separator. The horizontal separator is a line that can be used to visually separate elements in a layout.
Newly created separator.
Adds a new UI panel as a child of this layout. Panel is inserted after all existing elements.
Depth at which to position the panel. Panels with lower depth will be displayed in front of panels with higher depth. Provided depth is relative to the depth of the parent UI panel. The depth value will be clamped if outside of the depth range of the parent UI panel.
Options that allow you to control how is the panel positioned and sized.
Newly created UI panel.
Adds a new UI panel as a child of this layout. Panel is inserted after all existing elements.
Depth at which to position the panel. Panels with lower depth will be displayed in front of panels with higher depth. Provided depth is relative to the depth of the parent UI panel. The depth value will be clamped if outside of the depth range of the parent UI panel.
Smallest depth offset allowed by any child UI panels. If a child panel has a depth offset lower than this value it will be clamped.
Largest depth offset allowed by any child UI panels. If a child panel has a depth offset higher than this value it will be clamped.
Options that allow you to control how is the panel positioned and sized.
Newly created UI panel.
Adds a new fixed space object. Fixed space inserts a blank space with specific width or height (depending on layout type) in the layout. Space is inserted after all existing elements.
Size of the space in pixels. This will represent either width or height depending whether the layout is vertical or horizontal.
Optionalscalable: boolean
If this is true, this value will be scaled by the widget scaling factor.
Newly created fixed space.
Adds a CSS class to the element.
The class name to add.
Adds a new vertical layout as a child of this layout. Layout is inserted after all existing elements.
Options that allow you to control how is the layout positioned and sized.
Newly created vertical layout.
Add a new vertical separator. The vertical separator is a line that can be used to visually separate elements in a layout.
Newly created separator.
Creates an animation that executes an action lambda once the delay elapsed.
The action to execute.
Optionaldelay: number
The delay until the action is executed. Defaults to no delay.
Optionalrepeating: number | boolean
Whether the animation should repeat or not. Defaults to false.
Set to true, to repeat forever.
Set to false, to never repeat.
Set to a number, to indicate the repeat count.
The created animation.
Animates a property of the UIElement. The animation is automatically started.
The type of property to be animated.
The name of the property to be animated on the UIElement.
The starting value of the property.
The ending value of the property.
Optionalduration: number
The animation duration in seconds. Defaults to 1 seconds.
OptionaleasingCurve: Const<EasingCurve>
The easing curve to be used. Defaults to
Optionalrepeating: number | boolean
Whether the animation should repeat or not. Defaults to false.
Set to true, to repeat forever.
Set to false, to never repeat.
Set to a number, to indicate the repeat count.
The created animation.
Animates a property of the UIElement using a generic lambda function. The animation is
automatically started.
The lambda that is called when the value is updated. The lambda should be used to assign the value on the u
The starting value of the property.
The ending value of the property.
Optionalduration: number
The animation duration in seconds. Defaults to 1 seconds.
OptionaleasingCurve: Const<EasingCurve>
The easing curve to be used. Defaults to
Optionalrepeating: number | boolean
Whether the animation should repeat or not. Defaults to false.
Set to true, to repeat forever.
Set to false, to never repeat.
Set to a number, to indicate the repeat count.
The created animation.
Creates an animation that takes delay seconds to execute.
The delay in seconds.
The created animation.
Calculates the actual size of the layout, when it would be placed in the specified area.
The available area to for the layout.
The actual size of the layout when placed in the area.
Calculates the actual size of the layout, when it would be placed in the specified area.
The available area to for the layout.
The actual size of the layout when placed in the area.
Removes all child elements and destroys them.
Converts the originLocalPosition from the originElement to this element.
Converts the originLocalPosition from the originElement to this element.
Updates the layout of the UI element. Updates child elements positions, sizes, clip rectangles and depths so they fit into the provided bounds, while respecting their layout options.
Returns non-clipped bounds of the UI element. Relative to a parent UI panel.
OptionalrelativeTo: UIElementBase
Parent panel of the provided element relative to which to return the bounds. If null the bounds relative to the first parent panel are returned. Behavior is undefined if provided panel is not a parent of the element.
Return the child element at the specified index.
The index of the child element.
The child element, or null if the index is out of range.
Returns the child element's index, or no value if the element is not a child of this layout.
Checks if the element has a specific CSS class.
The class name to check.
True if the class is present.
Inserts a UI element before the element at the specified index.
The index where to insert the element.
The new element to insert.
Adds a new flexible space as a child of this layout. Flexible space expands to fill all available space in the layout. is inserted before the element at the specified index.
Newly created flexible space.
Adds a new horizontal layout as a child of this layout. Layout is inserted before the element at the specified index.
Index to insert the layout at. This must be in range [0, GetNumChildren()).
Options that allow you to control how is the layout positioned and sized.
Newly created horizontal layout.
Adds a new UI panel as a child of this layout. Panel is inserted before the element at the specified index.
Index to insert the panel at. This must be in range [0, GetNumChildren()).
Options that allow you to control how is the panel positioned and sized.
Newly created UI panel.
Adds a new UI panel as a child of this layout. Panel is inserted before the element at the specified index.
Index at which to insert the panel.
Optionaldepth: number
Depth at which to position the panel. Panels with lower depth will be displayed in front of panels with higher depth. Provided depth is relative to the depth of the parent UI panel. The depth value will be clamped if outside of the depth range of the parent UI panel.
OptionaldepthRangeMin: number
Smallest depth offset allowed by any child UI panels. If a child panel has a depth offset lower than this value it will be clamped.
OptionaldepthRangeMax: number
Largest depth offset allowed by any child UI panels. If a child panel has a depth offset higher than this value it will be clamped.
Options that allow you to control how is the panel positioned and sized.
Newly created UI panel.
Adds a new fixed space object. Fixed space inserts a blank space with specific width or height (depending on layout type) in the layout. Space is inserted after all existing elements.
Index at which to insert the space.
Size of the space in pixels. This will represent either width or height depending whether the layout is vertical or horizontal.
Newly created fixed space.
Adds a new vertical layout as a child of this layout. Layout is inserted before the element at the specified index.
Index to insert the layout at. This must be in range [0, GetNumChildren()).
Options that allow you to control how is the layout positioned and sized.
Newly created vertical layout.
Determines if the specified element is a child of this. If recursive is set, the method searches through the hierarchy
to see if element is a nested child.
Virtual
Called when the element has been added to a surface or window.
Virtual
Called when the element has been registered with its parent.
Virtual
Called when the element is about to be unregistered from its parent.
Virtual
Called when the element is updating.
Removes a child element at the specified index.
Removes a CSS class from the element.
The class name to remove.
Virtual
Resets element dimensions to their initial values dictated by the element's style.
Sets the bounds of the UI element. Relative to a parent UI panel. Equivalent to calling setPosition(), setWidth() and setHeight().
If scalable is set to true, the size will be scaled linearly with the DPI scaling factor of the surface the elements gets
attached. It false, the element will have this exact size no matter the DPI scaling factor.
Optionalscalable: booleanUnregisters all running animations for the UIElement.
The number of animations that were unregistered.
Toggles a CSS class on the element.
The class name to toggle.
True if the class is now present, false otherwise.
Scales a point value by using the element's DPI scale to the current pixel value.
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.
The value in pixels.
Converts a pixel value to points by using the element's DPI scale.
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.
The value in points.
StaticrenderRenders a UI element into a texture.
The non-null UI element to be drawn to a texture.
The UI skin to use, or null to use the default skin.
The size of the UI texture to draw.
OptionalscalingFactor: number
The DPI scaling factor of the RenderTarget. Can be used to linearly scale the entire UI, including text.
OptionalclearColor: Immutable<SRGBColor>
The clear color. (Default: [0, 0, 0, 0])
An async operation that returns the rendered texture once rendering has been completed by the GPU.
ReadonlyonEvent fired whenever the UI element size changes from a layout update.
ReadonlyonEvent fired whenever the UI element is registered with or unregistered from a parent element.
This does not mean that the element is currently visible on screen or that it is part of a layout. Use onActiveSurfaceChanged to determine if the element is part of a layout that is currently rendered.
ReadonlyonEvent fired whenever the UI element is registered with or unregistered from a surface.
Represents a horizontal layout that will layout out its child elements left to right.