Class UIFixedSpace

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

  • value: Immutable<Rect2>

  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

  • value: Immutable<Rect2>

  Returns void

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>

debugFlags

• get debugFlags(): EnumValue<UIElementDebugFlag, number>

• Sets the debug flags for the UI element.

  Returns EnumValue<UIElementDebugFlag, number>
• set debugFlags(value): void

• Parameters

  • value: EnumValue<UIElementDebugFlag, number>

  Returns void

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

  • value: EnumValue<UIDisplayType, number>

  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

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

• get layoutHorizontalAlignment(): EnumValue<UIHorizontalAlignment, number>

• Sets the horizontal alignment of the element when used in a layout.

  Returns EnumValue<UIHorizontalAlignment, number>
• set layoutHorizontalAlignment(value): void

• Parameters

  • value: EnumValue<UIHorizontalAlignment, number>

  Returns void

layoutVerticalAlignment

• get layoutVerticalAlignment(): EnumValue<UIVerticalAlignment, number>

• Sets the vertical alignment of the element when used in a layout.

  Returns EnumValue<UIVerticalAlignment, number>
• set layoutVerticalAlignment(value): void

• Parameters

  • value: EnumValue<UIVerticalAlignment, number>

  Returns void

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

  • value: Immutable<Vector2>

  Returns void

positionInteger

• set positionInteger(value): void

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

  Parameters

  • value: Immutable<Vector2>

  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

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.

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

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.

convertElementLocalPositionToLocalPosition

• convertElementLocalPositionToLocalPosition(originElement, originLocalPosition): Vector2

• Converts the originLocalPosition from the originElement to this element.

  Parameters

  • originElement: UIElementBase
  • originLocalPosition: Immutable<Vector2>

  Returns Vector2

  Note

  The elements must be located within the same UISurface or window.

convertElementLocalPositionToLocalPositionInPixels

• convertElementLocalPositionToLocalPositionInPixels(originElement, originLocalPosition): Vector2

• Converts the originLocalPosition from the originElement to this element.

  Parameters

  • originElement: UIElementBase
  • originLocalPosition: Immutable<Vector2>

  Returns Vector2

  Note

  The elements must be located within the same UISurface or window.

convertWindowPositionToScreenInPixels

• convertWindowPositionToScreenInPixels(position): Vector2

• Converts the surface (typically window) position to screen coordinates.

  Parameters

  • position: Immutable<Vector2>

  Returns Vector2

convertWindowPositionToScreenInPoints

• convertWindowPositionToScreenInPoints(position): Vector2

• Parameters

  • position: Immutable<Vector2>

  Returns Vector2

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.

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.

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

  • bounds: Immutable<Rect2>
  • Optionalscalable: boolean

  Returns void

setFixedHeight

• setFixedHeight(value): void

• Parameters

  • value: number

  Returns void

setFixedWidth

• setFixedWidth(value): void

• Parameters

  • value: number

  Returns void

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.

ReadonlyonLayoutSizeChanged

ReadonlyonRegistrationChanged

ReadonlyonActiveSurfaceChanged