Module ambient_ui_native::prelude

A prelude for users of the crate. Imports all the most commonly used types and functions.

Modules

• ambient_element
  Element is a React-inspired virtual tree library for the Ambient runtime.

Structs

• Alert
  A full-screen alert dialog that the user must acknowledge.
• ArrayEditor
  An editor for a fixed-size array.
• BookFile
  An entry in a Bookcase.
• Bookcase
  A bookcase layout is a min-max layout; it should be a list of BookFiles, where each BookFile has a container and a book. The book’s determine the size of the entire Bookcase, but their sizes are not manipulated. The containers are resized to fit the bookcase though, to align them.
• Button
  A button UI element.
• Centered
  A Centered is a Flow that is oriented vertically and is centered.
• Checkbox
  A checkbox.
• ClickArea
  An area that tracks mouse events.
• CustomParseInput
  An editor for a value that can be parsed from a string, but with custom parsing and stringification.
• DialogScreen
  Contains a single element with a background color and click area.
• Dock
  A docking layout, where each child specifies which side of the parent it should be docked to. It is top-down: it starts with a given area (say the screen) and then divides it into smaller pieces with each new element added to it.
• Dropdown
  A dropdown element: shows the dropdown when show is specified.
• DropdownSelect
  A dropdown select element. Presents a button next to content that, when clicked, shows a dropdown with the items in items.
• DurationEditor
  An editor for EditableDuration.
• EditableDuration
  A duration that can be edited.
• EditorColumn
  Legacy newtype for FlowColumn.
• EditorOpts
  Options for the Editor type.
• EditorPrompt
  A full-screen prompt dialog to edit a value.
• EditorRow
  A row with a title and an element, used as part of larger editors.
• Element
  A rendered ElementComponent instance.
• ElementTree
  A tree of instantiated Elements.
• FixedGrid
  A FixedGrid is a grid of elements with a fixed stride.
• Flow
  A flow layout. It is bottom-up: it auto-resizes itself to fit its constituent components.
• FlowColumn
  A FlowColumn is a Flow that is oriented vertically.
• FlowRow
  See https://docs.microsoft.com/en-us/dotnet/desktop/winforms/controls/layout?view=netdesktop-6.0#container-flow-layout
• Focus
  Keeps track of which element has focus.
• FocusRoot
  Provides a context for focusable UI elements.
• FontAwesomeIcon
  A FontAwesome icon.
• Group
  Wrap multiple Elements in a flat hierarchy.
• Hooks
  Hooks are a way to hook into the state and lifecycle of an Element.
• Hotkey
  An element that will invoke a callback when a hotkey is pressed.
• IndexMapEditor
  An editor for a IndexMap. The key and value types must implement Editor.
• IntegerSlider
  A slider for an integer value.
• KeyValueEditor
  An editor for a HashMap. The key and value types must implement Editor.
• Line
  A simple UI line. Use components like line_from, line_to, line_width, background_color, border_color, border_radius and border_thickness to control its appearance.
• ListEditor
  An editor for a list of items that implement Editor; each item can be edited, moved up or down, or deleted.
• ListSelect
  A DropdownSelect that shows the current item for you automatically.
• MeasureSize
  Measures the size of its inner element and calls the callback when it changes.
• Memo
  Memoize the ElementComponent, such that it is only re-rendered if the component changes.
• MinimalListEditor
  A MinimalListEditorWithItemEditor that uses the default editor for the items.
• MinimalListEditorItem
  A single item in a list editor
• MinimalListEditorWithItemEditor
  A configurable list editor that allows you to specify the editor for the items, and to provide other preset options.
• OffscreenEditor
  Delegates a type editor to edit in a new screen.
• PageScreen
  Contains several elements with a background color and click area.
• ParseableInput
  An editor for a value that can be parsed from a string.
• Prompt
  A full-screen prompt dialog that the user must acknowledge.
• Rectangle
  A simple UI rect. Use components like width, height, background_color, border_color, border_radius and border_thickness to control its appearance.
• ScreenContainer
  Contains an element with a background color and click area.
• ScrollArea
  A scroll area that can be used to scroll its child.
• Separator
  A simple separator, similar to <hr> in HTML.
• Slider
  A slider for a floating-point value.
• SystemTimeEditor
  An editor for SystemTime.
• TabBar
  A header bar of tabs. Does not contain the tab content.
• Tabs
  A set of tabs. Contains a TabBar and the content of the selected tab.
• Text
  A text element. Use the text, font_size, font_family and color components to set its state.
• TextEditor
  A text editor.
• Throbber
  Shows an animated progress bar to indicate that progress is being made and has not frozen.
• Tooltip
  A tooltip element: shows the tooltip when the inner is hovered.
• UIBase
  A base element for all UI elements. It contains all the components needed for a UI element to work.
• UIElement
  This only exists so that we can implement From<String> for Text, and then use it in for instance Button.
• WindowSized
  A Dock that is always the size of the window.
• World
• Wrap
  Wraps the inner Element. This is useful for introducing an intermediate component node in a tree.

Enums

• ButtonCb
  The callback invoked when a button is clicked.
• ButtonStyle
  The style of a button.
• MouseInput
  The state of a mouse button.
• ScrollAreaSizing
  Sizing config of a scroll area

Constants

• CHEVRON_DOWN
  Character code for the “down chevron” icon.
• CHEVRON_LEFT
  Character code for the “left chevron” icon.
• CHEVRON_RIGHT
  Character code for the “right chevron” icon.
• CHEVRON_UP
  Character code for the “up chevron” icon.
• COLLECTION_ADD_ICON
  Character code for the “add” icon.
• COLLECTION_DELETE_ICON
  Character code for the “delete” icon.
• MOVE_DOWN_ICON
  Character code for the “move down” icon.
• MOVE_UP_ICON
  Character code for the “move up” icon.
• SMALL_ROUNDING
  Default rounding of corners.
• STREET
  Default margin/padding.

Traits

• Editor
  A trait for types that can be edited in the UI.
• ElementComponent
  The base trait for all element components. These are similar to React components.
• ElementComponentExt
  A convenience trait for converting an ElementComponent into an Element.
• StylesExt
  A trait that adds some default styles to elements.
• UIExt
  A trait that provides helper methods for UI elements.

Functions

• align_horizontal_begin
  Align horizontal begin: Layout alignment: horizontal begin.
• align_horizontal_center
  Align horizontal center: Layout alignment: horizontal center.
• align_horizontal_end
  Align horizontal end: Layout alignment: horizontal end.
• align_vertical_begin
  Align vertical begin: Layout alignment: vertical begin.
• align_vertical_center
  Align vertical center: Layout alignment: vertical center.
• align_vertical_end
  Align vertical end: Layout alignment: vertical end.
• app_background_color
  The color used for the background of the app.
• background_color
  Background color: Background color of an entity with a rect component.
• border_color
  Border color: Border color of an entity with a rect component.
• border_radius
  Border radius: Radius for each corner of an entity with a rect component.
• border_thickness
  Border thickness: Border thickness of an entity with a rect component.
• cast_shadows
  Cast shadows: If attached, this entity will cast shadows.
• cb
  Helper for constructing a Cb.
• children
  Children: The children of this entity.
• color
  Color: This entity will be tinted with the specified color if the color is not black.
• cursor_position
  Cursor position: Absolute mouse cursor position in screen-space. This is the logical position. Multiply by the window_scale_factor to get the physical position.
• cutout_color
  A color slightly darker than app_background_color.
• cylindrical_billboard_z
  Cylindrical billboard Z: If attached, this ensures this entity is always aligned with the camera, except on the Z-axis.
• decal_from_url
  Decal material from URL: Load a Decal material from the URL and attach it to this entity.
• description
  Description: A human-friendly description for this entity.
• docking_bottom
  Docking bottom: Layout docking: bottom.
• docking_fill
  Docking fill: Layout docking: fill.
• docking_left
  Docking left: Layout docking: left.
• docking_right
  Docking right: Layout docking: right.
• docking_top
  Docking top: Layout docking: top.
• dont_despawn_on_unload
  Don’t automatically despawn on module unload: Indicates that this entity shouldn’t be despawned when the module that spawned it unloads.
• dont_store
  Don’t store: Indicates that this entity shouldn’t be stored on disk.
• double_sided
  Double-sided: If this is set, the entity will be rendered with double-sided rendering.
• dtime
  Delta Time: How long the previous tick took in seconds.
• element
  Element: The identifier of the Element that controls this entity.
• element_unmanaged_children
  Element unmanaged children: If this is set, the user is expected to manage the children of the Element themselves.
• error_color
  The error color.
• euler_rotation
  Euler rotation: The Euler rotation of this entity in ZYX order.
• fit_horizontal_children
  Fit horizontal children: Layout fit: horizontal children.
• fit_horizontal_none
  Fit horizontal none: Layout fit: horizontal none.
• fit_horizontal_parent
  Fit horizontal parent: Layout fit: horizontal parent.
• fit_vertical_children
  Fit vertical children: Layout fit: vertical children.
• fit_vertical_none
  Fit vertical none: Layout fit: vertical none.
• fit_vertical_parent
  Fit vertical parent: Layout fit: vertical parent.
• fog_color
  Fog color: The color of the fog for this sun.
• fog_density
  Fog density: The density of the fog for this sun.
• fog_height_falloff
  Fog height fall-off: The height at which the fog will fall off (i.e. stop being visible) for this sun.
• font_family
  Font family: Font family to be used. Can either be ‘Default’, ‘FontAwesome’, ‘FontAwesomeSolid’, ‘Code’ or a url to a font.
• font_size
  Font size: Size of the font.
• font_style
  Font style: One of Bold, BoldItalic, Medium, MediumItalic, Regular, Italic, Light or LightItalic.
• gpu_ui_size
  GPU UI size: Upload the width and height of this UI element to the GPU.
• height
  Height: The height of a UI element.
• id
  ID: The ID of the entity.
• inv_local_to_world
  Inverse Local to World: Converts a world position to a local position.
• is_book_file
  Is book file: This is a file in a layout_bookcase.
• joint_matrices
  Joint Matrices: Contains the matrices for each joint of this skinned mesh.
• joints
  Joints: Contains the joints that comprise this skinned mesh.
• layout_bookcase
  Bookcase layout: Min-max bookcase layout.
• layout_dock
  Dock layout: Top-down dock layout.
• layout_flow
  Flow layout: Bottom-up flow layout.
• layout_width_to_children
  Layout width to children: Width to children.
• light_ambient
  Light ambient: The ambient light color of the sun.
• light_diffuse
  Light diffuse: The diffuse light color of the sun.
• line_from
  Line from: Start point of a line.
• line_to
  Line to: End point of a line.
• line_width
  Line width: Width of line.
• local_to_parent
  Local to Parent: Transformation from the entity’s local space to the parent’s space.
• local_to_world
  Local to World: Transformation from the entity’s local space to worldspace.
• local_user_id
  Local user ID: The user ID of the local player.
• lookat_target
  Look-at target: The position that this entity should be looking at.
• lookat_up
  Look-at up: When combined with lookat_target, the up vector for this entity.
• main_scene
  Main scene: If attached, this entity belongs to the main scene.
• map_seed
  Map seed: A random number seed for this map.
• margin
  Margin: Layout margin: [top, right, bottom, left].
• max_height
  Maximum height: The maximum height of a UI element.
• max_width
  Maximum width: The maximum width of a UI element.
• mesh_to_local
  Mesh to Local: Transformation from mesh-space to the entity’s local space.
• mesh_to_local_from_size
  Mesh to local from size: Update the mesh_to_local based on the width and height of this entity.
• mesh_to_world
  Mesh to World: Transformation from mesh-space to world space.
• min_height
  Minimum height: The minimum height of a UI element.
• min_width
  Minimum width: The minimum width of a UI element.
• mouse_over
  Mouse over: The number of mouse cursors that are currently over this entity.
• mouse_pickable_max
  Mouse pickable max: This entity can be clicked by the mouse, and this component defines the max AABB bound of the click area.
• mouse_pickable_min
  Mouse pickable min: This entity can be clicked by the mouse, and this component defines the min AABB bound of the click area.
• name
  Name: A human-friendly name for this entity.
• orientation_horizontal
  Orientation horizontal: Layout orientation: horizontal.
• orientation_vertical
  Orientation vertical: Layout orientation: vertical.
• outline
  Outline: If attached, this entity will be rendered with an outline with the color specified.
• outline_recursive
  Outline (recursive): If attached, this entity and all of its children will be rendered with an outline with the color specified.
• overlay
  Overlay: If attached, this entity will be rendered with an overlay.
• padding
  Padding: Layout padding: [top, right, bottom, left].
• parent
  Parent: The parent of this entity.
• pbr_material_from_url
  PBR material from URL: Load a PBR material from the URL and attach it to this entity.
• player
  Player: This entity is a player.
• primary_color
  The primary color.
• project_name
  Project Name: The name of the project, from the manifest.
• rect
  Rect: If attached to an entity, the entity will be converted to a UI rectangle, with optionally rounded corners and borders.
• reset_scale
  Reset scale: If attached to a transform hierarchy, the scale will be reset at that point, with only rotation/translation considered.
• rotation
  Rotation: The rotation of this entity.
• scale
  Scale: The scale of this entity.
• screen
  Screen: This entity will be treated as a screen. Used by the Screen ui component.
• secondary_color
  The secondary color.
• selectable
  Selectable: If attached, this object can be selected in the editor.
• sky
  Sky: Add a realistic skybox to the scene.
• snap_to_ground
  Snap to ground: This object should automatically be moved with the terrain if the terrain is changed.
• space_between_items
  Space between items: Space between items in a layout.
• spherical_billboard
  Spherical billboard: If attached, this ensures that this entity is always aligned with the camera.
• sun
  Sun: Marks this entity as a sun (i.e. its rotation will be used to control the global light direction).
• tags
  Tags: Tags for categorizing this entity.
• text
  Text: Create a text mesh on this entity.
• tooltip_background_color
  The color used for tooltip backgrounds.
• translation
  Translation: The translation/position of this entity.
• transparency_group
  Transparency group: Controls when this transparent object will be rendered. Transparent objects are sorted by (transparency_group, z-depth).
• ui_scene
  UI scene: If attached, this entity belongs to the UI scene.
• use_focus
  A hook that returns the current focus state for this element and a callback to set the focus state.
• use_window_logical_resolution
  A hook that returns the current window logical resolution (i.e. taking DPI scaling into account)
• use_window_physical_resolution
  A hook that returns the current window physical resolution (i.e. not taking DPI scaling into account)
• user_id
  User ID: An identifier attached to all things owned by a user, and supplied by the user.
• water
  Water: Add a realistic water plane to this entity.
• width
  Width: The width of a UI element.
• window_logical_size
  Window logical size: The logical size is the physical size divided by the scale factor.
• window_physical_size
  Window physical size: The physical size is the actual number of pixels on the screen.
• window_scale_factor
  Window scale factor: The DPI/pixel scale factor of the window.
• with_rect
  Converts the given element into a rect.

Type Definitions

• ButtonCallback
  The type of function invoked by a button.
• Cb
  A helper type for callbacks that wraps around a function type with an Arc that implements Debug.
• ChangeCb
  Callback for when an editor changes its value.
• F32Input
  A ParseableInput for f32.
• I32Input
  A ParseableInput for i32.
• U32Input
  A ParseableInput for u32.
• U64Input
  A ParseableInput for u64.
• UsizeInput
  A ParseableInput for usize.

Attribute Macros

• element_component
  Helper macro to implement a ElementComponent with a pure free function.