Class UIGridLayout

Represents a layout that will layout its child elements in a fixed grid.

Hierarchy (view full)

Constructors

constructor

Properties

Accessors

bounds boundsInPixels cellSpacing childCount children clippedVisibleBounds clippedVisibleBoundsInPixels clippedVisibleScreenBounds clippedVisibleScreenBoundsInPixels contentPadding debugFlags debugName disabled displayType dpiScale fixedHeight fixedHeightInPixels fixedWidth fixedWidthInPixels isAutoResizing isDestroyed isLayoutBarrier isUpdating isVisible layoutHorizontalAlignment layoutVerticalAlignment maximumAutoScaleFactor minimumHeight minimumWidth parent position positionInteger readOnly rowSpacing screen screenBounds screenBoundsInPixels sizeHint sizeHintInPixels tileSize visibleBounds visibleBoundsInPixels window

Methods

addElement addFlexibleSpace addGridLayout addHorizontalLayout addHorizontalSeparator addPanel addPanelWithColor addPanelWithDepth addPanelWithDepthRange addSpace addVerticalLayout addVerticalSeparator animateWithAction animateWithProperty animateWithSetter animationDelay calculateActualSize calculateActualSizeInPixels clear convertElementLocalPositionToLocalPosition convertElementLocalPositionToLocalPositionInPixels convertWindowPositionToScreenInPixels convertWindowPositionToScreenInPoints destroy ensureLayoutCurrent getBoundsInPixels getChild getIndexForChild insertElement insertFlexibleSpace insertHorizontalLayout insertPanel insertPanelWithDepthRange insertSpace insertVerticalLayout isChild onActivate onDeactivate onRegister onUnregister onUpdate removeElement removeElementAtIndex resetDimensions setBounds setFixedHeight setFixedWidth setFlexibleHeight setFlexibleWidth stopAnimations toPixels toPixelsVector2 toPoints toPointsVector2 renderToTexture

Events

onLayoutSizeChanged onRegistrationChanged onActiveSurfaceChanged

Constructors

constructor

  • new UIGridLayout(options, isInternalConstructor?): UIGridLayout

  • Creates a new grid layout with the given size of each cell/tile.

    Parameters

    • options: {
          isAutoResizing?: boolean;
          tileSize: Immutable<Size2>;
      } | {
          isAutoResizing: boolean;
          options?: readonly Immutable<UIOption>[];
          tileSize: Immutable<Size2>;
      }

      Options object for the function call.

    • OptionalisInternalConstructor: boolean

    Returns UIGridLayout

Accessors

bounds

  • get bounds(): Immutable<Rect2>

  • 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 Immutable<Rect2>

  • set bounds(value): void

  • Parameters

    Returns void

boundsInPixels

  • get boundsInPixels(): Immutable<Rect2>

  • Gets or sets non-clipped bounds of the UI element in pixels. Relative to a parent UI panel.

    Returns Immutable<Rect2>

  • set boundsInPixels(value): void

  • Parameters

    Returns void

cellSpacing

  • get cellSpacing(): number

  • The cell spacing in points.

    Returns number

  • set cellSpacing(value): void

  • Parameters

    • value: number

    Returns void

childCount

  • get childCount(): number

  • Returns number of child elements in the layout.

    Returns number

children

clippedVisibleBounds

  • get clippedVisibleBounds(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. Relative to a parent UI panel.

    Returns Immutable<Rect2>

clippedVisibleBoundsInPixels

  • get clippedVisibleBoundsInPixels(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. Relative to a parent UI panel.

    Returns Immutable<Rect2>

clippedVisibleScreenBounds

  • get clippedVisibleScreenBounds(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. In Screenspace.

    Returns Immutable<Rect2>

clippedVisibleScreenBoundsInPixels

  • get clippedVisibleScreenBoundsInPixels(): Immutable<Rect2>

  • Returns the clipped bounds of the UI element including the margins. In Screenspace.

    Returns Immutable<Rect2>

contentPadding

debugFlags

debugName

  • get debugName(): string

  • Sets the debug name for the UI element.

    Returns string

  • set debugName(value): void

  • Parameters

    • value: string

    Returns void

disabled

  • get disabled(): boolean

  • Disables or enables the element. Disabled elements cannot be interacted with and have a faded out appearance.

    Returns boolean

  • set disabled(value): void

  • Parameters

    • value: boolean

    Returns void

displayType

  • get displayType(): EnumValue<UIDisplayType, number>

  • 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.

    Returns EnumValue<UIDisplayType, number>

  • set displayType(value): void

  • Parameters

    Returns void

dpiScale

  • get dpiScale(): number

  • 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.

    Returns number

    The scale factor for the element's parent surface.

fixedHeight

  • get fixedHeight(): number

  • Sets the element size to be fixed using the specified value.

    Returns number

  • set fixedHeight(value): void

  • Parameters

    • value: number

    Returns void

fixedHeightInPixels

  • set fixedHeightInPixels(value): void

  • Sets the element size to be fixed using the specified value in pixels.

    Parameters

    • value: number

    Returns void

fixedWidth

  • get fixedWidth(): number

  • Sets the element size to be fixed using the specified value.

    Returns number

  • set fixedWidth(value): void

  • Parameters

    • value: number

    Returns void

fixedWidthInPixels

  • set fixedWidthInPixels(value): void

  • Sets the element size to be fixed using the specified value in pixels.

    Parameters

    • value: number

    Returns void

isAutoResizing

  • get isAutoResizing(): boolean

  • Determines if the layout should auto-resize to better fit tiles into the available space.

    Returns boolean

  • set isAutoResizing(value): void

  • Parameters

    • value: boolean

    Returns void

isDestroyed

  • get isDestroyed(): boolean

  • Checks if the underlying native UIElement has been destroyed.

    Returns boolean

isLayoutBarrier

  • get isLayoutBarrier(): boolean

  • Specifies that layout passes of children elements should start from this element.

    Returns boolean

  • set isLayoutBarrier(value): void

  • Parameters

    • value: boolean

    Returns void

isUpdating

  • get isUpdating(): boolean

  • Specifies that per-frame updates are enabled. If enabled, the element's onUpdate method will be called every frame.

    Returns boolean

    Note

    Per-frame updates are expensive and most UI elements should be built using a fully event-driven approach. Do not enable per-frame updates unless there is no event available that can be used to drive the required behavior.

  • set isUpdating(value): void

  • Parameters

    • value: boolean

    Returns void

isVisible

  • get isVisible(): boolean

  • 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.

    Returns boolean

  • set isVisible(value): void

  • Parameters

    • value: boolean

    Returns void

layoutHorizontalAlignment

layoutVerticalAlignment

maximumAutoScaleFactor

minimumHeight

  • get minimumHeight(): number

  • Sets the minimum height in points of the element when used in a layout.

    Returns number

  • set minimumHeight(value): void

  • Parameters

    • value: number

    Returns void

minimumWidth

  • get minimumWidth(): number

  • Sets the minimum width in points of the element when used in a layout.

    Returns number

  • set minimumWidth(value): void

  • Parameters

    • value: number

    Returns void

parent

  • get parent(): UIElementBase

  • Returns the layout this element belongs to, if any.

    Returns UIElementBase

position

  • get position(): Immutable<Vector2>

  • Sets element position relative to parent UI panel in points.

    Returns Immutable<Vector2>

    Note

    Be aware that this value will be ignored if UI element is part of a layout since then the layout controls its placement.

  • set position(value): void

  • Parameters

    Returns void

positionInteger

  • set positionInteger(value): void

  • Sets element position relative to parent UI panel in pixels.

    Parameters

    Returns void

    Note

    Be aware that this value will be ignored if UI element is part of a layout since then the layout controls its placement.

readOnly

  • get readOnly(): boolean

  • Disables or enables the element. Disabled elements cannot be interacted with and have a faded out appearance.

    Returns boolean

  • set readOnly(value): void

  • Parameters

    • value: boolean

    Returns void

rowSpacing

  • get rowSpacing(): number

  • The row spacing in points.

    Returns number

  • set rowSpacing(value): void

  • Parameters

    • value: number

    Returns void

screen

  • get screen(): Screen

  • Returns the screen on which the element is displayed, if any.

    Returns Screen

screenBounds

  • get screenBounds(): Immutable<Rect2>

  • Returns non-clipped bounds of the UI element in screenspace.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive if the UI state is dirty.

screenBoundsInPixels

  • get screenBoundsInPixels(): Immutable<Rect2>

  • Returns non-clipped bounds of the UI element in screenspace.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive if the UI state is dirty.

sizeHint

  • get sizeHint(): Immutable<Size2>

  • Gets the size hint for this element.

    Returns Immutable<Size2>

    Note

    The size hint represents an approximation of the size. The actual size depends on the layouting that is done by the parent element. Layouts typically use the size hint to calculate the intial size of the element when distributing the available layout space.

sizeHintInPixels

  • get sizeHintInPixels(): Immutable<Vector2>

  • Gets the size hint for this element.

    Returns Immutable<Vector2>

    Note

    The size hint represents an approximation of the size. The actual size depends on the layouting that is done by the parent element. Layouts typically use the size hint to calculate the intial size of the element when distributing the available layout space.

tileSize

visibleBounds

  • get visibleBounds(): Immutable<Rect2>

  • Returns non-clipped visible bounds of the UI element (bounds exclude the margins). Relative to the parent UI panel.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive as the bounds need to be calculated based on current UI state.

visibleBoundsInPixels

  • get visibleBoundsInPixels(): Immutable<Rect2>

  • Returns non-clipped visible bounds of the UI element (bounds exclude the margins). Relative to the parent UI panel.

    Returns Immutable<Rect2>

    Note

    This call can be potentially expensive as the bounds need to be calculated based on current UI state.

window

  • get window(): RenderWindow

  • Get the window in which the element is positioned.

    Returns RenderWindow

Methods

addElement

  • addElement(element): boolean

  • Adds a new element to the layout after all existing elements. param element The new element to add.

    Parameters

    Returns boolean

addFlexibleSpace

  • addFlexibleSpace(): UIFlexibleSpace

  • 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.

    Returns UIFlexibleSpace

    Newly created flexible space.

addGridLayout

  • addGridLayout(tileSize, isAutoResizing, ...options): UIGridLayout

  • Adds a new UIGridLayout as a child of this layout. Layout is inserted after all existing elements.

    Parameters

    • tileSize: Immutable<Size2>

      The size of the grid tiles.

    • isAutoResizing: boolean

      Determines if the grid layout resizes to fit the full width.

    • Rest...options: UIOption[]

      Options that allow you to control how is the layout positioned and sized.

    Returns UIGridLayout

    Newly created vertical layout.

addHorizontalLayout

  • addHorizontalLayout(...options): UIHorizontalLayout

  • Adds a new horizontal layout as a child of this layout. Layout is inserted after all existing elements.

    Parameters

    • Rest...options: UIOption[]

      Options that allow you to control how is the layout positioned and sized.

    Returns UIHorizontalLayout

    Newly created horizontal layout.

addHorizontalSeparator

addPanel

  • addPanel(...options): UIPanel

  • Adds a new UI panel as a child of this layout. Panel is inserted after all existing elements.

    Parameters

    • Rest...options: UIOption[]

      Options that allow you to control how is the panel positioned and sized.

    Returns UIPanel

    Newly created UI panel.

addPanelWithColor

  • addPanelWithColor(color, depth?, cornerRadius?, borderColor?, borderWidth?): UIPanel

  • Adds a colored background panel to the layout.

    Parameters

    • color: Immutable<Color>

      The color.

    • Optionaldepth: number

      The panel depth, should be greater than 0 to be in the background. (Default: 10)

    • OptionalcornerRadius: number

      The optional corner radius.

    • OptionalborderColor: Immutable<Color>
    • OptionalborderWidth: number

    Returns UIPanel

addPanelWithDepth

  • addPanelWithDepth(depth, ...options): UIPanel

  • Adds a new UI panel as a child of this layout. Panel is inserted after all existing elements.

    Parameters

    • depth: 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.

    • Rest...options: UIOption[]

      Options that allow you to control how is the panel positioned and sized.

    Returns UIPanel

    Newly created UI panel.

addPanelWithDepthRange

  • addPanelWithDepthRange(depth, depthRangeMin, depthRangeMax, ...options): UIPanel

  • Adds a new UI panel as a child of this layout. Panel is inserted after all existing elements.

    Parameters

    • depth: 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.

    • depthRangeMin: 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.

    • depthRangeMax: 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.

    • Rest...options: UIOption[]

      Options that allow you to control how is the panel positioned and sized.

    Returns UIPanel

    Newly created UI panel.

addSpace

  • addSpace(size, scalable?): UIFixedSpace

  • 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.

    Parameters

    • size: number

      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.

    Returns UIFixedSpace

    Newly created fixed space.

addVerticalLayout

  • addVerticalLayout(...options): UIVerticalLayout

  • Adds a new vertical layout as a child of this layout. Layout is inserted after all existing elements.

    Parameters

    • Rest...options: UIOption[]

      Options that allow you to control how is the layout positioned and sized.

    Returns UIVerticalLayout

    Newly created vertical layout.

addVerticalSeparator

animateWithAction

  • animateWithAction(action, delay?, repeating?): EditorAnimation

  • Creates an animation that executes an action lambda once the delay elapsed.

    Parameters

    • action: (() => void)

      The action to execute.

        • (): void

        • Returns void

    • 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.

    Returns EditorAnimation

    The created animation.

animateWithProperty

  • animateWithProperty<T>(propertyName, starting, ending, duration?, easingCurve?, repeating?): EditorAnimation

  • Animates a property of the UIElement. The animation is automatically started.

    Type Parameters

    • T

      The type of property to be animated.

    Parameters

    • propertyName: string

      The name of the property to be animated on the UIElement.

    • starting: T

      The starting value of the property.

    • ending: T

      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.

    Returns EditorAnimation

    The created animation.

    See

    EasingCurve.inOutQuadratic.

animateWithSetter

  • animateWithSetter<T>(setter, starting, ending, duration?, easingCurve?, repeating?): EditorAnimation

  • Animates a property of the UIElement using a generic lambda function. The animation is automatically started.

    Type Parameters

    • T

    Parameters

    • setter: ((value: T) => void)

      The lambda that is called when the value is updated. The lambda should be used to assign the value on the u

        • (value): void

        • Parameters

          • value: T

          Returns void

    • starting: T

      The starting value of the property.

    • ending: T

      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.

    Returns EditorAnimation

    The created animation.

    See

    EasingCurve.inOutQuadratic.

animationDelay

  • animationDelay(delay): EditorAnimation

  • Creates an animation that takes delay seconds to execute.

    Parameters

    • delay: number

      The delay in seconds.

    Returns EditorAnimation

    The created animation.

    Note

    This animation is usedful when creating compound animations that are chained together by calls to then. This is helpful to create an animation that performs an action, waits and performs another action.

calculateActualSize

  • calculateActualSize(area, mode): Size2

  • Calculates the actual size of the layout, when it would be placed in the specified area.

    Parameters

    Returns Size2

    The actual size of the layout when placed in the area.

    Note

    This is an expensive method to call, and it's best to avoid it unless it's required. To respond to layout changes from the parent, use the OnLayoutSizeChanged event instead.

calculateActualSizeInPixels

  • calculateActualSizeInPixels(area, mode): Size2

  • Calculates the actual size of the layout, when it would be placed in the specified area.

    Parameters

    Returns Size2

    The actual size of the layout when placed in the area.

    Note

    This is an expensive method to call, and it's best to avoid it unless it's required. To respond to layout changes from the parent, use the OnLayoutSizeChanged event instead.

clear

  • clear(): void

  • Removes all child elements and destroys them.

    Returns void

convertElementLocalPositionToLocalPosition

convertElementLocalPositionToLocalPositionInPixels

convertWindowPositionToScreenInPixels

convertWindowPositionToScreenInPoints

destroy

  • destroy(): void
  • Virtual

    Destroys this element and all its children. Removes the element from parent layout/panel.

    Returns void

    Note

    Calling methods on a destroyed element is a no-operation. Destroyed elements aren't allowed to be assigned as children of other elements, or be parents of other elements.

ensureLayoutCurrent

  • ensureLayoutCurrent(): void

  • 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 void

    Note

    This may trigger the layout of more than this element and it's children! It can potentially update the layout of the whole UI tree.

getBoundsInPixels

  • getBoundsInPixels(relativeTo?): Rect2

  • Returns non-clipped bounds of the UI element. Relative to a parent UI panel.

    Parameters

    • 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.

    Returns Rect2

    Note

    This call can be potentially expensive if the UI state is dirty.

getChild

getIndexForChild

insertElement

  • insertElement(index, element): boolean

  • Inserts a UI element before the element at the specified index.

    Parameters

    • index: number

      The index where to insert the element.

    • element: UIElementBase

      The new element to insert.

    Returns boolean

insertFlexibleSpace

  • insertFlexibleSpace(index): UIFlexibleSpace

  • 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.

    Parameters

    • index: number

    Returns UIFlexibleSpace

    Newly created flexible space.

insertHorizontalLayout

  • insertHorizontalLayout(index, ...options): UIHorizontalLayout

  • Adds a new horizontal layout as a child of this layout. Layout is inserted before the element at the specified index.

    Parameters

    • index: number

      Index to insert the layout at. This must be in range [0, GetNumChildren()).

    • Rest...options: UIOption[]

      Options that allow you to control how is the layout positioned and sized.

    Returns UIHorizontalLayout

    Newly created horizontal layout.

insertPanel

  • insertPanel(index, ...options): UIPanel

  • Adds a new UI panel as a child of this layout. Panel is inserted before the element at the specified index.

    Parameters

    • index: number

      Index to insert the panel at. This must be in range [0, GetNumChildren()).

    • Rest...options: UIOption[]

      Options that allow you to control how is the panel positioned and sized.

    Returns UIPanel

    Newly created UI panel.

insertPanelWithDepthRange

  • insertPanelWithDepthRange(index, depth?, depthRangeMin?, depthRangeMax?, ...options): UIPanel

  • Adds a new UI panel as a child of this layout. Panel is inserted before the element at the specified index.

    Parameters

    • index: number

      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.

    • Rest...options: UIOption[]

      Options that allow you to control how is the panel positioned and sized.

    Returns UIPanel

    Newly created UI panel.

insertSpace

  • insertSpace(index, size): UIFixedSpace

  • 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.

    Parameters

    • index: number

      Index at which to insert the space.

    • size: number

      Size of the space in pixels. This will represent either width or height depending whether the layout is vertical or horizontal.

    Returns UIFixedSpace

    Newly created fixed space.

insertVerticalLayout

  • insertVerticalLayout(index, ...options): UIVerticalLayout

  • Adds a new vertical layout as a child of this layout. Layout is inserted before the element at the specified index.

    Parameters

    • index: number

      Index to insert the layout at. This must be in range [0, GetNumChildren()).

    • Rest...options: UIOption[]

      Options that allow you to control how is the layout positioned and sized.

    Returns UIVerticalLayout

    Newly created vertical layout.

isChild

  • isChild(element, recursive): boolean

  • 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.

    Parameters

    Returns boolean

onActivate

  • onActivate(): void
  • Virtual

    Called when the element has been added to a surface or window.

    Returns void

    Note

    This event allows to immediately access the layout data and bounds of the element and it's immediate parents and children. The event is helpful to perform initialization and registration to events. Implementing classes must call super.

onDeactivate

  • onDeactivate(): void
  • Virtual

    Called when the element has been removed from a surface or window.

    Returns void

    Note

    Layout data and bounds will no longer be available at this point. The event is helpful to perform cleanup and unregistration from events. Implementing classes must call super.

onRegister

  • onRegister(): void
  • Virtual

    Called when the element has been registered with its parent.

    Returns void

onUnregister

  • onUnregister(): void
  • Virtual

    Called when the element is about to be unregistered from its parent.

    Returns void

onUpdate

  • onUpdate(): void
  • Virtual

    Called when the element is updating.

    Returns void

    Note

    This is method is only called if the element has been marked as requiring updates.

    Note

    Per-frame updates are expensive and most UI elements should be built using a fully event-driven approach. Do not enable per-frame updates unless there is no event available that can be used to drive the required behavior.

removeElement

removeElementAtIndex

  • removeElementAtIndex(idx): boolean

  • Removes a child element at the specified index.

    Parameters

    • idx: number

    Returns boolean

resetDimensions

  • resetDimensions(): void
  • Virtual

    Resets element dimensions to their initial values dictated by the element's style.

    Returns void

setBounds

  • setBounds(bounds, scalable?): void

  • 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.

    Parameters

    Returns void

setFixedHeight

setFixedWidth

setFlexibleHeight

  • setFlexibleHeight(minHeight?, maxHeight?, scalable?): void

  • Sets element height in pixels. Element will be resized according to its contents and parent layout but will always stay within the provided range. If maximum height is zero, the element is allowed to expand as much as it needs.

    If scalable is set to true, the minimum and maximum heights 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.

    Parameters

    • OptionalminHeight: number
    • OptionalmaxHeight: number
    • Optionalscalable: boolean

    Returns void

setFlexibleWidth

  • setFlexibleWidth(minWidth?, maxWidth?, scalable?): void

  • Sets element width in pixels. Element will be resized according to its contents and parent layout but will always stay within the provided range. If maximum width is zero, the element is allowed to expand as much as it needs.

    If scalable is set to true, the minimum and maximum widths 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.

    Parameters

    • OptionalminWidth: number
    • OptionalmaxWidth: number
    • Optionalscalable: boolean

    Returns void

stopAnimations

  • stopAnimations(): number

  • Unregisters all running animations for the UIElement.

    Returns number

    The number of animations that were unregistered.

toPixels

  • toPixels(valueInPoints): number

  • Scales a point value by using the element's DPI scale to the current pixel value.

    Parameters

    • valueInPoints: number

      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.

    Returns number

    The value in pixels.

toPixelsVector2

  • toPixelsVector2(valueInPoints): Vector2

  • Scales a point value by using the element's DPI scale to the current pixel value.

    Parameters

    • valueInPoints: Immutable<Vector2>

      The element used to get the DPI scaling factor.

    Returns Vector2

    Result value in pixels.

toPoints

  • toPoints(valueInPixels): number

  • Converts a pixel value to points by using the element's DPI scale.

    Parameters

    • valueInPixels: number

      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.

    Returns number

    The value in points.

toPointsVector2

  • toPointsVector2(valueInPixels): Vector2

  • Scales a point value by using the element's DPI scale to the current point value.

    Parameters

    • valueInPixels: Immutable<Vector2>

      The element used to get the DPI scaling factor.

    Returns Vector2

    Result value in points.

StaticrenderToTexture

  • renderToTexture(element, skin, sizeInPixels, scalingFactor?, clearColor?): AsyncOp<ResourceHandle<Texture>, void>

  • Renders a UI element into a texture.

    Parameters

    • element: UIElementBase

      The UI element to be drawn to a texture.

    • skin: UISkin | ResourceHandle<UISkin>

      The UI skin to be used to render the element.

    • sizeInPixels: Immutable<Size2>

      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])

    Returns AsyncOp<ResourceHandle<Texture>, void>

    An async operation that returns the rendered texture once rendering has been completed by the GPU.

    Note

    Calling this method will detach the given element from it's current parent.

Events

ReadonlyonLayoutSizeChanged

onLayoutSizeChanged: Event<[Immutable<Size2>, Immutable<Size2>], void>

Event fired whenever the UI element size changes from a layout update.

Param: oldSize

The old size of the UI element, in points.

Param: newSize

The new size of the UI element, in points.

ReadonlyonRegistrationChanged

onRegistrationChanged: Event<[boolean], void>

Event fired whenever the UI element is registered with or unregistered from a parent element.

Note

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.

Param: isRegistered

True if the new state is registered in a parent element.

ReadonlyonActiveSurfaceChanged

onActiveSurfaceChanged: Event<[boolean], void>

Event fired whenever the UI element is registered with or unregistered from a surface.

Param: isRegistered

True if the new state is registered in a surface.

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods
addElementaddFlexibleSpaceaddGridLayoutaddHorizontalLayoutaddHorizontalSeparatoraddPaneladdPanelWithColoraddPanelWithDepthaddPanelWithDepthRangeaddSpaceaddVerticalLayoutaddVerticalSeparatoranimateWithActionanimateWithPropertyanimateWithSetteranimationDelaycalculateActualSizecalculateActualSizeInPixelsclearconvertElementLocalPositionToLocalPositionconvertElementLocalPositionToLocalPositionInPixelsconvertWindowPositionToScreenInPixelsconvertWindowPositionToScreenInPointsdestroyensureLayoutCurrentgetBoundsInPixelsgetChildgetIndexForChildinsertElementinsertFlexibleSpaceinsertHorizontalLayoutinsertPanelinsertPanelWithDepthRangeinsertSpaceinsertVerticalLayoutisChildonActivateonDeactivateonRegisteronUnregisteronUpdateremoveElementremoveElementAtIndexresetDimensionssetBoundssetFixedHeightsetFixedWidthsetFlexibleHeightsetFlexibleWidthstopAnimationstoPixelstoPixelsVector2toPointstoPointsVector2renderToTexture
Events