1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264
//! A UI library for [Ambient](https://github.com/AmbientRun/Ambient). Built on top of [ambient_element](https://crates.io/crates/ambient_element).
//!
//! Ambient's UI system is heavily inspired by React (with hooks), and follows many of the same patterns.
//! Take a look at the [React documentation](https://react.dev/reference/react) to learn how hooks work in general.
//!
//! ## Getting started
//!
//! Here's a minimal, complete example of a counter app:
//!
//! ```ignore
//! use ambient_api::prelude::*;
//!
//! #[element_component]
//! fn App(hooks: &mut Hooks) -> Element {
//! let (count, set_count) = use_state(hooks,0);
//! FlowColumn::el([
//! Text::el(format!("We've counted to {count} now")),
//! Button::new("Increase", move |_| set_count(count + 1)).el(),
//! ])
//! }
//!
//! #[main]
//! pub fn main() {
//! App.el().spawn_interactive();
//! }
//! ```
//!
//! [See all UI examples here](https://github.com/AmbientRun/Ambient/tree/main/guest/rust/examples/ui).
#![deny(missing_docs)]
use ambient_cb::{cb, Cb};
use ambient_element::{
element_component, use_frame, use_module_message, use_rerender_signal, use_runtime_message,
use_state, Element, ElementComponentExt, Hooks,
};
use ambient_guest_bridge::{
broadcast_local_message,
core::{
app::components::{ui_scene, window_logical_size, window_physical_size},
layout::components::{
gpu_ui_size, height, margin, mesh_to_local_from_size, padding, width,
},
rect::components::{background_color, background_url, rect},
transform::components::{
local_to_parent, local_to_world, mesh_to_local, mesh_to_world, scale, translation,
},
ui::{components::focus, messages::FocusChanged},
},
ecs::{EntityId, World},
};
use ambient_shared_types::{ModifiersState, VirtualKeyCode};
use clickarea::ClickArea;
use glam::{vec3, Mat4, UVec2, Vec3, Vec4};
pub mod button;
pub mod clickarea;
pub mod default_theme;
pub mod dropdown;
pub mod editor;
pub mod layout;
pub mod prelude;
pub mod prompt;
pub mod screens;
pub mod scroll_area;
pub mod select;
pub mod tabs;
pub mod text;
pub mod throbber;
pub mod window;
/// A base element for all UI elements. It contains all the components needed for a UI element to work.
#[element_component]
pub fn UIBase(_: &mut Hooks) -> Element {
Element::new()
.init(translation(), vec3(0., 0., -0.001))
.init_default(local_to_world())
.init_default(local_to_parent())
.init_default(mesh_to_world())
.init(width(), 0.)
.init(height(), 0.)
}
/// This only exists so that we can implement `From<String>` for [Text](text::Text), and then use it in
/// for instance [Button](button::Button).
pub struct UIElement(pub Element);
impl From<Element> for UIElement {
fn from(el: Element) -> Self {
Self(el)
}
}
/// A simple UI rect. Use components like `width`, `height`, `background_color`, `border_color`, `border_radius` and `border_thickness`
/// to control its appearance.
#[element_component]
pub fn Rectangle(_hooks: &mut Hooks) -> Element {
with_rect(UIBase.el())
.with(width(), 100.)
.with(height(), 100.)
.with(background_color(), Vec4::ONE)
}
/// Converts the given element into a rect.
pub fn with_rect(element: Element) -> Element {
element
.init(rect(), ())
.init(gpu_ui_size(), Vec4::ZERO)
.init(mesh_to_local(), Mat4::IDENTITY)
.init(scale(), Vec3::ONE)
.init(mesh_to_local_from_size(), ())
.init(ui_scene(), ())
}
/// Show an image loaded from a url
#[element_component]
pub fn ImageFromUrl(
_: &mut Hooks,
/// Url to load the image from
url: String,
) -> Element {
Rectangle
.el()
.with(background_color(), Vec4::ZERO)
.with(background_url(), url)
}
/// 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.
#[element_component]
pub fn Line(_hooks: &mut Hooks) -> Element {
with_rect(UIBase.el()).with(background_color(), Vec4::ONE)
}
fn use_focus_state(hooks: &mut Hooks) -> String {
let rerender = use_rerender_signal(hooks);
use_module_message::<FocusChanged>(hooks, move |_, _, _| {
rerender();
});
hooks.world.resource(focus()).clone()
}
/// Update the current focus to `new_focus` (if it's different from the current focus)
pub fn set_focus(world: &mut World, new_focus: String) {
let old_focus = world.get_cloned(EntityId::resources(), focus()).unwrap();
if old_focus != new_focus {
world
.set(EntityId::resources(), focus(), new_focus.clone())
.unwrap();
broadcast_local_message(
world,
FocusChanged {
from_external: false,
focus: new_focus,
},
);
}
}
/// A hook that returns the current focus state for this element and a callback to set the focus state.
pub fn use_focus(hooks: &mut Hooks) -> (bool, FocusSetter) {
use_focus_for_instance_id(hooks, hooks.instance_id().to_owned())
}
/// Set or unset focus of this element instance
pub type FocusSetter = Cb<dyn Fn(&mut World, bool) + Sync + Send>;
/// A hook that returns the current focus state for this element, given a specific `instance_id`, and a callback to set the focus state.
pub fn use_focus_for_instance_id(hooks: &mut Hooks, instance_id: String) -> (bool, FocusSetter) {
let current_focus = use_focus_state(hooks);
let focused = current_focus == instance_id;
(
focused,
cb(move |world, new_focus| {
set_focus(
world,
if new_focus {
instance_id.clone()
} else {
"".to_string()
},
);
}),
)
}
/// A trait that provides helper methods for UI elements.
pub trait UIExt {
/// Wraps this element in a [ClickArea] element.
fn with_clickarea(self) -> ClickArea;
/// Adds a background color to this element.
fn with_background(self, color: Vec4) -> Self;
/// Adds padding to all sides of this element.
fn with_padding_even(self, padding: f32) -> Self;
/// Adds margin to all sides of this element.
fn with_margin_even(self, margin: f32) -> Self;
}
impl UIExt for Element {
fn with_clickarea(self) -> ClickArea {
ClickArea::new(self)
}
fn with_background(self, background: Vec4) -> Self {
with_rect(self).with(background_color(), background)
}
fn with_padding_even(self, value: f32) -> Self {
self.with(padding(), Vec4::ONE * value)
}
fn with_margin_even(self, value: f32) -> Self {
self.with(margin(), Vec4::ONE * value)
}
}
/// Helper wrapper around [use_runtime_message] that listens to `WindowKeyboardInput` messages
/// and parses them for you.
///
/// The boolean is whether or not the button was pressed (true) or released (false).
///
/// NOTE: This may be removed in future versions of the API when parsing is no longer necessary.
pub fn use_keyboard_input(
hooks: &mut Hooks,
func: impl Fn(&mut World, Option<VirtualKeyCode>, ModifiersState, bool) + Sync + Send + 'static,
) {
use_runtime_message(
hooks,
move |world, event: &ambient_guest_bridge::core::messages::WindowKeyboardInput| {
func(
world,
event
.keycode
.as_ref()
.and_then(|k| k.parse::<VirtualKeyCode>().ok()),
ModifiersState::from_bits_truncate(event.modifiers),
event.pressed,
);
},
);
}
/// A hook that returns the current window physical resolution (i.e. not taking DPI scaling into account)
// We need `clone` as resource is a ref on host and a copy on guest
#[allow(clippy::clone_on_copy)]
pub fn use_window_physical_resolution(hooks: &mut Hooks) -> UVec2 {
let (res, set_res) = use_state(hooks, hooks.world.resource(window_physical_size()).clone());
use_frame(hooks, move |world| {
let new_res = world.resource(window_physical_size()).clone();
if new_res != res {
set_res(new_res);
}
});
res
}
/// A hook that returns the current window logical resolution (i.e. taking DPI scaling into account)
// We need `clone` as resource is a ref on host and a copy on guest
#[allow(clippy::clone_on_copy)]
pub fn use_window_logical_resolution(hooks: &mut Hooks) -> UVec2 {
let (res, set_res) = use_state(hooks, hooks.world.resource(window_logical_size()).clone());
use_frame(hooks, move |world| {
let new_res = world.resource(window_logical_size()).clone();
if new_res != res {
set_res(new_res);
}
});
res
}