RAUI

关于

RAUI 是一个渲染器无关的 UI 系统，深受 React 的声明式 UI 组合和 UE4 Slate 小部件组件系统的影响。

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

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

架构

应用

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

// 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 节点，它们存储
  • 指向 组件函数 的指针（处理其数据）
  • 唯一的 键（它是 widget ID 的一部分，将用于告诉系统是否应在下一次处理运行中携带其 状态）
  • boxed 可克隆的 属性 数据
  • 列表槽（简单地说：widget 子代）
  • 命名槽（类似于列表槽：widget 子代，但这些子代具有分配给它们的名称，因此您可以通过名称而不是索引来访问它们）
• 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方法的struct，您只需在那里发送与用户输入相关的消息到小部件。存在一个DefaultInteractionsEngine，它涵盖了小部件导航、按钮和输入字段 - 来自鼠标（或任何单一指针）、键盘和游戏手柄等输入设备的动作。当涉及到UI导航时，您可以向默认交互式引擎发送原始的NavSignal消息，尽管您可以随意选择/取消选择小部件，但您仍然可以使用典型的导航操作：上、下、左、右、上一个标签/屏幕、下一个标签/屏幕，还可以聚焦文本输入并将文本输入更改发送到焦点输入小部件。RAUI提供的所有交互式小部件组件都在它们的钩子中处理所有NavSignal动作，因此所有用户需要做的就是激活它们的导航功能（使用NavItemActive单元属性）。RAUI集成想要仅使用默认交互式引擎的应该使用它们中组合的此struct，并使用有关进行了何种输入更改的信息调用其interact方法。该功能的一个示例在Tetra集成crate（TetraInteractionsEngine struct）中。

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

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 差分算法，以优化树重建。
• 找到一种解决方案（或将其作为一项功能）将特性对象数据移动到强类型数据，用于属性和状态。

现在已经完成的事项

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