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, usually made with special macros.
let tree = widget! {
    (app {
        // <named slot name> = ( <widget to put in a slot> )
        title = (title_bar: {"Hello".to_owned()})
        content = (vertical_box [
            (#{"hi"} button: {"Say hi!".to_owned()})
            (#{"exit"} button: {"Close".to_owned()})
        ])
    })
};

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

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

// `render()` calls renderer to perform transformations on processed application widget tree.
if let Ok(output) = application.render(&mapping, &mut renderer) {
    println!("* OUTPUT:\n{}", output);
}

// 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(&mapping, &mut renderer) {
    println!("* OUTPUT:\n{}", output);
}

小部件

小部件分为三个类别

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

  widget! {
      (app {
          // <named slot name> = ( <widget to put in a slot> )
          title = (title_bar: {"Hello".to_owned()})
          content = (vertical_box [
              (#{"hi"} button: {"Say hi!".to_owned()})
              (#{"exit"} button: {"Close".to_owned()})
          ])
      })
  };

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

  widget! {{{
    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.
    widget! {
        // `#{key}` - provided value gives a unique name to node. keys allows widgets
        //      to save state between render calls. here we just pass key of this widget.
        // `vertical_box` - name of widget component to use, this one is built into RAUI.
        // `[...]` - listed widget slots. here we just put previously unpacked named slots.
        (#{index} vertical_box [
            {title}
            {content}
        ])
    }
}

状态

这可能会引起一个疑问："如果我只使用函数而不使用对象来描述如何可视化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);

    widget! {
        (#{key} text_box: {props.clone()})
    }
}

幕后发生了什么

• 应用程序在一个节点上调用 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方法，提供有关进行了什么输入更改的信息。Tetra集成包（TetraInteractionsEngine结构体）中有该功能的示例。

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

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 = widget! {
    (#{"app"} nav_content_box [
        // by default navigable items are inactive which means we have to tell RAUI we activate
        // them to interact with them.
        (#{"button"} button: {NavItemActive} {
            content = (#{"icon"} image_box)
        })
    ])
};
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 + Tetra In-Game RAUI与自定义Material主题的In-Game集成示例，使用Tetra作为渲染器。

  

• RAUI + Tetra todo app 使用Tetra渲染器和暗色主题Material组件库的TODO应用示例。

  

贡献

任何提高RAUI工具集质量的贡献都备受赞赏。

• 如果您有功能请求，请创建一个Issue帖子，并解释该功能的目标以及为什么需要它以及其优缺点。
• 每次您想要创建一个PR时，请从next分支创建您的功能分支，以便在获得批准后可以简单地使用GitHub合并按钮进行合并。
• 所有更改都放入next分支，并从其提交中创建新版本，master被认为是稳定/发布分支。
• 更改应通过测试，您可以通过以下方式运行测试：cargo test --all --features all。
• 此readme文件由lib.rs文档生成，可以使用cargo readme重新生成。

里程碑

RAUI目前处于早期开发阶段，因此请为这些变化做好准备，直到v1.0版本。

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

现在已经完成的事情

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