RAUI

关于

RAUI 是一个与渲染器无关的 UI 系统，它深受 React 的声明式 UI 组成和 UE4 Slate 小部件组件系统的启发。

🗣 发音： RAUI 发音类似于 "ra"（埃及神）+ "oui"（法语中的“是”）—— 音频示例。

RAUI 架构背后的主要思想是将 UI 视为另一个数据源，将其转换为您的首选渲染引擎使用的目标可渲染数据格式。

架构

应用程序

Application 是用户关注的中心。它执行整个 UI 处理逻辑。在那里您应用将被处理的控件树，从主机应用程序向控件发送消息并接收来自控件的信号。

// Coords mapping tell RAUI renderers how to convert coordinates
// between virtual-space and ui-space.
let mapping = CoordsMapping::new(Rect {
    left: 0.0,
    right: 1024.0,
    top: 0.0,
    bottom: 576.0,
});

// Application is UI host.
let mut application = Application::default();
// we use setup functions to register component and props mappings for serialization.
application.setup(setup);
// we can also register them at any time one by one.
application.register_component("app", FnWidget::pointer(app));

// Widget tree is simply a set of nested widget nodes.
let tree = make_widget!(app)
    .named_slot("title", make_widget!(title_bar).with_props("Hello".to_owned()))
    .named_slot("content", make_widget!(vertical_box)
        .listed_slot(make_widget!(text_button).key("hi").with_props("Say hi!".to_owned()))
        .listed_slot(make_widget!(text_button).key("exit").with_props("Exit!".to_owned()))
    );

// some dummy widget tree renderer.
// it reads widget unit tree and transforms it into target format.
let mut renderer = JsonRenderer::default();

// `apply()` sets new widget tree.
application.apply(tree);

// `render()` calls renderer to perform transformations on processed application widget tree.
// by default application won't process widget tree if nothing was changed.
// "change" is either any widget state change, or new message sent to any widget (messages
// can be sent from application host, for example a mouse click, or from another widget).
application.forced_process();
if let Ok(output) = application.render::<JsonRenderer, String, _>(&mapping, &mut renderer) {
    println!("* OUTPUT:\n{}", output);
}

控件

控件分为三个类别

• WidgetNode - 用作源 UI 树（可以是组件、单元或无的变体）

let tree = make_widget!(app)
    .named_slot("title", make_widget!(title_bar).with_props("Hello".to_owned()))
    .named_slot("content", make_widget!(vertical_box)
        .listed_slot(make_widget!(text_button).key("hi").with_props("Say hi!".to_owned()))
        .listed_slot(make_widget!(text_button).key("exit").with_props("Exit!".to_owned()))
    );

• WidgetComponent - 您可以将它们视为虚拟 DOM 节点，它们存储
  • 指向 组件函数 的指针（该函数处理其数据）
  • 唯一的 键（它是控件 ID 的一部分，并将用于告诉系统是否应该将其 状态 带到下一次处理运行）
  • boxed 可克隆的 属性 数据
  • 列出槽（简单地：控件子代）
  • 命名槽（类似于列出槽：控件子代，但这些子代被分配了名称，因此您可以通过名称而不是索引来访问它们）
• WidgetUnit - 渲染器用来将其转换为渲染引擎选择的目标可渲染数据格式的原子元素。

  # use raui::prelude::*;
  TextBoxNode {
      text: "Hello World".to_owned(),
      ..Default::default()
  };
  

组件功能

组件函数是静态函数，将输入数据（属性、状态或两者都不是）转换为输出小部件树（通常用于将另一个组件树简单地包装在一个简单的组件下，其中一些最简单的组件返回最终的 WidgetUnit）。它们作为一个转换链一起工作 - 根组件将其属性应用到子组件中，使用其自身的属性或状态中的数据。

#[derive(PropsData, Debug, Default, Copy, Clone, Serialize, Deserialize)]
struct AppProps {
    #[serde(default)]
    pub index: usize,
}
fn app(context: WidgetContext) -> WidgetNode {
    let WidgetContext {
        props, named_slots, ..
    } = context;
    // easy way to get widgets from named slots.
    unpack_named_slots!(named_slots => { title, content });
    let index = props.read::<AppProps>().map(|p| p.index).unwrap_or(0);

    // we always return new widgets tree.
    make_widget!(vertical_box)
        .key(index)
        .listed_slot(title)
        .listed_slot(content)
        .into()
}

状态

这可能会引发一个疑问： “如果我只使用函数而不使用对象来描述如何可视化UI，我如何在每次渲染运行之间保持一些数据？”。为了这个目的，你使用 状态。状态是在每次处理调用之间存储的数据（只要给定的部件是活跃的，这意味着：在两次处理调用之间，只要部件ID保持相同，为了确保你的部件保持不变，你使用键 - 如果没有分配键，系统将为你生成一个，但这将使得部件在任何时候都有可能死亡，例如，如果你的常见父组件中部件子项的数量发生变化，你的部件将在未分配键时更改其ID”）。一些附加说明：当使用 属性 传递信息以及使用 状态 在处理调用之间存储小部件数据时，你可以使用消息和信号与其他小部件和宿主应用程序进行通信！更重要的是，你可以使用钩子来监听小部件生命周期并在那里执行操作。值得注意的是，状态使用 属性 来保存其数据，因此你可以例如附加多个钩子，每个钩子使用不同的数据类型作为小部件状态，这为组合操作在同一小部件上操作的不同钩子打开了大门。

#[derive(PropsData, Debug, Default, Copy, Clone, Serialize, Deserialize)]
struct ButtonState {
    #[serde(default)]
    pub pressed: bool,
}

钩子

钩子用于将常用小部件逻辑放入单独的函数中，这些函数可以在小部件和其他钩子中串联（你可以使用它构建可重用的逻辑依赖链）。通常，它用于监听生命周期事件，例如挂载、更改和卸载，此外，你可以将钩子串联起来，按它们在小部件和其他钩子中串联的顺序顺序执行。

#[derive(MessageData, Debug, Copy, Clone, PartialEq, Eq)]
enum ButtonAction {
    Pressed,
    Released,
}

fn use_empty(context: &mut WidgetContext) {
    context.life_cycle.mount(|_| {
        println!("* EMPTY MOUNTED");
    });

    context.life_cycle.change(|_| {
        println!("* EMPTY CHANGED");
    });

    context.life_cycle.unmount(|_| {
        println!("* EMPTY UNMOUNTED");
    });
}

// you use life cycle hooks for storing closures that will be called when widget will be
// mounted/changed/unmounted. they exists for you to be able to reuse some common logic across
// multiple components. each closure provides arguments such as:
// - widget id
// - widget state
// - message sender (this one is used to message other widgets you know about)
// - signal sender (this one is used to message application host)
// although this hook uses only life cycle, you can make different hooks that use many
// arguments, even use context you got from the component!
#[pre_hooks(use_empty)]
fn use_button(context: &mut WidgetContext) {
    context.life_cycle.mount(|context| {
        println!("* BUTTON MOUNTED: {}", context.id.key());
        let _ = context.state.write(ButtonState { pressed: false });
    });

    context.life_cycle.change(|context| {
        println!("* BUTTON CHANGED: {}", context.id.key());
        for msg in context.messenger.messages {
            if let Some(msg) = msg.as_any().downcast_ref::<ButtonAction>() {
                let pressed = match msg {
                    ButtonAction::Pressed => true,
                    ButtonAction::Released => false,
                };
                println!("* BUTTON ACTION: {:?}", msg);
                let _ = context.state.write(ButtonState { pressed });
                let _ = context.signals.write(*msg);
            }
        }
    });

    context.life_cycle.unmount(|context| {
        println!("* BUTTON UNMOUNTED: {}", context.id.key());
    });
}

#[pre_hooks(use_button)]
fn button(mut context: WidgetContext) -> WidgetNode {
    let WidgetContext { key, props, .. } = context;
    println!("* PROCESS BUTTON: {}", key);

    make_widget!(text_box).key(key).merge_props(props.clone()).into()
}

内部发生的事情

• 应用程序在一个节点上调用 button
  • button 调用 use_button 钩子
    • use_button 调用 use_empty 钩子
  • use_button 逻辑被执行
• button 逻辑被执行

布局

RAUI公开了Application::layout() API，允许使用虚拟到真实坐标映射和自定义布局引擎来执行小部件树定位数据，这些数据随后由自定义UI渲染器用于指定小部件应放置的盒子。每次执行布局调用都会在应用程序中存储布局数据，您始终可以在任何时间访问该数据。有一个 DefaultLayoutEngine 以通用方式执行此操作。如果你发现其管道中的某些部分工作不同，你完全可以根据自己的需求创建自定义布局引擎！

let mut application = Application::default();
let mut layout_engine = DefaultLayoutEngine;
application.apply(tree);
application.forced_process();
println!(
    "* TREE INSPECTION:\n{:#?}",
    application.rendered_tree().inspect()
);
if application.layout(&mapping, &mut layout_engine).is_ok() {
    println!("* LAYOUT:\n{:#?}", application.layout_data());
}

交互性

RAUI 允许您通过交互引擎简化并自动化与 UI 的交互 - 这只是一个实现 perform_interactions 方法的结构，该方法与应用程序相关联，您在那里需要做的就是向小部件发送与用户输入相关的消息。存在一个 DefaultInteractionsEngine，涵盖了小部件导航、按钮和输入字段 - 来自鼠标（或任何单个指针）、键盘和游戏手柄等输入设备的动作。当涉及到 UI 导航时，您可以向默认交互引擎发送原始的 NavSignal 消息，尽管您可以随意选择/取消选择小部件，但您还有典型的导航动作可用：上、下、左、右、上一个标签/屏幕、下一个标签/屏幕，还可以聚焦文本输入并将文本输入更改发送到焦点输入小部件。RAUI 提供的所有交互式小部件组件都在它们的钩子中处理所有 NavSignal 动作，因此用户只需要激活它们的导航功能（使用 NavItemActive 单元属性）。仅想使用默认交互引擎的 RAUI 集成应使用其中组成的此结构，并使用有关进行了何种输入更改的信息调用其 interact 方法。RAUI App crate（AppInteractionsEngine 结构）中包含该功能的示例。

注意：交互引擎应使用布局来处理指针事件，因此在执行交互之前请确保您已重建布局！

let mut application = Application::default();
// default interactions engine covers typical pointer + keyboard + gamepad navigation/interactions.
let mut interactions = DefaultInteractionsEngine::default();
// we interact with UI by sending interaction messages to the engine.
interactions.interact(Interaction::PointerMove(Vec2 { x: 200.0, y: 100.0 }));
interactions.interact(Interaction::PointerDown(
    PointerButton::Trigger,
    Vec2 { x: 200.0, y: 100.0 },
));
// navigation/interactions works only if we have navigable items (such as `button`) registered
// in some navigable container (usually containers with `nav_` prefix).
let tree = make_widget!(nav_content_box)
    .key("app")
    .listed_slot(make_widget!(button)
        .key("button")
        .with_props(NavItemActive)
        .named_slot("content", make_widget!(image_box).key("icon"))
    );
application.apply(tree);
application.process();
let mapping = CoordsMapping::new(Rect {
    left: 0.0,
    right: 1024.0,
    top: 0.0,
    bottom: 576.0,
});
application
    .layout(&mapping, &mut DefaultLayoutEngine)
    .unwrap();
// Since interactions engines require constructed layout to process interactions we have to
// process interactions after we layout the UI.
application.interact(&mut interactions).unwrap();

媒体

• RAUI + Spitfire In-Game RAUI 与自定义 Material 主题的 In-Game 集成的示例，使用 Spitfire 作为渲染器。

  

• RAUI Todo App 一个使用深色主题 Material 组件库的 TODO 应用程序的示例。

  

贡献

任何改进 RAUI 工具集质量的贡献都将得到高度赞赏。

• 如果您有功能请求，请创建一个 Issue 贴文，并解释该功能的目标及其必要性和优缺点。
• 每当您想要创建一个 PR 时，请从 next 分支创建您的功能分支，这样当它获得批准时，可以使用 GitHub 合并按钮简单合并。
• 所有更改都提交到 next 分支，并从其提交中创建新版本，master 被视为稳定/发布分支。
• 更改应通过测试，您可以通过以下方式运行测试：cargo test --all --features all。
• 此说明文件是从 lib.rs 文档生成的，可以使用以下方式重新生成：cargo readme。

里程碑

RAUI 仍在早期开发阶段，因此请为 v1.0 之前的这些更改做好准备。

• 将 RAUI 集成到公共开源 Rust 游戏中。
• 编写文档。
• 编写关于如何正确使用RAUI以及如何使UI高效的MD书籍。
• 实现VDOM diffing算法以优化树重建。
• 找到一种解决方案（或将其作为一个功能）将特质对象数据移动到强类型数据以用于属性和状态。

现在已完成的事情

• 添加对布局的支持。
• 添加对交互（用户输入）的支持。
• 为GGEZ游戏框架创建渲染器。
• 创建基本用户组件。
• 创建基本的Hello World示例应用程序。
• 将共享属性从属性中解耦（不要合并它们，将共享属性放在上下文中）。
• 创建TODO应用程序作为示例。
• 创建In-Game应用程序作为示例。
• 为Oxygengine游戏引擎创建渲染器。
• 添加复杂的导航系统。
• 创建滚动框小部件。
• 添加“即时模式UI”构建器，以提供基于宏的声明性模式UI构建的替代方案（零开销，它相当于默认使用的声明性宏，即时模式和声明性模式的控件可以无缝交流）。
• 添加数据绑定属性类型，以便轻松从应用程序外部更改数据。
• 创建网格渲染器所需的顶点 + 索引 + 批处理缓冲区的网格化渲染器。
• 将widget_component!和widget_hook!宏规则移动到pre_hooks和post_hooks函数属性。
• 添加PropsData和MessageData过程宏，以逐步取代调用implement_props_data!和implement_message_data!宏的需要。
• 添加对门户的支持 - 一种将子树“传送”到另一个树节点（对模态框和拖放非常有用）的简单方法。
• 添加对View-Model的支持，以便在宿主应用程序和UI之间共享数据。