Creates a new UIInspector with a label.
OptionalstyleName: stringOptional style to use for the element. Style will be retrieved from UISkin of the UISurface the element is used on. If not specified default style is used.
OptionalisInternalConstructor: booleanSets the border radius of the style used by this element.
Sets the border radius of the style used by this element.
Sets the border radius of the style used by this element.
Sets the border radius of the style used by this element.
Sets new border width to be used by the element.
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.
Sets the content padding of the style used by this element.
Sets the content padding of the style used by this element.
Sets the content padding of the style used by this element.
Sets the content padding of the style used by this element.
Assigns a new context menu that will be opened when the element is right clicked. Null is allowed in case no context menu is wanted.
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.
Set element part of element depth. Less significant than both widget and area depth.
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.
Determines if the element can be navigated to by using keys/buttons (e.g. the 'Tab' button on the keyboard.
Determines if the element is currently being "clicked" by a pointer device or keyboard input.
Checks if the underlying native UIElement has been destroyed.
Determines will this element block elements underneath it from receiving events like pointer click, hover on/off or be able to gain focus. True by default.
Determines if the element is currently being focused, typically in a state to accept for keyboard input.
Determines if the element is currently hovered by a pointer device.
Determines if the element is receives hover events.
Determines if the element can be focused by clicking on it.
Determines if the element fill is interactive based on mouse events. This requires mouse-move events to be enabled.
Determines if the element stroke is interactive based on mouse events. This requires mouse-move events to be enabled.
Specifies that layout passes of children elements should start from this element.
Determines if the element is currently being "clicked" by a pointer device or keyboard input.
Determines if the element is receives hover events.
Determines if the element is receives hover events.
Determines if the user is allowed to resize the inspector or if the label is at a fixed position.
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.
The label width as a percentage of the whole element width.
Sets the horizontal alignment of the element when used in a layout.
Sets the vertical alignment of the element when used in a layout.
Gets the main element.
The maximum label width as a percentage of the whole element width. Used only when deducing a label width.
The maximum label width as a percentage of the whole element width.
The minimum label width as a percentage of the whole element width. Used only when deducing a label width.
Sets the minimum height in points of the element when used in a layout.
The minimum label width as a percentage of the whole element width.
Sets the minimum width in points of the element when used in a layout.
Sets a navigation group that determines in what order are UI elements visited when using a keyboard or gamepad to switch between the elements. If you don't set a navigation group the elements will inherit the default navigation group from their parent UISurface. Also see SetNavigationGroupIndex().
Sets the padding of the style used by this element.
Sets the padding of the style used by this element.
Sets the padding of the style used by this element.
Sets the padding of the style used by this element.
Returns the layout this element belongs to, if any.
Sets element position relative to parent UI panel in pixels.
Disables or enables the element. Disabled elements cannot be interacted with and have a faded out appearance.
The root form layout, used to synchronize splitter drags and size across multiple layouts.
Gets the number of total rows.
This API includes inactive rows. Use activeRowIndices to get the active indices.
Sets new style to be used by the element.
Get the window in which the element is positioned.
ProtectedaddAdds a new control with a label to the inspector.
The row index to add the element to. The row must be empty!
The optional label to be shown by the field.
The control to be shown on the row.
OptionalleftAccessory: UIElementBaseIf set, will shown an extra accessory element alongside the control.
OptionalrightAccessory: UIElementBaseIf set, will shown an extra accessory element alongside the control.
Optionaltooltip: stringA tooltip to be shown along the main control.
Creates a new UIHorizontalLayout and adds it to the field layout.
Index into the UI layout at which the field layout start at.
Optionaltooltip: stringA tooltip to be shown along the main control.
Newly created layout.
Adds a UI element to the inspector.
The main UI element to be displayed with the inspector row.
Optionalindex?: numberIndex into the inspector row at which the element should be added
Optionallabel?: UIContentContent to be displayed on the label.
OptionalleftThe accessory element to add left of the label.
OptionalrightThe accessory element to add right of the control.
Optionaltooltip?: stringA tooltip to be shown along the main control.
Creates a new UIVerticalLayout and adds it to the field layout.
Index into the UI layout at which the field layout start at.
Optionaltooltip: stringA tooltip to be shown along the main control.
Newly created layout.
Creates an animation that executes an action lambda once the delay elapsed.
The action to execute.
Optionaldelay: numberThe delay until the action is executed. Defaults to no delay.
Optionalrepeating: number | booleanWhether 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 name of the property to be animated on the UIElement.
The starting value of the property.
The ending value of the property.
Optionalduration: numberThe animation duration in seconds. Defaults to 1 seconds.
OptionaleasingCurve: Const<EasingCurve>The easing curve to be used. Defaults to
Optionalrepeating: number | booleanWhether 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: numberThe animation duration in seconds. Defaults to 1 seconds.
OptionaleasingCurve: Const<EasingCurve>The easing curve to be used. Defaults to
Optionalrepeating: number | booleanWhether 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.
VirtualCalled when a command event is triggered. Return true if you have processed the event and don't want other elements to process it.
Converts the originLocalPosition from the originElement to this element.
Converts the originLocalPosition from the originElement to this element.
Returns non-clipped bounds of the UI element. Relative to a parent UI panel.
OptionalrelativeTo: UIElementBaseParent 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.
Gets the MainElement as class of T.
The requested class
Gets the currently active element style.
VirtualCalled when a mouse event is received on any UI element the mouse is interacting with. Return true if you have processed the event and don't want other elements to process it.
VirtualInvoked when the UI requests the UIElement to create a custom tooltip.
A UIElement that contains the tooltip content.
Registers the child form layout.
If isBlocking is true, events emitted by this object are blocked. If isBlocking is false, no blocking will occur and events
will be triggered normally.
Events emitted while being blocked are not buffered.
Should the element block events
whether the element is already blocking events or not.
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.
Assigns a custom cursor type.
Options object for the function call.
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.
OptionalminHeight: numberOptionalmaxHeight: numberOptionalscalable: booleanSets 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.
OptionalminWidth: numberOptionalmaxWidth: numberOptionalscalable: booleanVirtualCalled when a shortcut action is triggered and the UI element has input focus. Return true if you have processed the event and don't want other elements to process it.
VirtualCalled when some text is input and the UI element has input focus. Return true if you have processed the event and don't want other elements to process it.
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.
Unregisters the child form layout.
StaticrenderRenders a UI element into a texture.
The UI element to be drawn to a texture.
The UI skin to be used to render the element.
The size of the UI texture to draw.
OptionalscalingFactor: numberThe 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.
ReadonlyonAn event triggered whenever the label width is changed by the user.
ReadonlyonAn event triggered whenever a label was double-clcked by the user.
ReadonlyonTriggered when the element gains focus.
ReadonlyonTriggered when the element loses focus.
ReadonlyonTriggered when the mouse enters over the UI element.
ReadonlyonTriggered when the mouse leaves the UI element.
ReadonlyonTriggered when the element was clicked.
ReadonlyonTriggered when the widget requests the creation of a context menu.
ReadonlyonTriggered when the element state changes.
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.
The UIFormLayout implements a UI element that displays a sequence of UI controls. Each control can have an optional label and an optional accessory view.
Note
The UIFormLayout serves as the UI element layout for the InspectorFieldContainer.